Skip to content

Latest commit

 

History

History
1131 lines (832 loc) · 50.6 KB

README.md

File metadata and controls

1131 lines (832 loc) · 50.6 KB
Raw

Build Status

BackstopJS

I'm in your webapps -- checkin your screens

BackstopJS automates visual regression testing of your responsive web UI by comparing DOM screenshots over time.

Breaking News

EmberJS users -- check out our ember-backstop test helper! https://github.com/garris/ember-backstop

Backstop Features

  • In-browser reporting UI with...
    • layout settings for print and screen
    • scenario display filtering
    • reference, test, visual diff inspector
    • cool scrubber thingy

BackstopJS browser report

  • Integrated Docker rendering -- to eliminate cross-platform rendering shenanigans
  • CLI reports
  • Render tests with Chrome Headless
  • Simulate user interactions with Puppeteer and ChromyJS scripts
  • JUnit reports
  • Plays nice with CI and source control
  • Run globally or locally as a standalone package app or require('backstopjs') right into your node app
  • Incredibly easy to use: just 3 commands go a long long way!

BackstopJS cli report

Install BackstopJS now

$ npm install -g backstopjs

Contents

The BackstopJS workflow

Installation

Getting Started

Using BackstopJS

Developing, bug fixing, contributing...

Troubleshooting

Tutorials, Extensions and more

Credits

The BackstopJS workflow

  • backstop init: Set up a new BackstopJS instance -- specify URLs, cookies, screen sizes, DOM selectors, interactions etc. (see examples directory)

  • backstop test: BackstopJS creates a set of test screenshots and compares them with your reference screenshots. Any changes show up in a visual report. (Run this after making CSS changes as many times as needed.)

  • backstop approve: If the test you ran looks good, then go ahead and approve it. Approving changes will update your reference files with the results from your last test. Future tests are compared against your most recent approved test screenshots.

Getting started

Installation

Global installation (recommended)

$ npm install -g backstopjs

Local installation

BackstopJS will run as a totally stand alone app -- but installing locally allows you to do this...

const backstop = require('backstopjs');

See Integration Options to learn about cool BackstopJS integration options!

Initializing your project

If you don't already have BackstopJS set up... BackstopJS can create a default configuration file and project scaffolding in your current working directory. Please note: this will overwrite any existing files!

cd to your project's directory and run...

$ backstop init

Working with your config file

By default, BackstopJS places backstop.json in the root of your project. And also by default, BackstopJS looks for this file when invoked.

Required config properties

As a new user setting up tests for your project, you will be primarily concerned with these properties...

id – Used for screenshot naming. Set this property when sharing reference files with teammates -- otherwise omit and BackstopJS will auto-generate one for you to avoid naming collisions with BackstopJS resources.

viewports – An array of screen size objects your DOM will be tested against. Add as many as you like -- but add at least one.

scenarios – This is where you set up your actual tests. The important sub properties are...

  • scenarios[n].label – Required. Also used for screenshot naming.
  • scenarios[n].url – Required. Tells BackstopJS what endpoint/document you want to test. This can be an absolute URL or local to your current working directory.

TIP: no other SCENARIO properties are required. Other properties can just be added as necessary

Generating test bitmaps

$ backstop test

This will create a new set of bitmaps in bitmaps_test/<timestamp>/

Once the test bitmaps are generated, a report comparing the most recent test bitmaps against the current reference bitmaps will display.

Pass a --config=<configFilePathStr> argument to test using a different config file.

Tip To use a js-module as a config file, just explicitly specify your config filepath and point to a .js file. Just be sure to export your config object as a node module.

Pass a --filter=<scenarioLabelRegex> argument to just run scenarios matching your scenario label.

Tip The --filter argument offers a useful shortcut for re-running a single test or failed tests.

Pass a --docker flag to render your test in a Docker container -- this will help with consistency if you are attempting to compare references across multiple environments.

Approving changes

$ backstop approve

