EngineInConstructorInKernelControllerTest::configureRoutes() - Code Metrics - Inspection of "Update EngineInConstructorInKernelControllerTest.p..." - symfony-util/controller-using-templating-http-foundation-http-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d3799...60d264 )

by Jean-Bernard

created 2017-08-25 13:23 UTC

configureRoutes() A

↳ Parent: EngineInConstructorInKernelControllerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

/*
 * This file is part of the Symfony-Util package.
 *
 * (c) Jean-Bernard Addor
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

use PHPUnit\Framework\TestCase;
use Symfony\Bridge\Twig\TwigEngine;
// use Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver;
//^ Do not know how to configure this.
// * In a constructor of a kernel derivative
// * Using the DI container and looking example config
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver;
use Symfony\Component\HttpKernel\Controller\ContainerControllerResolver;
use Symfony\Component\HttpKernel\Controller\ControllerResolver;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
use Symfony\Component\HttpKernel\DependencyInjection\ControllerArgumentValueResolverPass;
use Symfony\Component\HttpKernel\DependencyInjection\RegisterControllerArgumentLocatorsPass;
use Symfony\Component\HttpKernel\EventListener\ResponseListener;
use Symfony\Component\HttpKernel\EventListener\RouterListener;
use Symfony\Component\HttpKernel\HttpKernel;
use Symfony\Component\Routing\Matcher\UrlMatcher; // != Symfony\Bundle\FrameworkBundle\Routing\Router
use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\RouteCollectionBuilder;
use Symfony\Component\Templating\EngineInterface;
use Symfony\Component\Templating\TemplateNameParser;
use Symfony\Component\Templating\TemplateNameParserInterface;
use SymfonyUtil\Controller\EngineInConstructorController;
use Tests\Component\AppKernel;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

// use Tests\Component\EngineAsArgumentFrameworkController;

final class EngineInConstructorInKernelControllerTest extends TestCase
namespace YourVendor;

class YourClass { }
{
    public function testCanBeCreated()
    {
        $this->assertInstanceOf(
            // ...::class, // 5.4 < php

            'Symfony\Component\HttpKernel\Kernel',
            new AppKernel('dev', true)
        );
    }

    public function testKernelInterface()
    {
        $this->assertInstanceOf(
            // ...::class, // 5.4 < php

            'Symfony\Component\HttpKernel\KernelInterface',
            new AppKernel('dev', true)
        );
    }

    public function testFrameworkReturnsResponse()
    {
        $this->assertInstanceOf(
            // Response::class, // 5.4 < php
            'Symfony\Component\HttpFoundation\Response',
            (new AppKernel('dev', true))->handle(Request::create('/constructor', 'GET'))
        );
    }

    public function testControllerResponse()
    { // From: https://symfony.com/doc/current/create_framework/unit_testing.html
        // TODO: Try with a real matcher see next test...
        // TODO: Use real controller to be tested! OK
        $matcher = $this->createMock(UrlMatcherInterface::class); // What about another test with RequestMatcherInterface?
        // use getMock() on PHPUnit 5.3 or below
        // $matcher = $this->getMock(UrlMatcherInterface::class);


        $matcher
            ->expects($this->once())
            ->method('match')
            ->will($this->returnValue([
                '_route' => 'foo',
                'name' => 'Fabien',
                // '_controller' => function ($name) {

                //     return new Response('Hello '.$name);

                // },
                '_controller' => EngineInConstructorController::class,
            ]))
        ;
        $matcher
            ->expects($this->once())
            ->method('getContext')
            ->will($this->returnValue($this->createMock(RequestContext::class)))
        ;

        $c = $this->container();
        $c->compile();
        $requestStack = new RequestStack();
        $dispatcher = new EventDispatcher();
        $dispatcher->addSubscriber(new RouterListener(
            $matcher,
            $requestStack
        )); // Returns nothing.
        $dispatcher->addSubscriber(new ResponseListener('UTF-8'));
        $response = (new HttpKernel(
            $dispatcher,
            new ContainerControllerResolver($c),
            // new ControllerResolver(),

            $requestStack,
            new ArgumentResolver(
                // new ArgumentMetadataFactory(),

                // [
                //     new RequestAttributeValueResolver(),

                //     new RequestValueResolver(),

                //     new SessionValueResolver(),

                //     new ServiceValueResolver($c),

                //     new DefaultValueResolver(),

                //     new VariadicValueResolver(),

                // ]
            )
        // ))->handle(Request::create('/', 'GET'));

        ))->handle(new Request());

        $this->assertSame(200, $response->getStatusCode());
        $this->assertContains('Hello Component!', $response->getContent());
    }

    public function testContainerCanBeCreated()
    {
        $this->assertInstanceOf(
            // ...::class, // 5.4 < php

            'Symfony\Component\DependencyInjection\ContainerBuilder',
            $this->container()
        );
    }

    public function testContainerInterface()
    {
        $this->assertInstanceOf(
            // ...::class, // 5.4 < php

            'psr\Container\ContainerInterface',
            $this->container()
        );
    }

    public function testComponentReturnsResponse()
    {
        $c = $this->container();
        $c->compile();
        $requestStack = new RequestStack();
        $dispatcher = new EventDispatcher();
        $dispatcher->addSubscriber(new RouterListener(
            new UrlMatcher(
                $this->loadRoutes(),
                new RequestContext()
            ),
            $requestStack
        ));
        $dispatcher->addSubscriber(new ResponseListener('UTF-8'));

        $this->assertInstanceOf(
            // Response::class, // 5.4 < php
            'Symfony\Component\HttpFoundation\Response',
            (new HttpKernel(
                $dispatcher,
                new ContainerControllerResolver($c),
                $requestStack,
                new ArgumentResolver()
            ))->handle(Request::create('/', 'GET'))
        );
    }

    private function configureRoutes(RouteCollectionBuilder $routes)
    { // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
        $routes->add('/', EngineInConstructorController::class, 'index');
    }

    private function loadRoutes(LoaderInterface $loader = null)
    { // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
        $routes = new RouteCollectionBuilder($loader);
        $this->configureRoutes($routes);

        return $routes->build();
    }

    private function configureJustHelloRoutes(RouteCollectionBuilder $routes)
    { // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
        $routes->add(
            '/',
            function () {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return new Response('Hello');
            },
            'index'
        );
        //^ It should be tested if the actually used controller resolver can resolve this!
        //^ Returns Symfony/Component/Routing/Route .
    }

    private function loadJustHelloRoutes(LoaderInterface $loader = null)

    { // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
        $routes = new RouteCollectionBuilder($loader);
        $this->configureJustHelloRoutes($routes);

        return $routes->build();
    }

    private function container()
    {
        $c = new ContainerBuilder();
        // https://symfony.com/doc/current/service_container.html

        $c->autowire(TemplateNameParser::class)
            ->setAutoconfigured(true)
            ->setPublic(false);
        $c->setAlias(TemplateNameParserInterface::class, TemplateNameParser::class);

        $c->autowire(Twig_Loader_Array::class, Twig_Loader_Array::class)
            ->setArgument('$templates', ['index.html.twig' => 'Hello Component!'])
            ->setAutoconfigured(true)
            ->setPublic(false);
        $c->setAlias(Twig_LoaderInterface::class, Twig_Loader_Array::class);

        $c->autowire(Twig_Environment::class, Twig_Environment::class)
            ->setAutoconfigured(true)
            ->setPublic(false);
        $c->setAlias(Twig\Environment::class, Twig_Environment::class);

        $c->autowire(TwigEngine::class)
            ->setAutoconfigured(true)
            ->setPublic(false);
        $c->setAlias(EngineInterface::class, TwigEngine::class);

        // Unit Testing
        // $c->autowire('test.client', Client::class)

        //     ->setPublic(true); // Public needed!


        //Controllers
        $c->autowire(EngineInConstructorController::class)
            ->setAutoconfigured(true)
            ->addTag('controller.service_arguments')
            ->setPublic(true);

        return $c;
    }
}

// http://api.symfony.com/3.3/Symfony/Bridge/Twig/TwigEngine.html
// http://api.symfony.com/3.3/Symfony/Bundle/TwigBundle/TwigEngine.html


1			<?php
2
3			/*
4			* This file is part of the Symfony-Util package.
5			*
6			* (c) Jean-Bernard Addor
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			use PHPUnit\Framework\TestCase;
13			use Symfony\Bridge\Twig\TwigEngine;
14			// use Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver;
15			//^ Do not know how to configure this.
16			// * In a constructor of a kernel derivative
17			// * Using the DI container and looking example config
18			use Symfony\Component\DependencyInjection\ContainerBuilder;
19			use Symfony\Component\EventDispatcher\EventDispatcher;
20			use Symfony\Component\HttpFoundation\Request;
21			use Symfony\Component\HttpFoundation\RequestStack;
22			use Symfony\Component\HttpFoundation\Response;
23			use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
24			use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
25			use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
26			use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
27			use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver;
28			use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver;
29			use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver;
30			use Symfony\Component\HttpKernel\Controller\ContainerControllerResolver;
31			use Symfony\Component\HttpKernel\Controller\ControllerResolver;
32			use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
33			use Symfony\Component\HttpKernel\DependencyInjection\ControllerArgumentValueResolverPass;
34			use Symfony\Component\HttpKernel\DependencyInjection\RegisterControllerArgumentLocatorsPass;
35			use Symfony\Component\HttpKernel\EventListener\ResponseListener;
36			use Symfony\Component\HttpKernel\EventListener\RouterListener;
37			use Symfony\Component\HttpKernel\HttpKernel;
38			use Symfony\Component\Routing\Matcher\UrlMatcher; // != Symfony\Bundle\FrameworkBundle\Routing\Router
39			use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
40			use Symfony\Component\Routing\RequestContext;

symfony-util / controller-using-templating-http-foundation-http-kernel

Push — master ( 6d3799...60d264 )

configureRoutes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like