@penskemediacorp/backstopjs-config 1.24.1 → 1.26.0

package/__tests__/backstopjs-config.test.js

@@ -11,55 +11,69 @@ const processMocker = {
 		'/usr/local/Cellar/node/10.11.0/bin/node',
 		'/Users/laraschenck/Sites/pmc-deadline-2019/assets/node_modules/.bin/backstop',
 		'--configPath=node_modules/pmc-build-utils/lib/backstop.js',
-		'test'
+		'test',
 	],
 	argvWithUrl: [
 		'/usr/local/Cellar/node/10.11.0/bin/node',
 		'/Users/laraschenck/Sites/pmc-deadline-2019/assets/node_modules/.bin/backstop',
 		'--configPath=node_modules/pmc-build-utils/lib/backstop.js',
 		'test',
-		'--url=https://notlaura.com'
-	]
+		'--url=https://notlaura.com',
+	],
 };
 
 const expectations = {
-	url: 'https://notlaura.com'
+	url: 'https://notlaura.com',
 };
 
 // Basically what happens in index.js
 
-describe( 'url handling for backstop command', function() {
-
+describe( 'url handling for backstop command', function () {
 	it( 'overrides the configuration url with a CLI argument', () => {
-		assert.equal( backstopUtils.maybeUseCliUrl( processMocker.argvWithUrl, appConfiguration.testBaseUrl ), expectations.url );
-	});
+		assert.equal(
+			backstopUtils.maybeUseCliUrl(
+				processMocker.argvWithUrl,
+				appConfiguration.testBaseUrl
+			),
+			expectations.url
+		);
+	} );
 
 	it( 'uses the configuration URL if no URL parameter is passed', () => {
-		assert.equal( backstopUtils.maybeUseCliUrl( processMocker.argv, appConfiguration.testBaseUrl ), appConfiguration.testBaseUrl );
-	});
+		assert.equal(
+			backstopUtils.maybeUseCliUrl(
+				processMocker.argv,
+				appConfiguration.testBaseUrl
+			),
+			appConfiguration.testBaseUrl
+		);
+	} );
 
 	it( 'returns a testPaths url if there are no larva modules', () => {
 		const scenarios = getScenarios(
 			appConfiguration.testBaseUrl,
 			appConfiguration.testPaths,
 			backstopUtils.prepareTestSelectors( null ),
-			{} );
+			{}
+		);
 
 		// Remove larvaModules to test plain URLs
 		delete appConfiguration.larvaModules;
 
-		assert.equal( appConfiguration.testBaseUrl + appConfiguration.testPaths[0], scenarios[0].url );
-	});
+		assert.equal(
+			appConfiguration.testBaseUrl + appConfiguration.testPaths[ 0 ],
+			scenarios[ 0 ].url
+		);
+	} );
 
 	it( 'second scenario has a selector', () => {
 		const scenarios = getScenarios(
 			appConfiguration.testBaseUrl,
 			appConfiguration.testPaths,
 			backstopUtils.prepareTestSelectors( null ),
-			{} );
-
-		assert.equal( scenarios[1].selectors[0], 'document' );
-	});
-
-});
+			{}
+		);
 
+		assert.equal( scenarios[ 1 ].selectors[ 0 ], 'document' );
+	} );
+} );

package/__tests__/fixtures/larva.config.js

@@ -1,18 +1,13 @@
 const path = require( 'path' );
 
 module.exports = {
-
 	backstop: {
 		testBaseUrl: 'https://pmc:for-the-win@deadline-2019.pmcqa.com',
-		testPaths: [
-			'/',
-			'/blog/'
-		],
+		testPaths: [ '/', '/blog/' ],
 		testScenario: {
-			'delay': 5000,
-			'misMatchThreshold': 0.5
+			delay: 5000,
+			misMatchThreshold: 0.5,
 		},
-		larvaModules: [ 'footer', 'mega-menu-content', 'social-share' ]
+		larvaModules: [ 'footer', 'mega-menu-content', 'social-share' ],
 	},
-
-};
+};

