Merge pull request #29 from llonchj/master

generate_screenshot_path setting not honored in globals.visual_regression_settings
Crunch-io · Apr 2, 2019 · 1663e1e · 1663e1e
2 parents 65b2776 + d66cc32
commit 1663e1e
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ yarn.lock
 reports
 package-lock.json
 selenium-debug.log
+.DS_Store
diff --git a/lib/generate-screenshot-file-path.js b/lib/generate-screenshot-file-path.js
@@ -2,7 +2,8 @@
 
 const kebabCase = require('lodash/kebabCase'),
     path = require('path'),
-    get = require('lodash/get')
+    get = require('lodash/get'),
+    getVrtSettings = require('./get-vrt-settings')
 
 
 function appendExtensionToFilename(fileName) {
@@ -41,11 +42,7 @@ function defaultScreenshotFilePath(nightwatchClient, basePath, fileName) {
  * @param {String} [fileName] A custom filename for the screenshot
  */
 module.exports = function generateScreenshotFilePath(nightwatchClient, basePath, fileName) {
-    const globalSettings = get(
-        nightwatchClient,
-        'globals.test_settings.visual_regression_settings',
-        null
-    )
+    const globalSettings = getVrtSettings(nightwatchClient)
 
     if (globalSettings && globalSettings.generate_screenshot_path) {
         return globalSettings.generate_screenshot_path(

diff --git a/lib/get-vrt-settings.js b/lib/get-vrt-settings.js
@@ -1,6 +1,7 @@
 'use strict'
 
 const get = require('lodash/get')
+const isEmpty = require('lodash/isEmpty')
 
 /**
  * Get the visual regression tests settings from the nightwatch configuration file.
@@ -17,7 +18,7 @@ module.exports = function getVrtSettings(nightwatchClient, overrideSettings) {
 
     const settings = visualRegressionSettingsPaths.map((settingPath) =>
         get(nightwatchClient, settingPath, null)
-    ).find((vrtSettings) => vrtSettings)
+    ).filter((result) => !isEmpty(result))[0]
 
     return Object.assign(
         {

diff --git a/tests/lib/generate-screenshot-file-path-test.js b/tests/lib/generate-screenshot-file-path-test.js
@@ -1,23 +1,17 @@
-'use strict'
-
 const generateScreenshotFilePath = require('../../lib/generate-screenshot-file-path')
 const path = require('path')
+const set = require('lodash/set')
 
 describe('generateScreenshotFilePath', () => {
-    let customNameFn
-
     function getNightwatchClient() {
         return {
             currentTest: {
                 module: 'visualizations',
                 name: 'barPlots'
             },
             globals: {
-                test_settings: {
-                    visual_regression_settings: {
-                        generate_screenshot_path: customNameFn
-                    }
-                }
+                visual_regression_settings: {},
+                test_settings: { visual_regression_settings: {} }
             }
         }
     }
@@ -33,10 +27,35 @@ describe('generateScreenshotFilePath', () => {
     })
 
     it('should pass the correct filename to the custom naming function', () => {
-        customNameFn = (client, basePath, fileName) =>
-            path.join(process.cwd(), basePath, client.currentTest.module, `custom-${fileName}`)
+        const nightwatchClient = getNightwatchClient()
+        const testFn = jest.fn((client, basePath, fileName) =>
+            path.join(process.cwd(), basePath, client.currentTest.module, `test-setting-custom-${fileName}`))
 
-        expect(generateScreenshotFilePath(getNightwatchClient(), 'baseline', 'foo-test'))
+        set(nightwatchClient, 'globals.test_settings.visual_regression_settings.generate_screenshot_path', testFn)
+
+        const result = generateScreenshotFilePath(nightwatchClient, 'baseline', 'foo-test')
+
+        expect(testFn).toHaveBeenCalled()
+        expect(result)
+            .toEqual(`${process.cwd()}/baseline/visualizations/test-setting-custom-foo-test.png`)
+    })
+
+    it('should use the base global setting for generate_screenshot_path if a test_setting exists', () => {
+        const nightwatchClient = getNightwatchClient()
+        const testFn = jest.fn((client, basePath, fileName) =>
+            path.join(process.cwd(), basePath, client.currentTest.module, `test-setting-custom-${fileName}`))
+
+        set(nightwatchClient, 'globals.test_settings.visual_regression_settings.generate_screenshot_path', testFn)
+
+        const customFn = jest.fn((client, basePath, fileName) =>
+            path.join(process.cwd(), basePath, client.currentTest.module, `custom-${fileName}`))
+
+        set(nightwatchClient, 'globals.visual_regression_settings.generate_screenshot_path', customFn)
+        set(nightwatchClient, 'globals.test_settings.visual_regression_settings.generate_screenshot_path', testFn)
+
+        const result = generateScreenshotFilePath(nightwatchClient, 'baseline', 'foo-test')
+
+        expect(result, 'baseline', 'foo-test')
             .toEqual(`${process.cwd()}/baseline/visualizations/custom-foo-test.png`)
     })
 })