When running this command, all images (with changes) from your most recent test batch will be promoted to your reference collection. Subsequent tests will be compared against your updated reference files.

Pass a --filter=<image_filename_regex> argument to promote only the test captures matching your scenario filename. The filenames (which by default include scenario and viewport names) are displayed in the visual and cli reports.

Tip: Remember to pass a --config=<configFilePathStr> argument if you passed that when you ran your last test.

Using BackstopJS

Advanced Scenarios

Scenario properties are described throughout this document and processed sequentially in the following order...

label                    // [required] Tag saved with your reference images
onBeforeScript           // Used to set up browser state e.g. cookies.
cookiePath               // import cookies in JSON format (available with default onBeforeScript see setting cookies below)
url                      // [required] The url of your app state
referenceUrl             // Specify a different state or environment when creating reference.
readyEvent               // Wait until this string has been logged to the console.
readySelector            // Wait until this selector exists before continuing.
delay                    // Wait for x milliseconds
hideSelectors            // Array of selectors set to visibility: hidden
removeSelectors          // Array of selectors set to display: none
onReadyScript            // After the above conditions are met -- use this script to modify UI state prior to screen shots e.g. hovers, clicks etc.
keyPressSelectors        // Takes array of selector and string values -- simulates multiple sequential keypress interactions.
hoverSelector            // Move the pointer over the specified DOM element prior to screen shot.
hoverSelectors           // *Puppeteer only* takes array of selectors -- simulates multiple sequential hover interactions.
clickSelector            // Click the specified DOM element prior to screen shot.
clickSelectors           // *Puppeteer only* takes array of selectors -- simulates multiple sequential click interactions.
postInteractionWait      // Wait for a selector after interacting with hoverSelector or clickSelector (optionally accepts wait time in ms. Idea for use with a click or hover element transition. available with default onReadyScript)
scrollToSelector         // Scrolls the specified DOM element into view prior to screen shot (available with default onReadyScript)
selectors                // Array of selectors to capture. Defaults to document if omitted. Use "viewport" to capture the viewport size. See Targeting elements in the next section for more info...
selectorExpansion        // See Targeting elements in the next section for more info...
misMatchThreshold        // Percentage of different pixels allowed to pass test
requireSameDimensions    // If set to true -- any change in selector size will trigger a test failure.
viewports                // An array of screen size objects your DOM will be tested against. This configuration will override the viewports property assigned at the config root.

Testing click and hover interactions

BackstopJS ships with an onReady script that enables the following interaction selectors...

clickSelector: ".my-hamburger-menu",
hoverSelector: ".my-hamburger-menu .some-menu-item",

The above would tell BackstopJS to wait for your app to generate an element with a .my-hamburger-menu class, then click that selector. Then it would wait again for a .my-hamburger-menu .some-menu-item class, then move the cursor over that element (causing a hover state). Then BackstopJS would take a screenshot.

You can use these properties independent of each other to easily test various click and or hover states in your app. These are obviously simple scenarios -- if you have more complex needs then this example should serve as a pretty good starting point create your own onReady scripts.

NOTE: Puppeteer version optionally takes clickSelectors & hoverSelectors as arrays of selectors...

clickSelectors: [".my-hamburger-menu",".my-hamburger-item"],
hoverSelectors: [".my-nav-menu-item",".my-nav-menu-dropdown-item"],

Key Press interactions

BackstopJS ships with an onReady script that allows user to key press on selectors... NOTE: Supports Chromy and Puppeteer and takes arrays of selectors and key press values.

scenarios: [
  {
    "keyPressSelectors": [
      {
        "selector": "#email",
        "keyPress": "[email protected]"
      },
      {
        "selector": "#password",
        "keyPress": "1234"
      }
    ]
  }
]

Setting cookies

BackstopJS ships with an onBefore script that makes it easy to import cookie files…

cookiePath: "backstop_data/engine_scripts/cookies.json",

note: path is relative to your current working directory

