Refactor to exclude only command execution

lifion · Dec 9, 2021 · 7e41f3b · 7e41f3b
1 parent 5814b9a
commit 7e41f3b
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 186 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -6,15 +6,11 @@
 
 const chalk = require('chalk');
 const semver = require('semver');
+const path = require('path');
 const semverPrerelease = require('semver/functions/prerelease');
 const validatePackageName = require('validate-npm-package-name');
 
-const getInstalledVersionHelper = require('./utils/get-installed-versions');
-const getDependenciesHelper = require('./utils/get-dependencies');
-const getLatestVersionsHelper = require('./utils/get-latest-versions');
-const getLatestTagHelper = require('./utils/get-latest-tag');
-const installPackagesHelper = require('./utils/install-packages');
-const installDevPackagesHelper = require('./utils/install-dev-packages');
+const { execp, requireModule } = require('./utils');
 
 const { blue, bold, green, red } = chalk;
 
@@ -42,7 +38,7 @@ function isValidNpmPackageName(name) {
 async function getLatestVersions(name) {
   isValidNpmPackageName(name);
   try {
-    const { stdout } = await getLatestVersionsHelper(name);
+    const { stdout } = await execp(`npm view ${name} versions --json`);
     const versions = JSON.parse(stdout);
     return Array.isArray(versions) ? versions : [versions];
   } catch (err) {
@@ -64,7 +60,7 @@ async function getLatestVersions(name) {
 async function getLatestTag(name) {
   isValidNpmPackageName(name);
   try {
-    const { stdout } = await getLatestTagHelper(name);
+    const { stdout } = await execp(`npm view ${name} dist-tags --json`);
     const { latest } = JSON.parse(stdout);
     return latest;
   } catch (err) {
@@ -125,7 +121,7 @@ async function getLatestVersion(name, wanted) {
  */
 function getInstalledVersion(currentDir, name, logger) {
   try {
-    const { version } = getInstalledVersionHelper(currentDir, name);
+    const { version } = requireModule(path.join(currentDir, 'node_modules', name, 'package.json'));
     return version;
   } catch (err) {
     logger.info(`Error getting a list of installed modules from package.json - ${err}`);
@@ -203,7 +199,7 @@ function removeLockedDependencies(deps) {
  * @param {Logger} [options.logger] - A logger instance, with a similar API as the console object.
  */
 async function verifyDeps({ autoUpgrade = false, dir = '', logger = console } = {}) {
-  const { dependencies = {}, devDependencies = {} } = getDependenciesHelper({ dir });
+  const { dependencies = {}, devDependencies = {} } = requireModule(path.join(dir, 'package.json'));
   logger.info(blue('Verifying dependencies…\n'));
 
   const pkgs = await Promise.all([
@@ -225,8 +221,8 @@ async function verifyDeps({ autoUpgrade = false, dir = '', logger = console } =
     if (autoUpgrade) {
       logger.info('UPGRADING…');
       logger.info(upgradePackages);
-      const prodResult = await installPackagesHelper(getPkgIds(prodPkgs));
-      const devResult = await installDevPackagesHelper(getPkgIds(devPkgs));
+      const prodResult = await execp(`npm i ${getPkgIds(prodPkgs)}`);
+      const devResult = await execp(`npm i -D ${getPkgIds(devPkgs)}`);
       logger.info(`${green(`${bold('Upgraded dependencies:\n')}${prodResult.stdout}`)}`);
       logger.info(`${green(`${bold('Upgraded development dependencies:\n')}${devResult.stdout}`)}`);
     } else {

diff --git a/lib/index.test.js b/lib/index.test.js
@@ -1,18 +1,8 @@
 'use strict';
 
-jest.mock('./utils/get-installed-versions.js');
-jest.mock('./utils/get-dependencies.js');
-jest.mock('./utils/get-latest-versions.js');
-jest.mock('./utils/get-latest-tag.js');
-jest.mock('./utils/install-packages.js');
-jest.mock('./utils/install-dev-packages.js');
-
-const getInstalledVersion = require('./utils/get-installed-versions');
-const getDependencies = require('./utils/get-dependencies');
-const getLatestVersions = require('./utils/get-latest-versions');
-const getLatestTag = require('./utils/get-latest-tag');
-const installPackages = require('./utils/install-packages');
-const installDevPackages = require('./utils/install-dev-packages');
+jest.mock('./utils');
+
+const utils = require('./utils');
 const verifyDeps = require('.');
 
 jest.mock('chalk', () => ({
@@ -33,27 +23,25 @@ describe('lib/index', () => {
   });
 
   function mockDependencies(obj) {
-    getDependencies.mockImplementationOnce(() => obj);
+    utils.requireModule.mockImplementationOnce(() => obj);
   }
   function mockInstalledVersion(version) {
-    getInstalledVersion.mockImplementationOnce(() => ({ version }));
+    utils.requireModule.mockImplementationOnce(() => ({ version }));
   }
   function mockLatestVersions(arr) {
-    getLatestVersions.mockImplementationOnce(() =>
-      Promise.resolve({ stdout: JSON.stringify(arr) })
-    );
+    utils.execp.mockImplementationOnce(() => Promise.resolve({ stdout: JSON.stringify(arr) }));
   }
   function mockLatestTag(latest) {
-    getLatestTag.mockImplementationOnce(() =>
+    utils.execp.mockImplementationOnce(() =>
       Promise.resolve({ stdout: JSON.stringify({ latest }) })
     );
   }
 
   function mockInstallPackages(stdout) {
-    installPackages.mockImplementationOnce(() => Promise.resolve({ stdout }));
+    utils.execp.mockImplementationOnce(() => Promise.resolve({ stdout }));
   }
   function mockInstallDevPackages(stdout) {
-    installDevPackages.mockImplementationOnce(() => Promise.resolve({ stdout }));
+    utils.execp.mockImplementationOnce(() => Promise.resolve({ stdout }));
   }
 
   test('should upgrade upto patch versions when versions prefixed with ~', async () => {
@@ -108,7 +96,7 @@ describe('lib/index', () => {
 
   test('when node module is not installed', async () => {
     mockDependencies({ dependencies: {}, devDependencies: { mi: '^1.0.0' } });
-    getInstalledVersion.mockImplementationOnce(() => {
+    utils.requireModule.mockImplementationOnce(() => {
       throw new Error('foobar');
     });
     mockLatestVersions(['1.0.0', '1.0.1', '2.0.0']);
@@ -201,7 +189,7 @@ describe('lib/index', () => {
     } catch (err) {
       syntaxError = err;
     }
-    getLatestVersions.mockImplementationOnce(() => {
+    utils.execp.mockImplementationOnce(() => {
       throw syntaxError;
     });
     await expect(verifyDeps({ dir, logger })).rejects.toThrow(
@@ -220,7 +208,7 @@ describe('lib/index', () => {
     } catch (err) {
       syntaxError = err;
     }
-    getLatestTag.mockImplementationOnce(() => {
+    utils.execp.mockImplementationOnce(() => {
       throw syntaxError;
     });
     await expect(verifyDeps({ dir, logger })).rejects.toThrow(
@@ -231,7 +219,7 @@ describe('lib/index', () => {
   test('throw error when getting latest versions fails', async () => {
     mockDependencies({ dependencies: { tans: '^1.0.0' } });
     mockInstalledVersion('1.0.0');
-    getLatestVersions.mockImplementation(() => {
+    utils.execp.mockImplementation(() => {
       throw new Error('foo');
     });
     await expect(verifyDeps({ dir, logger })).rejects.toThrow(
@@ -243,7 +231,7 @@ describe('lib/index', () => {
     mockDependencies({ dependencies: { utex: '^1.0.0' } });
     mockInstalledVersion('1.0.0');
     mockLatestVersions(['1.0.0', '1.0.1']);
-    getLatestTag.mockImplementationOnce(() => {
+    utils.execp.mockImplementationOnce(() => {
       throw new Error('boo');
     });
     await expect(verifyDeps({ dir, logger })).rejects.toThrow(
@@ -316,7 +304,10 @@ describe('lib/index', () => {
   });
 
   test('should update to version aliased as latest when aliased latest is less that most recent published version', async () => {
-    mockDependencies({ dependencies: { foo1: '^1.2.3' }, devDependencies: { fooDev1: '^1.2.3' } });
+    mockDependencies({
+      dependencies: { foo1: '^1.2.3' },
+      devDependencies: { fooDev1: '^1.2.3' }
+    });
     mockInstalledVersion('1.2.3');
     mockInstalledVersion('1.2.3');
     mockLatestVersions(['1.2.4', '1.2.5']);
@@ -436,7 +427,7 @@ describe('lib/index', () => {
   test('throw error when npm module name is invalid', async () => {
     mockDependencies({ dependencies: { 'bad name Dependency': '^1.2.3' }, devDependencies: {} });
     mockInstalledVersion('1.2.3');
-    getLatestVersions.mockImplementationOnce(() => {
+    utils.execp.mockImplementationOnce(() => {
       throw new Error('name can only contain URL-friendly characters');
     });
     await expect(verifyDeps({ autoUpgrade: true, dir, logger })).rejects.toThrow(

diff --git a/lib/utils.js b/lib/utils.js
@@ -0,0 +1,16 @@
+'use strict';
+
+const { exec } = require('child_process');
+const { promisify } = require('util');
+
+const execPromise = promisify(exec);
+
+const execp = (cmd = '') => {
+  return execPromise(cmd);
+};
+
+const requireModule = (path = '') => {
+  return require(path);
+};
+
+module.exports = { execp, requireModule };
diff --git a/lib/utils/get-dependencies.js b/lib/utils/get-dependencies.js
diff --git a/lib/utils/get-installed-versions.js b/lib/utils/get-installed-versions.js
diff --git a/lib/utils/get-latest-tag.js b/lib/utils/get-latest-tag.js
diff --git a/lib/utils/get-latest-versions.js b/lib/utils/get-latest-versions.js
diff --git a/lib/utils/install-dev-packages.js b/lib/utils/install-dev-packages.js
diff --git a/lib/utils/install-packages.js b/lib/utils/install-packages.js
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "files": [
     "bin/lifion-verify-deps.js",
     "lib/index.js",
-    "lib/utils"
+    "lib/utils.js"
   ],
   "keywords": [
     "check",
@@ -83,7 +83,7 @@
     "test": {
       "collectCoverageFrom": [
         "**/*.js",
-        "!**/utils/*.js"
+        "!**/utils.js"
       ]
     }
   }