How to use installDependency method in Cypress

1jest.mock("../lib/get-package");2jest.mock("../lib/pack");3jest.mock("../lib/install");4jest.mock("../lib/utils");5jest.mock("ora", () => {6  const progress = {7    start: () => progress,8    fail: () => progress,9    succeed: () => progress,10  };11  return () => progress;12});13const program = require("commander");14const getPackage = require("../lib/get-package");15const packDependency = require("../lib/pack");16const installDependency = require("../lib/install");17const {18  getMonorepoMapping,19  outputError,20  outputSuccess,21  mkdir,22  moveFile,23} = require("../lib/utils");24const defer = (callback) => (done) =>25  setTimeout(() => {26    callback();27    done();28  }, 1);29const mockDependencyPackage = (options = { unversioned: false }) => ({30  err: null,31  path: `/my/monorepo/path/packages/test-${32    options.unversioned ? "unversioned-" : ""33  }dependency`,34  packageJson: {35    name: `mock-${options.unversioned ? "unversioned-" : ""}dependency`,36    version: options.unversioned ? undefined : "1.0.0",37  },38});39describe("install", () => {40  beforeEach(() => {41    jest.resetAllMocks();42    process.cwd = jest.fn().mockReturnValue("/my/project/path");43    process.argv = [44      "node",45      ".pkl/commands/install.js",46      "test-monorepo",47      "test-dependency",48    ];49    getMonorepoMapping.mockReturnValue({50      "test-monorepo": "/my/monorepo/path/",51    });52    getPackage.mockReturnValue(mockDependencyPackage());53    packDependency.mockReturnValue({54      isError: false,55      file: "test-dependency.tgz",56      stderr: 'lerna success exec Executed command in 1 package: "npm pack"',57      stdout: "test-dependency.tgz",58    });59  });60  describe("when monorepo name is not provided", () => {61    beforeEach(() => {62      process.argv = ["node", ".pkl/commands/install.js"];63      program.missingArgument = jest.fn();64      jest.isolateModules(() => require("../install"));65    });66    it("should not install", () => {67      expect(installDependency).not.toHaveBeenCalled();68    });69    it("should output missing monorepo error", () => {70      expect(program.missingArgument).toHaveBeenCalledTimes(1);71      expect(program.missingArgument).toHaveBeenCalledWith("monorepo");72    });73  });74  describe("when dependency name is not provided", () => {75    beforeEach(() => {76      process.argv = ["node", ".pkl/commands/install.js", "test-monorepo"];77      program.missingArgument = jest.fn();78      jest.isolateModules(() => require("../install"));79    });80    it("should not install", () => {81      expect(installDependency).not.toHaveBeenCalled();82    });83    it("should output missing dependency error", () => {84      expect(program.missingArgument).toHaveBeenCalledTimes(1);85      expect(program.missingArgument).toHaveBeenCalledWith("dependency");86    });87  });88  describe("when unknown monorepo name", () => {89    beforeEach(() => {90      getMonorepoMapping.mockReturnValue({});91      jest.isolateModules(() => require("../install"));92    });93    it("should not install", () => {94      expect(installDependency).not.toHaveBeenCalled();95    });96    it("should output unknown monorepo error", () => {97      expect(outputError).toHaveBeenCalledTimes(1);98      expect(outputError).toHaveBeenCalledWith("unknown monorepo name");99    });100  });101  describe("when dependency package.json cannot be found", () => {102    beforeEach(() => {103      getPackage.mockReturnValue({104        err: "unable to get package.json for test-dependency",105      });106      jest.isolateModules(() => require("../install"));107    });108    it("should not install", () => {109      expect(installDependency).not.toHaveBeenCalled();110    });111    it("should output error getting package.json", () => {112      expect(outputError).toHaveBeenCalledTimes(1);113      expect(outputError).toHaveBeenCalledWith(114        "unable to get package.json for test-dependency"115      );116    });117  });118  describe("when dependency pack fails", () => {119    beforeEach(() => {120      packDependency.mockReturnValue({121        isError: true,122        file: "",123        stderr: "lerna ERR! npm pack exited 127 in 'test-dependency'",124        stdout: "",125      });126      jest.isolateModules(() => require("../install"));127    });128    it("should not install", () => {129      expect(installDependency).not.toHaveBeenCalled();130    });131    it("should output error running pack", () => {132      expect(outputError).toHaveBeenCalledTimes(1);133      expect(outputError).toHaveBeenCalledWith(134        "pack failed",135        "lerna ERR! npm pack exited 127 in 'test-dependency'"136      );137    });138  });139  describe("when dependency install fails", () => {140    beforeEach(() => {141      installDependency.mockReturnValue({142        isError: true,143        stderr:144          'npm ERR! Could not install from ".pkl/mock-dependency.tgz" as it does not contain a package.json file.',145        stdout: "",146      });147      jest.isolateModules(() => require("../install"));148    });149    it("should call install", () => {150      expect(installDependency).toHaveBeenCalledTimes(1);151      expect(installDependency).toHaveBeenCalledWith(152        "/my/project/path",153        "/my/project/path/.pkl/test-dependency.tgz",154        { yarn: undefined }155      );156    });157    it(158      "should output error running install",159      defer(() => {160        expect(outputError).toHaveBeenCalledTimes(1);161        expect(outputError).toHaveBeenCalledWith(162          "install failed",163          'npm ERR! Could not install from ".pkl/mock-dependency.tgz" as it does not contain a package.json file.'164        );165      })166    );167  });168  describe("when dependency install is successful", () => {169    beforeEach(() => {170      installDependency.mockReturnValue({171        isError: false,172        stderr:173          "npm WARN deprecated left-pad@1.3.0: use String.prototype.padStart()",174        stdout: " + mock-dependency@1.0.0",175      });176      jest.isolateModules(() => require("../install"));177    });178    it("should call install", () => {179      expect(installDependency).toHaveBeenCalledTimes(1);180      expect(installDependency).toHaveBeenCalledWith(181        "/my/project/path",182        "/my/project/path/.pkl/test-dependency.tgz",183        { yarn: undefined }184      );185    });186    it("should create local .pkl directory", () => {187      expect(mkdir).toHaveBeenCalledTimes(1);188      expect(mkdir).toHaveBeenCalledWith("/my/project/path/.pkl");189    });190    it("should move pack file into place", () => {191      expect(moveFile).toHaveBeenCalledTimes(1);192      expect(moveFile).toHaveBeenCalledWith(193        "/my/monorepo/path/packages/test-dependency/test-dependency.tgz",194        "/my/project/path/.pkl/test-dependency.tgz"195      );196    });197    it(198      "should not output error",199      defer(() => {200        expect(outputError).not.toHaveBeenCalled();201      })202    );203    it(204      "should output success",205      defer(() => {206        expect(outputSuccess).toHaveBeenCalledTimes(1);207        expect(outputSuccess).toHaveBeenCalledWith(208          "installation complete",209          " - test-dependency (test-monorepo) → mock-dependency@1.0.0"210        );211      })212    );213  });214  describe("when multiple dependencies", () => {215    beforeEach(() => {216      process.argv = [...process.argv, "test-unversioned-dependency"];217      getPackage.mockReset();218      getPackage.mockReturnValueOnce(mockDependencyPackage());219      getPackage.mockReturnValueOnce(220        mockDependencyPackage({ unversioned: true })221      );222      packDependency.mockReset();223      packDependency.mockReturnValueOnce({224        isError: false,225        file: "test-dependency.tgz",226        stderr: 'lerna success exec Executed command in 1 package: "npm pack"',227        stdout: "test-dependency.tgz",228      });229      packDependency.mockReturnValueOnce({230        isError: false,231        file: "test-unversioned-dependency.tgz",232        stderr: 'lerna success exec Executed command in 1 package: "npm pack"',233        stdout: "test-unversioned-dependency.tgz",234      });235      installDependency.mockReturnValue({236        isError: false,237        stderr: "",238        stdout:239          " + mock-dependency@1.0.0\n + mock-unversioned-dependency@0.0.0",240      });241      jest.isolateModules(() => require("../install"));242    });243    it(244      "should call install",245      defer(() => {246        expect(installDependency).toHaveBeenCalledTimes(2);247        expect(installDependency).toHaveBeenCalledWith(248          "/my/project/path",249          "/my/project/path/.pkl/test-dependency.tgz",250          { yarn: undefined }251        );252        expect(installDependency).toHaveBeenCalledWith(253          "/my/project/path",254          "/my/project/path/.pkl/test-unversioned-dependency.tgz",255          { yarn: undefined }256        );257      })258    );259    it(260      "should create local .pkl directory",261      defer(() => {262        expect(mkdir).toHaveBeenCalledTimes(2);263        expect(mkdir).toHaveBeenCalledWith("/my/project/path/.pkl");264      })265    );266    it(267      "should move pack files into place",268      defer(() => {269        expect(moveFile).toHaveBeenCalledTimes(2);270        expect(moveFile).toHaveBeenCalledWith(271          "/my/monorepo/path/packages/test-dependency/test-dependency.tgz",272          "/my/project/path/.pkl/test-dependency.tgz"273        );274        expect(moveFile).toHaveBeenCalledWith(275          "/my/monorepo/path/packages/test-unversioned-dependency/test-unversioned-dependency.tgz",276          "/my/project/path/.pkl/test-unversioned-dependency.tgz"277        );278      })279    );280    it(281      "should not output error",282      defer(() => {283        expect(outputError).not.toHaveBeenCalled();284      })285    );286    it(287      "should output success",288      defer(() => {289        expect(outputSuccess).toHaveBeenCalledTimes(1);290        expect(outputSuccess).toHaveBeenCalledWith(291          "installation complete",292          " - test-dependency (test-monorepo) → mock-dependency@1.0.0",293          " - test-unversioned-dependency (test-monorepo) → mock-unversioned-dependency@0.0.0"294        );295      })296    );297  });298  describe("when using yarn", () => {299    beforeEach(() => {300      process.argv = [...process.argv, "--yarn"];301      installDependency.mockReturnValue({302        isError: false,303        stderr:304          "npm WARN deprecated left-pad@1.3.0: use String.prototype.padStart()",305        stdout: " + mock-dependency@1.0.0",306      });307      jest.isolateModules(() => require("../install"));308    });309    it("should call install", () => {310      expect(installDependency).toHaveBeenCalledTimes(1);311      expect(installDependency).toHaveBeenCalledWith(312        "/my/project/path",313        "/my/project/path/.pkl/test-dependency.tgz",314        { yarn: true }315      );316    });317  });...

...94                    totalDownloaded++95                    if (totalDependencies === totalDownloaded) {96                      callback()97                    } else {98                      installDependency()99                    }100                  } else {101                    var headerRequest = { uri: repoComponents + compInstallDepName + '.json', rejectUnauthorized: false }102                    request(headerRequest, function (error, response, body) {103                      if (response && response.statusCode === 200) {104                        var componentJsonDep = JSON.parse(body)105                        component.install(componentJsonDep, function (err) {106                          if (err) return console.log(' ERROR: '.bgRed, 'Sorry, the component could not be installed at this time.\n', err)107                          if (installedMessage) {108                            console.log(' SUCCESS: '.bgYellow, 'Component ' + compInstallDepName + ' updated success!')109                          } else {110                            console.log(' SUCCESS: '.bgGreen, 'Component ' + compInstallDepName + ' installed success!')111                          }112                          totalDownloaded++113                          if (totalDependencies === totalDownloaded) {114                            callback()115                          } else {116                            installDependency()117                          }118                        })119                      } else {120                        console.log(' ERROR: '.bgRed, 'Component ' + componentJson.dependencies[totalDownloaded] + ' not exist.')121                        totalDownloaded++122                        if (totalDependencies === totalDownloaded) {123                          callback()124                        } else {125                          installDependency()126                        }127                      }128                    })129                  }130                }131                installDependency()132              } else {133                callback()134              }135            })136          } else {137            console.log(' ERROR: '.bgRed, 'Component ' + componentName + ' not exist.')138            callback()139          }140        })141      } else {142        console.log(' ERROR: '.bgRed, 'You must be connected with the outside world.')143      }144    })145  }...

