element-web/README.md

55 lines
2.1 KiB
Markdown
Raw Normal View History

2018-07-05 13:56:19 +03: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.
## Current tests
- test riot loads (check title)
- signup with custom homeserver
2018-07-09 19:21:05 +03:00
- join preexisting room
2018-07-05 13:56:19 +03:00
## Roadmap
- get rid of jest, as a test framework won't be helpful to have a continuous flow going from one use case to another (think: do login, create a room, invite a user, ...). a test framework usually assumes the tests are semi-indepedent.
- better error reporting (show console.log, XHR requests, partial DOM, screenshot) on error
- cleanup helper methods
2018-07-06 13:40:42 +03:00
- add more css id's/classes to riot web to make css selectors in test less brittle.
2018-07-05 13:56:19 +03:00
- avoid delay when waiting for location.hash to change
- more tests!
2018-07-09 13:41:24 +03:00
- setup installing & running riot and synapse as part of the tests.
- Run 2 synapse instances to test federation use cases.
- start synapse with clean config/database on every test run
2018-07-05 13:56:19 +03:00
- look into CI(Travis) integration
- create interactive mode, where window is opened, and browser is kept open until Ctrl^C, for easy test debugging.
2018-07-05 13:56:19 +03:00
2018-07-20 20:00:38 +03:00
## It's broken! How do I see what's happening in the browser?
Look for this line:
```
puppeteer.launch();
```
Now change it to:
```
puppeteer.launch({headless: false});
```
2018-07-05 13:56:19 +03:00
## How to run
### Setup
2018-07-27 14:50:58 +03:00
Run `./install.sh`. This will:
2018-07-27 14:50:58 +03: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)
2018-07-05 13:56:19 +03:00
### Run tests
2018-07-20 20:00:38 +03:00
Run tests with `./run.sh`.
2018-07-20 20:00:38 +03: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