mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #97826 - GuillaumeGomez:rustdoc-gui-tests-info, r=Dylan-DPC

Browse Source 
Add more information for rustdoc-gui tests

It was missing `--no-sandbox` in the `--help` message and the README was a bit outdated.

cc `@jsha` (I recall you asking some questions about passing arguments to the rustdoc gui tester so here it).

r? `@notriddle`
This commit is contained in:
Dylan DPC 2022-06-07 17:25:45 +02:00 committed by GitHub
commit 4851ec729a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/test/rustdoc-gui/README.md
View File

@ -11,14 +11,24 @@ You can find more information and its documentation in its [repository][browser-
If you need to have more information on the tests run, you can use `--test-args`:
```bash
$ ./x.py test src/test/rustdoc-gui --stage 1 --jobs 8 --test-args --debug
$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --debug
```
There are three options supported:
If you don't want to run in headless mode (helpful to debug sometimes), you can use
`--no-headless`:
* `--debug`: allows to see puppeteer commands.
* `--no-headless`: disable headless mode so you can see what's going on.
* `--show-text`: by default, text isn't rendered because of issues with fonts, it enables it back.
```bash
$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-headless
```
To see the supported options, use `--help`.
Important to be noted: if the chromium instance crashes when you run it, you might need to
use `--no-sandbox` to make it work:
```bash
$ ./x.py test src/test/rustdoc-gui --stage 1 --test-args --no-sandbox
```
[browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/
[puppeteer]: https://pptr.dev/

1
src/tools/rustdoc-gui/tester.js
View File

@ -16,6 +16,7 @@ function showHelp() {
console.log(" --debug : show extra information about script run");
console.log(" --show-text : render font in pages");
console.log(" --no-headless : disable headless mode");
console.log(" --no-sandbox : disable sandbox mode");
console.log(" --help : show this message then quit");
console.log(" --tests-folder [PATH] : location of the .GOML tests folder");
console.log(" --jobs [NUMBER] : number of threads to run tests on");