Fix test name (#75)

* FIx issue with testName

Author: NimaSoroush

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.3.1] - 2018-5-25
+### Fixed
+- Bug fixed for testName not being picked up correctly
+
 ## [1.3.0] - 2017-12-15
 ### Fixed
 - Support all puppeteer API calls

README.md

@@ -77,6 +77,8 @@ describe('tests differencify', () => {
   it('validate github page appear correctly', async () => {
     await differencify
       .init()
+      .launch()
+      .newPage()
       .goto('https://github.com/NimaSoroush/differencify')
       .screenshot()
       .toMatchSnapshot()

package.json

@@ -1,6 +1,6 @@
 {
   "name": "differencify",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Perceptual diffing tool",
   "main": "dist/index.js",
   "scripts": {

src/__snapshots__/sanitiser.test.js.snap

@@ -33,6 +33,7 @@ Object {
   "isUpdate": false,
   "testId": 1,
   "testName": "test",
+  "testNameProvided": false,
 }
 `;
 
@@ -42,5 +43,6 @@ Object {
   "isUpdate": false,
   "testId": 1,
   "testName": "test",
+  "testNameProvided": false,
 }
 `;

src/index.test.js

@@ -83,6 +83,7 @@ describe('Differencify', () => {
       {
         chain: false,
         testName: 'test',
+        testNameProvided: false,
         isUpdate: 'true',
         testId: 1,
       });

src/integration.tests/__image_snapshots__/test1.snap.png

@@ -171,4 +171,18 @@ describe('Differencify', () => {
     expect(result).toEqual(true);
     expect(result2).toEqual(true);
   }, 20000);
+  it('Custom test name', async () => {
+    const target = differencify.init({
+      testName: 'test1',
+      chain: false,
+    });
+    const page = await target.newPage();
+    await page.goto('http://example.com/');
+    await page.setViewport({ width: 1600, height: 1200 });
+    await page.waitFor(1000);
+    const image = await page.screenshot();
+    const result = await target.toMatchSnapshot(image);
+    await page.close();
+    expect(result).toEqual(true);
+  }, 20000);
 });

src/integration.tests/integration.test.js

@@ -23,6 +23,7 @@ const sanitiseTestConfiguration = (conf, testId) => {
   configuration.chain = checkProperty(conf, 'chain', 'boolean')
     ? conf.chain
     : testConfig.chain;
+  configuration.testNameProvided = checkProperty(conf, 'testName', 'string');
   configuration.testName = checkProperty(conf, 'testName', 'string')
     ? conf.testName
     : testConfig.testName;

src/sanitiser.js

@@ -198,7 +198,7 @@ export default class Target {
     if (image) {
       this.image = image;
     }
-    if (this.testConfig.isJest) {
+    if (this.testConfig.isJest && !this.testConfig.testNameProvided) {
       this.testConfig.testName = this.testId
         ? `${this.testStats.currentTestName} ${this.testId}`
         : this.testStats.currentTestName;

src/target.js

@@ -260,6 +260,33 @@ describe('Target', () => {
       expect(target.testId).toEqual(2);
       expect(mockErr).toHaveBeenCalledTimes(0);
     });
+    it('Will respect to testName if it is provided', async () => {
+      target.testId = 0;
+      target.testConfig.testName = 'test';
+      target.testConfig.testNameProvided = true;
+      target.isJest();
+      target.toMatchSnapshot();
+      expect(target.testConfig.isJest).toEqual(true);
+      expect(target.testStats).not.toBeNull();
+      expect(target.testConfig.testName)
+        .toEqual('test');
+      expect(target.testId).toEqual(1);
+      expect(mockErr).toHaveBeenCalledTimes(0);
+    });
+    it('Will respect to testName if it is provided', async () => {
+      target.testId = 0;
+      target.testConfig.testName = 'test';
+      target.testConfig.testNameProvided = true;
+      target.isJest();
+      target.toMatchSnapshot();
+      target.toMatchSnapshot();
+      expect(target.testConfig.isJest).toEqual(true);
+      expect(target.testStats).not.toBeNull();
+      expect(target.testConfig.testName)
+        .toEqual('test 1');
+      expect(target.testId).toEqual(2);
+      expect(mockErr).toHaveBeenCalledTimes(0);
+    });
   });
   describe('isJest', () => {
     it('will set test to jest mode', async () => {