Skip to content

Commit

Permalink
Add test suite instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
cc-a committed Mar 14, 2024
1 parent 923e628 commit f3e9fc5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,25 @@ A simple Continuous Integration setup is provided via GitHub Actions. This check
target commit against the project QA tooling and for commits to the main branch builds
and pushes Docker images for the web application and frontend.

### Tests

A test suite is provided in the `tests` directory. Assuming services have already been
setup, tests can be run with:

```console
invenio services start
pipenv run pytest
```

All development work should be supported by an appropriate set of tests. Best practices
around testing are expected to evolve as the project develops.

The [pytest-invenio] plugin is provided to support test development. This extends
[pytest-flask] to provide fixtures and support for testing Invenio.

[pytest-invenio]: https://pytest-invenio.readthedocs.io/en/latest/
[pytest-flask]: https://pytest-flask.readthedocs.io/en/latest/

### Local Installation

The standard local installation as described in [Getting Started] is suitable for
Expand Down

0 comments on commit f3e9fc5

Please sign in to comment.