...166  const content = JSON.stringify(config, null, 2);167  if (isBrowser) {168    switch (frontEndFramework) {169      case FrontEndFramework.REACT: {170        installDependency("eslint-plugin-react", true);171        break;172      }173      case FrontEndFramework.VUE2:174      case FrontEndFramework.VUE3: {175        installDependency("eslint-plugin-vue", true);176        if (usingPrettier) {177          installDependency("@vue/eslint-config-prettier", true);178        }179        if (isTypeScript) {180          installDependency("@vue/eslint-config-typescript", true);181        }182        break;183      }184    }185  }186  installDependency("eslint", true);187  // TODO: Support vue188  installDependency("eslint-plugin-eslint-comments", true);189  installDependency("eslint-plugin-import", true);190  if (usingPrettier) {191    installDependency("eslint-config-prettier", true);192  }193  if (isTypeScript) {194    installDependency("@typescript-eslint/eslint-plugin", true);195    installDependency("@typescript-eslint/parser", true);196  }197  addScript("fix:lint", "eslint src --ext .ts,.js,tsx,.jsx --fix");198  addScript("test:lint", "eslint src --ext .ts,.js,tsx,.jsx");199  writeFile(".eslintrc.json", content);200}...

...98                    // exact version?99                    if (regex.test(entry[1])) {100                        updater.addDependency(entry[0]);101                    } else {102                        updater.installDependency(entry[0], entry[1]);103                    }104                });105        }106        if (bowerJson.devDependencies) {107            Object108                .keys(bowerJson.devDependencies)109                .forEach(function (dep) {110                    updater.addDependency(dep, true);111                });112        }113        updater.updateNext();114    };115    fs.readFile('bower.json', 'utf-8', handleFile);116}());

