diff options
Diffstat (limited to 'org/perl8/test/Test.html')
| -rw-r--r-- | org/perl8/test/Test.html | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/org/perl8/test/Test.html b/org/perl8/test/Test.html index eeaec84..36482bd 100644 --- a/org/perl8/test/Test.html +++ b/org/perl8/test/Test.html @@ -44,7 +44,9 @@ </span> </h4> - <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Base trait for test classes in this framework + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Base trait for test classes in this framework. Any tests that should be +autodiscovered by <code>sbt test</code> should extend this trait, and implement +<a href="#runTests(terminalInUse:Boolean):Int" class="extmbr" name="org.perl8.test.Test#runTests">runTests</a>. </p></div><div class="toggleContainer block"> <span class="toggle">Linear Supertypes</span> <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> @@ -338,8 +340,13 @@ </h4> <p class="shortcomment cmt">Runs the test.</p><div class="fullcomment"><div class="comment cmt"><p>Runs the test. The TAP stream will be written to Console.out and Console.err, so you can swap these out as required in order to parse it. -</p></div></div> - </li><li name="org.perl8.test.Test#runInHarness" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> +</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>The exit code that the test produced. Success is indicated by 0, + failure to run the correct number of tests by 255, and any other + failure by the number of tests that failed. This should be used + by reporters which run a single test, which can call + <code>sys.exit(exitCode)</code> +</p></dd></dl></div> + </li><li name="org.perl8.test.Test#runInHarness" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="runInHarness:Int"></a> <a id="runInHarness:Int"></a> <h4 class="signature"> @@ -351,7 +358,14 @@ Console.err, so you can swap these out as required in order to parse it. <span class="name">runInHarness</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> </span> </h4> - + <p class="shortcomment cmt">Runs the test just like <a href="#run:Int" class="extmbr" name="org.perl8.test.Test#run">run</a>, but in a way that makes sense when test + results are being summarized rather than directly displayed.</p><div class="fullcomment"><div class="comment cmt"><p>Runs the test just like <a href="#run:Int" class="extmbr" name="org.perl8.test.Test#run">run</a>, but in a way that makes sense when test + results are being summarized rather than directly displayed.</p><p> Summarizing test reporters tend to repeatedly update the same line on + the terminal, so this method makes calls to + <a href="tap/TestBuilder.html#diag(message:String):Unit" class="extmbr" name="org.perl8.test.tap.TestBuilder#diag">diag</a> (which sends messages to + stderr, where they are typically displayed as-is) prefix the message + with a newline, to ensure that the output starts on its own line. +</p></div></div> </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> <a id="synchronized[T0](x$1:=>T0):T0"></a> <a id="synchronized[T0](⇒T0):T0"></a> |