Pro tip: If your app uses a lot of cookies then do yourself a favor and download this extension for chrome. It adds a tab to your dev-tools so you can download all your cookies as a JSON file that you can directly use with BackstopJS https://chrome.google.com/webstore/detail/cookie-inspector/jgbbilmfbammlbbhmmgaagdkbkepnijn?hl=en

Targeting elements

BackstopJS makes it super easy to capture screenshots of your entire layout or just parts of your layout. This is defined in your scenario.selectors array. Elements are defined with standard CSS notation. By default BackstopJS takes a screenshot of the first occurrence of any selector found in your DOM. e.g. If you have three li tags in your layout only the first will used.

selectorExpansion

If you want BackstopJS to find and take screenshots of all matching selector instances then there is a handy switch for that. Set selectorExpansion to true like so...

scenarios: [
  {
    "selectors": [
      ".aListOfStuff li"
    ],
    "selectorExpansion": true
  }
]
// captures all <li> tags inside .aListOfStuff

(Default behavior) If you want very explicit control of what you capture then you can disable selectorExpansion and explicitly select what you want...

scenarios: [
  {
    "selectors": [
      ".aListOfStuff li"
    ],
    "selectorExpansion": false
  }
]
// Just captures the first <li> tag inside .aListOfStuff

expect

When working with selector expansion(set selectors in selectors properties and set selectorExpansion to true), you might want to explicitly set the number of results that you expect to find by the selectors. Set expect in the scenario to a number which is greater than 0, then the test will fail for the scenario if the number of selected result does not match the expect number.

scenarios: [
  {
    "selectors": [
      ".aListOfStuff li"
    ],
    "selectorExpansion": true,
    "expect": 5
  }
]
// captures all <li> tags inside .aListOfStuff, and make sure the number of <li> tags is 5

(Default behavior) If you don't care the number of the selected elements, just set expect to 0 or not set the property.

scenarios: [
  {
    "selectors": [
      ".aListOfStuff li"
    ],
    "selectorExpansion": false,
    "expect": 0
  }
]
// Captures all <li> tags inside .aListOfStuff, and not check the number of <li> tags

Testing Progressive apps, SPAs and AJAX content

It is very common for client-side web apps is to initially download a small chunk of bootstrapping code/content/state and render it to the screen as soon as it arrives at the browser. Once this has completed, various JS components often take over to progressively load more content/state.

The problem testing these scenarios is knowing when to take the screenshot. BackstopJS solves this problem with two config properties: readySelector, readyEvent and delay.

Trigger screen capture via selector

The readySelector property tells BackstopJS to wait until a selector exists before taking a screenshot. For example, the following line will delay screen capture until a selector with the id '#catOfTheDayResult' is present somewhere in the DOM.

"readySelector": "#catOfTheDayResult"

Another approach might look like this...

"readySelector": "body.ember-has-rendered"

Trigger screen capture via console.log()

The readyEvent property enables you to trigger the screen capture by logging a predefined string to the console. For example, the following line will delay screen capture until your web app calls console.log("backstopjs_ready")...

"readyEvent": "backstopjs_ready"

In the above case it would be up to you to wait for all dependencies to complete before calling logging "backstopjs_ready" string to the console.

Delay screen capture

The delay property enables you to pause screen capturing for a specified duration of time. This delay is applied after readyEvent (if also applied).

"delay": 1000 //delay in ms

In the above case, BackstopJS would wait for one second before taking a screenshot.

In the following case, BackstopJS would wait for one second after the string backstopjs_ready is logged to the console.

{
  // ...
  "readyEvent": "backstopjs_ready",
  "delay": 1000 //delay in ms
  // ...
}

Dealing with dynamic content

For obvious reasons, this screenshot approach is not optimal for testing live dynamic content. The best way to test a dynamic app would be to use a known static content data stub – or ideally many content stubs of varying lengths which, regardless of input length, should produce certain specific bitmap output.

Hiding selectors

