backstop-settings.js

// How to use
/*
step # 1
  Please update this with the Heroku deployment id or your pull request ID
*/
var deploymentId = "1107";

/*
Step # 2

Run the following commands in your terminal based on your prefered test cases bleow

------------------------------------------
  To test default setting (only Homepage)
------------------------------------------
  1. run command on all devices - this prepares everything to initiate the test
  backstop reference --configPath=backstop-settings.js
  2. initiates the test and compares to production
  backstop test --configPath=backstop-settings.js

-------------------------------------------------------------------------------
To test specific pages of your choice, add the page name, followed by a comma
-------------------------------------------------------------------------------
  backstop reference --configPath=backstop-settings.js --paths=/,/partnerships
  backstop test --configPath=backstop-settings.js --paths=/,/partnerships

-------------------------------------
To test the entire site all at once
-------------------------------------
  backstop reference --configPath=backstop-settings.js --pathfile=paths
  backstop test --configPath=backstop-settings.js --pathfile=paths
*/

/*
That's all! Now watch your browser do some magic :)
*/
var arguments = require('minimist')(process.argv.slice(2)); // grabs the process arguments
var defaultPaths = ['/']; // By default is just checks the homepage
var scenarios = []; // The array that'll have the pages to test

/*
  Work out the environments that are being compared
 */
// The host to test
// TODO:
// Pass the deplyment ID
// Pass the french array path list
if (!arguments.testhost) {
//added temporairly for testing
  arguments.testhost  = "https://digital-canada-ca-pr-"+ deploymentId +".herokuapp.com"; // Default test host
}
// The host to reference
if (!arguments.refhost) {
  arguments.refhost  = "https://digital.canada.ca"; // Default test host
}
/*
  Work out which paths to use, either a supplied array, an array from a file, or the defaults
 */
if (arguments.paths) {
  pathString = arguments.paths;
  var paths = pathString.split(',');
} else if (arguments.pathfile) {
  var pathConfig = require('./'+arguments.pathfile+'.js');
  var paths = pathConfig.array;
} else {
  var paths = defaultPaths; // keep with the default of just the homepage
}


for (var k = 0; k < paths.length; k++) {
  scenarios.push({
    "label": paths[k],
    "referenceUrl": arguments.refhost+paths[k],
    "url": arguments.testhost+paths[k],
    "hideSelectors": [],
    "removeSelectors": [],
    "selectors": [],
    "readyEvent": null,
    "delay": 500,
    "misMatchThreshold" : 0.1
  });
}

// Configuration
module.exports =
{
  "id": "prod_test",
  "viewports": [
    {
      "name": "small",
      "width": 320,
      "height": 480
    },
    {
      "name": "mediumish",
      "width": 568,
      "height": 760
    },
    {
      "name": "medium",
      "width": 768,
      "height": 1024
    },
    {
      "name": "large",
      "width": 1024,
      "height": 768
    },
    {
      "name": "xlarge",
      "width": 1440,
      "height": 900
    }
  ],
  "scenarios":
    scenarios
  ,
  "paths": {
    "bitmaps_reference": "backstop_data/bitmaps_reference",
    "bitmaps_test":      "backstop_data/bitmaps_test",
    "casper_scripts":    "backstop_data/casper_scripts",
    "html_report":       "backstop_data/html_report",
    "ci_report":         "backstop_data/ci_report"
  },
  "casperFlags": [],
  "engine": "puppeteer",
  "report": ["browser"],
  "debug": true
};