Add a message parameter to k5test's success(), to briefly indicate the

scope of test scripts.  Only displayed when verbose is set.

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@23768 dc483132-0cff-0310-8789-dd5450dbe970

1 files changed, 9 insertions, 6 deletions

diff --git a/src/util/k5test.py b/src/util/k5test.py
index 5a1103219..aa972d742 100644
--- a/src/util/k5test.py
+++ b/src/util/k5test.py
@@ -38,7 +38,7 @@ script usage:
     realm.run_as_client(['./clientprog', realm.host_princ])
 
     # Inform framework that tests completed successfully.
-    success()
+    success('World peace and cure for cancer.')
 
 By default, the realm will have:
 
@@ -124,6 +124,12 @@ Scripts may use the following functions and variables:
 * fail(message): Display message (plus leading marker and trailing
   newline) and explanatory messages about debugging.
 
+* success(message): Indicate that the test script has completed
+  successfully.  Suppresses the display of explanatory debugging
+  messages in the on-exit handler.  message should briefly summarize
+  the operations tested; it will only be displayed (with leading
+  marker and trailing newline) if the script is running verbosely.
+
 * output(message, force_verbose=False): Place message (without any
   added newline) in testlog, and write it to stdout if running
   verbosely.
@@ -144,10 +150,6 @@ Scripts may use the following functions and variables:
   honored.  If keywords contains krb5_conf and/or kdc_conf fragments,
   they will be merged with the default and per-pass specifications.
 
-* success(): Indicate that the test script has completed successfully.
-  Suppresses the display of explanatory debugging messages in the
-  on-exit handler.
-
 * buildtop: The top of the build directory (absolute path).
 
 * srctop: The top of the source directory (absolute path).
@@ -308,8 +310,9 @@ def fail(msg):
     sys.exit(1)
 
 
-def success():
+def success(msg):
     global _success
+    output('*** Success: %s\n' % msg)
     _success = True