package/__tests__/lib/getScenarios.test.js

@@ -1,70 +1,76 @@
-const getScenarios = require('../../lib/getScenarios');
+const getScenarios = require( '../../lib/getScenarios' );
 const assert = require( 'assert' );
 
-let stub = {
-	paths: ['/modules/footer', '/modules/header'],
+const stub = {
+	paths: [ '/modules/footer', '/modules/header' ],
 	urlBase: 'http://localhost:3000',
 	selectors: [ '.footer', '.header' ],
-	scenarioOverride: {}
+	scenarioOverride: {},
 };
 
-const expectation = [{
+const expectation = [
+	{
 		label: '/modules/footer',
 		url: 'http://localhost:3000/modules/footer',
 		hideSelectors: [],
 		removeSelectors: [],
-		selectors: ['.footer'],
+		selectors: [ '.footer' ],
 		delay: 500,
 		misMatchThreshold: 0.1,
 		onBeforeScript: 'puppet/onBefore.js',
-		onReadyScript: 'puppet/onReady.js'
+		onReadyScript: 'puppet/onReady.js',
 	},
 	{
 		label: '/modules/header',
 		url: 'http://localhost:3000/modules/header',
 		hideSelectors: [],
 		removeSelectors: [],
-		selectors: ['.header'],
+		selectors: [ '.header' ],
 		delay: 500,
 		misMatchThreshold: 0.1,
 		onBeforeScript: 'puppet/onBefore.js',
-		onReadyScript: 'puppet/onReady.js'
-	}
+		onReadyScript: 'puppet/onReady.js',
+	},
 ];
 
-describe('getScenarios', () => {
-
-	it('outputs backstop scenario objects', () => {
-
-		let testScenarios = getScenarios(
-			stub.urlBase, stub.paths, stub.selectors, stub.scenarioOverride
+describe( 'getScenarios', () => {
+	it( 'outputs backstop scenario objects', () => {
+		const testScenarios = getScenarios(
+			stub.urlBase,
+			stub.paths,
+			stub.selectors,
+			stub.scenarioOverride
 		);
 
 		assert.deepEqual( testScenarios, expectation );
+	} );
 
-	});
-
-	it('supports document for selector', () => {
-
+	it( 'supports document for selector', () => {
 		stub.selectors = [ 'document' ];
 
-		let testScenarios = getScenarios(
-			stub.urlBase, stub.paths, stub.selectors, stub.scenarioOverride
+		const testScenarios = getScenarios(
+			stub.urlBase,
+			stub.paths,
+			stub.selectors,
+			stub.scenarioOverride
 		);
 
-		assert.deepEqual( testScenarios[0].selectors, stub.selectors );
-
-	});
+		assert.deepEqual( testScenarios[ 0 ].selectors, stub.selectors );
+	} );
 
 	it( 'overrides scenario config', () => {
-
 		stub.scenarioOverride.delay = 1000;
 
-		let testScenario = getScenarios(
-			stub.urlBase, stub.paths, stub.selectors, stub.scenarioOverride
+		const testScenario = getScenarios(
+			stub.urlBase,
+			stub.paths,
+			stub.selectors,
+			stub.scenarioOverride
 		);
 
-		assert.deepEqual( testScenario[0].delay, stub.scenarioOverride.delay );
-
-	});
-})
+		assert.deepEqual(
+			testScenario[ 0 ].delay,
+			stub.scenarioOverride.delay
+		);
+	} );
+} );

package/__tests__/lib/utils.test.js

@@ -6,24 +6,40 @@ const { prepareTestPaths, prepareTestSelectors } = require( '../../lib/utils' );
 const getAppConfiguration = require( '../../lib/getConfig' );
 const appConfiguration = getAppConfiguration( 'backstop' );
 
-describe( 'backstop utils', function() {
-
+describe( 'backstop utils', function () {
 	it( 'prepareTestPaths - returns paths for modules if present', () => {
 		assert.deepEqual(
-			prepareTestPaths( appConfiguration.larvaModules, appConfiguration.testPaths ),
-			[ '/modules/footer', '/modules/mega-menu-content', '/modules/social-share' ]
+			prepareTestPaths(
+				appConfiguration.larvaModules,
+				appConfiguration.testPaths
+			),
+			[
+				'/modules/footer',
+				'/modules/mega-menu-content',
+				'/modules/social-share',
+			]
 		);
-	});
+	} );
 
 	it( 'prepareTestPaths - returns array of pmcPaths if no larva modules', () => {
-		assert.deepEqual( prepareTestPaths( [], [ '/', '/blog/', '/about/' ] ), [ '/', '/blog/', '/about/' ] );
-	});
+		assert.deepEqual(
+			prepareTestPaths( [], [ '/', '/blog/', '/about/' ] ),
+			[ '/', '/blog/', '/about/' ]
+		);
+	} );
 
 	it( 'prepareTestSelectors - adds a . in front of each module to make it a class', () => {
-		assert.deepEqual( prepareTestSelectors( [ 'footer', 'mega-menu-content', 'social-share' ] ), [ '.footer', '.mega-menu-content', '.social-share' ] );
-	});
+		assert.deepEqual(
+			prepareTestSelectors( [
+				'footer',
+				'mega-menu-content',
+				'social-share',
+			] ),
+			[ '.footer', '.mega-menu-content', '.social-share' ]
+		);
+	} );
 
 	it( 'prepareTestSelectors - returns document if array of modules is null', () => {
 		assert.deepEqual( prepareTestSelectors( null ), [ 'document' ] );
-	});
-});
+	} );
+} );

