From 81643488518c11ed66e3d4d8ac6cbc9f0eac6800 Mon Sep 17 00:00:00 2001 From: aviau Date: Tue, 9 Jun 2015 14:09:38 -0400 Subject: [PATCH] Docs: Running the tests Change-Id: Iab621ad1bbea74e0fc70948126801d9ca885d9a2 --- doc/source/tutorials/index.rst | 1 + doc/source/tutorials/running_the_tests.rst | 26 ++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 doc/source/tutorials/running_the_tests.rst diff --git a/doc/source/tutorials/index.rst b/doc/source/tutorials/index.rst index 83fb6f7..ed15139 100644 --- a/doc/source/tutorials/index.rst +++ b/doc/source/tutorials/index.rst @@ -6,3 +6,4 @@ Tutorials getting_started developing_the_api + running_the_tests diff --git a/doc/source/tutorials/running_the_tests.rst b/doc/source/tutorials/running_the_tests.rst new file mode 100644 index 0000000..d58ba30 --- /dev/null +++ b/doc/source/tutorials/running_the_tests.rst @@ -0,0 +1,26 @@ + +Running the tests +----------------- + +Using tox +````````` + +Surveil is tested and supported on Python 2.7 and Python 3.4. The project uses tox to manage tests. + +The following command will run the tests for Python 3.4, Python 2.7, Flake8 and Docs: :: + + tox + +You can also run only one set of tests by specifying the tox environment to run (see tox.ini for more details): :: + + tox -epy27 + +Building the docs +````````````````` + +To build the docs, simply run ``tox -edocs``. The docs will be available in the ``doc/build/html`` folder. After every commit, docs are automatically built on readthedocs and hosted on `surveil.readthedocs.org `_. + +Integration tests +````````````````` + +Integration tests are ran nightly on `test.savoirfairelinux.net `_. You can run them on your machine with ``tox -eintegration``. Before you launch the command, make sure that you don't have any other Surveil containers running as they may interfere with the integration tests. Integration tests will create muliple containers on your machine.