Tidy up code + npmignore

Author: Dan Ristea

.gitignore

@@ -32,6 +32,5 @@ dist/
 # Built docs
 docs/
 .vscode/
-dist/
 differencify_report/
 screenshots/

.npmignore

@@ -1,2 +1,13 @@
 src/
 examples/
+.circleci/
+.vscode/
+.idea/
+.babelrc
+.editorconfig
+.eslintignore
+.gitignore
+.eslintrc
+.nvmrc
+_config.yml
+Dockerfile

CHANGELOG.md

@@ -28,7 +28,7 @@
 
 ## [0.0.5] - 2017-07-06
 ### Changed
-- Decreased default threashhold to 0.01
+- Decreased default threshold to 0.01
 - Updated logging to log difference error
 - Update Readme.md
 - Added a Dockerfile for local/CI usage

README.md

@@ -30,7 +30,7 @@ const differencify = new Differencify(GlobalOptions);
 ```js
 async () => {
   const result = await differencify.update(TestOptions);
-  console.log(result); //true if update succeded
+  console.log(result); //true if update succeeded
 }
 ```
 ### Validate your changes

src/chromyRunner.js

@@ -5,9 +5,10 @@ import actions from './actions';
 import { configTypes } from './defaultConfig';
 
 const saveImage = (filename, image, testType, screenshotsPath, testReportPath) => {
-  const filePath = testType === configTypes.test ? testReportPath : screenshotsPath;
-  logger.log(`screenshot saved in -> ${filePath}/${filename}.png`);
-  return fs.writeFileSync(`${filePath}/${filename}.png`, image);
+  const directory = testType === configTypes.test ? testReportPath : screenshotsPath;
+  const filePath = `${directory}/${filename}.png`;
+  logger.log(`screenshot saved in -> ${filePath}`);
+  return fs.writeFileSync(filePath, image);
 };
 
 const run = async (chromy, options, test) => {
@@ -29,7 +30,7 @@ const run = async (chromy, options, test) => {
             try {
               logger.log('Capturing screenshot of whole DOM');
               const png = await chromy.screenshotDocument();
-              await saveImage(test.name, png, test.type, options.screenshots, options.testReportPath);
+              saveImage(test.name, png, test.type, options.screenshots, options.testReportPath);
             } catch (error) {
               logger.error(error);
               return false;
@@ -39,7 +40,7 @@ const run = async (chromy, options, test) => {
             try {
               logger.log('Capturing screenshot of chrome window');
               const png = await chromy.screenshot();
-              await saveImage(test.name, png, test.type, options.screenshots, options.testReportPath);
+              saveImage(test.name, png, test.type, options.screenshots, options.testReportPath);
             } catch (error) {
               logger.error(error);
               return false;
@@ -49,7 +50,7 @@ const run = async (chromy, options, test) => {
             try {
               logger.log(`Capturing screenshot of ${action.value} selector`);
               const png = await chromy.screenshotSelector(action.value);
-              await saveImage(test.name, png, test.type, options.screenshots, options.testReportPath);
+              saveImage(test.name, png, test.type, options.screenshots, options.testReportPath);
             } catch (error) {
               logger.error(error);
               return false;
@@ -59,8 +60,6 @@ const run = async (chromy, options, test) => {
         break;
       case actions.test:
         try {
-          logger.log(`comparing -> ${options.testReportPath}/${test.name}.png
-            and ${options.screenshots}/${test.name}.png`);
           const result = await compareImage(options, test.name);
           logger.log(result);
         } catch (error) {

src/chromyRunner.test.js

@@ -69,7 +69,6 @@ describe('ChromyRunner', () => {
       expect(loggerCalls[0]).toEqual('goto -> www.example.com');
       expect(loggerCalls[1]).toEqual('Capturing screenshot of whole DOM');
       expect(loggerCalls[2]).toEqual('screenshot saved in -> ./differencify_report/default.png');
-      expect(loggerCalls[4]).toEqual('Saving the diff image to disk');
       expect(writeFileSyncCalls).toEqual(['./differencify_report/default.png', 'png file']);
     });
     it('Step runner: update action', async () => {

src/compareImage.js

@@ -5,6 +5,8 @@ const compareImage = async (options, testName) => {
   const referenceFile = `${options.screenshots}/${testName}.png`;
   const testFile = `${options.testReportPath}/${testName}.png`;
 
+  logger.log(`${testName}: comparing ${referenceFile} and ${testFile}`);
+
   let referenceImage;
   try {
     referenceImage = await Jimp.read(referenceFile);
@@ -24,11 +26,17 @@ const compareImage = async (options, testName) => {
   if (distance < options.mismatchThreshold || diff.percent < options.mismatchThreshold) {
     return `${testName}: no mismatch found ✅`;
   }
+
   if (options.saveDifferencifiedImage) {
-    const diffPath = `${options.testReportPath}/${testName}_differencified.png`;
-    logger.log(`${testName}: Saving the diff image to disk at ${diffPath}`);
-    diff.image.write(diffPath);
+    try {
+      const diffPath = `${options.testReportPath}/${testName}_differencified.png`;
+      diff.image.write(diffPath);
+      logger.log(`${testName}: saved the diff image to disk at ${diffPath}`);
+    } catch (err) {
+      throw new Error(`${testName}: failed to save the diff image ${err}`);
+    }
   }
+
   throw new Error(`${testName}: mismatch found❗
     Result:
       distance: ${distance}

src/index.js

@@ -29,6 +29,7 @@ export default class Differencify {
     createDir(this.configuration.screenshots);
     createDir(this.configuration.testReportPath);
   }
+
   _createChromeInstance(testConfig) {
     const width = testConfig.resolution.width || CHROME_WIDTH;
     const height = testConfig.resolution.height || CHROME_HEIGHT;
@@ -41,19 +42,22 @@ export default class Differencify {
     });
     return chromy;
   }
+
   _updateChromeInstances(id, chromy) {
     this.chromeInstances[id] = chromy;
     this.chromeInstancesId += 1;
   }
+
   async _closeChrome(id, chromy) {
     try {
       logger.log('closing browser');
-      chromy.close();
+      await chromy.close();
       delete this.chromeInstances[id];
     } catch (error) {
       logger.error(error);
     }
   }
+
   async _run(config, type, step) {
     const testConfig = sanitiseTestConfiguration(config);
     const chromy = this._createChromeInstance(testConfig);
@@ -67,13 +71,16 @@ export default class Differencify {
     await this._closeChrome(testId, chromy);
     return result;
   }
+
   async update(config) {
     return await this._run(config, configTypes.update, null);
   }
+
   async test(config) {
     const testStep = { name: actions.test, value: this.configuration.testReportPath };
     return await this._run(config, configTypes.test, testStep);
   }
+
   async cleanup() {
     await Promise.all(
       Object.values(this.chromeInstances).map(chromeInstance => chromeInstance.close()),

src/index.test.js

@@ -4,7 +4,7 @@ import Differencify from './index';
 import logger from './logger';
 
 let chromyCloseCallsCounter = 0;
-jest.mock('chromy', () => jest.fn().mockImplementation(() =>
+jest.mock('chromy', () => jest.fn(() =>
     ({
       goto: jest.fn(),
       close: jest.fn(() => { chromyCloseCallsCounter += 1; }),
@@ -78,7 +78,6 @@ describe('Differencify', () => {
     expect(loggerCalls[0]).toEqual('goto -> www.example.com');
     expect(loggerCalls[1]).toEqual('Capturing screenshot of whole DOM');
     expect(loggerCalls[2]).toEqual('screenshot saved in -> ./differencify_report/default.png');
-    expect(loggerCalls[4]).toEqual('Saving the diff image to disk');
     expect(writeFileSyncCalls).toEqual(['./differencify_report/default.png', 'png file']);
   });
   it('cleanup fn', async () => {

src/logger.js

@@ -1,5 +1,4 @@
 /* eslint-disable no-console */
-/* eslint-disable class-methods-use-this */
 class Logger {
   constructor() {
     if (!Logger.instance) {