mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
8a68e24e69
* Add README.md to tests/ to describe test structure and pytest customizations * Add package-level docstrings to backends * Add README.md explaining the backend architecture * Small improvements to docstrings in backend modules * Restructure the backend automodule docs * Add more docstrings to backend connections * Add init to base backend Connection class to document expected interface * Reword the backend/README.md docs
19 lines
658 B
Markdown
19 lines
658 B
Markdown
# Tests
|
|
|
|
## Test Structure
|
|
|
|
Generally all tests are meant to be unit tests, with the exception of those in the [`integration/` folder](./integration/).
|
|
|
|
A few notes:
|
|
|
|
- [`common/`](./common/) contains self-contained tests only testing
|
|
[`bigchaindb/common/`](../bigchaindb/common/)
|
|
- [`db/`](./db/) contains tests requiring the database backend (e.g. RethinkDB)
|
|
|
|
## Pytest Customizations
|
|
|
|
Customizations we've added to `pytest`:
|
|
|
|
- `--database-backend`: Defines the backend to use for the tests. Must be one of the backends
|
|
available in the [server configuration](https://docs.bigchaindb.com/projects/server/en/latest/server-reference/configuration.html)
|