Skip to content
This repository was archived by the owner on Sep 11, 2024. It is now read-only.

Commit c853257

Browse files
authored
Document how to match the CI config for Cypress (#11531)
* Document how to match the CI config for Cypress * Clarify language about needing Chrome * Move Cypress info into the Cypress-specific docs
1 parent 3818c1d commit c853257

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,5 @@ Now the yarn commands should work as normal.
209209

210210
### End-to-End tests
211211

212-
Make sure you've got your Element development server running (by doing `yarn
213-
start` in element-web), and then in this project, run `yarn run test:cypress`. See
214-
[`docs/cypress.md`](https://github.com/matrix-org/matrix-react-sdk/blob/develop/docs/cypress.md)
215-
for more information.
212+
We use Cypress and Element Web for end-to-end tests. See
213+
[`docs/cypress.md`](docs/cypress.md) for more information.

docs/cypress.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# Cypress in Element Web
22

3-
## Scope of this Document
3+
## Contents
44

5-
This doc is about our Cypress tests in Element Web and how we use Cypress to write tests.
6-
It aims to cover:
7-
8-
- How to run the tests yourself
5+
- How to run the tests
96
- How the tests work
107
- How to write great Cypress tests
118
- Visual testing
@@ -45,6 +42,28 @@ To launch it:
4542
yarn run test:cypress:open
4643
```
4744

45+
### Matching the CI environment
46+
47+
In our Continuous Integration environment, we run the Cypress tests in the
48+
Chrome browser.
49+
50+
In some rare cases, tests behave differently between different browsers, so if
51+
you see CI failures for the Cypress tests, but those tests work OK on your local
52+
machine, try running them in Chrome like this:
53+
54+
```bash
55+
yarn run test:cypress --browser=chrome
56+
```
57+
58+
(Use `--browser=chromium` if you'd prefer to use Chromium.)
59+
60+
If you launch the interactive UI you can choose the browser you want to use. To
61+
match the CI setup, choose Chrome.
62+
63+
Note that you will need to have Chrome installed on your system to run the tests
64+
inside those browsers, whereas the default is to use Electron, which is included
65+
within the Cypress dependency.
66+
4867
### Running with Rust cryptography
4968

5069
`matrix-js-sdk` is currently in the

0 commit comments

Comments
 (0)