Changeset 12744

Timestamp:

10/10/11 23:59:34 (21 months ago)

Author:

GeorgeClark

Message:

Item11177: add a failure hint message to tests

Location:

trunk

Files:

• TestFixturePlugin/data/System/TestFixturePlugin.txt (modified) (1 diff)
• TestFixturePlugin/lib/Foswiki/Plugins/TestFixturePlugin.pm (modified) (1 diff)
• core/data/TestCases/TestCaseAutoSearchOrder.txt (modified) (1 diff)

trunk/TestFixturePlugin/data/System/TestFixturePlugin.txt

@@ -42 +42 @@
 </verbatim>
 
+If there are some hints to resolve common failures, you can include them into the failure results by setting the FAILMSG variable to describe possible failures.  Note that this message is expanded after rendering, so it should be defined as plain HTML.  See the example in TestCases.TestCaseAutoSearchOrder (Hidden in HTML comments).
+
 Some notes about the comparison process:
         1 The comparison is performed by Algorithm::Diff, which compares the HTML structures found in the text. See the documentation on Algorithm::Diff for help.

trunk/TestFixturePlugin/lib/Foswiki/Plugins/TestFixturePlugin.pm

@@ -235 +235 @@
         );
         if ($res) {
-            $res = "<font color=\"red\">TESTS FAILED</font><p />$res";
+            my $failmsg = Foswiki::Func::expandCommonVariables( '%FAILMSG{default=""}%');
+            $res = "<font color=\"red\">TESTS FAILED</font><p />$failmsg<p />$res";
         }
         else {

trunk/core/data/TestCases/TestCaseAutoSearchOrder.txt

@@ -6 +6 @@
 Designed by: Lynnwood Brown
 
+<!--
+   * Set FAILMSG = <b>Verify the file system dates of the <code>.txt,v</code> files for each of the 3 SearchTestTopicX topics.   If the <code>.txt</code> file is newer in the file system than the corresponding <code>.txt,v</code> file, the test will fail.   <code>touch</code> each <code>.txt,v</code> file to resolve the failure.</b>
+-->
 Topics created for test (Text Item; Number Item; Created; Modified):
    * SearchTestTopic1 (Value_1; 3; 14 Dec 2005 - 21:56; 14 Dec 2005 - 21:56)