From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Mon, 12 Apr 2021 15:18:01 +0000 (+0100)
Subject: Add tests readme
X-Git-Tag: 3.0.dev0~74
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=735053c6178fb100e998d651475ae47737749494;p=thirdparty%2Fpsycopg.git

Add tests readme
---

diff --git a/tests/README.rst b/tests/README.rst
new file mode 100644
index 000000000..030477fe9
--- /dev/null
+++ b/tests/README.rst
@@ -0,0 +1,56 @@
+psycopg3 test suite
+===================
+
+Quick version
+-------------
+
+To run tests on the current code you can install the `test` extra of the
+package, specify a connection string  in the `PSYCOPG3_TEST_DSN` env var to
+connect to a test database, and run ``pytest``::
+
+    $ pip install -e psycopg3[test]
+    $ export PSYCOPG3_TEST_DSN="host=localhost dbname=psycopg3_test"
+    $ pytest
+
+
+Test options
+------------
+
+- The tests output header shows additional psycopg3 related information,
+  on top of the one normally displayed by ``pytest`` and the extensions used::
+
+      $ pytest
+      ========================= test session starts =========================
+      platform linux -- Python 3.8.5, pytest-6.0.2, py-1.10.0, pluggy-0.13.1
+      Using --randomly-seed=2416596601
+      libpq available: 130002
+      libpq wrapper implementation: c
+
+
+- By default the tests run using the ``pq`` implementation that psycopg3 would
+  choose (the C module if installed, else the Python one). In order to test a
+  different implementation, use the normal `pq module selection mechanism`__
+  of the ``PSYCOPG3_IMPL`` env var::
+
+      $ PSYCOPG3_IMPL=python pytest 
+      ========================= test session starts =========================
+      [...]
+      libpq available: 130002
+      libpq wrapper implementation: python
+
+  .. __: https://www.psycopg.org/psycopg3/docs/api/pq.html#pq-module-implementations
+
+
+- Slow tests have a ``slow`` marker which can be selected to reduce test
+  runtime to a few seconds only. Please add a ``@pytest.mark.slow`` marker to
+  any test needing an arbitrary wait. At the time of writing::
+
+      $ pytest
+      ========================= test session starts =========================
+      [...]
+      ======= 1983 passed, 3 skipped, 110 xfailed in 78.21s (0:01:18) =======
+
+      $ pytest -m "not slow"
+      ========================= test session starts =========================
+      [...]
+      ==== 1877 passed, 2 skipped, 169 deselected, 48 xfailed in 13.47s =====