From 96c25b4797edb048ca7fb8dab4d79e3176384e47 Mon Sep 17 00:00:00 2001
From: Greg Hudson <ghudson@mit.edu>
Date: Fri, 5 Mar 2010 19:30:32 +0000
Subject: [PATCH] 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
---
 src/tests/t_anonpkinit.py |  2 +-
 src/tests/t_general.py    |  4 ++--
 src/util/k5test.py        | 15 +++++++++------
 3 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/src/tests/t_anonpkinit.py b/src/tests/t_anonpkinit.py
index 4ed03d974..e75cf38e1 100644
--- a/src/tests/t_anonpkinit.py
+++ b/src/tests/t_anonpkinit.py
@@ -31,4 +31,4 @@ realm.addprinc('WELLKNOWN/ANONYMOUS')
 realm.kinit('@%s' % realm.realm, flags=['-n'])
 realm.klist('WELLKNOWN/ANONYMOUS@WELLKNOWN:ANONYMOUS')
 
-success()
+success('Anonymous PKINIT.')
diff --git a/src/tests/t_general.py b/src/tests/t_general.py
index fb0649d57..cb2fcbc74 100755
--- a/src/tests/t_general.py
+++ b/src/tests/t_general.py
@@ -11,7 +11,7 @@ for realm in multipass_realms(create_host=False):
     if 'fred\n' not in output:
         fail('Policy not preserved across dump/load.')
 
-    # Check that kinit fails appropriatel with the wrong password.
+    # Check that kinit fails appropriately with the wrong password.
     output = realm.run_as_client([kinit, realm.user_princ], input='wrong\n',
                                  expected_code=1)
     if 'Password incorrect while getting initial credentials' not in output:
@@ -45,4 +45,4 @@ for realm in multipass_realms(create_host=False):
     if 'Key: vno 258,' not in output:
         fail('Expected vno not seen in kadmin.local output')
 
-success()
+success('Dump/load, FAST kinit, kdestroy, kvno wrapping.')
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
 
 
-- 
2.26.2