diff options
Diffstat (limited to 'docs/development/tests.rst')
-rw-r--r-- | docs/development/tests.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/development/tests.rst b/docs/development/tests.rst new file mode 100644 index 00000000..72e2d087 --- /dev/null +++ b/docs/development/tests.rst @@ -0,0 +1,33 @@ +.. _tests: + +Tests +===== + +We use `pytest <https://docs.pytest.org/en/latest/>`_ as a testing framework +and `Tox <https://tox.readthedocs.io>`_ as a test environment manager. +Currently, tests reside in the `testing/` folder and some of them need a +couchdb server to be run against. + +If you do have a couchdb server running on localhost on default port, the +following command should be enough to run tests:: + + tox + +CouchDB dependency +------------------ + +In case you want to use a couchdb on another host or port, use the +`--couch-url` parameter for `pytest`:: + + tox -- --couch-url=http://couch_host:5984 + +If you want to exclude all tests that depend on couchdb, deselect tests marked +with `needs_couch`:: + + tox -- -m 'not needs_couch' + +Benchmark tests +--------------- + +A set of benchmark tests is provided to measure the time and resources taken to +perform some actions. See the :ref:`documentation for benchmarks <benchmarks>`. |