PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

update readme

Browse source
This commit is contained in:
Bruno Windels 2019-04-16 15:39:33 +02:00
parent 48c1d46aa7
commit eae830a4d4
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -24,14 +24,12 @@ node start.js <parameters>
``` ```
It's important to always stop and start synapse before each run of the tests to clear the in-memory sqlite database it uses, as the tests assume a blank slate. It's important to always stop and start synapse before each run of the tests to clear the in-memory sqlite database it uses, as the tests assume a blank slate.
start.js accepts the following parameters that can help running the tests locally: start.js accepts these parameters (and more, see `node start.js --help`) that can help running the tests locally:
- `--no-logs` dont show the excessive logging show by default (meant for CI), just where the test failed.
- `--riot-url <url>` don't use the riot copy and static server provided by the tests, but use a running server like the webpack watch server to run the tests against. Make sure to have the following local config: - `--riot-url <url>` don't use the riot copy and static server provided by the tests, but use a running server like the webpack watch server to run the tests against. Make sure to have the following local config:
- `welcomeUserId` disabled as the tests assume there is no riot-bot currently. Make sure to set the default homeserver to - `welcomeUserId` disabled as the tests assume there is no riot-bot currently.
- `"default_hs_url": "http://localhost:5005"`, to use the e2e tests synapse (the tests use the default HS to run against atm) - `--slow-mo` type at a human speed, useful with `--windowed`.
- `"feature_lazyloading": "labs"`, currently assumes lazy loading needs to be turned on in the settings, will change soon. - `--throttle-cpu <factor>` throttle cpu in the browser by the given factor. Useful to reproduce failures because of insufficient timeouts happening on the slower CI server.
- `--slow-mo` run the tests a bit slower, so it's easier to follow along with `--windowed`.
- `--windowed` run the tests in an actual browser window Try to limit interacting with the windows while the tests are running. Hovering over the window tends to fail the tests, dragging the title bar should be fine though. - `--windowed` run the tests in an actual browser window Try to limit interacting with the windows while the tests are running. Hovering over the window tends to fail the tests, dragging the title bar should be fine though.
- `--dev-tools` open the devtools in the browser window, only applies if `--windowed` is set as well. - `--dev-tools` open the devtools in the browser window, only applies if `--windowed` is set as well.