mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-09-07 18:11:56 +00:00
Document the SYNAPSE_TEST_PERSIST_SQLITE_DB
unit test env var (#11715)
This commit is contained in:
parent
ffd227c382
commit
7c3408d1a8
1
changelog.d/11715.doc
Normal file
1
changelog.d/11715.doc
Normal file
@ -0,0 +1 @@
|
|||||||
|
Document the new `SYNAPSE_TEST_PERSIST_SQLITE_DB` environment variable in the contributing guide.
|
@ -169,6 +169,27 @@ To increase the log level for the tests, set `SYNAPSE_TEST_LOG_LEVEL`:
|
|||||||
SYNAPSE_TEST_LOG_LEVEL=DEBUG trial tests
|
SYNAPSE_TEST_LOG_LEVEL=DEBUG trial tests
|
||||||
```
|
```
|
||||||
|
|
||||||
|
By default, tests will use an in-memory SQLite database for test data. For additional
|
||||||
|
help with debugging, one can use an on-disk SQLite database file instead, in order to
|
||||||
|
review database state during and after running tests. This can be done by setting
|
||||||
|
the `SYNAPSE_TEST_PERSIST_SQLITE_DB` environment variable. Doing so will cause the
|
||||||
|
database state to be stored in a file named `test.db` under the trial process'
|
||||||
|
working directory. Typically, this ends up being `_trial_temp/test.db`. For example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
SYNAPSE_TEST_PERSIST_SQLITE_DB=1 trial tests
|
||||||
|
```
|
||||||
|
|
||||||
|
The database file can then be inspected with:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sqlite3 _trial_temp/test.db
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the database file is cleared at the beginning of each test run. Thus it
|
||||||
|
will always only contain the data generated by the *last run test*. Though generally
|
||||||
|
when debugging, one is only running a single test anyway.
|
||||||
|
|
||||||
### Running tests under PostgreSQL
|
### Running tests under PostgreSQL
|
||||||
|
|
||||||
Invoking `trial` as above will use an in-memory SQLite database. This is great for
|
Invoking `trial` as above will use an in-memory SQLite database. This is great for
|
||||||
|
Loading…
Reference in New Issue
Block a user