From 2e9bccd8b186b51bc50cf4ebb4cae9a0612e3e70 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Thu, 19 Jan 2017 12:59:20 +0100 Subject: [PATCH] Explain new test structure --- docs/contributing.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index f40e6ca..95f3da5 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -89,4 +89,21 @@ Then you can run:: If you have any questions, feel free to open issues about it. +Structure of the testsuite +-------------------------- + +Within ``tests/``, there are three main folders: + +- ``system`` contains system- and also integration tests. A rough rule is: If + the test is using temporary files, put it here. + +- ``unit``, where each testcase tests a single class or function. + +- ``storage`` runs a generic storage testsuite against all storages. + +The reason for this separation is: We are planning to generate separate +coverage reports for each of those testsuites. Ideally ``unit`` would generate +palatable coverage of the entire codebase *on its own*, and the *combination* +of ``system`` and ``storage`` as well. + .. _virtualenv: http://virtualenv.readthedocs.io/