mingw/html/lib/Test/Builder/Tester.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>Test::Builder::Tester - test testsuites that have been built with
   6 Test::Builder</title>
   7 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   8 <link rev="made" href="mailto:" />
   9 </head>
  10
  11 <body style="background-color: white">
  12 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  13 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  14 <big><strong><span class="block">&nbsp;Test::Builder::Tester - test testsuites that have been built with
  15 Test::Builder</span></strong></big>
  16 </td></tr>
  17 </table>
  18
  19 <p><a name="__index__"></a></p>
  20 <!-- INDEX BEGIN -->
  21
  22 <ul>
  23
  24         <li><a href="#name">NAME</a></li>
  25         <li><a href="#synopsis">SYNOPSIS</a></li>
  26         <li><a href="#description">DESCRIPTION</a></li>
  27         <ul>
  28
  29                 <li><a href="#methods">Methods</a></li>
  30         </ul>
  31
  32         <li><a href="#bugs">BUGS</a></li>
  33         <li><a href="#author">AUTHOR</a></li>
  34         <li><a href="#notes">NOTES</a></li>
  35         <li><a href="#see_also">SEE ALSO</a></li>
  36 </ul>
  37 <!-- INDEX END -->
  38
  39 <hr />
  40 <p>
  41 </p>
  42 <h1><a name="name">NAME</a></h1>
  43 <p>Test::Builder::Tester - test testsuites that have been built with
  44 Test::Builder</p>
  45 <p>
  46 </p>
  47 <hr />
  48 <h1><a name="synopsis">SYNOPSIS</a></h1>
  49 <pre>
  50     use Test::Builder::Tester tests =&gt; 1;
  51     use Test::More;</pre>
  52 <pre>
  53     test_out(&quot;not ok 1 - foo&quot;);
  54     test_fail(+1);
  55     fail(&quot;foo&quot;);
  56     test_test(&quot;fail works&quot;);</pre>
  57 <p>
  58 </p>
  59 <hr />
  60 <h1><a name="description">DESCRIPTION</a></h1>
  61 <p>A module that helps you test testing modules that are built with
  62 <strong>Test::Builder</strong>.</p>
  63 <p>The testing system is designed to be used by performing a three step
  64 process for each test you wish to test.  This process starts with using
  65 <a href="#item_test_out"><code>test_out</code></a> and <a href="#item_test_err"><code>test_err</code></a> in advance to declare what the testsuite you
  66 are testing will output with <strong>Test::Builder</strong> to stdout and stderr.</p>
  67 <p>You then can run the <code>test(s)</code> from your test suite that call
  68 <strong>Test::Builder</strong>.  At this point the output of <strong>Test::Builder</strong> is
  69 safely captured by <strong>Test::Builder::Tester</strong> rather than being
  70 interpreted as real test output.</p>
  71 <p>The final stage is to call <a href="#item_test_test"><code>test_test</code></a> that will simply compare what you
  72 predeclared to what <strong>Test::Builder</strong> actually outputted, and report the
  73 results back with a ``ok'' or ``not ok'' (with debugging) to the normal
  74 output.</p>
  75 <p>
  76 </p>
  77 <h2><a name="methods">Methods</a></h2>
  78 <p>These are the six methods that are exported as default.</p>
  79 <dl>
  80 <dt><strong><a name="item_test_out">test_out</a></strong>
  81
  82 <dt><strong><a name="item_test_err">test_err</a></strong>
  83
  84 <dd>
  85 <p>Procedures for predeclaring the output that your test suite is
  86 expected to produce until <a href="#item_test_test"><code>test_test</code></a> is called.  These procedures
  87 automatically assume that each line terminates with ``\n''.  So</p>
  88 </dd>
  89 <dd>
  90 <pre>
  91    test_out(&quot;ok 1&quot;,&quot;ok 2&quot;);</pre>
  92 </dd>
  93 <dd>
  94 <p>is the same as</p>
  95 </dd>
  96 <dd>
  97 <pre>
  98    test_out(&quot;ok 1\nok 2&quot;);</pre>
  99 </dd>
 100 <dd>
 101 <p>which is even the same as</p>
 102 </dd>
 103 <dd>
 104 <pre>
 105    test_out(&quot;ok 1&quot;);
 106    test_out(&quot;ok 2&quot;);</pre>
 107 </dd>
 108 <dd>
 109 <p>Once <a href="#item_test_out"><code>test_out</code></a> or <a href="#item_test_err"><code>test_err</code></a> (or <a href="#item_test_fail"><code>test_fail</code></a> or <a href="#item_test_diag"><code>test_diag</code></a>) have
 110 been called once all further output from <strong>Test::Builder</strong> will be
 111 captured by <strong>Test::Builder::Tester</strong>.  This means that your will not
 112 be able perform further tests to the normal output in the normal way
 113 until you call <a href="#item_test_test"><code>test_test</code></a> (well, unless you manually meddle with the
 114 output filehandles)</p>
 115 </dd>
 116 </li>
 117 <dt><strong><a name="item_test_fail">test_fail</a></strong>
 118
 119 <dd>
 120 <p>Because the standard failure message that <strong>Test::Builder</strong> produces
 121 whenever a test fails will be a common occurrence in your test error
 122 output, and because has changed between Test::Builder versions, rather
 123 than forcing you to call <a href="#item_test_err"><code>test_err</code></a> with the string all the time like
 124 so</p>
 125 </dd>
 126 <dd>
 127 <pre>
 128     test_err(&quot;# Failed test ($0 at line &quot;.line_num(+1).&quot;)&quot;);</pre>
 129 </dd>
 130 <dd>
 131 <p><a href="#item_test_fail"><code>test_fail</code></a> exists as a convenience method that can be called
 132 instead.  It takes one argument, the offset from the current line that
 133 the line that causes the fail is on.</p>
 134 </dd>
 135 <dd>
 136 <pre>
 137     test_fail(+1);</pre>
 138 </dd>
 139 <dd>
 140 <p>This means that the example in the synopsis could be rewritten
 141 more simply as:</p>
 142 </dd>
 143 <dd>
 144 <pre>
 145    test_out(&quot;not ok 1 - foo&quot;);
 146    test_fail(+1);
 147    fail(&quot;foo&quot;);
 148    test_test(&quot;fail works&quot;);</pre>
 149 </dd>
 150 </li>
 151 <dt><strong><a name="item_test_diag">test_diag</a></strong>
 152
 153 <dd>
 154 <p>As most of the remaining expected output to the error stream will be
 155 created by Test::Builder's <code>diag</code> function, <strong>Test::Builder::Tester</strong>
 156 provides a convience function <a href="#item_test_diag"><code>test_diag</code></a> that you can use instead of
 157 <a href="#item_test_err"><code>test_err</code></a>.</p>
 158 </dd>
 159 <dd>
 160 <p>The <a href="#item_test_diag"><code>test_diag</code></a> function prepends comment hashes and spacing to the
 161 start and newlines to the end of the expected output passed to it and
 162 adds it to the list of expected error output.  So, instead of writing</p>
 163 </dd>
 164 <dd>
 165 <pre>
 166    test_err(&quot;# Couldn't open file&quot;);</pre>
 167 </dd>
 168 <dd>
 169 <p>you can write</p>
 170 </dd>
 171 <dd>
 172 <pre>
 173    test_diag(&quot;Couldn't open file&quot;);</pre>
 174 </dd>
 175 <dd>
 176 <p>Remember that <strong>Test::Builder</strong>'s diag function will not add newlines to
 177 the end of output and test_diag will. So to check</p>
 178 </dd>
 179 <dd>
 180 <pre>
 181    Test::Builder-&gt;new-&gt;diag(&quot;foo\n&quot;,&quot;bar\n&quot;);</pre>
 182 </dd>
 183 <dd>
 184 <p>You would do</p>
 185 </dd>
 186 <dd>
 187 <pre>
 188   test_diag(&quot;foo&quot;,&quot;bar&quot;)</pre>
 189 </dd>
 190 <dd>
 191 <p>without the newlines.</p>
 192 </dd>
 193 </li>
 194 <dt><strong><a name="item_test_test">test_test</a></strong>
 195
 196 <dd>
 197 <p>Actually performs the output check testing the tests, comparing the
 198 data (with <code>eq</code>) that we have captured from <strong>Test::Builder</strong> against
 199 that that was declared with <a href="#item_test_out"><code>test_out</code></a> and <a href="#item_test_err"><code>test_err</code></a>.</p>
 200 </dd>
 201 <dd>
 202 <p>This takes name/value pairs that effect how the test is run.</p>
 203 </dd>
 204 <dl>
 205 <dt><strong><a name="item_title">title (synonym 'name', 'label')</a></strong>
 206
 207 <dd>
 208 <p>The name of the test that will be displayed after the <code>ok</code> or <code>not
 209 ok</code>.</p>
 210 </dd>
 211 </li>
 212 <dt><strong><a name="item_skip_out">skip_out</a></strong>
 213
 214 <dd>
 215 <p>Setting this to a true value will cause the test to ignore if the
 216 output sent by the test to the output stream does not match that
 217 declared with <a href="#item_test_out"><code>test_out</code></a>.</p>
 218 </dd>
 219 </li>
 220 <dt><strong><a name="item_skip_err">skip_err</a></strong>
 221
 222 <dd>
 223 <p>Setting this to a true value will cause the test to ignore if the
 224 output sent by the test to the error stream does not match that
 225 declared with <a href="#item_test_err"><code>test_err</code></a>.</p>
 226 </dd>
 227 </li>
 228 </dl>
 229 <p>As a convience, if only one argument is passed then this argument
 230 is assumed to be the name of the test (as in the above examples.)</p>
 231 <p>Once <a href="#item_test_test"><code>test_test</code></a> has been run test output will be redirected back to
 232 the original filehandles that <strong>Test::Builder</strong> was connected to
 233 (probably STDOUT and STDERR,) meaning any further tests you run
 234 will function normally and cause success/errors for <strong>Test::Harness</strong>.</p>
 235 <dt><strong><a name="item_line_num">line_num</a></strong>
 236
 237 <dd>
 238 <p>A utility function that returns the line number that the function was
 239 called on.  You can pass it an offset which will be added to the
 240 result.  This is very useful for working out the correct text of
 241 diagnostic methods that contain line numbers.</p>
 242 </dd>
 243 <dd>
 244 <p>Essentially this is the same as the <code>__LINE__</code> macro, but the
 245 <a href="#item_line_num"><code>line_num(+3)</code></a> idiom is arguably nicer.</p>
 246 </dd>
 247 </li>
 248 </dl>
 249 <p>In addition to the six exported functions there there exists one
 250 function that can only be accessed with a fully qualified function
 251 call.</p>
 252 <dl>
 253 <dt><strong><a name="item_color">color</a></strong>
 254
 255 <dd>
 256 <p>When <a href="#item_test_test"><code>test_test</code></a> is called and the output that your tests generate
 257 does not match that which you declared, <a href="#item_test_test"><code>test_test</code></a> will print out
 258 debug information showing the two conflicting versions.  As this
 259 output itself is debug information it can be confusing which part of
 260 the output is from <a href="#item_test_test"><code>test_test</code></a> and which was the original output from
 261 your original tests.  Also, it may be hard to spot things like
 262 extraneous whitespace at the end of lines that may cause your test to
 263 fail even though the output looks similar.</p>
 264 </dd>
 265 <dd>
 266 <p>To assist you, if you have the <strong>Term::ANSIColor</strong> module installed
 267 (which you should do by default from perl 5.005 onwards), <a href="#item_test_test"><code>test_test</code></a>
 268 can colour the background of the debug information to disambiguate the
 269 different types of output. The debug output will have it's background
 270 coloured green and red.  The green part represents the text which is
 271 the same between the executed and actual output, the red shows which
 272 part differs.</p>
 273 </dd>
 274 <dd>
 275 <p>The <a href="#item_color"><code>color</code></a> function determines if colouring should occur or not.
 276 Passing it a true or false value will enable or disable colouring
 277 respectively, and the function called with no argument will return the
 278 current setting.</p>
 279 </dd>
 280 <dd>
 281 <p>To enable colouring from the command line, you can use the
 282 <strong>Text::Builder::Tester::Color</strong> module like so:</p>
 283 </dd>
 284 <dd>
 285 <pre>
 286    perl -Mlib=Text::Builder::Tester::Color test.t</pre>
 287 </dd>
 288 <dd>
 289 <p>Or by including the <strong>Test::Builder::Tester::Color</strong> module directly in
 290 the PERL5LIB.</p>
 291 </dd>
 292 </li>
 293 </dl>
 294 <p>
 295 </p>
 296 <hr />
 297 <h1><a name="bugs">BUGS</a></h1>
 298 <p>Calls <strong>Test::Builder</strong>'s <code>no_ending</code> method turning off the ending
 299 tests.  This is needed as otherwise it will trip out because we've run
 300 more tests than we strictly should have and it'll register any
 301 failures we had that we were testing for as real failures.</p>
 302 <p>The color function doesn't work unless <strong>Term::ANSIColor</strong> is installed
 303 and is compatible with your terminal.</p>
 304 <p>Bugs (and requests for new features) can be reported to the author
 305 though the CPAN RT system:
 306 <a href="http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Builder-Tester">http://rt.cpan.org/NoAuth/ReportBug.html</a></p>
 307 <p>
 308 </p>
 309 <hr />
 310 <h1><a name="author">AUTHOR</a></h1>
 311 <p>Copyright Mark Fowler &lt;<a href="mailto:mark@twoshortplanks.com">mark@twoshortplanks.com</a>&gt; 2002, 2004.</p>
 312 <p>Some code taken from <strong>Test::More</strong> and <strong>Test::Catch</strong>, written by by
 313 Michael G Schwern &lt;<a href="mailto:schwern@pobox.com">schwern@pobox.com</a>&gt;.  Hence, those parts
 314 Copyright Micheal G Schwern 2001.  Used and distributed with
 315 permission.</p>
 316 <p>This program is free software; you can redistribute it
 317 and/or modify it under the same terms as Perl itself.</p>
 318 <p>
 319 </p>
 320 <hr />
 321 <h1><a name="notes">NOTES</a></h1>
 322 <p>This code has been tested explicitly on the following versions
 323 of perl: 5.7.3, 5.6.1, 5.6.0, 5.005_03, 5.004_05 and 5.004.</p>
 324 <p>Thanks to Richard Clamp &lt;<a href="mailto:richardc@unixbeard.net">richardc@unixbeard.net</a>&gt; for letting
 325 me use his testing system to try this module out on.</p>
 326 <p>
 327 </p>
 328 <hr />
 329 <h1><a name="see_also">SEE ALSO</a></h1>
 330 <p><a href="file://C|\msysgit\mingw\html/lib/Test/Builder.html">the Test::Builder manpage</a>, <a href="file://C|\msysgit\mingw\html/lib/Test/Builder/Tester/Color.html">the Test::Builder::Tester::Color manpage</a>, <a href="file://C|\msysgit\mingw\html/lib/Test/More.html">the Test::More manpage</a>.</p>
 331 <table border="0" width="100%" cellspacing="0" cellpadding="3">
 332 <tr><td class="block" style="background-color: #cccccc" valign="middle">
 333 <big><strong><span class="block">&nbsp;Test::Builder::Tester - test testsuites that have been built with
 334 Test::Builder</span></strong></big>
 335 </td></tr>
 336 </table>
 337
 338 </body>
 339
 340 </html>