Update to rra-c-util 5.7 and C TAP Harness 4.1

[kerberos/krb5-strength.git] / tests / README

diff --git a/tests/HOWTO b/tests/README
similarity index 90%
rename from tests/HOWTO
rename to tests/README
index b94985def87eeff3cf5140c58bbc58f1da19cd61..e31a47d80d14a592f1943fc686dd5f99f5a2db59 100644 (file)
--- a/tests/HOWTO
+++ b/tests/README
@@ -70,18 +70,20 @@ Writing TAP Tests
 
     One of the special features of C TAP Harness is the environment that
     it sets up for your test cases.  If your test program is called under
-    the runtests driver, the environment variables SOURCE and BUILD will
-    be set to the top of the test directory in the source tree and the top
-    of the build tree, respectively.  You can use those environment
-    variables to locate additional test data, programs and libraries built
-    as part of your software build, and other supporting information
-    needed by tests.
+    the runtests driver, the environment variables C_TAP_SOURCE and
+    C_TAP_BUILD will be set to the top of the test directory in the source
+    tree and the top of the build tree, respectively.  You can use those
+    environment variables to locate additional test data, programs and
+    libraries built as part of your software build, and other supporting
+    information needed by tests.
 
     The C and shell TAP libraries support a test_file_path() function,
     which looks for a file under the build tree and then under the source
-    tree, using the BUILD and SOURCE environment variables, and return the
-    full path to the file.  This can be used to locate supporting data
-    files.
+    tree, using the C_TAP_BUILD and C_TAP_SOURCE environment variables,
+    and return the full path to the file.  This can be used to locate
+    supporting data files.  They also support a test_tmpdir() function
+    that returns a directory that can be used for temporary files during
+    tests.
 
   Perl
 
@@ -151,7 +153,7 @@ Writing TAP Tests
     Complete API documentation for the basic C TAP library that comes with
     C TAP Harness is available at:
 
-        <http://www.eyrie.org/~eagle/software/c-tap-harness/>
+        <https://www.eyrie.org/~eagle/software/c-tap-harness/>
 
     It's common to need additional test functions and utility functions
     for your C tests, particularly if you have to set up and tear down a
@@ -168,7 +170,7 @@ Writing TAP Tests
     Libraries of additional useful TAP test functions are available in
     rra-c-util at:
 
-        <http://www.eyrie.org/~eagle/software/rra-c-util/>
+        <https://www.eyrie.org/~eagle/software/rra-c-util/>
 
     Some of the code there is particularly useful when testing programs
     that require Kerberos keys.
@@ -190,15 +192,15 @@ Writing TAP Tests
     your test suite area.  It can then be loaded by tests written in shell
     using the environment set up by runtests with:
 
-        . "$SOURCE"/tap/libtap.sh
+        . "$C_TAP_SOURCE"/tap/libtap.sh
 
     Here is a complete test case written in shell which produces the same
     output as the TAP sample above:
 
         #!/bin/sh
 
-        . "$SOURCE"/tap/libtap.sh
-        cd "$BUILD"
+        . "$C_TAP_SOURCE"/tap/libtap.sh
+        cd "$C_TAP_BUILD"
 
         plan 4
         ok 'the first test' true
@@ -238,9 +240,9 @@ Writing TAP Tests
 License
 
     This file is part of the documentation of C TAP Harness, which can be
-    found at <http://www.eyrie.org/~eagle/software/c-tap-harness/>.
+    found at <https://www.eyrie.org/~eagle/software/c-tap-harness/>.
 
-    Copyright 2010 Russ Allbery <eagle@eyrie.org>
+    Copyright 2010, 2016 Russ Allbery <eagle@eyrie.org>
 
     Copying and distribution of this file, with or without modification,
     are permitted in any medium without royalty provided the copyright