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

Test Failed

Push — master ( 2fb631...eb50a0 )

by Jean-Bernard

created 2017-08-24 03:21 UTC

loadRoutes() A

↳ Parent: EngineAsArgumentInKernelControllerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
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.
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\ContainerControllerResolver;
use Symfony\Component\HttpKernel\EventListener\ResponseListener;
use Symfony\Component\HttpKernel\EventListener\RouterListener;
use Symfony\Component\HttpKernel\HttpKernel;
use Symfony\Component\Routing\Matcher\UrlMatcher;
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\EngineAsArgumentController;
use Tests\Component\AppKernel;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

/**
 * @covers \SymfonyUtil\Controller\EngineAsArgumentController
 */
final class EngineAsArgumentInKernelControllerTest 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('/', 'GET'))
        );
    }

    public function testControllerResponse()
    {
        $matcher = $this->createMock(Routing\Matcher\UrlMatcherInterface::class);
        // use getMock() on PHPUnit 5.3 or below
        // $matcher = $this->getMock(Routing\Matcher\UrlMatcherInterface::class);


        $matcher
            ->expects($this->once())
            ->method('match')
            ->will($this->returnValue(array(
                '_route' => 'foo',
                'name' => 'Fabien',
                '_controller' => function ($name) {
                    return new Response('Hello '.$name);
                }
            )))
        ;
        $matcher
            ->expects($this->once())
            ->method('getContext')
            ->will($this->returnValue($this->createMock(Routing\RequestContext::class)))
        ;
        $controllerResolver = new ControllerResolver();
        $argumentResolver = new ArgumentResolver();

        $framework = new Framework($matcher, $controllerResolver, $argumentResolver);

        $response = $framework->handle(new Request());

        $this->assertEquals(200, $response->getStatusCode());
        $this->assertContains('Hello Fabien', $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 ComponentReturnsResponse() // Not yet a test!
    {
        $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('/', EngineAsArgumentController::class, 'index'); // .'::__invoke'
        //^ It should be tested if the actually used controller resolver can resolve this!
        //^ Returns Symfony/Component/Routing/Route .
    }

    private function loadRoutes(LoaderInterface $loader = null)
    { // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
        $routes = new RouteCollectionBuilder($loader);
        $this->configureRoutes($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(EngineAsArgumentController::class)
            ->setAutoconfigured(true)
            ->addTag('controller.service_arguments')
            ->setPublic(false);

        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; // Do not know how to configure this.
15			use Symfony\Component\DependencyInjection\ContainerBuilder;
16			use Symfony\Component\EventDispatcher\EventDispatcher;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\HttpFoundation\RequestStack;
19			use Symfony\Component\HttpFoundation\Response;
20			use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
21			use Symfony\Component\HttpKernel\Controller\ContainerControllerResolver;
22			use Symfony\Component\HttpKernel\EventListener\ResponseListener;
23			use Symfony\Component\HttpKernel\EventListener\RouterListener;
24			use Symfony\Component\HttpKernel\HttpKernel;
25			use Symfony\Component\Routing\Matcher\UrlMatcher;
26			use Symfony\Component\Routing\RequestContext;
27			use Symfony\Component\Routing\RouteCollectionBuilder;
28			use Symfony\Component\Templating\EngineInterface;
29			use Symfony\Component\Templating\TemplateNameParser;
30			use Symfony\Component\Templating\TemplateNameParserInterface;
31			use SymfonyUtil\Controller\EngineAsArgumentController;
32			use Tests\Component\AppKernel;
			0 ignored issues – show Bug introduced 2017-08-23 16:51 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `AppKernel`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
33
34			/**
35			* @covers \SymfonyUtil\Controller\EngineAsArgumentController
36			*/
37			final class EngineAsArgumentInKernelControllerTest extends TestCase
			0 ignored issues – show Coding Style Compatibility introduced 2017-08-23 15:34 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
38			{
39			public function testCanBeCreated()
40			{
41			$this->assertInstanceOf(
42			// ...::class, // 5.4 < php
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-23 16:33 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
43			'Symfony\Component\HttpKernel\Kernel',
44			new AppKernel('dev', true)
45			);
46			}
47
48			public function testKernelInterface()
49			{
50			$this->assertInstanceOf(
51			// ...::class, // 5.4 < php
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-23 16:33 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
52			'Symfony\Component\HttpKernel\KernelInterface',
53			new AppKernel('dev', true)
54			);
55			}
56
57			public function testFrameworkReturnsResponse()
58			{
59			$this->assertInstanceOf(
60			// Response::class, // 5.4 < php
61			'Symfony\Component\HttpFoundation\Response',
62			(new AppKernel('dev', true))->handle(Request::create('/', 'GET'))
63			);
64			}
65
66			public function testControllerResponse()
67			{
68			$matcher = $this->createMock(Routing\Matcher\UrlMatcherInterface::class);
69			// use getMock() on PHPUnit 5.3 or below
70			// $matcher = $this->getMock(Routing\Matcher\UrlMatcherInterface::class);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-24 03:23 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
71
72			$matcher
73			->expects($this->once())
74			->method('match')
75			->will($this->returnValue(array(
76			'_route' => 'foo',
77			'name' => 'Fabien',
78			'_controller' => function ($name) {
79			return new Response('Hello '.$name);
80			}
81			)))
82			;
83			$matcher
84			->expects($this->once())
85			->method('getContext')
86			->will($this->returnValue($this->createMock(Routing\RequestContext::class)))
87			;
88			$controllerResolver = new ControllerResolver();
89			$argumentResolver = new ArgumentResolver();
90
91			$framework = new Framework($matcher, $controllerResolver, $argumentResolver);
92
93			$response = $framework->handle(new Request());
94
95			$this->assertEquals(200, $response->getStatusCode());
96			$this->assertContains('Hello Fabien', $response->getContent());
97			}
98
99			public function testContainerCanBeCreated()
100			{
101			$this->assertInstanceOf(
102			// ...::class, // 5.4 < php
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-24 02:11 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
103			'Symfony\Component\DependencyInjection\ContainerBuilder',
104			$this->container()
105			);
106			}
107
108			public function testContainerInterface()
109			{
110			$this->assertInstanceOf(
111			// ...::class, // 5.4 < php
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-24 02:11 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
112			'psr\Container\ContainerInterface',
113			$this->container()
114			);
115			}
116
117			public function ComponentReturnsResponse() // Not yet a test!
118			{
119			$requestStack = new RequestStack();
120			$dispatcher = new EventDispatcher();
121			$dispatcher->addSubscriber(new RouterListener(
122			new UrlMatcher(
123			$this->loadRoutes(),
124			new RequestContext()
125			),
126			$requestStack
127			));
128			$dispatcher->addSubscriber(new ResponseListener('UTF-8'));
129
130
131			$this->assertInstanceOf(
132			// Response::class, // 5.4 < php
133			'Symfony\Component\HttpFoundation\Response',
134			(new HttpKernel(
135			$dispatcher,
136			new ContainerControllerResolver($c),
			0 ignored issues – show Bug introduced 2017-08-24 03:23 UTC by Report Bug Copy Issue Report The variable `$c` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
137			$requestStack,
138			new ArgumentResolver()
139			))->handle(Request::create('/', 'GET'))
140			);
141			}
142
143			private function configureRoutes(RouteCollectionBuilder $routes)
144			{ // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
145			$routes->add('/', EngineAsArgumentController::class, 'index'); // .'::__invoke'
146			//^ It should be tested if the actually used controller resolver can resolve this!
147			//^ Returns Symfony/Component/Routing/Route .
148			}
149
150			private function loadRoutes(LoaderInterface $loader = null)
151			{ // from Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait
152			$routes = new RouteCollectionBuilder($loader);
153			$this->configureRoutes($routes);
154
155			return $routes->build();
156			}
157
158			private function container()
159			{
160			$c = new ContainerBuilder();
161			// https://symfony.com/doc/current/service_container.html
162
163			$c->autowire(TemplateNameParser::class)
164			->setAutoconfigured(true)
165			->setPublic(false);
166			$c->setAlias(TemplateNameParserInterface::class, TemplateNameParser::class);
167
168			$c->autowire(Twig_Loader_Array::class, Twig_Loader_Array::class)
169			->setArgument('$templates', ['index.html.twig' => 'Hello Component!'])
170			->setAutoconfigured(true)
171			->setPublic(false);
172			$c->setAlias(Twig_LoaderInterface::class, Twig_Loader_Array::class);
173
174			$c->autowire(Twig_Environment::class, Twig_Environment::class)
175			->setAutoconfigured(true)
176			->setPublic(false);
177			$c->setAlias(Twig\Environment::class, Twig_Environment::class);
178
179			$c->autowire(TwigEngine::class)
180			->setAutoconfigured(true)
181			->setPublic(false);
182			$c->setAlias(EngineInterface::class, TwigEngine::class);
183
184			// Unit Testing
185			// $c->autowire('test.client', Client::class)
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-23 20:13 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
186			// ->setPublic(true); // Public needed!
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-23 20:13 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
187
188			//Controllers
189			$c->autowire(EngineAsArgumentController::class)
190			->setAutoconfigured(true)
191			->addTag('controller.service_arguments')
192			->setPublic(false);
193
194			return $c;
195			}
196			}
197
198			// http://api.symfony.com/3.3/Symfony/Bridge/Twig/TwigEngine.html
199			// http://api.symfony.com/3.3/Symfony/Bundle/TwigBundle/TwigEngine.html
200

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

Push — master ( 2fb631...eb50a0 )

loadRoutes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like