changeset 4117:ab08a74ad2f4

Document how to run database tests
author Tom Gottfried <tom@intevation.de>
date Wed, 31 Jul 2019 18:26:02 +0200
parents 3cec90587ff9
children b785b6bef578
files README.md
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Wed Jul 31 18:00:49 2019 +0200
+++ b/README.md	Wed Jul 31 18:26:02 2019 +0200
@@ -21,6 +21,21 @@
 For further details see [docs/DEVELOPMENT](docs/DEVELOPMENT.md),
 
 
+## Running Tests
+
+- Running database tests:
+
+  * You will need a PostgreSQL cluster with PostGIS and pgTAP.
+  * To run the tests use the script `./schema/run_tests.sh`.
+  * `./schema/run_tests.sh --help` shows you available options.
+    Per default the script will create (and drop if it already exists)
+    a database named "gemma_test" and all necessary roles in the postgres
+    default cluster (listening on port 5432) and run the tests
+    in that database.
+  * The script must be run as a user with PostgreSQL super user rights.
+    By convention this is "postgres" on most systems.
+
+
 ## Setup Database
 
 - You will need a PostgreSQL cluster with PostGIS.