From f70b1d00446864d2a2a21bb6b2a954b4c9b20729 Mon Sep 17 00:00:00 2001 From: drebs Date: Wed, 12 Jul 2017 15:20:25 -0300 Subject: [doc] add explanation on how to run benchmark tests --- docs/benchmarks.rst | 12 +++++++++++- docs/tests.rst | 2 ++ 2 files changed, 13 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/benchmarks.rst b/docs/benchmarks.rst index d24590f5..5338fdee 100644 --- a/docs/benchmarks.rst +++ b/docs/benchmarks.rst @@ -6,7 +6,17 @@ Benchmarks We currently use `pytest-benchmark `_ to write tests to assess the time and resources taken by various tasks. -Results of benchmarking can be seen in https://benchmarks.leap.se/. +To run benchmark tests, once inside a cloned Soledad repository, do the +following:: + + cd testing/ + tox -e benchmark + +Results of automated benchmarking for each commit in the repository can be seen +in: https://benchmarks.leap.se/. + +Benchmark tests also depend on `tox` and `CouchDB`. See the :ref:`tests` page +for more information on how to setup the test environment. Test repetition --------------- diff --git a/docs/tests.rst b/docs/tests.rst index 3c80a898..8a412701 100644 --- a/docs/tests.rst +++ b/docs/tests.rst @@ -1,3 +1,5 @@ +.. _tests: + Tests ===== -- cgit v1.2.3