That said, for a use case where you are testing a DOM with say an ad banner or a block of dynamic content which retains static dimensions, we have the hideSelectors property in capture/config.json which will set the corresponding DOM to visibility:hidden, thus hiding the content from our Resemble.js analysis but retaining the original layout flow.

"hideSelectors": [
  "#someFixedSizeDomSelector"
]

Removing selectors

There may also be elements which need to be completely removed during testing. For that we have removeSelectors which removes them from the DOM before screenshots.

"removeSelectors": [
  "#someUnpredictableSizedDomSelector"
]

Changing test sensitivity

"misMatchThreshold" (percentage 0.00%-100.00%) will change the amount of difference BackstopJS will tolerate before marking a test screenshot as "failed". The default setting is 0.1, this may need to be adjusted based on the kinds of testing you're doing.

More info on how misMatchThreshold is derived can be found here... https://github.com/Huddle/Resemble.js/blob/af57cb2f4edfbe718d24b350b2be1d956b764298/resemble.js#L495

"requireSameDimensions" (true || false) will change whether BackstopJS will accept any change in dimensions. The default setting is true. If set to true then the test must be the same dimensions as the reference. If set to false the test does not have to be the same dimensions as the reference.

This setting can be used in conjunction with "misMatchThreshold", for example, when setting a "misMatchThreshold" of more than 0.00% and the mismatch causing a change in dimensions, setting "requireSameDimensions" to false will allow the test to still pass, setting it to true would still make it fail.

Capturing the entire document or just the viewport, or just an element, or a combination.

BackstopJS recognizes two magic selectors: document and viewport -- these capture the entire document and just the current specified viewport respectively. e.g.

"scenarios": [
  {
    "selectors": [
      "document",
      "viewport",
      "#myFeature",
      // ...
    ],
     // ...
  }
]

Comparing different endpoints (e.g. comparing staging and production)

Pointing to different endpoints is easy. (e.g. to compare a production environment against a staging environment).

You can create reference files (without previewing) by using the command backstop reference. By default this command calls the url property specified in your config. Optionally, you can add a referenceUrl property to your scenario configuration. If found, BackstopJS will use referenceUrl for screen grabs when running $ backstop reference.

"scenarios": [
  {
    "label": "cat meme feed sanity check",
    "url": "http://www.moreCatMemes.com",
    "referenceUrl": "http://staging.moreCatMemes.com:81",
    // ...
  }
]

Running custom scripts

Simulate user actions (click, scroll, hover, wait, etc.) or states (cookie values) by running your own script on ready. For each scenario, the custom .js file you specify is imported and run when the BackstopJS ready events are fulfilled.

From your project root, place your scripts in...

./backstop_data/engine_scripts

at the root of your config or in your scenario...

"onReadyScript": "filename.js"   // Runs after onReady event on all scenarios -- use for simulating interactions (.js suffix is optional)
"onBeforeScript": "filename.js"  // Runs before each scenario -- use for setting cookies or other env state (.js suffix is optional)
"scenarios": [
  {
    "label": "cat meme feed sanity check",
    "onReadyScript": "filename.js"   //  If found will run instead of onReadyScript set at the root (.js suffix is optional)
    "onBeforeScript": "filename.js" // If found will run instead of onBeforeScript at the root (.js suffix is optional)
     // ...
  }
]

Inside filename.js, structure it like this:

// onBefore example (puppeteer engine)
module.exports = async (page, scenario, vp) => {
  await require('./loadCookies')(page, scenario);

  // Example: set user agent
  await page.setUserAgent('some user agent string here');

};


// onReady example (puppeteer engine)
module.exports = async (page, scenario, vp) => {
  console.log('SCENARIO > ' + scenario.label);
  await require('./clickAndHoverHelper')(page, scenario);

  // Example: changing behavior based on config values
  if (vp.label === 'phone') {
    console.log( 'doing stuff for just phone viewport here' );
  }

  // add more stuff here...
};

