How to prevent opening report

[anton-kulagin]

Hi @garris , is there a way to prevent opening report after backstop test (or other command). Because sometimes it opened sometimes not. And if not, how do you think about adding such flag to config file?

[garris]

There is already a config for this. See the report property.

[anton-kulagin]

Will it generate html and CI report if i just keep report parameter empty?

[mhavelant]

@anton-kulagin If you keep the report parameter empty you'll get the HTML one, but no CI report will be generated. You need to add CI to report to get both the HTML and CI reports without the browser opening.

[kevinmpowell]

@garris I've just tested this with both 3.8.8 and the Canary 3.9.4 releases and no matter what I put for my "report" settings in my config file, the browser always opens the html report.
I've tried:

"report": ["html"]

"report": ["CI"]

"report": []"

Any thoughts?

[kevinmpowell]

[Edit:] - This happens when docker: true is passed in node:

backstop('test', {
  config: '/my-path/to/backstop.js',
  docker: true
}

If I remove docker: true and run locally, then the opening of the report seems to respect my "report" config as described in the README.

[kevinmpowell]

Here's the log from my last run if it's helpful, you can see where openReport is being executed:

[Browsersync] Serving files from: demo
Loading config:  /path/to/my/config

COMMAND | Executing core for "test"
Delegating command to Docker... docker run --rm -it --mount type=bind,source="/path/to/my/project",target=/src backstopjs/backstopjs:3.8.8 test "--moby=true" "--config=./backstop.js" ""
BackstopJS v3.8.8
Loading config:  /src/backstop.js

COMMAND | Executing core for "test"
createBitmaps | Selected 1 of 1 scenarios.
searching for 2 available ports.
These ports will be used: [9222,9223]
Starting Chromy: {"chromeFlags":["--disable-gpu","--force-device-scale-factor=1","--disable-infobars=true","--window-size=320,480"],"port":9222,"waitTimeout":30000,"visible":false}
Starting Chromy: {"chromeFlags":["--disable-gpu","--force-device-scale-factor=1","--disable-infobars=true","--window-size=1024,768"],"port":9223,"waitTimeout":30000,"visible":false}
9222 Chrome v71 detected.
9223 Chrome v71 detected.
9222 INFO >  BackstopTools have been installed.
9223 INFO >  BackstopTools have been installed.
      COMMAND | Executing core for "report"
      compare | OK: Testing backstop_default_Testing_0_document_0_phone.png
      compare | OK: Testing backstop_default_Testing_0_document_1_tablet.png
       report | Test completed...
       report | 2 Passed
       report | 0 Failed
       report | Writing browser report
       report | Resources copied
       report | Copied configuration to: /src/backstop_data/html_report/config.js
      COMMAND | Command "report" successfully executed in [0.232s]
      COMMAND | Command "test" successfully executed in [2.625s]
COMMAND | Executing core for "openReport"
openReport | Attempting to ping
openReport | Remote not detected. Opening backstop_data/html_report/index.html

[kevinmpowell]

This may be the culprit:
https://github.com/garris/BackstopJS/blob/master/core/command/test.js#L11

[kevinmpowell]

Changing the docker branch of the code in test.js to this:

        .finally(() => {
            if (config.openReport && config.report && config.report.indexOf('browser') > -1) {
                executeCommand('_openReport', config);
            }
        });

Seems to do the trick. If I have time I'll get a PR together.

[kevinmpowell]

PR is here: #1007

[DEfusion]

This should be closed, the PR was merged.