Improve documentation for the (internal) test rules with infrastructure

... explaining, in particular, which environment variables are provided
by the test-runner framework.

1 files changed, 38 insertions, 8 deletions

diff --git a/test/end-to-end/RULES b/test/end-to-end/RULES
index 14a9aa95..04a06a89 100644
--- a/test/end-to-end/RULES
+++ b/test/end-to-end/RULES
@@ -18,11 +18,21 @@
     { "test":
       [ "The shell script for the test, launched with sh."
       , ""
-      , "An empty directory is created to store any temporary files needed"
+      , "The script will be invoked in the specified TEST_ENV with the"
+      , "following variables added."
+      , " - REMOTE_EXECUTION_ADDRESS containing the IP:port pair the"
+      , "   implicit remote-execution endpoint is listening at."
+      , " - COMAPTIBLE is set to an non-empty string, if the server was"
+      , "   started in compatible mode, and unset otherwise."
+      , "Additionally, the variables TLS_CA_CERT, TLS_CLIENT_CERT, and"
+      , "TLS_CLIENT_KEY are removed from the environment."
+      , ""
+      , "Moreover, an empty directory is created for any temporary files needed"
       , "by the test, and it is made available in the environment variable"
       , "TEST_TMPDIR. The test should not assume write permissions"
       , "outside the working directory and the TEST_TMPDIR."
-      , "For convenience, the environment variable TMPDIR is also set to TEST_TMPDIR."
+      , "For convenience, the environment variable TMPDIR is also set to"
+      , "TEST_TMPDIR."
       ]
     , "name":
       [ "A name for the test, used in reporting, as well as for staging"
@@ -231,13 +241,33 @@
     { "test":
       [ "The shell script for the test, launched with sh."
       , ""
-      , "An empty directory is created to store any temporary files needed"
+      , "The script will be invoked in the specified TEST_ENV with the"
+      , "following variables added."
+      , " - REMOTE_EXECUTION_ADDRESS containing the IP:port pair the"
+      , "   implicit remote-execution endpoint is listening at."
+      , " - COMAPTIBLE is set to an non-empty string, if the server was"
+      , "   started in compatible mode, and unset otherwise."
+      , " - REMOTE_LBR containing the absolute path to the local build root"
+      , "   of the implicit remote-execution end point"
+      , " - SERVE_ADDRESS containing the IP:port pair the"
+      , "   implicit serve endpoint is listening at."
+      , " - SERVE_LBR containing the absolute path to the local build root"
+      , "   of the implicit serve end point"
+      , " - COMMIT_0, COMMIT_1, ... containing the commit id of the head"
+      , "   commit of the repositories available to the serve endpoint"
+      , " - TREE_0, TREE_1, ... containing the git tree identifiers of"
+      , "   the head commit of the repositories available ot the serve"
+      , "   endpoint"
+      , "Additionally, the variables TLS_CA_CERT, TLS_CLIENT_CERT, and"
+      , "TLS_CLIENT_KEY are removed from the environment."
+      , ""
+      , "Moreover, an empty directory is created for any temporary files needed"
       , "by the test, and it is made available in the environment variable"
-      , "TEST_TMPDIR. Also, the serve server build root is being made available"
-      , "in the environment variable SERVE_LBR. The test should not assume"
-      , "write permissions outside the working directory, the TEST_TMPDIR, and"
-      , "the SERVE_LBR."
-      , "For convenience, the environment variable TMPDIR is also set to TEST_TMPDIR."
+      , "TEST_TMPDIR. The test should not assume write permissions"
+      , "write permissions outside the working directory, the TEST_TMPDIR,"
+      , "REMOTE_LBR, and SERVE_LBR."
+      , "For convenience, the environment variable TMPDIR is also set to"
+      , "TEST_TMPDIR."
       ]
     , "name":
       [ "A name for the test, used in reporting, as well as for staging"