summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorefkin <efkin@riseup.net>2017-03-13 19:23:08 +0100
committerKali Kaneko <kali@leap.se>2017-03-17 17:52:54 +0100
commit5cf77ccd4df00a59c8cb8d4670f2964f021ae862 (patch)
treed4d3f97535f226630e30b6b80a840845de7767d1
parent1c054f4783a17ceef393ccd3249b66c3871c85d1 (diff)
[docs] Define in details the testing environment
On debian stable the `python3-tox` and `python-tox` packages come with a really old version of `pip` and `setup_tools`. This makes unusable PEP496 that comes handy when dependencies are "py-version-related". As a workaround we can "inject" an upgraded version of `pip` just before running `tox`.
-rw-r--r--.gitignore1
-rw-r--r--README.rst14
-rw-r--r--testing/requirements-testing.pip2
3 files changed, 15 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index 1f278cbf..a8df15eb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -21,3 +21,4 @@ scripts/profiling/sync/profiles
testing/htmlcov
testing/.coverage
+testing/test-env \ No newline at end of file
diff --git a/README.rst b/README.rst
index 11455880..d8713df6 100644
--- a/README.rst
+++ b/README.rst
@@ -47,10 +47,20 @@ Compatibility
Tests
-----
+System dependencies::
+
+ python3-venv
+
+Install local dependencies::
+
+ $ cd testing
+ $ pyvenv test-env
+ $ source test-env/bin/activate
+ $ pip3 install -U -r requirements-testing.pip
+
Soledad tests use tox, and they live in the testing folder::
- cd testing
- tox
+ $ tox
Note that to run CouchDB tests, be sure you have `CouchDB`_ installed on your
system.
diff --git a/testing/requirements-testing.pip b/testing/requirements-testing.pip
new file mode 100644
index 00000000..a33c65ab
--- /dev/null
+++ b/testing/requirements-testing.pip
@@ -0,0 +1,2 @@
+pip
+tox \ No newline at end of file