home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _95d5e2470adfe399a87f41030b542014 < prev    next >
Text File  |  2000-03-23  |  8KB  |  193 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Test::Harness - run perl standard test scripts with statistics</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Test::Harness - run perl standard test scripts with statistics</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#the test script output">The test script output</A></LI>
  28.     </UL>
  29.  
  30.     <LI><A HREF="#export">EXPORT</A></LI>
  31.     <LI><A HREF="#diagnostics">DIAGNOSTICS</A></LI>
  32.     <LI><A HREF="#environment">ENVIRONMENT</A></LI>
  33.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  34.     <LI><A HREF="#authors">AUTHORS</A></LI>
  35.     <LI><A HREF="#bugs">BUGS</A></LI>
  36. </UL>
  37. <!-- INDEX END -->
  38.  
  39. <HR>
  40. <P>
  41. <H1><A NAME="name">NAME</A></H1>
  42. <P>Test::Harness - run perl standard test scripts with statistics</P>
  43. <P>
  44. <HR>
  45. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  46. <UL>
  47. <LI>Linux</LI>
  48. <LI>Solaris</LI>
  49. <LI>Windows</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <P>use Test::Harness;</P>
  54. <P>runtests(@tests);</P>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P>(By using the <A HREF="../../lib/Test.html">the Test manpage</A> module, you can write test scripts without
  59. knowing the exact output this module expects.  However, if you need to
  60. know the specifics, read on!)</P>
  61. <P>Perl test scripts print to standard output <CODE>"ok N"</CODE> for each single
  62. test, where <CODE>N</CODE> is an increasing sequence of integers. The first line
  63. output by a standard test script is <CODE>"1..M"</CODE> with <CODE>M</CODE> being the
  64. number of tests that should be run within the test
  65. script. Test::Harness::runtests(@tests) runs all the testscripts
  66. named as arguments and checks standard output for the expected
  67. <CODE>"ok N"</CODE> strings.</P>
  68. <P>After all tests have been performed, <CODE>runtests()</CODE> prints some
  69. performance statistics that are computed by the Benchmark module.</P>
  70. <P>
  71. <H2><A NAME="the test script output">The test script output</A></H2>
  72. <P>Any output from the testscript to standard error is ignored and
  73. bypassed, thus will be seen by the user. Lines written to standard
  74. output containing <CODE>/^(not\s+)?ok\b/</CODE> are interpreted as feedback for
  75. runtests().  All other lines are discarded.</P>
  76. <P>It is tolerated if the test numbers after <CODE>ok</CODE> are omitted. In this
  77. case Test::Harness maintains temporarily its own counter until the
  78. script supplies test numbers again. So the following test script</P>
  79. <PRE>
  80.     print <<END;
  81.     1..6
  82.     not ok
  83.     ok
  84.     not ok
  85.     ok
  86.     ok
  87.     END</PRE>
  88. <P>will generate</P>
  89. <PRE>
  90.     FAILED tests 1, 3, 6
  91.     Failed 3/6 tests, 50.00% okay</PRE>
  92. <P>The global variable $Test::Harness::verbose is exportable and can be
  93. used to let <CODE>runtests()</CODE> display the standard output of the script
  94. without altering the behavior otherwise.</P>
  95. <P>The global variable $Test::Harness::switches is exportable and can be
  96. used to set perl command line options used for running the test
  97. script(s). The default value is <CODE>-w</CODE>.</P>
  98. <P>If the standard output line contains substring <CODE> # Skip</CODE> (with
  99. variations in spacing and case) after <CODE>ok</CODE> or <CODE>ok NUMBER</CODE>, it is
  100. counted as a skipped test.  If the whole testscript succeeds, the
  101. count of skipped tests is included in the generated output.</P>
  102. <P><CODE>Test::Harness</CODE> reports the text after <CODE> # Skip(whatever)</CODE> as a
  103. reason for skipping.  Similarly, one can include a similar explanation
  104. in a <CODE>1..0</CODE> line emitted if the test is skipped completely:</P>
  105. <PRE>
  106.   1..0 # Skipped: no leverage found</PRE>
  107. <P>
  108. <HR>
  109. <H1><A NAME="export">EXPORT</A></H1>
  110. <P><CODE>&runtests</CODE> is exported by Test::Harness per default.</P>
  111. <P>
  112. <HR>
  113. <H1><A NAME="diagnostics">DIAGNOSTICS</A></H1>
  114. <DL>
  115. <DT><STRONG><A NAME="item_All_tests_successful%2E%5CnFiles%3D%25d%2C_Tests%3"><CODE>All tests successful.\nFiles=%d,  Tests=%d, %s</CODE></A></STRONG><BR>
  116. <DD>
  117. If all tests are successful some statistics about the performance are
  118. printed.
  119. <P></P>
  120. <DT><STRONG><A NAME="item_FAILED_tests_%25s%5Cn%5CtFailed_%25d%2F%25d_tests%"><CODE>FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay.</CODE></A></STRONG><BR>
  121. <DD>
  122. For any single script that has failing subtests statistics like the
  123. above are printed.
  124. <P></P>
  125. <DT><STRONG><A NAME="item_d"><CODE>Test returned status %d (wstat %d)</CODE></A></STRONG><BR>
  126. <DD>
  127. Scripts that return a non-zero exit status, both <CODE>$? >> 8</CODE> and <CODE>$?</CODE> are
  128. printed in a message similar to the above.
  129. <P></P>
  130. <DT><STRONG><A NAME="item_Failed_1_test%2C_%25%2E2f%25%25_okay%2E_%25s"><CODE>Failed 1 test, %.2f%% okay. %s</CODE></A></STRONG><BR>
  131. <DD>
  132. <DT><STRONG><A NAME="item_Failed_%25d%2F%25d_tests%2C_%25%2E2f%25%25_okay%2E"><CODE>Failed %d/%d tests, %.2f%% okay. %s</CODE></A></STRONG><BR>
  133. <DD>
  134. If not all tests were successful, the script dies with one of the
  135. above messages.
  136. <P></P></DL>
  137. <P>
  138. <HR>
  139. <H1><A NAME="environment">ENVIRONMENT</A></H1>
  140. <P>Setting <CODE>HARNESS_IGNORE_EXITCODE</CODE> makes harness ignore the exit status
  141. of child processes.</P>
  142. <P>Setting <CODE>HARNESS_NOTTY</CODE> to a true value forces it to behave as though
  143. STDOUT were not a console.  You may need to set this if you don't want
  144. harness to output more frequent progress messages using carriage returns.
  145. Some consoles may not handle carriage returns properly (which results
  146. in a somewhat messy output).</P>
  147. <P>Setting <CODE>HARNESS_COMPILE_TEST</CODE> to a true value will make harness attempt
  148. to compile the test using <CODE>perlcc</CODE> before running it.</P>
  149. <P>If <CODE>HARNESS_FILELEAK_IN_DIR</CODE> is set to the name of a directory, harness
  150. will check after each test whether new files appeared in that directory,
  151. and report them as</P>
  152. <PRE>
  153.   LEAKED FILES: scr.tmp 0 my.db</PRE>
  154. <P>If relative, directory name is with respect to the current directory at
  155. the moment <CODE>runtests()</CODE> was called.  Putting absolute path into 
  156. <CODE>HARNESS_FILELEAK_IN_DIR</CODE> may give more predicatable results.</P>
  157. <P>The value of <CODE>HARNESS_PERL_SWITCHES</CODE> will be prepended to the
  158. switches used to invoke perl on each test.  For example, setting
  159. <CODE>HARNESS_PERL_SWITCHES</CODE> to ``-W'' will run all tests with all
  160. warnings enabled.</P>
  161. <P>Harness sets <CODE>HARNESS_ACTIVE</CODE> before executing the individual tests.
  162. This allows the tests to determine if they are being executed through the
  163. harness or by any other means.</P>
  164. <P>
  165. <HR>
  166. <H1><A NAME="see also">SEE ALSO</A></H1>
  167. <P><A HREF="../../lib/Test.html">the Test manpage</A> for writing test scripts and also <A HREF="../../lib/Benchmark.html">the Benchmark manpage</A> for the
  168. underlying timing routines.</P>
  169. <P>
  170. <HR>
  171. <H1><A NAME="authors">AUTHORS</A></H1>
  172. <P>Either Tim Bunce or Andreas Koenig, we don't know. What we know for
  173. sure is, that it was inspired by Larry Wall's TEST script that came
  174. with perl distributions for ages. Numerous anonymous contributors
  175. exist. Current maintainer is Andreas Koenig.</P>
  176. <P>
  177. <HR>
  178. <H1><A NAME="bugs">BUGS</A></H1>
  179. <P>Test::Harness uses $^X to determine the perl binary to run the tests
  180. with. Test scripts running via the shebang (<CODE>#!</CODE>) line may not be
  181. portable because $^X is not consistent for shebang scripts across
  182. platforms. This is no problem when Test::Harness is run with an
  183. absolute path to the perl binary or when $^X can be found in the path.</P>
  184. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  185. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  186. <STRONG><P CLASS=block> Test::Harness - run perl standard test scripts with statistics</P></STRONG>
  187. </TD></TR>
  188. </TABLE>
  189.  
  190. </BODY>
  191.  
  192. </HTML>
  193.