pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-04-05 11:36:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update tests/README.md to add specific test run

Browse source
This commit is contained in:
Morgan Courbet 2017-07-06 19:11:38 +02:00
parent 9bca0b4897
commit b67b15f7b0
No known key found for this signature in database
GPG key ID: 467299D324A21B24
1 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
tests/README.md
View file

@ -13,6 +13,8 @@ $ sudo apt install pypy python2.7 python3.5 python3.6 python-tox
Running the tests
-----------------
### Running the complete test suite
```shell-session
$ make test
```
@ -22,3 +24,23 @@ If the tests failed whereas [the ones from the last tag](https://travis-ci.org/p
```shell-session
$ env HOME=/tmp make test
```
### Running only a specific test
If you are developing a new hook or adding features to an existing one, you may want to run the tests for that particular hook. The following command will run the wanted test on every supported Python version.
```shell-session
$ tox tests/<your_test>.py
```
If you want to run your test for a specific Python version (for a quicker execution), you can specify it with the `-e` option of `tox`. At the moment, the supported Python versions are `2.7` (`-e py27`), `3.4` (`-e py34`), and `3.5` (`-e py35`). For example:
```shell-session
$ tox -e py27 tests/<your_test>.py
```
You can run your specific test ignoring your own Git configuration like so:
```shell-session
$ env HOME=/tmp tox -e py27 tests/<your_test>.py
```