...58  }59}60async function installAllDependencies(projectPath) {61  console.log('installing dependencies...')62  await installDependency('fiber','go',['get', 'github.com/gofiber/fiber/v2'], projectPath)63  await installDependency('godotenv', 'go',['get', 'github.com/joho/godotenv'], projectPath)64  await installDependency('validator', 'go',['get', 'github.com/go-playground/validator/v10'], projectPath)65  await installDependency('mongo', 'go',['get', 'go.mongodb.org/mongo-driver'], projectPath)66  await installDependency('testify', 'go',['get', 'github.com/stretchr/testify'], projectPath)67  68}69async function installDependency(name, cmd, opts, projectPath) {70  console.log(`installing ${name}...`)71  const [error, response ] = await handlePromise(72    exec(cmd, opts, {cwd: projectPath}, (data)=>{73      console.log(data)74    })75  )76  if (error) {77    return console.log(`error while installing ${name} package: ${error.error}`)78  }else{79    console.log(`${name} installed`)80  }81}82async function runCommand( cmd, opts, projectPath) {83  const [error, response ] = await handlePromise(...

...82  outDir,83  declaration,84  libraryName85) {86  installDependency("rollup", true);87  installDependency("@rollup/plugin-commonjs", true);88  installDependency("@rollup/plugin-json", true);89  installDependency("@rollup/plugin-node-resolve", true);90  installDependency("rollup-plugin-sourcemaps", true);91  const rollupConfig = useTypeScript92    ? baseRollupConfig(isBrowser, outDir, libraryName)93    : typeScriptBaseRollupConfig(isBrowser, declaration, outDir, libraryName);94  writeFile("rollup.config.js", rollupConfig);95  installDependency("rollup", true);96  installDependency("rollup-plugin-sourcemaps", true);97  installDependency("@rollup/plugin-commonjs", true);98  installDependency("@rollup/plugin-json", true);99  installDependency("@rollup/plugin-node-resolve", true);100  if (useTypeScript) {101    installDependency("@rollup/plugin-typescript", true);102  }103}...

...28		});29		this._root = tmpDir.name;30		const nodeModules = path.resolve(this._root, 'node_modules');31		await fse.mkdir(nodeModules);32		await this.installDependency('zombiebox', zombieboxRoot);33		await this.installDependency(34			'zombiebox-platform-pc',35			path.dirname(require.resolve('zombiebox-platform-pc/package.json')),36			true37		);38		// eslint-disable-next-line node/global-require39		const pcPackageJson = require('zombiebox-platform-pc/package.json');40		for (const pcDependency of Object.keys(pcPackageJson['dependencies'])) {41			await this.installDependency(42				pcDependency,43				path.dirname(require.resolve(pcDependency + '/package.json'))44			);45		}46		await fse.copy(boilerplate, this._root);47	}48	/**49	 * @return {Promise}50	 */51	async cleanup() {52		await fse.remove(this._root);53	}54	/**55	 * @param {string} name56	 * @param {string} source57	 * @param {boolean} copy58	 * @return {Promise}59	 */60	async installDependency(name, source, copy = false) {61		const target = path.resolve(this._root, 'node_modules', name);62		if (copy) {63			await fse.copy(source, target);64		} else {65			await fse.symlink(source, target, 'junction');66		}67	}68	/**69	 * @param {...?} args70	 * @return {Application}71	 */72	createZbApplication(...args) {73		return new Application(this._root, ...args);74	}...

