src/test/rustdoc-gui/README.md

   1 The tests present here are used to test the generated HTML from rustdoc. The
   2 goal is to prevent unsound/unexpected GUI changes.
   3
   4 This is using the [browser-ui-test] framework to do so. It works as follows:
   5
   6 It wraps [puppeteer] to send commands to a web browser in order to navigate and
   7 test what's being currently displayed in the web page.
   8
   9 You can find more information and its documentation in its [repository][browser-ui-test].
  10
  11 If you need to have more information on the tests run, you can use `--test-args`:
  12
  13 ```bash
  14 $ ./x.py test src/test/rustdoc-gui --stage 1 --jobs 8 --test-args --debug
  15 ```
  16
  17 There are three options supported:
  18
  19  * `--debug`: allows to see puppeteer commands.
  20  * `--no-headless`: disable headless mode so you can see what's going on.
  21  * `--show-text`: by default, text isn't rendered because of issues with fonts, it enables it back.
  22
  23 [browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/
  24 [puppeteer]: https://pptr.dev/