DefaultRouterTest::getExpectedRequestContext() - Code Metrics - Inspection of "EZEE-2145: [Router] Fixed generating Req. Context..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 29f099...87ed20 )

by Łukasz

created 2018-06-28 11:02 UTC

DefaultRouterTest::getExpectedRequestContext() B

↳ Parent: DefaultRouterTest

Complexity

Conditions	7
Paths	8

Size

Total Lines

Duplication

Lines	9
Ratio	47.37 %

Importance

Changes

Metric	Value
cc	7
nc	8
nop	1
dl	9
loc	19
rs	8.8333
c	0
b	0
f	0

<?php

/**
 * File containing the DefaultRouterTest class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Bundle\EzPublishCoreBundle\Tests\Routing;

use eZ\Bundle\EzPublishCoreBundle\Routing\DefaultRouter;
use eZ\Bundle\EzPublishCoreBundle\SiteAccess\Matcher;
use eZ\Publish\Core\MVC\ConfigResolverInterface;
use eZ\Publish\Core\MVC\Symfony\Routing\SimplifiedRequest;
use eZ\Publish\Core\MVC\Symfony\SiteAccess;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\RequestContext;
use ReflectionObject;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use PHPUnit\Framework\TestCase;

class DefaultRouterTest extends TestCase
{
    /**
     * @var \PHPUnit\Framework\MockObject\MockObject|\Symfony\Component\DependencyInjection\ContainerInterface
     */
    protected $container;

    /**
     * @var \PHPUnit\Framework\MockObject\MockObject|\eZ\Publish\Core\MVC\ConfigResolverInterface
     */
    protected $configResolver;

    /**
     * @var \Symfony\Component\Routing\RequestContext
     */
    protected $requestContext;

    protected function setUp()
    {
        parent::setUp();
        $this->container = $this->createMock(ContainerInterface::class);
        $this->configResolver = $this->createMock(ConfigResolverInterface::class);
        $this->requestContext = new RequestContext();
    }

    protected function getRouterClass()
    {
        return DefaultRouter::class;
    }

    /**
     * @param array $mockedMethods
     *
     * @return \PHPUnit\Framework\MockObject\MockObject|DefaultRouter
     */
    protected function generateRouter(array $mockedMethods = array())
    {
        /** @var \PHPUnit\Framework\MockObject\MockObject|DefaultRouter $router */
        $router = $this
            ->getMockBuilder($this->getRouterClass())
            ->setConstructorArgs(array($this->container, 'foo', array(), $this->requestContext))
            ->setMethods(array_merge($mockedMethods))
            ->getMock();
        $router->setConfigResolver($this->configResolver);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return $router;
    }

    public function testMatchRequestWithSemanticPathinfo()
    {
        $pathinfo = '/siteaccess/foo/bar';
        $semanticPathinfo = '/foo/bar';
        $request = Request::create($pathinfo);
        $request->attributes->set('semanticPathinfo', $semanticPathinfo);

        /** @var \PHPUnit\Framework\MockObject\MockObject|DefaultRouter $router */
        $router = $this->generateRouter(array('match'));

        $matchedParameters = array('_controller' => 'AcmeBundle:myAction');
        $router
            ->expects($this->once())
            ->method('match')
            ->with($semanticPathinfo)
            ->will($this->returnValue($matchedParameters));
        $this->assertSame($matchedParameters, $router->matchRequest($request));
    }

    public function testMatchRequestRegularPathinfo()
    {
        $matchedParameters = array('_controller' => 'AcmeBundle:myAction');
        $pathinfo = '/siteaccess/foo/bar';

        $request = Request::create($pathinfo);

        $this->configResolver->expects($this->never())->method('getParameter');

        /** @var \PHPUnit\Framework\MockObject\MockObject|DefaultRouter $router */
        $router = $this->generateRouter(array('match'));
        $router
            ->expects($this->once())
            ->method('match')
            ->with($pathinfo)
            ->will($this->returnValue($matchedParameters));
        $this->assertSame($matchedParameters, $router->matchRequest($request));
    }

    /**
     * @dataProvider providerGenerateNoSiteAccess
     */
    public function testGenerateNoSiteAccess($url)
    {
        $generator = $this->createMock(UrlGeneratorInterface::class);
        $generator
            ->expects($this->once())
            ->method('generate')
            ->with(__METHOD__)
            ->will($this->returnValue($url));

        /** @var DefaultRouter|\PHPUnit\Framework\MockObject\MockObject $router */
        $router = $this->generateRouter(array('getGenerator'));
        $router
            ->expects($this->any())
            ->method('getGenerator')
            ->will($this->returnValue($generator));

        $this->assertSame($url, $router->generate(__METHOD__));
    }

    public function providerGenerateNoSiteAccess()
    {
        return array(
            array('/foo/bar'),
            array('/foo/bar/baz?truc=muche&tata=toto'),
            array('http://ez.no/Products/eZ-Publish-CMS'),
            array('http://www.metalfrance.net/decouvertes/edge-caress-inverse-ep'),
        );
    }

    /**
     * @dataProvider providerGenerateWithSiteAccess
     *
     * @param string $urlGenerated The URL generated by the standard UrLGenerator
     * @param string $relevantUri The relevant URI part of the generated URL (without host and basepath)
     * @param string $expectedUrl The URL we're expecting to be finally generated, with siteaccess
     * @param string $saName The SiteAccess name
     * @param bool $isMatcherLexer True if the siteaccess matcher is URILexer
     * @param int $referenceType The type of reference to be generated (one of the constants)
     * @param string $routeName
     */
    public function testGenerateWithSiteAccess($urlGenerated, $relevantUri, $expectedUrl, $saName, $isMatcherLexer, $referenceType, $routeName)
    {
        $routeName = $routeName ?: __METHOD__;
        $nonSiteAccessAwareRoutes = array('_dontwantsiteaccess');
        $generator = $this->createMock(UrlGeneratorInterface::class);
        $generator
            ->expects($this->once())
            ->method('generate')
            ->with($routeName)
            ->will($this->returnValue($urlGenerated));

        /** @var DefaultRouter|\PHPUnit\Framework\MockObject\MockObject $router */
        $router = $this->generateRouter(array('getGenerator'));
        $router
            ->expects($this->any())
            ->method('getGenerator')
            ->will($this->returnValue($generator));

        // If matcher is URILexer, we make it act as it's supposed to, prepending the siteaccess.
        if ($isMatcherLexer) {
            $matcher = $this->createMock(SiteAccess\URILexer::class);
            // Route is siteaccess aware, we're expecting analyseLink() to be called
            if (!in_array($routeName, $nonSiteAccessAwareRoutes)) {
                $matcher
                    ->expects($this->once())
                    ->method('analyseLink')
                    ->with($relevantUri)
                    ->will($this->returnValue("/$saName$relevantUri"));
            } else {
                // Non-siteaccess aware route, it's not supposed to be analysed
                $matcher
                    ->expects($this->never())
                    ->method('analyseLink');
            }
        } else {
            $matcher = $this->createMock(Matcher::class);
        }

        $sa = new SiteAccess($saName, 'test', $matcher);
        $router->setSiteAccess($sa);

        $requestContext = new RequestContext();
        $urlComponents = parse_url($urlGenerated);
        if (isset($urlComponents['host'])) {

            $requestContext->setHost($urlComponents['host']);
            $requestContext->setScheme($urlComponents['scheme']);
            if (isset($urlComponents['port']) && $urlComponents['scheme'] === 'http') {
                $requestContext->setHttpPort($urlComponents['port']);
            } elseif (isset($urlComponents['port']) && $urlComponents['scheme'] === 'https') {
                $requestContext->setHttpsPort($urlComponents['port']);
            }
        }
        $requestContext->setBaseUrl(
            substr($urlComponents['path'], 0, strpos($urlComponents['path'], $relevantUri))
        );
        $router->setContext($requestContext);
        $router->setNonSiteAccessAwareRoutes($nonSiteAccessAwareRoutes);

        $this->assertSame($expectedUrl, $router->generate($routeName, array(), $referenceType));
    }

    public function providerGenerateWithSiteAccess()
    {
        return array(
            array('/foo/bar', '/foo/bar', '/foo/bar', 'test_siteaccess', false, UrlGeneratorInterface::ABSOLUTE_PATH, null),
            array('http://ezpublish.dev/foo/bar', '/foo/bar', 'http://ezpublish.dev/foo/bar', 'test_siteaccess', false, UrlGeneratorInterface::ABSOLUTE_URL, null),
            array('http://ezpublish.dev/foo/bar', '/foo/bar', 'http://ezpublish.dev/test_siteaccess/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
            array('http://ezpublish.dev/foo/bar', '/foo/bar', 'http://ezpublish.dev/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, '_dontwantsiteaccess'),
            array('http://ezpublish.dev:8080/foo/bar', '/foo/bar', 'http://ezpublish.dev:8080/test_siteaccess/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
            array('http://ezpublish.dev:8080/foo/bar', '/foo/bar', 'http://ezpublish.dev:8080/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, '_dontwantsiteaccess'),
            array('https://ezpublish.dev/secured', '/secured', 'https://ezpublish.dev/test_siteaccess/secured', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
            array('https://ezpublish.dev:445/secured', '/secured', 'https://ezpublish.dev:445/test_siteaccess/secured', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
            array('http://ezpublish.dev:8080/foo/root_folder/bar/baz', '/bar/baz', 'http://ezpublish.dev:8080/foo/root_folder/test_siteaccess/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
            array('/foo/bar/baz', '/foo/bar/baz', '/test_siteaccess/foo/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_PATH, null),
            array('/foo/root_folder/bar/baz', '/bar/baz', '/foo/root_folder/test_siteaccess/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_PATH, null),
            array('/foo/bar/baz', '/foo/bar/baz', '/foo/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_PATH, '_dontwantsiteaccess'),
        );
    }

    public function testGenerateReverseSiteAccessMatch()
    {
        $routeName = 'some_route_name';
        $urlGenerated = 'http://phoenix-rises.fm/foo/bar';

        $siteAccessName = 'foo_test';
        $siteAccessRouter = $this->createMock(SiteAccess\SiteAccessRouterInterface::class);
        $versatileMatcher = $this->createMock(SiteAccess\VersatileMatcher::class);
        $simplifiedRequest = new SimplifiedRequest(
            array(
                'host' => 'phoenix-rises.fm',
                'scheme' => 'http',
            )
        );
        $versatileMatcher
            ->expects($this->once())
            ->method('getRequest')
            ->will($this->returnValue($simplifiedRequest));
        $siteAccessRouter
            ->expects($this->once())
            ->method('matchByName')
            ->with($siteAccessName)
            ->will($this->returnValue(new SiteAccess($siteAccessName, 'foo', $versatileMatcher)));

        $generator = $this->createMock(UrlGeneratorInterface::class);
        $generator
            ->expects($this->at(0))
            ->method('setContext')
            ->with($this->isInstanceOf(RequestContext::class));
        $generator
            ->expects($this->at(1))
            ->method('generate')
            ->with($routeName)
            ->will($this->returnValue($urlGenerated));
        $generator
            ->expects($this->at(2))
            ->method('setContext')
            ->with($this->requestContext);

        $router = new DefaultRouter($this->container, 'foo', array(), $this->requestContext);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $router->setConfigResolver($this->configResolver);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $router->setSiteAccess(new SiteAccess('test', 'test', $this->createMock(Matcher::class)));
        $router->setSiteAccessRouter($siteAccessRouter);
        $refRouter = new ReflectionObject($router);
        $refGenerator = $refRouter->getProperty('generator');
        $refGenerator->setAccessible(true);
        $refGenerator->setValue($router, $generator);

        $this->assertSame(
            $urlGenerated,
            $router->generate($routeName, array('siteaccess' => $siteAccessName), DefaultRouter::ABSOLUTE_PATH)
        );
    }

    /**
     * @dataProvider providerGetContextBySimplifiedRequest
     *
     * @param string $uri
     */
    public function testGetContextBySimplifiedRequest($uri)
    {
        $this->getExpectedRequestContext($uri);

        $router = new DefaultRouter($this->container, 'foo', [], $this->requestContext);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        self::assertEquals(
            $this->getExpectedRequestContext($uri),
            $router->getContextBySimplifiedRequest(SimplifiedRequest::fromUrl($uri))
        );
    }

    /**
     * Data provider for testGetContextBySimplifiedRequest.
     *
     * @see testGetContextBySimplifiedRequest
     *
     * @return array
     */
    public function providerGetContextBySimplifiedRequest()
    {
        return [
            ['/foo/bar'],
            ['http://ezpublish.dev/foo/bar'],
            ['http://ezpublish.dev:8080/foo/bar'],
            ['https://ezpublish.dev/secured'],
            ['https://ezpublish.dev:445/secured'],
            ['http://ezpublish.dev:8080/foo/root_folder/bar/baz'],
        ];
    }

    private function getExpectedRequestContext($uri)
    {
        $requestContext = new RequestContext();
        $uriComponents = parse_url($uri);
        if (isset($uriComponents['host'])) {

            $requestContext->setHost($uriComponents['host']);
            $requestContext->setScheme($uriComponents['scheme']);
            if (isset($uriComponents['port']) && $uriComponents['scheme'] === 'http') {
                $requestContext->setHttpPort($uriComponents['port']);
            } elseif (isset($uriComponents['port']) && $uriComponents['scheme'] === 'https') {
                $requestContext->setHttpsPort($uriComponents['port']);
            }
        }
        if (isset($uriComponents['path'])) {
            $requestContext->setPathInfo($uriComponents['path']);
        }

        return $requestContext;
    }
}


1		<?php
2
3		/**
4		* File containing the DefaultRouterTest class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*/
9		namespace eZ\Bundle\EzPublishCoreBundle\Tests\Routing;
10
11		use eZ\Bundle\EzPublishCoreBundle\Routing\DefaultRouter;
12		use eZ\Bundle\EzPublishCoreBundle\SiteAccess\Matcher;
13		use eZ\Publish\Core\MVC\ConfigResolverInterface;
14		use eZ\Publish\Core\MVC\Symfony\Routing\SimplifiedRequest;
15		use eZ\Publish\Core\MVC\Symfony\SiteAccess;
16		use Symfony\Component\DependencyInjection\ContainerInterface;
17		use Symfony\Component\HttpFoundation\Request;
18		use Symfony\Component\Routing\RequestContext;
19		use ReflectionObject;
20		use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
21		use PHPUnit\Framework\TestCase;
22
23		class DefaultRouterTest extends TestCase
24		{
25		/**
26		* @var \PHPUnit\Framework\MockObject\MockObject\|\Symfony\Component\DependencyInjection\ContainerInterface
27		*/
28		protected $container;
29
30		/**
31		* @var \PHPUnit\Framework\MockObject\MockObject\|\eZ\Publish\Core\MVC\ConfigResolverInterface
32		*/
33		protected $configResolver;
34
35		/**
36		* @var \Symfony\Component\Routing\RequestContext
37		*/
38		protected $requestContext;
39
40		protected function setUp()
41		{
42		parent::setUp();
43		$this->container = $this->createMock(ContainerInterface::class);
44		$this->configResolver = $this->createMock(ConfigResolverInterface::class);
45		$this->requestContext = new RequestContext();
46		}
47
48		protected function getRouterClass()
49		{
50		return DefaultRouter::class;
51		}
52
53		/**
54		* @param array $mockedMethods
55		*
56		* @return \PHPUnit\Framework\MockObject\MockObject\|DefaultRouter
57		*/
58		protected function generateRouter(array $mockedMethods = array())
59		{
60		/** @var \PHPUnit\Framework\MockObject\MockObject\|DefaultRouter $router */
61		$router = $this
62		->getMockBuilder($this->getRouterClass())
63		->setConstructorArgs(array($this->container, 'foo', array(), $this->requestContext))
64		->setMethods(array_merge($mockedMethods))
65		->getMock();
66		$router->setConfigResolver($this->configResolver);
		0 ignored issues – show Bug introduced 2018-02-09 15:57 UTC by Report Bug Copy Issue Report It seems like `$this->configResolver` can also be of type `object<PHPUnit\Framework\MockObject\MockObject>`; however, `eZ\Bundle\EzPublishCoreB...er::setConfigResolver()` does only seem to accept `object<eZ\Publish\Core\M...onfigResolverInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
67
68		return $router;
69		}
70
71		public function testMatchRequestWithSemanticPathinfo()
72		{
73		$pathinfo = '/siteaccess/foo/bar';
74		$semanticPathinfo = '/foo/bar';
75		$request = Request::create($pathinfo);
76		$request->attributes->set('semanticPathinfo', $semanticPathinfo);
77
78		/** @var \PHPUnit\Framework\MockObject\MockObject\|DefaultRouter $router */
79		$router = $this->generateRouter(array('match'));
80
81		$matchedParameters = array('_controller' => 'AcmeBundle:myAction');
82		$router
83		->expects($this->once())
84		->method('match')
85		->with($semanticPathinfo)
86		->will($this->returnValue($matchedParameters));
87		$this->assertSame($matchedParameters, $router->matchRequest($request));
88		}
89
90		public function testMatchRequestRegularPathinfo()
91		{
92		$matchedParameters = array('_controller' => 'AcmeBundle:myAction');
93		$pathinfo = '/siteaccess/foo/bar';
94
95		$request = Request::create($pathinfo);
96
97		$this->configResolver->expects($this->never())->method('getParameter');
98
99		/** @var \PHPUnit\Framework\MockObject\MockObject\|DefaultRouter $router */
100		$router = $this->generateRouter(array('match'));
101		$router
102		->expects($this->once())
103		->method('match')
104		->with($pathinfo)
105		->will($this->returnValue($matchedParameters));
106		$this->assertSame($matchedParameters, $router->matchRequest($request));
107		}
108
109		/**
110		* @dataProvider providerGenerateNoSiteAccess
111		*/
112		public function testGenerateNoSiteAccess($url)
113		{
114		$generator = $this->createMock(UrlGeneratorInterface::class);
115		$generator
116		->expects($this->once())
117		->method('generate')
118		->with(__METHOD__)
119		->will($this->returnValue($url));
120
121		/** @var DefaultRouter\|\PHPUnit\Framework\MockObject\MockObject $router */
122		$router = $this->generateRouter(array('getGenerator'));
123		$router
124		->expects($this->any())
125		->method('getGenerator')
126		->will($this->returnValue($generator));
127
128		$this->assertSame($url, $router->generate(__METHOD__));
129		}
130
131	View Code Duplication	public function providerGenerateNoSiteAccess()
132		{
133		return array(
134		array('/foo/bar'),
135		array('/foo/bar/baz?truc=muche&tata=toto'),
136		array('http://ez.no/Products/eZ-Publish-CMS'),
137		array('http://www.metalfrance.net/decouvertes/edge-caress-inverse-ep'),
138		);
139		}
140
141		/**
142		* @dataProvider providerGenerateWithSiteAccess
143		*
144		* @param string $urlGenerated The URL generated by the standard UrLGenerator
145		* @param string $relevantUri The relevant URI part of the generated URL (without host and basepath)
146		* @param string $expectedUrl The URL we're expecting to be finally generated, with siteaccess
147		* @param string $saName The SiteAccess name
148		* @param bool $isMatcherLexer True if the siteaccess matcher is URILexer
149		* @param int $referenceType The type of reference to be generated (one of the constants)
150		* @param string $routeName
151		*/
152		public function testGenerateWithSiteAccess($urlGenerated, $relevantUri, $expectedUrl, $saName, $isMatcherLexer, $referenceType, $routeName)
153		{
154		$routeName = $routeName ?: __METHOD__;
155		$nonSiteAccessAwareRoutes = array('_dontwantsiteaccess');
156		$generator = $this->createMock(UrlGeneratorInterface::class);
157		$generator
158		->expects($this->once())
159		->method('generate')
160		->with($routeName)
161		->will($this->returnValue($urlGenerated));
162
163		/** @var DefaultRouter\|\PHPUnit\Framework\MockObject\MockObject $router */
164		$router = $this->generateRouter(array('getGenerator'));
165		$router
166		->expects($this->any())
167		->method('getGenerator')
168		->will($this->returnValue($generator));
169
170		// If matcher is URILexer, we make it act as it's supposed to, prepending the siteaccess.
171		if ($isMatcherLexer) {
172		$matcher = $this->createMock(SiteAccess\URILexer::class);
173		// Route is siteaccess aware, we're expecting analyseLink() to be called
174		if (!in_array($routeName, $nonSiteAccessAwareRoutes)) {
175		$matcher
176		->expects($this->once())
177		->method('analyseLink')
178		->with($relevantUri)
179		->will($this->returnValue("/$saName$relevantUri"));
180		} else {
181		// Non-siteaccess aware route, it's not supposed to be analysed
182		$matcher
183		->expects($this->never())
184		->method('analyseLink');
185		}
186		} else {
187		$matcher = $this->createMock(Matcher::class);
188		}
189
190		$sa = new SiteAccess($saName, 'test', $matcher);
191		$router->setSiteAccess($sa);
192
193		$requestContext = new RequestContext();
194		$urlComponents = parse_url($urlGenerated);
195	View Code Duplication	if (isset($urlComponents['host'])) {
		0 ignored issues – show Duplication introduced 2018-06-28 11:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
196		$requestContext->setHost($urlComponents['host']);
197		$requestContext->setScheme($urlComponents['scheme']);
198		if (isset($urlComponents['port']) && $urlComponents['scheme'] === 'http') {
199		$requestContext->setHttpPort($urlComponents['port']);
200		} elseif (isset($urlComponents['port']) && $urlComponents['scheme'] === 'https') {
201		$requestContext->setHttpsPort($urlComponents['port']);
202		}
203		}
204		$requestContext->setBaseUrl(
205		substr($urlComponents['path'], 0, strpos($urlComponents['path'], $relevantUri))
206		);
207		$router->setContext($requestContext);
208		$router->setNonSiteAccessAwareRoutes($nonSiteAccessAwareRoutes);
209
210		$this->assertSame($expectedUrl, $router->generate($routeName, array(), $referenceType));
211		}
212
213		public function providerGenerateWithSiteAccess()
214		{
215		return array(
216		array('/foo/bar', '/foo/bar', '/foo/bar', 'test_siteaccess', false, UrlGeneratorInterface::ABSOLUTE_PATH, null),
217		array('http://ezpublish.dev/foo/bar', '/foo/bar', 'http://ezpublish.dev/foo/bar', 'test_siteaccess', false, UrlGeneratorInterface::ABSOLUTE_URL, null),
218		array('http://ezpublish.dev/foo/bar', '/foo/bar', 'http://ezpublish.dev/test_siteaccess/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
219		array('http://ezpublish.dev/foo/bar', '/foo/bar', 'http://ezpublish.dev/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, '_dontwantsiteaccess'),
220		array('http://ezpublish.dev:8080/foo/bar', '/foo/bar', 'http://ezpublish.dev:8080/test_siteaccess/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
221		array('http://ezpublish.dev:8080/foo/bar', '/foo/bar', 'http://ezpublish.dev:8080/foo/bar', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, '_dontwantsiteaccess'),
222		array('https://ezpublish.dev/secured', '/secured', 'https://ezpublish.dev/test_siteaccess/secured', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
223		array('https://ezpublish.dev:445/secured', '/secured', 'https://ezpublish.dev:445/test_siteaccess/secured', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
224		array('http://ezpublish.dev:8080/foo/root_folder/bar/baz', '/bar/baz', 'http://ezpublish.dev:8080/foo/root_folder/test_siteaccess/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_URL, null),
225		array('/foo/bar/baz', '/foo/bar/baz', '/test_siteaccess/foo/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_PATH, null),
226		array('/foo/root_folder/bar/baz', '/bar/baz', '/foo/root_folder/test_siteaccess/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_PATH, null),
227		array('/foo/bar/baz', '/foo/bar/baz', '/foo/bar/baz', 'test_siteaccess', true, UrlGeneratorInterface::ABSOLUTE_PATH, '_dontwantsiteaccess'),
228		);
229		}
230
231		public function testGenerateReverseSiteAccessMatch()
232		{
233		$routeName = 'some_route_name';
234		$urlGenerated = 'http://phoenix-rises.fm/foo/bar';
235
236		$siteAccessName = 'foo_test';
237		$siteAccessRouter = $this->createMock(SiteAccess\SiteAccessRouterInterface::class);
238		$versatileMatcher = $this->createMock(SiteAccess\VersatileMatcher::class);
239		$simplifiedRequest = new SimplifiedRequest(
240		array(
241		'host' => 'phoenix-rises.fm',
242		'scheme' => 'http',
243		)
244		);
245		$versatileMatcher
246		->expects($this->once())
247		->method('getRequest')
248		->will($this->returnValue($simplifiedRequest));
249		$siteAccessRouter
250		->expects($this->once())
251		->method('matchByName')
252		->with($siteAccessName)
253		->will($this->returnValue(new SiteAccess($siteAccessName, 'foo', $versatileMatcher)));
254
255		$generator = $this->createMock(UrlGeneratorInterface::class);
256		$generator
257		->expects($this->at(0))
258		->method('setContext')
259		->with($this->isInstanceOf(RequestContext::class));
260		$generator
261		->expects($this->at(1))
262		->method('generate')
263		->with($routeName)
264		->will($this->returnValue($urlGenerated));
265		$generator
266		->expects($this->at(2))
267		->method('setContext')
268		->with($this->requestContext);
269
270		$router = new DefaultRouter($this->container, 'foo', array(), $this->requestContext);
		0 ignored issues – show Bug introduced 2018-02-09 15:57 UTC by Report Bug Copy Issue Report It seems like `$this->container` can also be of type `object<PHPUnit\Framework\MockObject\MockObject>`; however, `Symfony\Bundle\Framework...g\Router::__construct()` does only seem to accept `object<Symfony\Component...ion\ContainerInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
271		$router->setConfigResolver($this->configResolver);
		0 ignored issues – show Bug introduced 2018-02-09 15:57 UTC by Report Bug Copy Issue Report It seems like `$this->configResolver` can also be of type `object<PHPUnit\Framework\MockObject\MockObject>`; however, `eZ\Bundle\EzPublishCoreB...er::setConfigResolver()` does only seem to accept `object<eZ\Publish\Core\M...onfigResolverInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
272		$router->setSiteAccess(new SiteAccess('test', 'test', $this->createMock(Matcher::class)));
273		$router->setSiteAccessRouter($siteAccessRouter);
274		$refRouter = new ReflectionObject($router);
275		$refGenerator = $refRouter->getProperty('generator');
276		$refGenerator->setAccessible(true);
277		$refGenerator->setValue($router, $generator);
278
279		$this->assertSame(
280		$urlGenerated,
281		$router->generate($routeName, array('siteaccess' => $siteAccessName), DefaultRouter::ABSOLUTE_PATH)
282		);
283		}
284
285		/**
286		* @dataProvider providerGetContextBySimplifiedRequest
287		*
288		* @param string $uri
289		*/
290		public function testGetContextBySimplifiedRequest($uri)
291		{
292		$this->getExpectedRequestContext($uri);
293
294		$router = new DefaultRouter($this->container, 'foo', [], $this->requestContext);
		0 ignored issues – show Bug introduced 2018-06-28 11:26 UTC by Report Bug Copy Issue Report It seems like `$this->container` can also be of type `object<PHPUnit\Framework\MockObject\MockObject>`; however, `Symfony\Bundle\Framework...g\Router::__construct()` does only seem to accept `object<Symfony\Component...ion\ContainerInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
295
296		self::assertEquals(
297		$this->getExpectedRequestContext($uri),
298		$router->getContextBySimplifiedRequest(SimplifiedRequest::fromUrl($uri))
299		);
300		}
301
302		/**
303		* Data provider for testGetContextBySimplifiedRequest.
304		*
305		* @see testGetContextBySimplifiedRequest
306		*
307		* @return array
308		*/
309	View Code Duplication	public function providerGetContextBySimplifiedRequest()
310		{
311		return [
312		['/foo/bar'],
313		['http://ezpublish.dev/foo/bar'],
314		['http://ezpublish.dev:8080/foo/bar'],
315		['https://ezpublish.dev/secured'],
316		['https://ezpublish.dev:445/secured'],
317		['http://ezpublish.dev:8080/foo/root_folder/bar/baz'],
318		];
319		}
320
321		private function getExpectedRequestContext($uri)
322		{
323		$requestContext = new RequestContext();
324		$uriComponents = parse_url($uri);
325	View Code Duplication	if (isset($uriComponents['host'])) {
		0 ignored issues – show Duplication introduced 2018-06-28 11:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
326		$requestContext->setHost($uriComponents['host']);
327		$requestContext->setScheme($uriComponents['scheme']);
328		if (isset($uriComponents['port']) && $uriComponents['scheme'] === 'http') {
329		$requestContext->setHttpPort($uriComponents['port']);
330		} elseif (isset($uriComponents['port']) && $uriComponents['scheme'] === 'https') {
331		$requestContext->setHttpsPort($uriComponents['port']);
332		}
333		}
334		if (isset($uriComponents['path'])) {
335		$requestContext->setPathInfo($uriComponents['path']);
336		}
337
338		return $requestContext;
339		}
340		}
341

ezsystems / ezpublish-kernel

Push — master ( 29f099...87ed20 )

DefaultRouterTest::getExpectedRequestContext() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like