Setting the base path for custom onBefore and onReady scripts

By default the base path is a folder called engine_scripts inside your BackstopJS installation directory. You can override this by setting the paths.scripts property in your backstop.json file to point to somewhere in your project directory (recommended).

"paths": {
  "engine_scripts": "backstop_data/engine_scripts"
}

onBeforeScript/onReadyScript available variables

onBefore(engine, scenario, viewport, isReference, Engine, config)

engine:      chromy or puppeteer engine instance
scenario:    currently running scenario config
viewport:    viewport info
isReference: whether scenario contains reference URL propery
Engine:      Static class reference (Chromy or Puppeteer)
config:      the whole config object

Reporting workflow tips

One testing approach to consider is incorporating BackstopJS into your build process and just let the CLI report run on each build or before each deploy.

It's natural for your layout to break while you're in feature development -- in that case you might just run a backstop test when you feel things should be shaping up.

Use the report property in your config to enable or disable the respective properties. E.g. The following settings will open a browser and write a junit report.

"report": ["browser", "CI"]

You can also specify a json report:

"report": ["json"]

If you choose the CI-only reporting or even no reporting (CLI is always on) you can always enter the following command to see the latest test run report in the browser.

$ backstop openReport

Test report integration with a build system like Jenkins/Travis

The following config would enable the CI - report (default: junit format)

"report" : [ "CI" ],

The regression test report will be generated in the JUnit format and the report will be placed in the given directory (default: [backstopjs dir]/test/ci_report/xunit.xml).

You may customize the testsuite name and/or a report file (xunit.xml) path to your build report directory by using the below configuration overrides,

"paths": {
  "ci_report" :  "backstop_data/ci_report"
},
"ci": {
  "format" :  "junit" ,
  "testReportFileName": "myproject-xunit", // in case if you want to override the default filename (xunit.xml)
  "testSuiteName" :  "backstopJS"
},

CLI error handling

When a layout error is found in CLI mode, BackstopJS will let you know in a general report displayed in the console. In addition, BackstopJS will return a 1 (error) to the calling CLI process.

Setting the bitmap and script directory paths

By default, BackstopJS saves generated resources into the backstop_data directory in parallel with your backstop.json config file. The location of the various resource types are configurable so they can easily be moved inside or outside your source control or file sharing environment. See below for options...

Tip: these file paths are relative to your current working directory._

  ...
  "paths": {
    "bitmaps_reference": "backstop_data/bitmaps_reference",
    "bitmaps_test": "backstop_data/bitmaps_test",
    "engine_scripts": "backstop_data/engine_scripts",
    "html_report": "backstop_data/html_report",
    "json_report": "backstop_data/json_report",
    "ci_report": "backstop_data/ci_report"
  }
  ...

Changing the rendering engine

Puppeteer is currently the default value and will be installed by default. You could choose to use Chromy as well.

Chrome-Headless (The latest webkit library)

