element-web/README.md

# Matrix React Web App End-to-End tests

This repository contains tests for the matrix-react-sdk web app. The tests fire up a headless chrome and simulate user interaction (end-to-end). Note that end-to-end has little to do with the end-to-end encryption matrix supports, just that we test the full stack, going from user interaction to expected DOM in the browser.

## Setup

Run `./install.sh`. This will:
 - install synapse, fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.
 - install riot, this fetches the master branch at the moment.
 - install dependencies (will download copy of chrome)

## Running the tests

Run tests with `./run.sh`.

### Debug tests locally.

`./run.sh` will run the tests against the riot copy present in `riot/riot-web` served by a static python http server. You can symlink your `riot-web` develop copy here but that doesn't work well with webpack recompiling. You can run the test runner directly and specify parameters to get more insight into a failure or run the tests against your local webpack server.

```
./synapse/stop.sh && \
./synapse/start.sh && \
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.

start.js accepts these parameters (and more, see `node start.js --help`) that can help running the tests locally:

 - `--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.
 - `--slow-mo` type at a human speed, useful with `--windowed`.
 - `--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.
 - `--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.

Developer Guide
===============

Please follow the standard Matrix contributor's guide:
https://github.com/matrix-org/synapse/tree/master/CONTRIBUTING.rst

Please follow the Matrix JS/React code style as per:
https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md
add initial README 2018-07-05 10:56:19 +00:00			`# Matrix React Web App End-to-End tests`

			`This repository contains tests for the matrix-react-sdk web app. The tests fire up a headless chrome and simulate user interaction (end-to-end). Note that end-to-end has little to do with the end-to-end encryption matrix supports, just that we test the full stack, going from user interaction to expected DOM in the browser.`

structure flags better and document them 2018-09-12 15:27:51 +00:00			`## Setup`
update README 2018-07-27 11:50:58 +00:00
make scripts executable, running them with sh does something weird on travis 2018-07-27 14:01:54 +00:00			Run `./install.sh`. This will:
update README 2018-07-27 11:50:58 +00:00			`- install synapse, fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.`
			`- install riot, this fetches the master branch at the moment.`
			`- install dependencies (will download copy of chrome)`
add initial README 2018-07-05 10:56:19 +00:00
structure flags better and document them 2018-09-12 15:27:51 +00:00			`## Running the tests`

make scripts executable, running them with sh does something weird on travis 2018-07-27 14:01:54 +00:00			Run tests with `./run.sh`.
update instructions 2018-07-20 17:00:38 +00:00
structure flags better and document them 2018-09-12 15:27:51 +00:00			`### Debug tests locally.`

			`./run.sh` will run the tests against the riot copy present in `riot/riot-web` served by a static python http server. You can symlink your `riot-web` develop copy here but that doesn't work well with webpack recompiling. You can run the test runner directly and specify parameters to get more insight into a failure or run the tests against your local webpack server.

			```
			`./synapse/stop.sh && \`
			`./synapse/start.sh && \`
			`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.`

update readme 2019-04-16 13:39:33 +00:00			start.js accepts these parameters (and more, see `node start.js --help`) that can help running the tests locally:
structure flags better and document them 2018-09-12 15:27:51 +00:00
add config file instructions to run with --riot-url 2018-10-08 14:58:01 +00:00			- `--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:
update readme 2019-04-16 13:39:33 +00:00			- `welcomeUserId` disabled as the tests assume there is no riot-bot currently.
			- `--slow-mo` type at a human speed, useful with `--windowed`.
			- `--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.
structure flags better and document them 2018-09-12 15:27:51 +00:00			- `--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.

link to code style document, instead of having local copy 2018-07-23 08:36:21 +00:00			`Developer Guide`
			`===============`

			`Please follow the standard Matrix contributor's guide:`
			`https://github.com/matrix-org/synapse/tree/master/CONTRIBUTING.rst`

			`Please follow the Matrix JS/React code style as per:`
			`https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md`