From: Peter Eisentraut <peter@eisentraut.org>
Date: Wed, 19 Jun 2019 15:19:28 +0000 (+0200)
Subject: Add documentation for available test suites
X-Git-Tag: pgbouncer_1_10_0~15
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=db85c7d83da5f1992df7e16fca0dffe0e295eabe;p=pgbouncer

Add documentation for available test suites

fixes #83
---

diff --git a/test/README.md b/test/README.md
new file mode 100644
index 0000000..b3ef30b
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,39 @@
+Tests
+=====
+
+Various ways to test PgBouncer:
+
+- `test.sh`
+
+    General test of basic functionality and different configuration
+    parameters including timeouts, pool size, online restart,
+    pause/resume, etc.  To invoke, just run `./test.sh`.  This needs
+    PostgreSQL server programs (`initdb`, `pg_ctl`) in the path, so if
+    you are on a system that doesn't have those in the normal path
+    (e.g., Debian, Ubuntu), set `PATH` beforehand.
+
+    Note: This test suite will ask for `sudo` access to use
+    `iptables`/`pfctl` to simulate various network conditions.  If you
+    don't want that, just enter an empty password at the `sudo`
+    prompt, and those tests will be skipped.  Check the source if
+    there are any doubts.
+
+- `ssl/test.sh`
+
+    Tests SSL/TLS functionality.  Otherwise very similar to `test.sh`.
+
+- `hba_test`
+
+    Tests hba parsing.  Run `make all` to build and `make check` to execute.
+
+- `run-conntest.sh`
+
+    This is a more complex setup that continuously runs queries
+    through PgBouncer while messing around with the network, checking
+    whether PgBouncer correctly reconnects and all the queries get
+    processed.  First, run `make asynctest` to build, then see
+    `run-conntest.sh` how to run the different pieces.
+
+- `stress.py`
+
+    Stress test, see source for details.  Requires Python and `psycopg2` module.