To use chrome headless you have two options for scripting engines, the default puppeteer (https://github.com/GoogleChrome/puppeteer) or the very cool chromy.js (https://github.com/OnetapInc/chromy) library.

"engine": "puppeteer"

or

"engine": "chromy"

Setting Puppeteer option flags

Backstop sets two defaults for Puppeteer:

ignoreHTTPSErrors: true,
headless: <!!!config.debugWindow>

You can add more settings (or override the defaults) with the engineOptions property. (properties are merged)

"engineOptions": {
	"ignoreHTTPSErrors": false,
	"args": ["--no-sandbox", "--disable-setuid-sandbox"]
}

More info here: Puppeteer on github.

Setting Chromy option flags

Chromy enables a lot of behavior via constructor options. See Chromy documentation for more info.

NOTE: Backstop sets defaults for many Chromy properties. Setting a parameter value with engineOptions will override any default value set by backstop. But please watch out for the following...

  • (TLDR) Setting port as a chromy option flag is very very not advised. Instead, consider changing the startingPort property in the Backstop configuration. e.g. "startingPort": 9333
  • Setting chromeFlags will override all chromeFlags properties set by backstop -- EXCEPT FOR --window-size*... (i.e. --window-size flag will be added by backstop if not found in chromeFlags)
  • Setting --window-size explicitly in chromeFlags will override values used in your viewport settings.

An example config below...

"engineOptions": {
  "waitTimeout": 120000,
  "chromePath": "/path/to/chrome",
  "chromeFlags": ["--disable-gpu", "--force-device-scale-factor=1"]
}

Using Chromy static functions

To access use of Chromys static functions (such as addCustomDevice) the static chromy reference is sent as the fifth parameter to your onBefore/onReady scripts.

Example usage:

module.exports = function (chromy, scenario, vp, isReference, chromyStatic) {
  if(vp.label === "phone") {
    chromyStatic.addCustomDevice({ name: "some-phone", /.../ });
    chromy.emulate("some-phone");
  }
}

For more info, see the Chromy script documentation.

Using Docker for testing across different environments

We've found that different environments can render the same webpage in slightly different ways -- in particular with text. E.G. see the text in this example rendering slightly differently between Linux and Mac...

BakcstopJS OS rendering differences

You can make this issue go away by rendering in a BackstopJS Docker container. Lucky for you we've made it incredibly easy to do.

First, go ahead and install docker on your machine from the Docker Downloads Page.

Make sure Docker is running on your machine. On MacOS there is a menu item that looks like this... MacOS Docker Menu Item

Then, simply add a --docker flag onto your commands. E.G...

backstop test --docker

or for a local install

const backstop = require('backstopjs');
backstop('test', {docker: true});

The above flag will cause BackstopJS to hit your Docker local client, spin up the BackstopJS container at https://hub.docker.com/r/backstopjs/backstopjs/ and execute your test.

If the default docker command or image does not work for you, you can customize the command to run BackstopJS with Docker by changing the dockerCommandTemplate config option. The default is:

"dockerCommandTemplate": "docker run --rm -it --mount type=bind,source=\"{cwd}\",target=/src backstopjs/backstopjs:{version} {backstopCommand} {args}"

Tip: to run BackstopJS in Docker in an environment where the output is piped (e.g. CI server or an IDE's output window), remove the -t parameter (change the default to "docker run --rm -i --mount...)

Requirements for when you're using docker...

1) If you are using a config generated prior to version 3.5 and you get an error like this...

  COMMAND | Command "test" ended with an error after [0.312s]
  COMMAND | Error: Failed to launch chrome!
            ... Running as root without --no-sandbox is not supported. See https://crbug.com/638180.
            TROUBLESHOOTING: https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md

then you need to add this to the root of your config...

"engineOptions": {
    "args": ["--no-sandbox"]
},

2) localhost won't work in your scenarios -- instead, mac and win users can use host.docker.internal e.g.

"url": "https://host.docker.internal/?someCoolAppParameter=true"

Integration options (local install)

Installing BackstopJS locally to your project makes a few integration options available.

Using Backstop as a locally installed standalone app looks like this....

# Install from your project root
npm install backstopjs

# Then, run commands by directly calling the cli
./node_modules/backstopjs/cli/index.js test --config=<myConfigPath>

The more interesting case is calling backstop from another node app...

const backstop = require('backstopjs');

Invoke default behavior in the current working directory context

backstop('test')
  .then(() => {
    // test successful
  }).catch(() => {
    // test failed
  });

Pass options to the command

backstop('test', {config:'custom/backstop/config.json'});

Pass a config object to the command

// you can also pass a literal object
backstop('test', {
  config: {
    id: "foo",
    scenarios: [
      //some scenarios here
    ]
  }
});

The --filter argument still works too -- just pass a filter prop instead.

// you can also pass a literal object
backstop('test', {
  filter: 'someScenarioLabelAsRegExString',
  config: {
    id: "foo",
    scenarios: [
      //some scenarios here
    ]
  }
});

