repo_zf1/documentation/manual/en/module_specs/Zend_Test-PHPUnit-Testing.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect2 id="zend.test.phpunit.testing">
    <title>Testing your Controllers and MVC Applications</title>

    <para>
        Once you have your bootstrap in place, you can begin testing. Testing
        is basically as you would expect in an PHPUnit test suite, with a few
        minor differences.
    </para>

    <para>
        First, you will need to dispatch a <acronym>URL</acronym> to test, using the
        <methodname>dispatch()</methodname> method of the TestCase:
    </para>

    <programlisting language="php"><![CDATA[
class IndexControllerTest extends Zend_Test_PHPUnit_ControllerTestCase
{
    // ...

    public function testHomePage()
    {
        $this->dispatch('/');
        // ...
    }
}
]]></programlisting>

    <para>
        There will be times, however, that you need to provide extra
        information -- GET and POST variables, COOKIE information, etc. You can
        populate the request with that information:
    </para>

    <programlisting language="php"><![CDATA[
class FooControllerTest extends Zend_Test_PHPUnit_ControllerTestCase
{
    // ...

    public function testBarActionShouldReceiveAllParameters()
    {
        // Set GET variables:
        $this->request->setQuery(array(
            'foo' => 'bar',
            'bar' => 'baz',
        ));

        // Set POST variables:
        $this->request->setPost(array(
            'baz'  => 'bat',
            'lame' => 'bogus',
        ));

        // Set a cookie value:
        $this->request->setCookie('user', 'matthew');
        // or many:
        $this->request->setCookies(array(
            'timestamp' => time(),
            'host'      => 'foobar',
        ));

        // Set headers, even:
        $this->request->setHeader('X-Requested-With', 'XmlHttpRequest');

        // Set the request method:
        $this->request->setMethod('POST');

        // Dispatch:
        $this->dispatch('/foo/bar');

        // ...
    }
}
]]></programlisting>

    <para>
        Now that the request is made, it's time to start making assertions
        against it.
    </para>

    <sect3 id="zend.test.phpunit.testing.redirector">
        <title>Controller Tests and the Redirector Action Helper</title>

        <important>
            <para>
                The redirect action helper issues an <methodname>exit()</methodname> statement
                when using the method <methodname>gotoAndExit()</methodname>
                and will then obviously also stops a test running for this method.
                For testability of your application dont use that method on the
                redirector!
            </para>
        </important>

        <para>
            Due to its nature the redirector action helper plugin issues a redirect
            and exists after this. Because you cannot test parts of an application
            that issue exit calls <classname>Zend_Test_PHPUnit_ControllerTestCase</classname>
            automatically disables the exit part of the redirector which can cause
            different behaviours in tests and the real application. To make sure
            redirect work correctly you should it them in the following way:
        </para>

        <programlisting language="php"><![CDATA[
class MyController extends Zend_Controller_Action
{
    public function indexAction()
    {
        if($someCondition == true) {
            return $this->_redirect(...);
        } else if($anotherCondition == true) {
            $this->_redirector->gotoSimple("foo");
            return;
        }

        // do some stuff here
    }
}
]]></programlisting>

        <important>
            <para>
                Depending on your application this is not enough as additional action, <methodname>preDispatch()</methodname> or
                <methodname>postDispatch()</methodname> logic might be executed. This cannot be handled in a good way with
                Zend Test currently.
            </para>
        </important>
    </sect3>
</sect2>
<!--
vim:se ts=4 sw=4 et:
-->