From fdb34824e01d14e21566806ea37e974ac61ef1a4 Mon Sep 17 00:00:00 2001
From: Peter Eisentraut <peter_e@gmx.net>
Date: Sat, 3 Mar 2018 01:29:51 -0500
Subject: Add PG_TEST_EXTRA to control optional test suites

The SSL and LDAP test suites are not run by default, as they are not
secure for multi-user environments.  This commit adds an extra make
variable to optionally enable them, for example:

make check-world PG_TEST_EXTRA='ldap ssl'

Author: Michael Paquier <michael@paquier.xyz>
---
 doc/src/sgml/regress.sgml | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

(limited to 'doc/src')

diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index ca2716a6d7a..3c448dc5bc4 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -211,6 +211,44 @@ make installcheck-world
    option <option>--enable-tap-tests</option>.  This is recommended for
    development, but can be omitted if there is no suitable Perl installation.
   </para>
+
+  <para>
+   Some test suites are not run by default, either because they are not secure
+   to run on a multiuser system or because they require special software.  You
+   can decide which test suites to run additionally by setting the
+   <command>make</command> or environment variable
+   <varname>PG_TEST_EXTRA</varname> to a whitespace-separated list, for
+   example:
+<programlisting>
+make check-world PG_TEST_EXTRA='ldap ssl'
+</programlisting>
+   The following values are currently supported:
+   <variablelist>
+    <varlistentry>
+     <term><literal>ldap</literal></term>
+     <listitem>
+      <para>
+       Runs the test suite under <filename>src/test/ldap</filename>.  This
+       requires an <productname>OpenLDAP</productname> installation and opens
+       TCP/IP listen sockets.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term><literal>ssl</literal></term>
+     <listitem>
+      <para>
+       Runs the test suite under <filename>src/test/ssl</filename>.  This opens TCP/IP listen sockets.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+
+   Tests for features that are not supported by the current build
+   configuration are not run even if they are mentioned in
+   <varname>PG_TEST_EXTRA</varname>.
+  </para>
   </sect2>
 
   <sect2>
-- 
cgit v1.2.3