python/docs/TESTS.md

# Tests

## Installing `pytest`

We recommend you install [pytest](http://pytest.org/en/latest/) and
[pytest-cache](http://pythonhosted.org/pytest-cache/). `pytest` is a testing
tool that will give you more flexibility over running your unit tests.

To install `pytest`, run the following command:

```bash
pip3 install pytest pytest-cache
```

If you get a `command not found` response from your system, you can find a
tutorial on how to install `pip`
[here](https://pip.pypa.io/en/stable/installing/).

If you want to check what the default version of `pytest` being used is, run the following:

```bash
pytest --version
```

If you choose not to install `pytest`, you can still run tests individually and
skip the rest of this tutorial:

```bash
cd exercism/python/bob
python bob_test.py
```

## Running the Tests

### Run All Tests

To run all tests for a specific exercise (we will take the `bob.py` exercise as
an example here), place yourself in the directory where that exercise has been
fetched and run:

```bash
pytest bob_test.py
```

**Note:** To run the tests you need to pass the name of the testsuite file to
`pytest` (generally, the file ending with `_test.py`), **NOT** the file you
created to solve the problem (which is your _implementation_). This is because
in the latter case, since there are no defined test cases in your
implementation, `pytest` will just return a positive result, specifying that
it ran zero tests. Like this:

```
=============================  bob.py  ==============================

---------------------------------------------------------------------

Ran 0 tests in 0.000s

OK
```

### More `pytest` Examples

#### Stop After First Failure
The above will run all the tests, whether they fail or not. If you'd rather stop
the process and exit on the first failure, run:

```bash
pytest -x bob_test.py
```

#### Failed Tests First

`pytest-cache` remembers which tests failed, and can run those tests first.

```bash
pytest --ff bob_test.py
```

#### Running All Tests for All Exercises

```bash
cd exercism/python/
pytest
```

## Recommended Workflow

We recommend you run this command while working on exercises.

```bash
cd exercism/python/bob
pytest -x --ff bob_test.py
```

## PDB

Will drop you into the python debugger when a test fails. To learn how to use
pdb, check out the
[documentation](https://docs.python.org/3/library/pdb.html#debugger-commands).

```bash
pytest --pdb bob_test.py
```

You may also be interested in watching [Clayton Parker's "So you think you can
pdb?" PyCon 2015 talk](https://www.youtube.com/watch?v=P0pIW5tJrRM).

## PEP8

PEP8 is the [Style Guide for Python
Code](https://www.python.org/dev/peps/pep-0008/). If you would like to test for
compliance to the style guide, install
[pytest-pep8](https://pypi.python.org/pypi/pytest-pep8).

```bash
pip install pytest-pep8
```

Then, just add the `--pep8` flag to your command

```bash
pytest --pep8 bob_test.py
```

Read the [pytest documentation](https://docs.pytest.org/en/latest/contents.html) and
[pytest-cache](http://pythonhosted.org/pytest-cache/) documentation to learn
more.