aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2018-06-19 19:30:50 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2018-06-19 19:30:50 -0400
commitc992dca26e2b7d02ec7d43f2b71ff23d77e39f27 (patch)
treed87775c7a800e40bac9fd6d71b5895bb9d324198
parent9bab9cb36ad9186c9898703106b545d6dbb2aa24 (diff)
downloadpostgresql-c992dca26e2b7d02ec7d43f2b71ff23d77e39f27.tar.gz
postgresql-c992dca26e2b7d02ec7d43f2b71ff23d77e39f27.zip
Clarify the README files for the various separate TAP-based test suites.
Explain the difference between "make check" and "make installcheck". Mention the need for --enable-tap-tests (only some of these did so before). Standardize their wording about how to run the tests.
-rw-r--r--src/test/authentication/README12
-rw-r--r--src/test/kerberos/README14
-rw-r--r--src/test/ldap/README12
-rw-r--r--src/test/recovery/README16
-rw-r--r--src/test/ssl/README21
-rw-r--r--src/test/subscription/README18
6 files changed, 62 insertions, 31 deletions
diff --git a/src/test/authentication/README b/src/test/authentication/README
index dd797467538..a8f27bfdaf5 100644
--- a/src/test/authentication/README
+++ b/src/test/authentication/README
@@ -11,10 +11,16 @@ are more complicated, and are not safe to run in a multi-user system.
Running the tests
=================
- make check
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Run
+ make check
or
-
make installcheck
+You can use "make installcheck" if you previously did "make install".
+In that case, the code in the installation tree is tested. With
+"make check", a temporary installation tree is built from the current
+sources and then tested.
-NOTE: This requires the --enable-tap-tests argument to configure.
+Either way, this test initializes, starts, and stops a test Postgres
+cluster.
diff --git a/src/test/kerberos/README b/src/test/kerberos/README
index cdfaeb89d33..93af72e1636 100644
--- a/src/test/kerberos/README
+++ b/src/test/kerberos/README
@@ -16,11 +16,19 @@ users.
Running the tests
=================
- make check
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Run
+ make check
or
-
make installcheck
+You can use "make installcheck" if you previously did "make install".
+In that case, the code in the installation tree is tested. With
+"make check", a temporary installation tree is built from the current
+sources and then tested.
+
+Either way, this test initializes, starts, and stops a test Postgres
+cluster, as well as a test KDC server.
Requirements
============
@@ -30,6 +38,6 @@ supported.
Debian/Ubuntu packages: krb5-admin-server krb5-kdc krb5-user
-RHEL/CentOS packages: krb5-server krb5-workstation
+RHEL/CentOS/Fedora packages: krb5-server krb5-workstation
FreeBSD port: krb5 (base system has Heimdal)
diff --git a/src/test/ldap/README b/src/test/ldap/README
index 3e4c5cbaf95..4dc53a1bde0 100644
--- a/src/test/ldap/README
+++ b/src/test/ldap/README
@@ -17,11 +17,19 @@ users.
Running the tests
=================
- make check
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Run
+ make check
or
-
make installcheck
+You can use "make installcheck" if you previously did "make install".
+In that case, the code in the installation tree is tested. With
+"make check", a temporary installation tree is built from the current
+sources and then tested.
+
+Either way, this test initializes, starts, and stops a test Postgres
+cluster, as well as a test LDAP server.
Requirements
============
diff --git a/src/test/recovery/README b/src/test/recovery/README
index 93bdcf4fed6..a1e1aa1be1c 100644
--- a/src/test/recovery/README
+++ b/src/test/recovery/README
@@ -8,14 +8,16 @@ This directory contains a test suite for recovery and replication.
Running the tests
=================
- make check
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Run
+ make check
or
-
make installcheck
+You can use "make installcheck" if you previously did "make install".
+In that case, the code in the installation tree is tested. With
+"make check", a temporary installation tree is built from the current
+sources and then tested.
-NOTE: This creates a temporary installation (in the case of "check"),
-and some tests may create one or multiple nodes, be they master or
-standby(s) for the purpose of the tests.
-
-NOTE: This requires the --enable-tap-tests argument to configure.
+Either way, this test initializes, starts, and stops several test Postgres
+clusters.
diff --git a/src/test/ssl/README b/src/test/ssl/README
index 5e8bf641ba4..84baa478cef 100644
--- a/src/test/ssl/README
+++ b/src/test/ssl/README
@@ -7,20 +7,27 @@ This directory contains a test suite for SSL support. It tests both
client-side functionality, i.e. verifying server certificates, and
server-side functionality, i.e. certificate authorization.
+CAUTION: The test server run by this test is configured to listen for
+TCP connections on localhost. Any user on the same host is able to
+log in to the test server while the tests are running. Do not run this
+suite on a multi-user system where you don't trust all local users!
+
Running the tests
=================
- make check
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Run
+ make check
or
-
make installcheck
+You can use "make installcheck" if you previously did "make install".
+In that case, the code in the installation tree is tested. With
+"make check", a temporary installation tree is built from the current
+sources and then tested.
-NOTE: This creates a temporary installation (in the case of "check"),
-and sets it up to listen for TCP connections on localhost. Any user on
-the same host is allowed to log in to the test installation while the
-tests are running. Do not run this suite on a multi-user system where
-you don't trust all local users!
+Either way, this test initializes, starts, and stops a test Postgres
+cluster that is accessible to other local users!
Certificates
============
diff --git a/src/test/subscription/README b/src/test/subscription/README
index 4270a010276..fb5382e1205 100644
--- a/src/test/subscription/README
+++ b/src/test/subscription/README
@@ -8,16 +8,16 @@ This directory contains a test suite for subscription/logical replication.
Running the tests
=================
- make check
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Run
+ make check
or
-
make installcheck
+You can use "make installcheck" if you previously did "make install"
+(including installing the hstore extension). In that case, the code
+in the installation tree is tested. With "make check", a temporary
+installation tree is built from the current sources and then tested.
-This requires the --enable-tap-tests argument to configure.
-
-Running the tests creates a temporary installation (in the case of
-"check"), and some tests may create one or multiple nodes, for the
-purpose of the tests.
-
-Running installcheck requires the hstore extension to be installed.
+Either way, this test initializes, starts, and stops several test Postgres
+clusters.