mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
Add Tests section to README
This commit is contained in:
parent
7d4d2711ba
commit
c791e5c0ad
30
README.md
30
README.md
@ -297,6 +297,36 @@ GRIST_TEST_SSL_CERT | if set, contains filename of SSL certificate.
|
|||||||
GRIST_TEST_SSL_KEY | if set, contains filename of SSL private key.
|
GRIST_TEST_SSL_KEY | if set, contains filename of SSL private key.
|
||||||
GRIST_TEST_LOGIN | allow fake unauthenticated test logins (suitable for dev environment only).
|
GRIST_TEST_LOGIN | allow fake unauthenticated test logins (suitable for dev environment only).
|
||||||
GRIST_TEST_ROUTER | if set, then the home server will serve a mock version of router api at /test/router
|
GRIST_TEST_ROUTER | if set, then the home server will serve a mock version of router api at /test/router
|
||||||
|
GREP_TESTS | pattern for selecting specific tests to run (e.g. `env GREP_TESTS=ActionLog yarn test`).
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
Tests are run automatically as part of CI when a PR is opened. However, it can be helpful to run tests locally
|
||||||
|
before pushing your changes to GitHub. First, you'll want to make sure you've installed all dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn install
|
||||||
|
yarn install:python
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, you can run the main test suite like so:
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn test
|
||||||
|
```
|
||||||
|
|
||||||
|
Python tests may also be run locally. (Note: currently requires Python 3.9).
|
||||||
|
|
||||||
|
```
|
||||||
|
yarn test:python
|
||||||
|
```
|
||||||
|
|
||||||
|
For running specific tests, you can specify a pattern with the `GREP_TESTS` variable:
|
||||||
|
|
||||||
|
```
|
||||||
|
env GREP_TESTS=ChoiceList yarn test
|
||||||
|
env GREP_TESTS=summary yarn test:python
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user