Skip to content

Commit

Permalink
Remote docs (#1445)
Browse files Browse the repository at this point in the history
* Improve documentation for interactive web report

This probably solves #1158.

* Fix link to interactive web reporting
  • Loading branch information
domibarton authored Nov 4, 2022
1 parent 1018f68 commit aa4c2a4
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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=<your 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://<backstopHost>/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....

Expand Down

0 comments on commit aa4c2a4

Please sign in to comment.