SimpleTest ships with the simplest possible interface by default.
Mostly you just want to know if your test passed, or your test failed.
If it failed, you want the reason.
Nothing more.
Sometimes you want a more sophisticated output for stakeholders
and for acceptance testing.
If a minimal display is not enough, here
is how to roll your own.
Do you really need to see the passes?
Oh all right then, here's how.
We have to subclass the attached display, which in our case
is currently HtmlReporter.
The HtmlReporter class is in
the file simpletest/reporter.php and currently has
the following interface...
Here is what the relevant methods mean.
You can see the
whole list here
if you are interested.
-
__construct()
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 passive receiver of test events.
This allows easy adaption of the display for other test
systems beside unit tests, such as monitoring servers.
It also means that the unit test can write to more than
one display at a time.
-
void paintFail(string $message)
paints a failure.
See below.
-
void paintPass(string $message)
by default does nothing.
This is the method we will modify.
-
string getCss()
returns the CSS styles as a string for the page header
method.
Additional styles have to be appended here.
-
array getTestList()
is a 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.
To show the passes we just need the
paintPass() method to behave
just like paintFail().
Of course we won't modify the original, we'll subclass.
Firstly we'll create a tests/show_passes.php file
in our logging project and then place in it this empty class...
]]>
A quick peruse of the
SimpleTest code base
shows the paintFail() implementation
at the time of writing to look like this...
Fail: ";
$breadcrumb = $this->getTestList();
array_shift($breadcrumb);
print implode("->", $breadcrumb);
print "->$message
\n";
}
]]>
Essentially it chains to the parent's version, which we
have to do also to preserve house keeping, and then
prints a breadcrumbs trail calculated from the current test
list.
It drops the top level tests name, though.
As it is the same on every test that would be a little bit too
much information.
Transposing this to our new class...
function paintPass($message) {
parent::paintPass($message);
print "Pass: ";
$breadcrumb = $this->getTestList();
array_shift($breadcrumb);
print implode("->", $breadcrumb);
print "->$message
\n";
}
}
]]>
So far so good.
Now to make use of our new class we have to modify our
tests/all_tests.php file.
require_once('show_passes.php');
require_once('simpletest/simpletest.php');
SimpleTest::prefer(new ShowPasses());
require_once('simpletest/autorun.php');
class AllTests extends TestSuite {
function __construct() {
parent::__construct('All tests');
$this->addFile(dirname(__FILE__).'/log_test.php');
$this->addFile(dirname(__FILE__).'/clock_test.php');
}
}
?>
]]>
We can run this to see the results of our handywork...
All tests
Pass: log_test.php->Log class test->testappendingtofile->Expecting [/Test line 1/] in [Test line 1]
Pass: log_test.php->Log class test->testappendingtofile->Expecting [/Test line 2/] in [Test line 2]
Pass: log_test.php->Log class test->testcreatingnewfile->Created before message
Pass: log_test.php->Log class test->testcreatingnewfile->File created
Pass: clock_test.php->Clock class test->testclockadvance->Advancement
Pass: clock_test.php->Clock class test->testclocktellstime->Now is the right time
3/3 test cases complete.
6 passes and 0 fails.
Nice, but no gold star.
We have lost a little formatting here.
The display does not have a CSS style for
span.pass, but we can add this
easily by overriding one more method...
Pass: ";
$breadcrumb = $this->getTestList();
array_shift($breadcrumb);
print implode("->", $breadcrumb);
print "->$message
\n";
}
protected function getCss() {
return parent::getCss() . ' .pass { color: green; }';
}
}
]]>
If you are adding the code as you go, you will see the style
appended when you do view source on the test results page in your browser.
To the eye the display itself should now look like this...
All tests
Pass: log_test.php->Log class test->testappendingtofile->Expecting [/Test line 1/] in [Test line 1]
Pass: log_test.php->Log class test->testappendingtofile->Expecting [/Test line 2/] in [Test line 2]
Pass: log_test.php->Log class test->testcreatingnewfile->Created before message
Pass: log_test.php->Log class test->testcreatingnewfile->File created
Pass: clock_test.php->Clock class test->testclockadvance->Advancement
Pass: clock_test.php->Clock class test->testclocktellstime->Now is the right time
3/3 test cases complete.
6 passes and 0 fails.
Some people definitely prefer to see the passes being added
as they are working on code; the feeling that you are getting
work done is nice after all.
Once you have to scroll up and down the page to find failures
though, you soon come to realise its dark side.
Try it both ways and see which you prefer.
We'll leave it in for a bit anyhow when looking at the
mock objects coming up.
This is the first test tool that generates additional tests
and it will be useful to see what is happening behind the scenes.