Parse a config file explicitly

backstop('test', {
  config: require("./backstop.config.js")({
    "foo": "bar"
  })
});


// Inside of `backstop.config.js` we export a function that returns the configuration object
module.exports = options => {
  return {
    //you can access options.foo here
  }
}

Since the backstop returns promises so it can run natively as a task in build systems like gulp

const gulp = require('gulp');
const backstop = require('backstopjs');

gulp.task('backstop_reference', () => backstop('reference'));
gulp.task('backstop_test', () => backstop('test'));

Using npm run scripts

When BackstopJS is installed locally, NPM will recognize the backstop <command> pattern originating from your own npm package.json scripts. The following would enable you to run the respective npm <command> commands locally in your project.

"scripts": {
  "approve": "backstop approve",
  "test": "backstop test",
  "init": "backstop init"
}

The above is a basic example -- check out the NPM documentation for more info.

Tuning BackstopJS performance

During a test, BackstopJS processes image capture and image comparisons in parallel. You can adjust how much BackstopJS does at one time by changing

Capturing screens in parallel

By default, this value is limited to 10. This value can be adjusted as needed to increase/decrease the amount of RAM required during a test.

The example below would capture 5 screens at a time...

asyncCaptureLimit: 5

Comparing screens in parallel

By default, this value is limited to 50. This value can be adjusted as needed to increase/decrease the amount of RAM required during a test.

As a (very approximate) rule of thumb, BackstopJS will use 100MB RAM plus approximately 5 MB for each concurrent image comparison.

To adjust this value add the following to the root of your config...

"asyncCompareLimit": 100
// Would require 600MB to run tests. Your mileage most likely will vary ;)

Creating reference files

This Utility command will by default delete all existing screen references and create new ones based on the referenceUrl or url config config. It will not run any file comparisons.

Use this when you...

  • create references from another environment (e.g. staging vs prod)
  • or clean out your reference files and start fresh with all new reference
  • or just create references without previewing

From your project directory...

$ backstop reference

optional parameters --config=<configFilePath> point to a specific config file --filter=<scenario.name> filter on scenario.name via regex string --i incremental flag -- use if you don't want BackstopJS do first delete all files in your reference directory

Modifying output settings of image-diffs

By specifying resembleOutputOptions in your backstop.json file you can modify the image-diffs transparency, errorcolor, etc. (See Resemble.js outputSettings for the full list.)

