BRAKKO
Brakko is a simple runner of BackstopJS for visual regression testing.
You can easly split, manage and run your scenarios
Installation
npm install brakko --save
-
Create folder
casper_scripts
with default file onReady.js and onBefore.js - See doc of BackstopJS -
Create folder
scenarios
with subfolder and js file for each scenarios - See file structure
Methods
init(conf[Object])
Initialize the runner.
Arguments: the conf object used in your scenario
conf[Object]
testhost: "https://www.amazon.it/" refhost: "https://www.amazon.co.uk/" delay: 1000 misMatchThreshold: 10
reference(options[Object], test[Boolean])
Reference task of backstopJS.
options[Object]
scenario: NameOfSubfolderstring/array tags: string/array labels: string/array
The second argument test is a bool flag if you want run test task after the reference task is finished.
test(options[Object])
Test task of backstopJS.
options[Object]
scenario: NameOfSubfolderstring/array tags: string/array labels: string/array
Files structure
Create in the root of your project a folder named scenarios
and create subfolder for each group of scenario.
Example:
casper_sripts
│ onBefore.js
│ onReady.js
│
└───footer
│ │ onBefore.js
│ │ onReady.js
│
scenarios
│
└───header
│ │ headerAll.js
│ │ headerMenu.js
│ │ headerSearch.js
│ │ ...
│
└───footer
│ footerAll.js
│ footerSocial.js
│ ...
Basic Usage
index.js
const brakko = ; brakko; brakko;
scenarios/footer/footerAll.js
moduleexports = { return "label": "FooterAll" "tags": "common" "referenceUrl": confrefhost "url": conftesthost "removeSelectors": '#unrec-pageContent' "selectors": ".navFooterCopyright" "misMatchThreshold" : 5 "onBeforeScript": "footer/onBefore.js" "onReadyScript": "footer/onReady.js" };
casper_scripts/footer/onReady.js
module { casper; console;};
casper_scripts/footer/onBefore.js
module { //This script runs before your app loads. Edit here to log-in, load cookies or set other states required for your test. console;};
TODO
- add label to task cofig
- add the support for multiple scenarios
- add country to init config
- yeoman generator