<h1>Introduction</h1>
<p>There are times where you will want behavior beyond a basic assertion, or you expect an error to occur because of bad data passed in. SnapTest can account for these things using special test conditions.</p>
<p><strong>Note:</strong> These are the only three “Assertions” that are not required to have a return statement. This is because their occurrence will naturally interrupt the running test and therefore won’t have time to reach a return statement.</p>
<h1>Using $this→willThrow($class_name)</h1>
<p><code>$this->willThrow($class_name)</code> specifically can handle the unhandled exception that may be encountered. This is simply a shorthand way of writing the following test:</p>
<pre><code>
// willThrow method
public function testMethod() {
$this->willThrow('Foo_Exception');
$test_obj->brokenMethod(); // throws a foo
}
// traditional method
public function testMethod() {
try {
$test_obj->brokenMethod(); // throws a foo
}
catch (Foo_Exception $e) {
return $this->assertIsA($e, 'Foo_Exception');
}
catch (Exception $e) {
return $this->assertIsA($e, 'Foo_Exception');
}
return $this->assertIsA(false, 'Foo_Exception'); // no good descriptor for this part
}
</code></pre>
<h1>Using $this→willError()</h1>
<p>Similar to the willThrow call, using <code>$this->willError()</code> indicates to the test class that the currently running test will cause a <span class="caps">PHP</span> error. Any errors encountered during the running of the test are swallowed.</p>
<p><strong>Note:</strong> <span class="caps">PHP</span> Errors are not always failures. However, in the default report format (text), you will be notified if any warnings or errors were encountered in your script.</p>
<pre><code>
public function testMethod() {
$this->willError();
$this->methodDoesArrayOpsWithoutChecking(null);
}
</code></pre>
<h1>Using $this→todo()</h1>
<p>The last of the special assertions indicates a test that is not complete. This will end the running testMethod and throw a failure. This is very useful for marking untested functionality that is needed, or flagging a method that does not have all its tests written.</p>
<pre><code>
public function testMethod() {
$this->todo();
}
</code></pre>
<p>An optional message can be passed into todo() which will be displayed in the output.</p>
<h1>Using $this→skip()</h1>
<p>If the criteria aren’t met, then it’s possible to skip over a test that cannot be run, as opposed to throwing an error. For example, a MySQL test on an Oracle system would probably fail, so it’s safe to skip that test as opposed to failing it. Skipped tests are counted as neither passes nor fails.</p>
<pre><code>
public function testMethod() {
$this->skip();
}
</code></pre>
<p>An optional message can be passed into skip() which will be displayed in the output. Additionally, putting <code>$this->skip()</code> in your setup() method makes it possible to skip all tests in a given class.</p>
2009-11-26T18:51:00-08:00
266967
special-assertions
1880
Special Assertions
2009-07-15T09:51:25-07:00
1795