reporter_documentation.html.svn-base
来自「PHP 知识管理系统（基于树结构的知识管理系统）, 英文原版的PHP源码。」· SVN-BASE 代码 · 共 520 行 · 第 1/2 页
SVN-BASE
520 行
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>SimpleTest for PHP test runner and display documentation</title><link rel="stylesheet" type="text/css" href="docs.css" title="Styles"></head><body><div class="menu_back"><div class="menu"><a href="index.html">SimpleTest</a> | <a href="overview.html">Overview</a> | <a href="unit_test_documentation.html">Unit tester</a> | <a href="group_test_documentation.html">Group tests</a> | <a href="mock_objects_documentation.html">Mock objects</a> | <a href="partial_mocks_documentation.html">Partial mocks</a> | <span class="chosen">Reporting</span> | <a href="expectation_documentation.html">Expectations</a> | <a href="web_tester_documentation.html">Web tester</a> | <a href="form_testing_documentation.html">Testing forms</a> | <a href="authentication_documentation.html">Authentication</a> | <a href="browser_documentation.html">Scriptable browser</a></div></div><h1>Test reporter documentation</h1> This page... <ul><li> Displaying <a href="#html">results in HTML</a> </li><li> Displaying and <a href="#other">reporting results</a> in other formats </li><li> Using <a href="#cli">SimpleTest from the command line</a> </li><li> Using <a href="#xml">Using XML</a> for remote testing </li></ul><div class="content"> <p> SimpleTest pretty much follows the MVC pattern (Model-View-Controller). The reporter classes are the view and the model is your test cases and their hiearchy. The controller is mostly hidden from the user of SimpleTest unless you want to change how the test cases are actually run, in which case it is possible to override the runner objects from within the test case. As usual with MVC, the controller is mostly undefined and there are other places to control the test run. </p> <p><a class="target" name="html"><h2>Reporting results in HTML</h2></a></p> <p> The default test display is minimal in the extreme. It reports success and failure with the conventional red and green bars and shows a breadcrumb trail of test groups for every failed assertion. Here's a fail... <div class="demo"> <h1>File test</h1> <span class="fail">Fail</span>: createnewfile->True assertion failed.<br> <div style="padding: 8px; margin-top: 1em; background-color: red; color: white;">1/1 test cases complete. <strong>0</strong> passes, <strong>1</strong> fails and <strong>0</strong> exceptions.</div> </div> And here all tests passed... <div class="demo"> <h1>File test</h1> <div style="padding: 8px; margin-top: 1em; background-color: green; color: white;">1/1 test cases complete. <strong>1</strong> passes, <strong>0</strong> fails and <strong>0</strong> exceptions.</div> </div> The good news is that there are several points in the display hiearchy for subclassing. </p> <p> For web page based displays there is the <span class="new_code">HtmlReporter</span> class with the following signature...<pre>class HtmlReporter extends SimpleReporter { public HtmlReporter($encoding) { ... } public makeDry(boolean $is_dry) { ... } public void paintHeader(string $test_name) { ... } public void sendNoCacheHeaders() { ... } public void paintFooter(string $test_name) { ... } public void paintGroupStart(string $test_name, integer $size) { ... } public void paintGroupEnd(string $test_name) { ... } public void paintCaseStart(string $test_name) { ... } public void paintCaseEnd(string $test_name) { ... } public void paintMethodStart(string $test_name) { ... } public void paintMethodEnd(string $test_name) { ... } public void paintFail(string $message) { ... } public void paintPass(string $message) { ... } public void paintError(string $message) { ... } public void paintException(string $message) { ... } public void paintMessage(string $message) { ... } public void paintFormattedMessage(string $message) { ... } protected string _getCss() { ... } public array getTestList() { ... } public integer getPassCount() { ... } public integer getFailCount() { ... } public integer getExceptionCount() { ... } public integer getTestCaseCount() { ... } public integer getTestCaseProgress() { ... }}</pre> Here is what some of these methods mean. First the display methods that you will probably want to override... <ul class="api"> <li> <span class="new_code">HtmlReporter(string $encoding)</span><br> is the constructor. Note that the unit test sets up the link to the display rather than the other way around. The display is a mostly passive receiver of test events. This allows easy adaption of the display for other test systems beside unit tests, such as monitoring servers. The encoding is the character encoding you wish to display the test output in. In order to correctly render debug output when using the web tester, this should match the encoding of the site you are trying to test. The available character set strings are described in the PHP <a href="http://www.php.net/manual/en/function.htmlentities.php">html_entities()</a> function. </li> <li> <span class="new_code">void paintHeader(string $test_name)</span><br> is called once at the very start of the test when the first start event arrives. The first start event is usually delivered by the top level group test and so this is where <span class="new_code">$test_name</span> comes from. It paints the page titles, CSS, body tag, etc. It returns nothing (<span class="new_code">void</span>). </li> <li> <span class="new_code">void paintFooter(string $test_name)</span><br> Called at the very end of the test to close any tags opened by the page header. By default it also displays the red/green bar and the final count of results. Actually the end of the test happens when a test end event comes in with the same name as the one that started it all at the same level. The tests nest you see. Closing the last test finishes the display. </li> <li> <span class="new_code">void paintMethodStart(string $test_name)</span><br> is called at the start of each test method. The name normally comes from method name. The other test start events behave the same way except that the group test one tells the reporter how large it is in number of held test cases. This is so that the reporter can display a progress bar as the runner churns through the test cases. </li> <li> <span class="new_code">void paintMethodEnd(string $test_name)</span><br> backs out of the test started with the same name. </li> <li> <span class="new_code">void paintFail(string $message)</span><br> paints a failure. By default it just displays the word fail, a breadcrumbs trail showing the current test nesting and the message issued by the assertion. </li> <li> <span class="new_code">void paintPass(string $message)</span><br> by default does nothing. </li> <li> <span class="new_code">string _getCss()</span><br> Returns the CSS styles as a string for the page header method. Additional styles have to be appended here if you are not overriding the page header. You will want to use this method in an overriden page header if you want to include the original CSS. </li> </ul> There are also some accessors to get information on the current state of the test suite. Use these to enrich the display... <ul class="api"> <li> <span class="new_code">array getTestList()</span><br> is the first convenience method for subclasses. Lists the current nesting of the tests as a list of test names. The first, most deeply nested test, is first in the list and the current test method will be last. </li> <li> <span class="new_code">integer getPassCount()</span><br> returns the number of passes chalked up so far. Needed for the display at the end. </li> <li> <span class="new_code">integer getFailCount()</span><br> is likewise the number of fails so far. </li> <li> <span class="new_code">integer getExceptionCount()</span><br> is likewise the number of errors so far. </li> <li> <span class="new_code">integer getTestCaseCount()</span><br> is the total number of test cases in the test run. This includes the grouping tests themselves. </li> <li> <span class="new_code">integer getTestCaseProgress()</span><br> is the number of test cases completed so far. </li> </ul> One simple modification is to get the HtmlReporter to display the passes as well as the failures and errors...<pre><strong>class ShowPasses extends HtmlReporter { function paintPass($message) { parent::paintPass($message); print "&<span class=\"pass\">Pass</span>: "; $breadcrumb = $this->getTestList(); array_shift($breadcrumb); print implode("-&gt;", $breadcrumb); print "-&gt;$message<br />\n"; } function _getCss() { return parent::_getCss() . ' .pass { color: green; }'; }}</strong></pre> </p> <p> One method that was glossed over was the <span class="new_code">makeDry()</span> method. If you run this method, with no parameters, on the reporter before the test suite is run no actual test methods will be called. You will still get the events of entering and leaving the test methods and test cases, but no passes or failures etc, because the test code will not actually be executed. </p>⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?