[test] mark tests that depend on couchdb server

1 files changed, 21 insertions, 0 deletions

diff --git a/testing/README b/testing/README
new file mode 100644
index 00000000..94be7250
--- /dev/null
+++ b/testing/README
@@ -0,0 +1,21 @@
+Soledad Tests
+=============
+
+This folder contains all tests for Soledad client and server.
+
+Dependency on CouchDB
+---------------------
+
+Currently, some tests depend on availability of a CouchDB server. You can pass
+a custom couchdb url by using the --couch-url option when running tox (or
+pytest), like this:
+
+  tox -- --couch-url http://couch_host:5984
+
+Tests that depend on couchdb are marked as such with the 'needs_couch' pytest
+marker. You can skip them by avoiding tests with that marker:
+
+  tox -- -m 'not needs_couch'
+
+In the future we want to isolate all tests that need couch as integration
+tests, and use mocks everywhere else.