Feature/implementing tests

README.md

@@ -12,7 +12,7 @@ $ npm install add-dependencies [-g]
 
 ### Usage
 
-Run:
+Run (for `nodejs` see Example):
 
 ```sh
 $ add-dependencies [package_file] <dependencies> [target] [--no-overwrite]
@@ -46,3 +46,27 @@ or with `npx`:
 ```sh
 $ npx add-dependencies /home/user/project/package.json [email protected] [email protected] redux eslint --dev
 ```
+
+or via nodejs
+
+```js
+const npmAdd = require('add-dependencies');
+//OR
+// Note: to use import you must have `"type": "module"` in your projects package.json
+import npmAdd from 'add-dependencies';
+const dependencies = [
+    'package1',
+    'package2',
+    'package3',
+];
+const target = npmAdd.CONSTANTS.DEPENDENCIES;
+const overwrite = false;
+const packageFilePath = 'package.json';
+new npmAdd(dependencies, target, overwrite, packageFilePath)
+    .run()
+    .then(() => console.log('completed'));
+```
+
+### Tests
+
+Simply run `npm i` and then `npm test`

cli-index.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+
+const AddDependencies = require('./lib/AddDependencies');
+
+console.log(
+  '\x1b[33m%s\x1b[0m',
+  'This script adds dependencies (latest or specified versions) to the package.json file skipping the installation process.'
+);
+
+const app = new AddDependencies();
+
+app.run().catch((error) => {
+  console.error('\x1b[31m%s\x1b[0m', error);
+  process.exit(1);
+});

index.js

@@ -1,11 +1,3 @@
 #!/usr/bin/env node
-const AddDependencies = require('./lib/AddDependencies');
 
-console.log('\x1b[33m%s\x1b[0m', 'This script adds dependencies (latest or specified versions) to the package.json file skipping the installation process.');
-
-const app = new AddDependencies();
-
-app.addDependencies().then(app.saveToPackage.bind(app)).catch((error) => {
-  console.error('\x1b[31m%s\x1b[0m', error);
-  process.exit(1);
-});
+module.exports = require('./lib/AddDependencies');

lib/AddDependencies.js

@@ -3,12 +3,17 @@ const semver = require('semver');
 const Files = require('./Files');
 
 class AddDependencies {
-  constructor() {
+  constructor(
+    dependencies = [],
+    target = 'dependencies',
+    overwrite = true,
+    packageFilePath = './package.json'
+  ) {
     this.result = {};
-    this.dependencies = [];
-    this.target = 'dependencies';
-    this.overwrite = true;
-    this.packageFilePath = './package.json';
+    this.dependencies = dependencies;
+    this.target = target;
+    this.overwrite = overwrite;
+    this.packageFilePath = packageFilePath;
   }
 
   addDependencies() {
@@ -59,7 +64,19 @@ class AddDependencies {
     return Promise.all(this.dependencies.map((dep) => this.runNpmShow(dep)));
   }
 
+  run() {
+    return this.addDependencies().then(() => this.saveToPackage());
+  }
+
   runNpmShow(dep) {
+    if (!dep) {
+      console.error(
+        '\x1b[31m%s\x1b[0m',
+        `No Dependency Provided to runNpmShow()`
+      );
+      return new Promise((resolve) => resolve());
+    }
+
     const depSplit = dep.split('@');
     const [depName, depVersion] = dep.charAt(0) !== '@' ? depSplit : [`@${depSplit[1]}`, depSplit[2]];
 
@@ -125,7 +142,7 @@ class AddDependencies {
   }
 
   saveToPackage() {
-    Files.readFromFile(this.packageFilePath).then(async (data) => {
+    return Files.readFromFile(this.packageFilePath).then(async (data) => {
       let json;
 
       try {
@@ -147,7 +164,7 @@ class AddDependencies {
 
       json[this.target] = this.result;
 
-      Files.writeToFile(this.packageFilePath, JSON.stringify(json, null, 2)).then(() => {
+      return Files.writeToFile(this.packageFilePath, JSON.stringify(json, null, 2)).then(() => {
         console.log('\x1b[32m%s\x1b[0m', 'Done.');
       }).catch(() => {
         console.error('\x1b[31m%s\x1b[0m', `Could not write to ${this.packageFilePath}. Stop.`);
@@ -158,6 +175,15 @@ class AddDependencies {
       process.exit(1);
     });
   }
+
+  static get CONSTANTS() {
+    return {
+      DEPENDENCIES: 'dependencies',
+      DEV_DEPENDENCIES: 'devDependencies',
+      PEER_DEPENDENCIES: 'peerDependencies',
+      OPTIONAL_DEPENDENCIES: 'optionalDependencies',
+    };
 }
+};
 
 module.exports = AddDependencies;

lib/Files.js

@@ -5,7 +5,7 @@ class Files {
     return new Promise((resolve, reject) => {
       fs.readFile(filePath, (err, data) => {
         if (err) {
-          return reject();
+          return reject(err);
         }
 
         return resolve(data.toString());
@@ -17,7 +17,7 @@ class Files {
     return new Promise((resolve, reject) => {
       fs.writeFile(filePath, fileContent, (err) => {
         if (err) {
-          return reject();
+          return reject(err);
         }
 
         return resolve();

package.json

@@ -11,7 +11,7 @@
   },
   "homepage": "https://github.com/arfeo/npm-add-dependencies#readme",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --config ./tests/jest.config.js"
   },
   "keywords": [
     "dependencies",
@@ -23,10 +23,17 @@
   "license": "MIT",
   "preferGlobal": true,
   "bin": {
-    "add-dependencies": "index.js"
+    "add-dependencies": "cli-index.js"
   },
   "dependencies": {
     "npm-run": "^5.0.1",
     "semver": "^6.3.0"
+  },
+  "devDependencies": {
+    "blueimp-md5": "^2.16.0",
+    "mock-argv": "^1.1.7",
+    "jest": "^26.0.1",
+    "concat-stream": "^2.0.0",
+    "child_process": "^1.0.2"
   }
 }

tests/__mocks__/cmd.js

@@ -0,0 +1,31 @@
+const concat = require('concat-stream');
+const spawn = require('child_process').spawn;
+
+function createProcess(processPath, args = []) {
+  args = [processPath].concat(args);
+  return spawn('node', args, {
+    env: Object.assign({
+      NODE_ENV: 'test',
+    }),
+  });
+}
+
+function execute(processPath, args = []) {
+  const childProcess = createProcess(processPath, args);
+  childProcess.stdin.setEncoding('utf-8');
+  const promise = new Promise((resolve, reject) => {
+    childProcess.stderr.once('data', (err) => {
+      reject(err.toString());
+    });
+    childProcess.on('error', reject);
+    childProcess.stdout.pipe(
+      concat((result) => {
+        resolve(result.toString());
+      })
+    );
+  });
+  return promise;
+}
+module.exports = {
+  execute, //
+};

tests/__mocks__/utils.js

@@ -0,0 +1,134 @@
+const path = require('path');
+const Files = require('../../lib/Files');
+const {
+  TEST_JSON_DIR, //
+} = require('../jest.config');
+const md5 = require('blueimp-md5');
+const cmd = require('./cmd');
+
+// no params
+const defaultExpect = {
+  dependencies: ['[email protected]'],
+  target: 'dependencies',
+  overwrite: true,
+  packageFilePath: './package.json',
+};
+
+const generateDefaultPackageJson = () => {
+  return Files.readFromFile(
+    path.resolve(__dirname, '../..', 'package.json')
+  ).then((defaultPackageJsonString) => {
+    const defaultPackageJson = JSON.parse(defaultPackageJsonString);
+    defaultPackageJson.dependencies = {
+      jest: '26.0.0',
+    };
+    defaultPackageJson.devDependencies = {
+      jest: '26.0.0',
+    };
+    defaultPackageJson.optionalDependencies = {
+      jest: '26.0.0',
+    };
+    defaultPackageJson.peerDependencies = {
+      jest: '26.0.0',
+    };
+    defaultPackageJson.name = '';
+    return defaultPackageJson;
+  });
+};
+
+const cliRunAndVerify = async (
+  done,
+  packageJsonFilename,
+  args,
+  expectedJsonOverrides
+) => {
+  generateDefaultPackageJson().then((defaultPackageJson) => {
+    Files.writeToFile(
+      packageJsonFilename,
+      JSON.stringify(defaultPackageJson)
+    ).then(() => {
+      cmd.execute('cli-index.js', args).then(() => {
+        Files.readFromFile(packageJsonFilename).then((jsonResult) => {
+          const expectedJson = {
+            ...defaultPackageJson,
+            ...expectedJsonOverrides,
+          };
+          try {
+            expect(JSON.parse(jsonResult)).toEqual(expectedJson);
+            // expect(console.log).toBeCalledWith('\x1b[32m%s\x1b[0m', 'Done.');
+            done();
+          } catch (e) {
+            done(e);
+          }
+        });
+      });
+    });
+  });
+};
+
+const runAndVerify = async (
+  done,
+  classForTesting,
+  packageJsonFilename,
+  testExpectObject,
+  expectedJsonOverrides
+) => {
+  expect(classForTesting).toMatchObject(testExpectObject);
+  generateDefaultPackageJson().then((defaultPackageJson) =>
+    Files.writeToFile(
+      packageJsonFilename,
+      JSON.stringify(defaultPackageJson)
+    ).then(() =>
+      classForTesting.run().then(() =>
+        Files.readFromFile(packageJsonFilename).then((jsonResult) => {
+          const expectedJson = {
+            ...defaultPackageJson,
+            ...expectedJsonOverrides,
+          };
+          try {
+            expect(JSON.parse(jsonResult)).toEqual(expectedJson);
+            expect(console.log).toBeCalledWith('\x1b[32m%s\x1b[0m', 'Done.');
+            done();
+          } catch (e) {
+            done(e);
+          }
+        })
+      )
+    )
+  );
+};
+
+const runAndVerifyWithFailures = async (
+  done,
+  classForTesting,
+  packageJson,
+  testExpectObject
+) => {
+  expect(classForTesting).not.toEqual(testExpectObject);
+  generateDefaultPackageJson().then((defaultPackageJson) =>
+    Files.writeToFile(packageJson, JSON.stringify(defaultPackageJson)).then(
+      () => {
+        classForTesting.run().then(() =>
+          Files.readFromFile(packageJson).then((expectedJson) => {
+            expect(JSON.parse(expectedJson)).not.toEqual(defaultPackageJson);
+            // expect(console.error).toBeCalledWith('\x1b[31m%s\x1b[0m', 'No dependencies passed. Stop.');
+            // expect(process.exit).toHaveBeenCalledWith(1);
+            done();
+          })
+        );
+      }
+    )
+  );
+};
+
+const generateRandomFilename = async () =>
+  path.resolve(TEST_JSON_DIR, `${md5(Math.random().toString())}package.json`);
+
+module.exports = {
+  defaultExpect,
+  runAndVerify,
+  runAndVerifyWithFailures,
+  generateRandomFilename,
+  generateDefaultPackageJson,
+  cliRunAndVerify,
+};