Custom reports Readme

Author: justyna-olszak-wttech

README.md

@@ -529,6 +529,36 @@ If you choose the CI-only reporting or even no reporting (CLI is always on) you
 $ backstop openReport
 ```
 
+### Reporting in custom format
+
+To format tests output in a custom way you may provide a script that will transform data. Add below configuration to your test config.
+
+```json
+"customReports": {
+    "reports": [
+      {
+        "script": "customReports/customReport.js",
+        "name": "resultName.json"
+      }
+    ],
+    "reportLocation": "backstop_data/custom_report"
+  }
+```
+
+Your script `customReport.js` should take `config, reporter, resultName` as parameters and return a `Promise` when result is processed. 
+To see example see `/test/configs/backstop_data/engine_scripts/customReports/xrayReport.js`. It can also incorporate additional information passed within scenarios like below: 
+```json
+"scenarios": [
+    {
+      "label": "BackstopJstop_data/engine_scripts/cookies.json",
+      "url": "https://garris.github.io/BackstopJS/",
+      "metadata": ["TEST-1"]
+    }
+```
+
+
+
+Additionally 
 #### Test report integration with a build system like Jenkins/Travis
 
 The following config would enable the CI - report (*default: junit format*)

core/util/engineTools.js

@@ -141,7 +141,7 @@ function generateTestPair (config, scenario, viewport, variantOrScenarioLabelSaf
     requireSameDimensions: getRequireSameDimensions(scenario, config),
     misMatchThreshold: getMisMatchThreshHold(scenario, config),
     expect: getScenarioExpect(scenario),
-    veportLabel: viewport.label,
+    viewportLabel: viewport.label,
     ...scenario
   };
 }

docker/Dockerfile

@@ -9,7 +9,7 @@ ENV \
 RUN apt-get update && \
 	apt-get install -y git sudo software-properties-common
 
-RUN sudo npm install -g --unsafe-perm=true --allow-root https://github.com/justyna-olszak-wttech/BackstopJS.git#v5.4.5
+RUN sudo npm install -g --unsafe-perm=true --allow-root https://github.com/justyna-olszak-wttech/BackstopJS.git#v6.0.4
 
 RUN wget https://dl-ssl.google.com/linux/linux_signing_key.pub && sudo apt-key add linux_signing_key.pub
 RUN sudo add-apt-repository "deb http://dl.google.com/linux/chrome/deb/ stable main"

test/configs/backstop.json

@@ -31,7 +31,7 @@
       "selectors": [],
       "selectorExpansion": true,
       "misMatchThreshold": 0.1,
-      "requireSameDimensions": true,
+      "requireSameDimensions": true
     }
   ],
   "paths": {