4171c008a4
* Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement |
||
|---|---|---|
| .. | ||
| element | ||
| src | ||
| synapse | ||
| .gitignore | ||
| has-custom-app.js | ||
| install.sh | ||
| package.json | ||
| pick-synapse-log-file.js | ||
| README.md | ||
| run.sh | ||
| start.ts | ||
| TODO.md | ||
| tsconfig.json | ||
| Windows.md | ||
| yarn.lock | ||
Matrix React SDK End-to-End tests
This directory contains tests for matrix-react-sdk. 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 develop 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 Element Web, this fetches the develop 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 Element copy present in element/element-web served by a static Python HTTP server. You can symlink your element-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:
--app-url <url>don't use the Element Web copy and static server provided by the tests, but use a running server like the Webpack watch server to run the tests against.--slow-motype 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.--windowedrun 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-toolsopen the devtools in the browser window, only applies if--windowedis set as well.
For god level debug (e.g. for debugging slow tests):
env DEBUG="puppeteer:*" ./test/end-to-end-tests/run.sh --app-url http://localhost:8080 --log-directory pwd/logs --dev-tools --windowed 2>&1 | cat
(piping everything through cat means you get proper timestamps on the debugging, and the chromiums hang around at the end)
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