Instead of calling resemble`s ignoreAntialiasing(), you may set it as a property in the config. (See example)

"resembleOutputOptions": {
  "errorColor": {
    "red": 255,
    "green": 0,
    "blue": 255
  },
  "errorType": "movement",
  "transparency": 0.3,
  "ignoreAntialiasing": true
}

Git Integration

For most users, it can be helpful to keep a record of reference files over the long haul -- but saving multiple test screenshots is probably overkill. So, just like checking-in your unit tests with your production code you can similarly check in your Backstop reference files with your production code.

For many users, adding these lines to your .gitignore or .git/info/exclude files will pare down your backstop files in a sensible way.

backstop_data/html_report/
bitmaps_test/

Of course you can alternatively change your default config to save these files somewhere else out of the source control scope -- thats cool too.

Developing, bug fixing, contributing...

First off, You are awesome! Thanks for your interest, time and hard work! Here are some tips...

We use eslint-config-semistandard.

Please run the linter before each submit, as follows. Thank you. 🙇🏽

$ npm run lint --fix

There is a BackstopJS SMOKE TEST

See the next section for running the SMOKE TEST -- Please make sure this is working before submitting any PR's. Thanks!

HTML report development

Here's some suggestions if you want to work on the HTML report locally...

  • The HTML front end is a React app. It lives in /compare/src/

  • To test your work you can build with

     npm run build-and-copy-report-bundle

  • 👆 As a convenience, this command will move your newly built React bundle into test/configs/backstop_data/html_report/ so you can then test your changes with some of these commands...

     # From root directory
 # ---------------
 # simple test
 	npm run sanity-test

 # longer test covering many features
 	npm run smoke-test

# Or another way to test...

 # From test/configs/ directory
 # ---------------
 # simple test
 	../../cli/index.js test --config=backstop --docker
 # longer test covering many features
 	../../cli/index.js test --config=backstop_features --docker

Troubleshooting

SANITY TEST: Does Backstop work in my environment?

Run the following command from your Desktop, home or project directory to check that Backstop will install and run in your environment. Please make sure you have node version 8 or above. Windows users: Powershell is recommended.

mkdir backstopSanityTest; cd backstopSanityTest; npm install backstopjs; node ./node_modules/backstopjs/cli/ init; node ./node_modules/backstopjs/cli/ test

Here is a sanity test which also uses docker...

mkdir backstopSanityTest; cd backstopSanityTest; npm install backstopjs; node ./node_modules/backstopjs/cli/ init; node ./node_modules/backstopjs/cli/ test --docker

SMOKE TEST: Are backstop features working ok?

Run this command if you have made changes to the BackstopJS codebase and you want to make sure that you haven't hosed anything.

    # from the backstopjs directory
    npm run smoke-test

Debugging

If you are using Chrome-Headless engine then you have the option of displaying the Chrome window as tests are running. This can be helpful for visually monitoring your app state at the time of your test. To enable use...

"debugWindow": true

For all engines there is also the debug setting. This enables verbose console output.This will also output your source payload to the terminal so you can make sure to check that the server is sending what you expect. 😉

"debug": true

Issues with Chrome-Headless in Docker

Please keep in mind, Chrome-Headless will need a lot of memory. Take a look at these if you are seeing weird timeout errors with Docker...

garris#603 (comment)

garris#537 (comment)

Interaction: clicking a link that loads a new page

This is a grey area for BackstopJS. When you click a link to a new page inside of Chrome headless then you are unloading all your current app state and starting fresh with a new app state. If this is your case, the best practice is to simply create a new BackstopJS scenario with the required URL state etc. If you have some kind of situation which really requires this kind of behavior then it's doable -- take a look at this issue for inspiration... garris#657

Chrome Zombies!

Sometimes when developing scrips -- browser errors can actually cause Chrome-Headless and Chromy to loose their special connection to each other. If you find that Chome zombies are accumulating in your ENV spacetime continuum then please follow these steps:

  1. DON’T PANIC!

  2. Remain calm.

  3. do the following...

    MacOS and Linux users can run...

    pkill -f "(chrome)?(--headless)"

    Windows users can run... (in PowerShell)

    Get-CimInstance Win32_Process -Filter "Name = 'chrome.exe' AND CommandLine LIKE '%--headless%'" | %{Stop-Process $_.ProcessId}

The dreaded: command-not-found error...

Did you install BackstopJS with the global option? If installing globally remember to add that -g when installing with npm i.e. npm install -g backstopjs. If you installed locally, remember that the backstop <command> pattern will only be available to your npm scripts -- see the local installation section above for more info.

Issues when installing

Sometimes bad permissions happen to good people. It's ok, this is a safe space. Hopefully this will help... garris#545

Projects don't work when I share with other users or run in different environments.

Be sure to use a config id in your config file. See garris#291

If you just upgraded to 2.x or 3.x

Filename formats have changed. To use the 1.x (compatible) file format, use the fileNameTemplate property like so...

{
  // ...
  fileNameTemplate: '{scenarioIndex}_{scenarioLabel}_{selectorIndex}_{selectorLabel}_{viewportIndex}_{viewportLabel}',
  // ...
}

Tutorials, Extensions and more

Credits

BackstopJS was created and is maintained by Garris Shipon

Follow @garris

💙㊗️🙇 Many many thanks to all the contributors with special thanks to our BackstopJS core contributors...