package/index.js

@@ -14,64 +14,91 @@ const cliArgs = ( function getCliArgs() {
 	}
 
 	return process.argv;
-}() );
+} )();
 
-const urlBase = backstopUtils.maybeUseCliUrl( cliArgs, appConfiguration.testBaseUrl );
-const selectors = backstopUtils.prepareTestSelectors( ( appConfiguration.larvaModules || null ) );
+const urlBase = backstopUtils.maybeUseCliUrl(
+	cliArgs,
+	appConfiguration.testBaseUrl
+);
+const selectors = backstopUtils.prepareTestSelectors(
+	appConfiguration.larvaModules || null
+);
 
-let paths = backstopUtils.prepareTestPaths( appConfiguration.larvaModules, appConfiguration.testPaths );
+const paths = backstopUtils.prepareTestPaths(
+	appConfiguration.larvaModules,
+	appConfiguration.testPaths
+);
 
 // Exit if no paths in config.
 if ( 0 === paths.length ) {
-	console.error( chalk.red.bold( '\nPlease specify paths to test in larva.config.js in the structure `backstop.testPaths`, or add modules in `backstop.larvaModules`\n' ) );
+	console.error(
+		chalk.red.bold(
+			'\nPlease specify paths to test in larva.config.js in the structure `backstop.testPaths`, or add modules in `backstop.larvaModules`\n'
+		)
+	);
 	process.exit( 1 );
 }
 
 // Exit if no URL from config or CLI.
 if ( undefined === appConfiguration.testBaseUrl && false === urlFromCli ) {
-	console.error( chalk.red.bold( '\nPlease specify a QA URL in pmc.config.js in `backstop.testBaseUrl`, or pass in a full URL with the comman e.g. `npm run backstop -- test --url=https://example.com`\n' ) );
+	console.error(
+		chalk.red.bold(
+			'\nPlease specify a QA URL in pmc.config.js in `backstop.testBaseUrl`, or pass in a full URL with the comman e.g. `npm run backstop -- test --url=https://example.com`\n'
+		)
+	);
 	process.exit( 1 );
 }
 
-const scenarios = getScenarios( urlBase, paths, selectors, appConfiguration.testScenario );
+const scenarios = getScenarios(
+	urlBase,
+	paths,
+	selectors,
+	appConfiguration.testScenario
+);
 
 console.log( chalk.blue( 'Testing paths: \n' + paths ) );
 
