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

Document that you should keep Synapse up-to-date (#11581)

Browse source 
to ensure the local Cypress tests run against the same version of
Synapse as the CI uses.
This commit is contained in:
Andy Balaam 2023-09-08 03:23:54 +01:00 committed by GitHub
parent 0059c7c1ee
commit a81393d974
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/cypress.md
View file

@ -24,11 +24,15 @@ need to have Docker installed and working in order to run the Cypress tests.
There are a few different ways to run the tests yourself. The simplest is to run: There are a few different ways to run the tests yourself. The simplest is to run:
``` ```
docker pull matrixdotorg/synapse:develop
yarn run test:cypress yarn run test:cypress
``` ```
This will run the Cypress tests once, non-interactively. This will run the Cypress tests once, non-interactively.
Note: you don't need to run the `docker pull` command every time, but you should
do it regularly to ensure you are running against an up-to-date Synapse.
You can also run individual tests this way too, as you'd expect: You can also run individual tests this way too, as you'd expect:
``` ```
@ -45,7 +49,7 @@ yarn run test:cypress:open
### Matching the CI environment ### Matching the CI environment
In our Continuous Integration environment, we run the Cypress tests in the In our Continuous Integration environment, we run the Cypress tests in the
Chrome browser. Chrome browser, and with the latest Synapse image from Docker Hub.
In some rare cases, tests behave differently between different browsers, so if In some rare cases, tests behave differently between different browsers, so if
you see CI failures for the Cypress tests, but those tests work OK on your local you see CI failures for the Cypress tests, but those tests work OK on your local
@ -64,6 +68,17 @@ Note that you will need to have Chrome installed on your system to run the tests
inside those browsers, whereas the default is to use Electron, which is included inside those browsers, whereas the default is to use Electron, which is included
within the Cypress dependency. within the Cypress dependency.
Another cause of inconsistency between local and CI is the Synapse version. The
first time you run the tests, they automatically fetch the latest Docker image
of Synapse, but this won't update again unless you do it explicitly. To update
the Synapse you are using, run:
```
docker pull matrixdotorg/synapse:develop
```
and then run the tests as normal.
### Running with Rust cryptography ### Running with Rust cryptography
`matrix-js-sdk` is currently in the `matrix-js-sdk` is currently in the