From aa4c2a4d30c7fbe1afc319a8106dc970ed1aa0bd Mon Sep 17 00:00:00 2001 From: Dominique Barton Date: Fri, 4 Nov 2022 18:13:44 +0100 Subject: [PATCH] Remote docs (#1445) * Improve documentation for interactive web report This probably solves #1158. * Fix link to interactive web reporting --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 100b88131..06fc0f08b 100644 --- a/README.md +++ b/README.md @@ -388,7 +388,7 @@ There may also be elements which need to be completely removed during testing. F ### Capturing Browser Console Logs -Sometimes you need a little more information to debug misbehavior. If that information is in the browser console logs, it won't appear in a screenshot. To capture the bowser console logs along with the screenshots, set `scenarioLogsInReports`. ( _Note: In order to view the logs, you will have to serve the reports from an HTTP server. See _Serving Reports_ below._) +Sometimes you need a little more information to debug misbehavior. If that information is in the browser console logs, it won't appear in a screenshot. To capture the browser console logs along with the screenshots, set `scenarioLogsInReports`. ( _Note: In order to view the logs, you will have to serve the reports from an HTTP server. See [Interactive Web Reporting](#interactive-web-reporting) below._) ```json "scenarioLogsInReports": true @@ -566,10 +566,14 @@ You may customize the testsuite name and/or a report file (xunit.xml) path to yo Backstop web reports support *approving scenarios* and *viewing browser logs* generated by each scenario. To enable these features you will need to run the backstop remote HTTP service in another terminal window... -```js +```bash BACKSTOP_REMOTE_HTTP_PORT=3000 backstop remote --config= ``` +Tip: The command above needs to be running before you open the report, so that Backstop detects it automatically. By default Backstop will open a report after running `backstop test`. Additionally reports can always be opened by running `backstop openReport`. Also have a look at [Reporting workflow tips](#reporting-workflow-tips). + +Pro Tip: To stop the remote server, you can either hit `Ctrl-C` or `GET` the `http:///stop/` endpoint. + ### BackstopJS and CLI return values Pro Tip: When run on the command line, the BackstopJS process will return a 0 if tests were successful and a 1 if anything failed. So you always have the flexibility of branching way up high in your CLI if needed -- e.g....