...23 * @param {FrontEndFramework} frontEndFramework24 */25function configureJest(useTypeScript, isBrowser, frontEndFramework) {26  let jestConfig = getJestConfig(false);27  installDependency("jest", true);28  if (useTypeScript) {29    installDependency("@types/jest", true);30    installDependency("ts-jest", true);31  }32  if (isBrowser) {33    if (frontEndFramework) {34      switch (frontEndFramework) {35        case FrontEndFramework.REACT: {36          installDependency("@testing-library/jest-dom", true);37          installDependency("@testing-library/user-event", true);38          installDependency("@testing-library/react", true);39          break;40        }41        case FrontEndFramework.VUE2: {42          installDependency("@vue/cli-plugin-unit-jest", true);43          installDependency("@vue/test-utils", true);44          installDependency("vue-jest", true);45          jestConfig = getJestConfig(true);46          break;47        }48        case FrontEndFramework.VUE3: {49          installDependency("@vue/cli-plugin-unit-jest", true);50          installDependency("@vue/test-utils@next", true);51          installDependency("vue-jest", true);52          jestConfig = getJestConfig(true);53          break;54        }55      }56    } else {57      installDependency("@testing-library/jest-dom", true);58      installDependency("@testing-library/user-event", true);59    }60  }61  writeFile("jest.config.json", JSON.stringify(jestConfig, null, 2));62}...