-module.exports = merge({
-	'id': 'backstop_test',
-	'viewports': [
-		{
-			'name': 'small',
-			'width': 400,
-			'height': 620
+module.exports = merge(
+	{
+		id: 'backstop_test',
+		viewports: [
+			{
+				name: 'small',
+				width: 400,
+				height: 620,
+			},
+			{
+				name: 'desktop',
+				width: 1000,
+				height: 800,
+			},
+			{
+				name: 'desktop-xl',
+				width: 1300,
+				height: 1000,
+			},
+		],
+		scenarios,
+		paths: {
+			bitmaps_reference:
+				process.cwd() + '/backstop_data/bitmaps_reference',
+			bitmaps_test: process.cwd() + '/backstop_data/bitmaps_test',
+			engine_scripts: path.join(
+				__dirname,
+				'./backstop_data/engine_scripts'
+			),
+			html_report: process.cwd() + '/backstop_data/html_report',
+			ci_report: process.cwd() + '/backstop_data/ci_report',
 		},
-		{
-			'name': 'desktop',
-			'width': 1000,
-			'height': 800
+		report: [ 'browser' ],
+		engine: 'puppeteer',
+		engineOptions: {
+			waitTimeout: 120000,
 		},
-		{
-			'name': 'desktop-xl',
-			'width': 1300,
-			'height': 1000
-		}
-	],
-	'scenarios': scenarios,
-	'paths': {
-		'bitmaps_reference': process.cwd() + '/backstop_data/bitmaps_reference',
-		'bitmaps_test': process.cwd() + '/backstop_data/bitmaps_test',
-		'engine_scripts': path.join( __dirname, './backstop_data/engine_scripts' ),
-		'html_report': process.cwd() + '/backstop_data/html_report',
-		'ci_report': process.cwd() + '/backstop_data/ci_report'
+		asyncCaptureLimit: 5,
+		asyncCompareLimit: 50,
+		debug: false,
+		debugWindow: false,
 	},
-	'report': [ 'browser' ],
-	'engine': 'puppeteer',
-	'engineOptions': {
-		'waitTimeout': 120000
-	},
-	'asyncCaptureLimit': 5,
-	'asyncCompareLimit': 50,
-	'debug': false,
-	'debugWindow': false
-}, appConfiguration.backstopConfig );
-
+	appConfiguration.backstopConfig
+);

package/lib/getConfig.js

@@ -20,7 +20,6 @@ const path = require( 'path' );
  */
 
 module.exports = function getAppConfiguration( key ) {
-
 	try {
 		let appRoot = process.cwd();
 
@@ -28,15 +27,22 @@ module.exports = function getAppConfiguration( key ) {
 			appRoot = path.join( __dirname, '../__tests__/fixtures' );
 		}
 
-		let config = require( `${appRoot}/larva.config.js` )[ key ];
+		const config = require( `${ appRoot }/larva.config.js` )[ key ];
 
 		if ( undefined === config ) {
-			throw new Error( `Configuration for \`${key}\` is required in larva.config.js. \nPlease refer to the Larva's docs for adding configuration: https://github.com/penske-media-corp/pmc-larva` );
+			throw new Error(
+				`Configuration for \`${ key }\` is required in larva.config.js. \nPlease refer to the Larva's docs for adding configuration: https://github.com/penske-media-corp/pmc-larva`
+			);
 		}
 
 		return config;
-
 	} catch ( error ) {
-		console.error( chalk.red( chalk.bold( 'There is no larva.config.js in this directory.\n' ) + error ) );
+		console.error(
+			chalk.red(
+				chalk.bold(
+					'There is no larva.config.js in this directory.\n'
+				) + error
+			)
+		);
 	}
 };

package/lib/getScenarios.js

@@ -1,29 +1,36 @@
 const { merge } = require( 'webpack-merge' );
 
-module.exports = function getScenarios( urlBase, paths, selectorArr, scenarioOverride ) {
-
-	let scenarios = [];
+module.exports = function getScenarios(
+	urlBase,
+	paths,
+	selectorArr,
+	scenarioOverride
+) {
+	const scenarios = [];
 
 	for ( let i = 0; i < paths.length; i++ ) {
+		const selectors =
+			1 === selectorArr.length ? selectorArr[ 0 ] : selectorArr[ i ];
 
-		let selectors = 1 === selectorArr.length ? selectorArr[0] : selectorArr[i];
-
-		console.log( urlBase + paths[i] );
+		console.log( urlBase + paths[ i ] );
 
-		scenarios.push( merge({
-			'label': paths[i],
-			'url': urlBase + paths[i],
-			'hideSelectors': [],
-			'removeSelectors': [],
-			'selectors': [
-				selectors
-			],
-			'delay': 500,
-			'misMatchThreshold': 0.1,
-			'onBeforeScript': 'puppet/onBefore.js',
-			'onReadyScript': 'puppet/onReady.js'
-		}, scenarioOverride ) );
-	};
+		scenarios.push(
+			merge(
+				{
+					label: paths[ i ],
+					url: urlBase + paths[ i ],
+					hideSelectors: [],
+					removeSelectors: [],
+					selectors: [ selectors ],
+					delay: 500,
+					misMatchThreshold: 0.1,
+					onBeforeScript: 'puppet/onBefore.js',
+					onReadyScript: 'puppet/onReady.js',
+				},
+				scenarioOverride
+			)
+		);
+	}
 
 	return scenarios;
-}
+};

package/lib/utils.js

@@ -1,26 +1,21 @@
 module.exports = {
 	maybeUseCliUrl: ( argv, configUrl ) => {
-
-		if ( argv[4] && argv[4].includes( '--url=' ) ) {
-			return argv[4].replace( '--url=', '' );
+		if ( argv[ 4 ] && argv[ 4 ].includes( '--url=' ) ) {
+			return argv[ 4 ].replace( '--url=', '' );
 		}
 
 		return configUrl;
-
 	},
 
 	/**
 	 * Prepare Test Paths
-	 * 
+	 *
 	 * @param modules array of module names e.g. [ 'footer', 'header', 'author' ]
 	 * @param pmcPaths array of test paths e.g. [ '/', '/blog ]
 	 */
 	prepareTestPaths: ( modules, pmcPaths ) => {
-		
 		if ( modules && modules.length > 0 ) {
-			return modules.map( a => '/modules/' + a );
-		} else {
-
+			return modules.map( ( a ) => '/modules/' + a );
 		}
 
 		if ( pmcPaths && pmcPaths.length > 0 ) {
@@ -29,24 +24,26 @@ module.exports = {
 
 		// We are not testing patterns. Return array of paths from config.
 
-		throw new Error( chalk.red.bold( 'Couldn\'t find configuration for larvaModukes or testPaths. Make sure those entries exist in the `backstop` object in larva.config.js' ) );
+		throw new Error(
+			chalk.red.bold(
+				"Couldn't find configuration for larvaModukes or testPaths. Make sure those entries exist in the `backstop` object in larva.config.js"
+			)
+		);
 	},
-	
+
 	/**
 	 * Prepare Module Selectors
-	 * 
+	 *
 	 * Make a class selector out of each module from CLI, or return document.
-	 * 
+	 *
 	 * @param array of modules
 	 */
 	prepareTestSelectors: ( array ) => {
-
 		// Test the whole document if there are no modules in the CLI
 		if ( null === array ) {
 			return [ 'document' ];
 		}
 
-		return array.map( a => '.' + a );
-	}
-
+		return array.map( ( a ) => '.' + a );
+	},
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penskemediacorp/backstopjs-config",
-  "version": "1.24.1",
+  "version": "1.26.0",
   "description": "Visual regression testing with Backstop JS.",
   "author": "laras126 <laras126@gmail.com>",
   "homepage": "https://github.com/penske-media-corp/pmc-larva#readme",
@@ -27,5 +27,5 @@
     "chalk": "^4.1.0",
     "webpack-merge": "^5.0.9"
   },
-  "gitHead": "dd41bb6e0401d247edc4b4210db962bcdd9155bc"
+  "gitHead": "b9202e08f96e47041512b3b1a743c58f89b39152"
 }