diff --git a/test/README.md b/test/README.md index 805e9d8e..09df7967 100644 --- a/test/README.md +++ b/test/README.md @@ -1,14 +1,12 @@ -This is the mailinabox test suite. IT uses the excellent pytest module to check the functionality -of the different services. +This is the mailinabox test suite. It uses the excellent pytest module to check the functionality of the different services. -Usage -===== +# Usage start-up a vagrant box vagrant up -install test requirements +install test requirements (using a virtualenv is highly recommended) pip install -r requirements.txt @@ -21,13 +19,6 @@ to just run a subset of the tests (e.g. the ssh related ones): pytest test_ssh.py -Contributing -============ +# Contributing -pytest auto-discovers all tests in this directory. The test functions need to be named "test_..." -and there needs to be at least one assert statement. - - -TODO -===== -* dns +pytest auto-discovers all tests in this directory. The test functions need to be named "test_..." and there needs to be at least one assert statement.