feat: add an option to configure jest matcher (#19)

At this stage, it is only possible to configure appName. Later it will be easier to add batch support.

This is part of #15 effort

README.md

@@ -103,6 +103,29 @@ When you change production code implementation, Eyes will break, and you will ha
 
   `version` <[string]> (optional) Used to create a new baseline. See [Creating a new baseline](https://github.com/wix-incubator/match-screenshot#creating-a-new-baseline) for more details. Default value: 'v1.0.0'.
 
+
+#### jestWithConfig([options])
+
+Configure your matcher with global options.
+
+Set the matcher:
+
+```js
+"jest": {
+  "setupTestFrameworkScriptFile": "<rootDir>/setupTestFrameworkScriptFile.js"
+},
+```
+
+Inside `setupTestFrameworkScriptFile.js` you can then:
+
+```js
+require('match-screenshot/jestWithConfig')(options);
+```
+
+- options
+
+  `appName` <[string]> Application name. Will be used inside Applitools as part of test title
+
 ## How does it work
 
 Everytime you use `toMatchScreenshot` matcher, a screenshot will be sent to [Applitools Eyes](https://applitools.com/), which will compare the new screenshot with the baseline. The test will fail if they are not equal.

jestWithConfig.js

@@ -0,0 +1 @@
+module.exports = (options = {}) => require('./lib/jestWithConfig')(options);

lib/chai.js

@@ -1,6 +1,6 @@
 const toMatchEyesScreenshot = require('./toMatchEyesScreenshot.js');
 
 async function toMatchScreenshot(options) {
-  await toMatchEyesScreenshot(this._obj, options);
+  await toMatchEyesScreenshot()(this._obj, options);
 }
 module.exports = toMatchScreenshot;

lib/jest.js

@@ -1,4 +1,4 @@
 const matcherGenerator = require('./matcherGenerator');
 const toMatchEyesScreenshot = require('./toMatchEyesScreenshot');
 
-module.exports = matcherGenerator(toMatchEyesScreenshot);
+module.exports = matcherGenerator(toMatchEyesScreenshot());

lib/jestWithConfig.js

@@ -0,0 +1,4 @@
+const matcherGenerator = require('./matcherGenerator');
+const toMatchEyesScreenshot = require('./toMatchEyesScreenshot');
+
+module.exports = options => matcherGenerator(toMatchEyesScreenshot(options));

lib/toMatchEyesScreenshot.js

@@ -2,22 +2,24 @@ const {Eyes} = require('eyes.images');
 const path = require('path');
 require('dotenv').config();
 
-async function toMatchScreenshot(instance, {key, version = 'v1.0.0'}) {
-  const eyes = new Eyes();
-  if (process.env.EYES_API_KEY) {
-    eyes.setOs(process.platform);
-    eyes.setApiKey(process.env.EYES_API_KEY);
-  }
-  const appName = require(path.join(process.cwd(), 'package.json')).name;
+module.exports = (options = {}) =>
+  async function toMatchScreenshot(instance, {key, version = 'v1.0.0'}) {
+    const eyes = new Eyes();
+    if (process.env.EYES_API_KEY) {
+      eyes.setOs(process.platform);
+      eyes.setApiKey(process.env.EYES_API_KEY);
+    }
+    const appName =
+      options.appName || require(path.join(process.cwd(), 'package.json')).name;
 
-  await sendToEyes({
-    eyes,
-    img: instance,
-    appName,
-    specName: key,
-    version,
-  });
-}
+    await sendToEyes({
+      eyes,
+      img: instance,
+      appName,
+      specName: key,
+      version,
+    });
+  };
 
 const sendToEyes = async ({eyes, img, appName, specName, version}) => {
   try {
@@ -33,5 +35,3 @@ const sendToEyes = async ({eyes, img, appName, specName, version}) => {
   await eyes.close();
   console.log(`eyes comparison succeed for test "${specName} ${version}"`);
 };
-
-module.exports = toMatchScreenshot;

tests/__fixtures__/conf.json → tests/__fixtures__/jest-default/conf.json

@@ -1,5 +1,5 @@
 {
   "preset": "jest-puppeteer",
-  "testMatch": [ "**/tests/__fixtures__/*.jest.js"],
+  "testMatch": [ "**/tests/__fixtures__/jest-default/*.jest.js"],
   "setupTestFrameworkScriptFile": "<rootDir>/setupTestFrameworkScriptFile.js"
 }

tests/__fixtures__/jest-default/setupTestFrameworkScriptFile.js

@@ -0,0 +1 @@
+require('../../../lib/jest');

tests/__fixtures__/jest-with-config/conf.json

@@ -0,0 +1,5 @@
+{
+  "preset": "jest-puppeteer",
+  "testMatch": [ "**/tests/__fixtures__/jest-with-config/*.jest.js"],
+  "setupTestFrameworkScriptFile": "<rootDir>/setupTestFrameworkScriptFile.js"
+}

tests/__fixtures__/jest-with-config/setupTestFrameworkScriptFile.js

@@ -0,0 +1,3 @@
+require('../../../lib/jestWithConfig')({
+  appName: 'match-screenshot-with-config',
+});

tests/__fixtures__/jest-with-config/test.jest.js

@@ -0,0 +1,8 @@
+it(`should work`, async () => {
+  jest.setTimeout(30000);
+  await global.page.setContent('<div>Hi there with config</div>');
+  const screenshot = await global.page.screenshot({fullpage: true});
+  await expect(screenshot).toMatchScreenshot({
+    key: 'should work with jest',
+  });
+});

tests/toMatchScreenshotJest.test.js

@@ -7,12 +7,30 @@ describe('EYES', () => {
   describe('Log', () => {
     test('should log after eyes success', async () => {
       const options = {
-        config: require.resolve('./__fixtures__/conf.json'),
+        config: require.resolve('./__fixtures__/jest-default/conf.json'),
       };
 
       const res = await execa('node', [
         require.resolve('jest/bin/jest'),
-        require.resolve('./__fixtures__/test.jest'),
+        require.resolve('./__fixtures__/jest-default/test.jest'),
+        dargs(options),
+      ]);
+
+      expect(res.stdout).toContain(
+        'eyes comparison succeed for test "should work with jest v1.0.0"',
+      );
+    });
+  });
+
+  describe('should works with configurations', () => {
+    test('should log after eyes success', async () => {
+      const options = {
+        config: require.resolve('./__fixtures__/jest-with-config/conf.json'),
+      };
+
+      const res = await execa('node', [
+        require.resolve('jest/bin/jest'),
+        require.resolve('./__fixtures__/jest-with-config/test.jest'),
         dargs(options),
       ]);