Skip to content

Commit

Permalink
Document using tox for running unit tests locally
Browse files Browse the repository at this point in the history
  • Loading branch information
kriation committed Jun 8, 2022
1 parent 2efcce6 commit b5468c7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ Pull requests are definitely welcome. In order to be most useful, please try and
* the code is clean and understandable
* the pull request would merge cleanly

### Unit Tests

If you're adding new functionality to the code base, please make sure you add a
corresponding unit test in the tests/ directory.

The project's unit tests can be run using [tox](https://tox.wiki/en/latest/).
A container to use for testing can be built using the following steps:

1. Spin up a container using ubuntu:latest: `docker run -it ubuntu:latest`
2. Add a few of prerequisite packages: `apt -y update && apt -y install git python3 tox`
3. Clone the repository: `git clone https://github.com/cevoaustralia/aws-google-auth.git`
4. Navigate to the directory and run tox: `cd aws-google-auth && tox`

Running tox without any arguments will run flake8 and the full test suite!

## Issues

Issues are also very welcome! Please try and make sure that:
Expand Down

0 comments on commit b5468c7

Please sign in to comment.