Module Configuration and Features

Settings Tab

• Test Domain: This field is automatically populated with your current site URL. It is the site you want to test.
• Reference Domain: This field is where you enter the URL of the site to compare against, typically your live production site.
• Scenario Defaults: Settings to include in the scenarioDefaults section. These can be overridden at the Profile level. All new Profiles you create will inherit these defaults.
• Profile Parameters: Default settings that can be overridden at the Profile level. All new Profiles you create will inherit these defaults.

Note: The settings you configure here will be applied to new Profiles only. Existing Profiles will retain their individual settings unless manually updated.

Viewports Tab

Viewports are automatically generated based on the breakpoints in your site's default theme. You can also manually add new Viewports or use the Viewport Generator to create them for other enabled themes with breakpoints.

Viewport Generator

Backstop Generator can automatically create Viewports for any enabled theme that has configured breakpoints. To do this, select the theme from the list and click the Generate viewports button. This will generate Viewports based on the breakpoints defined in the theme's [theme].breakpoints.yml file.

Profiles Tab

The Profiles tab allows you to create and manage your BackstopJS Profiles. Each Profile contains a set of Scenarios and can have its own configuration settings. The default settings are inherited from the Profile parameters section on the module configuration form. Below are the key parameters you can configure for each Profile.

Scenario Generator

When creating a Profile, Use the Scenario Generator to automatically create Scenarios based on your site's content. You can select which languages to test, include the homepage, and choose specific menus and content types to generate Scenarios from. You can also manually add paths for specific nodes or views.

Scenarios Tab

The Scenarios tab allows you to manage individual test scenarios for your BackstopJS Profiles. Each Scenario represents a specific page of your site that you want to visually test. Below are the key settings you can configure for each Scenario. Settings here will override those set globally in the Profile's scenarioDefaults section.

Commands Tab

The Commands tab scans the folder where Backstop's JSON files are stored and displays the terminal commands you need to run the tests. You can copy and paste these commands into your terminal to generate reference images and run tests against your current site.