horros / agavi2

src/testing/ViewTestCase.class.php

<?php
namespace Agavi\Testing;

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+
use Agavi\Dispatcher\ExecutionContainer;
use Agavi\Response\WebResponse;
use Agavi\Testing\PHPUnit\Constraint\ConstraintViewHandlesOutputType;
use Agavi\Util\Toolkit;
use Agavi\View\View;

/**
 * ViewTestCase is the base class for all view testcases and provides
 * the necessary assertions
 *
 *
 * @package    agavi
 * @subpackage testing
 *
 * @author     Felix Gilcher <felix.gilcher@bitextender.com>
 * @copyright  The Agavi Project
 *
 * @since      1.0.0
 *
 * @version    $Id$
 */
abstract class ViewTestCase extends FragmentTestCase
{
    /**
     * @var        string the (short) name of the view
     */
    protected $viewName;
    
    /**
     * @var        mixed the result of the view execution
     */
    protected $viewResult;
    
    /**
     *  creates the view instance for this testcase
     *
     * @return     View
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function createViewInstance()
    {
        $this->getContext()->getDispatcher()->initializeModule($this->moduleName);
        $viewName = $this->normalizeViewName($this->viewName);
        $viewInstance = $this->getContext()->getDispatcher()->createViewInstance($this->moduleName, $viewName);
        $viewInstance->initialize($this->container);
        return $viewInstance;
    }
    
    /**
     *  runs the view instance for this testcase
     *
     * @param      string $otName the name of the output type to run the view for
     *                    null for the default output type
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function runView($otName = null)
    {
        $this->container->setControllerInstance($this->createControllerInstance());

The method setControllerInstance() does not seem to exist on object<Agavi\Dispatcher\ExecutionContainer>.

        $this->container->setOutputType($this->getContext()->getDispatcher()->getOutputType($otName));
        $this->container->setViewInstance($this->createViewInstance());
        $executionFilter = $this->createExecutionFilter();
        $this->viewResult = $executionFilter->executeView($this->container);

The method executeView() cannot be called from this context as it is declared protected in class Agavi\Filter\ExecutionFilter.

    }
    
    /**
     * assert that the view handles the given output type
     *
     * @param      string  $method the output type name
     * @param      boolean $acceptGeneric true if the generic 'execute' method should be accepted as handled
     * @param      string  $message an optional message to display if the test fails
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertHandlesOutputType($method, $acceptGeneric = false, $message = '')

This method seems to be duplicated in your project.

    {
        $viewInstance = $this->createViewInstance();
        $constraint = new ConstraintViewHandlesOutputType($viewInstance, $acceptGeneric);
        
        self::assertThat($method, $constraint, $message);
    }
    
    /**
     * assert that the view does not handle the given output type
     *
     * @param      string  $method the output type name
     * @param      boolean $acceptGeneric true if the generic 'execute' method should be accepted as handled
     * @param      string  $message an optional message to display if the test fails
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertNotHandlesOutputType($method, $acceptGeneric = false, $message = '')

This method seems to be duplicated in your project.

    {
        $viewInstance = $this->createViewInstance();
        $constraint = self::logicalNot(new ConstraintViewHandlesOutputType($viewInstance, $acceptGeneric));
        
        self::assertThat($method, $constraint, $message);
    }
    
    /**
     * assert that the response contains a redirect
     *
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewRedirects($message = 'Failed asserting that the view redirects')

This method seems to be duplicated in your project.

    {
        $response = $this->container->getResponse();
        try {
            $this->assertTrue($response->hasRedirect(), $message);
        } catch (\Exception $e) {
            $this->fail($message);
        }
    }
    
    /**
     * assert that the response contains no redirect
     *
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewRedirectsNot($message = 'Failed asserting that the view does not redirect')

This method seems to be duplicated in your project.

    {
        $response = $this->container->getResponse();
        try {
            $this->assertFalse($response->hasRedirect(), $message);
        } catch (\Exception $e) {
            $this->fail($message);
        }
    }
    
    /**
     * assert that the response contains the expected redirect
     *
     * @param      mixed  $expected the expected redirect
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewRedirectsTo($expected, $message = 'Failed asserting that the view redirects to the given target.')
    {
        $response = $this->container->getResponse();
        try {
            $this->assertEquals($expected, $response->getRedirect(), $message);
        } catch (\Exception $e) {
            $this->fail($message);
        }
    }
    
    /**
     * Assert that the view sets the given content type.
     *
     * this assertion only works on WebResponse or subclasses
     *
     * @param      string $expected the expected content type
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewSetsContentType($expected, $message = 'Failed asserting that the view sets the content type "%1$s".')

This method seems to be duplicated in your project.

    {
        $response = $this->container->getResponse();
        
        if (!($response instanceof WebResponse)) {
            $this->fail(sprintf($message . ' (response is not an WebResponse)', $expected));
        }
        $this->assertEquals($expected, $response->getContentType(), sprintf($message, $expected));

The method getContentType() does not exist on Agavi\Response\Response. Did you maybe mean getContent()?

    }
    
    /**
     * Assert that the view sets the given header with the given value.
     *
     * this response only works on WebResponse and subclasses
     *
     * @param      string $expected the name of the expected header
     * @param      string $expectedValue the value of the expected header
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewSetsHeader($expected, $expectedValue = null, $message = 'Failed asserting that the view sets a header named <%1$s> with the value <%2$s>')

This method seems to be duplicated in your project.

    {
        $response = $this->container->getResponse();
        
        if (!($response instanceof WebResponse)) {
            $this->fail(sprintf($message . ' (response is not an WebResponse)', $expected));
        }
        $this->assertEquals($expectedValue, $response->getHttpHeader($expected), sprintf($message, $expected, $expectedValue));
    }
    
    /**
     * Assert that the view sets the given cookie with the given value.<y></y>
     *
     * this response only works on WebResponse and subclasses
     *
     * @param      string $expected the name of the expected cookie
     * @param      string $expectedValue the value of the expected header
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewSetsCookie($expected, $expectedValue = null, $message = 'Failed asserting that the view sets a cookie named <%1$s> with a value of <%2$s>')
    {
        $response = $this->container->getResponse();
        
        if (!($response instanceof WebResponse)) {
            $this->fail(sprintf($message . ' (response is not an WebResponse)', $expected, var_export($expectedValue, true)));
        }
        $this->assertEquals($expectedValue, $response->getCookie($expected), sprintf($message, $expected, var_export($expectedValue, true)));
    }
    
    /**
     * assert that the response has the given http status
     *
     * this assertion only works on WebResponse or subclasses
     *
     * @param      string $expected the expected http status
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewResponseHasHTTPStatus($expected, $message = 'Failed asserting that the response status is %1$s.')

This method seems to be duplicated in your project.

    {
        $response = $this->container->getResponse();
        
        if (!($response instanceof WebResponse)) {
            $this->fail(sprintf($message . ' (response is not an WebResponse)', $expected));
        }
        $this->assertEquals($expected, $response->getHttpStatusCode(), sprintf($message, $expected));
    }
    
    /**
     * assert that the response has the given content
     *
     * @param      mixed $expected the expected content
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewResponseHasContent($expected, $message = 'Failed asserting that the response has content <%1$s>.')
    {
        $response = $this->container->getResponse();
        $this->assertEquals($expected, $response->getContent(), sprintf($message, $expected));
    }
    
    /**
     * assert that the view result has the given content
     *
     * @param      mixed $expected the expected content
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewResultEquals($expected, $message = 'Failed asserting the expected view result.')
    {
        $this->assertEquals($expected, $this->viewResult, sprintf($message, $expected));
    }
    
    /**
     * assert that the view forwards to the given module/controller
     *
     * @param      string $expectedModule the expected module name
     * @param      string $expectedController the expected controller name
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertViewForwards($expectedModule, $expectedController, $message = 'Failed asserting that the view forwards to "%1$s" "%2$s".')
    {
        if (!($this->viewResult instanceof ExecutionContainer)) {
            $this->fail(sprintf($message, $expectedModule, $expectedController));
        }
        $this->assertEquals($expectedModule, $this->viewResult->getModuleName());
        $this->assertEquals(Toolkit::canonicalName($expectedController), $this->viewResult->getControllerName());
    }
    
    /**
     * assert that the view has the  given layer
     *
     * @param      string $expectedLayer the expected layer name
     * @param      string $message the message to emit on failure
     *
     * @author     Felix Gilcher <felix.gilcher@bitextender.com>
     * @since      1.0.0
     */
    protected function assertHasLayer($expectedLayer, $message = 'Failed asserting that the view contains the layer "%1$s".')

This method seems to be duplicated in your project.

    {
        $viewInstance = $this->container->getViewInstance();
        $layer = $viewInstance->getLayer($expectedLayer);
        
        if (null === $layer) {
            $this->fail(sprintf($message, $expectedLayer));
        }
    }
    
    /**
     * assert that the view has the  given layer
     *
     * @param      string $expectedLayer the expected layer name
     * @param      string $message the message to emit on failure
     *
     * @author     David Zülke <david.zuelke@bitextender.com>
     * @since      1.0.6
     */
    protected function assertNotHasLayer($expectedLayer, $message = '')

The parameter $message is not used and could be removed.

This method seems to be duplicated in your project.

    {
        $viewInstance = $this->container->getViewInstance();
        $layer = $viewInstance->getLayer($expectedLayer);
        
        if (null !== $layer) {
            $this->fail('Failed asserting that the view does not contain the layer.');
        }
    }
}