cakephp/tests/TestCase/Routing/RouteCollectionTest.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Routing;

use Cake\Routing\RouteBuilder;
use Cake\Routing\RouteCollection;
use Cake\Routing\Router;
use Cake\Routing\Route\Route;
use Cake\TestSuite\TestCase;

class RouteCollectionTest extends TestCase {

/**
 * Setup method
 *
 * @return void
 */
	public function setUp() {
		parent::setUp();
		$this->collection = new RouteCollection();
	}

/**
 * Test parse() throws an error on unknown routes.
 *
 * @expectedException Cake\Routing\Error\MissingRouteException
 * @expectedExceptionMessage A route matching "/" could not be found
 */
	public function testParseMissingRoute() {
		$routes = new RouteBuilder($this->collection, '/b', ['key' => 'value']);
		$routes->connect('/', ['controller' => 'Articles']);
		$routes->connect('/:id', ['controller' => 'Articles', 'action' => 'view']);

		$result = $this->collection->parse('/');
		$this->assertEquals([], $result, 'Should not match, missing /b');
	}

/**
 * Test parsing routes.
 *
 * @return void
 */
	public function testParse() {
		$routes = new RouteBuilder($this->collection, '/b', ['key' => 'value']);
		$routes->connect('/', ['controller' => 'Articles']);
		$routes->connect('/:id', ['controller' => 'Articles', 'action' => 'view']);
		$routes->connect('/media/search/*', ['controller' => 'Media', 'action' => 'search']);

		$result = $this->collection->parse('/b/');
		$expected = [
			'controller' => 'Articles',
			'action' => 'index',
			'pass' => [],
			'plugin' => null,
			'key' => 'value',
		];
		$this->assertEquals($expected, $result);

		$result = $this->collection->parse('/b/the-thing?one=two');
		$expected = [
			'controller' => 'Articles',
			'action' => 'view',
			'id' => 'the-thing',
			'pass' => [],
			'plugin' => null,
			'key' => 'value',
			'?' => ['one' => 'two'],
		];
		$this->assertEquals($expected, $result);

		$result = $this->collection->parse('/b/media/search');
		$expected = [
			'key' => 'value',
			'pass' => [],
			'plugin' => null,
			'controller' => 'Media',
			'action' => 'search'
		];
		$this->assertEquals($expected, $result);

		$result = $this->collection->parse('/b/media/search/thing');
		$expected = [
			'key' => 'value',
			'pass' => ['thing'],
			'plugin' => null,
			'controller' => 'Media',
			'action' => 'search'
		];
		$this->assertEquals($expected, $result);
	}

/**
 * Test that parsing checks all the related path scopes.
 *
 * @return void
 */
	public function testParseFallback() {
		$routes = new RouteBuilder($this->collection, '/', []);

		$routes->resources('Articles');
		$routes->connect('/:controller', ['action' => 'index'], [], ['routeClass' => 'InflectedRoute']);
		$routes->connect('/:controller/:action', [], ['routeClass' => 'InflectedRoute']);

		$result = $this->collection->parse('/articles/add');
		$expected = [
			'controller' => 'Articles',
			'action' => 'add',
			'plugin' => null,
			'pass' => []
		];
		$this->assertEquals($expected, $result);
	}

/**
 * Test match() throws an error on unknown routes.
 *
 * @expectedException Cake\Routing\Error\MissingRouteException
 * @expectedExceptionMessage A route matching "array (
 */
	public function testMatchError() {
		$context = [
			'_base' => '/',
			'_scheme' => 'http',
			'_host' => 'example.org',
		];
		$routes = new RouteBuilder($this->collection, '/b');
		$routes->connect('/', ['controller' => 'Articles']);

		$result = $this->collection->match(['plugin' => null, 'controller' => 'Articles', 'action' => 'add'], $context);
		$this->assertFalse($result, 'No matches');
	}

/**
 * Test matching routes.
 *
 * @return void
 */
	public function testMatch() {
		$context = [
			'_base' => '/',
			'_scheme' => 'http',
			'_host' => 'example.org',
		];
		$routes = new RouteBuilder($this->collection, '/b');
		$routes->connect('/', ['controller' => 'Articles']);
		$routes->connect('/:id', ['controller' => 'Articles', 'action' => 'view']);

		$result = $this->collection->match(['plugin' => null, 'controller' => 'Articles', 'action' => 'index'], $context);
		$this->assertEquals('b', $result);

		$result = $this->collection->match(
			['id' => 'thing', 'plugin' => null, 'controller' => 'Articles', 'action' => 'view'],
			$context);
		$this->assertEquals('b/thing', $result);
	}

/**
 * Test matching routes with names
 *
 * @return void
 */
	public function testMatchNamed() {
		$context = [
			'_base' => '/',
			'_scheme' => 'http',
			'_host' => 'example.org',
		];
		$routes = new RouteBuilder($this->collection, '/b');
		$routes->connect('/', ['controller' => 'Articles']);
		$routes->connect('/:id', ['controller' => 'Articles', 'action' => 'view'], ['_name' => 'article:view']);

		$result = $this->collection->match(['_name' => 'article:view', 'id' => '2'], $context);
		$this->assertEquals('/b/2', $result);

		$result = $this->collection->match(['plugin' => null, 'controller' => 'Articles', 'action' => 'view', 'id' => '2'], $context);
		$this->assertEquals('b/2', $result);
	}

/**
 * Test matching routes with names and failing
 *
 * @expectedException Cake\Routing\Error\MissingRouteException
 * @return void
 */
	public function testMatchNamedError() {
		$context = [
			'_base' => '/',
			'_scheme' => 'http',
			'_host' => 'example.org',
		];
		$routes = new RouteBuilder($this->collection, '/b');
		$routes->connect('/:id', ['controller' => 'Articles', 'action' => 'view'], ['_name' => 'article:view']);

		$this->collection->match(['_name' => 'derp'], $context);
	}

/**
 * Test matching plugin routes.
 *
 * @return void
 */
	public function testMatchPlugin() {
		$context = [
			'_base' => '/',
			'_scheme' => 'http',
			'_host' => 'example.org',
		];
		$routes = new RouteBuilder($this->collection, '/contacts', ['plugin' => 'Contacts']);
		$routes->connect('/', ['controller' => 'Contacts']);

		$result = $this->collection->match(['plugin' => 'Contacts', 'controller' => 'Contacts', 'action' => 'index'], $context);
		$this->assertEquals('contacts', $result);
	}

/**
 * Test that prefixes increase the specificity of a route match.
 *
 * Connect the admin route after the non prefixed version, this means
 * the non-prefix route would have a more specific name (users:index)
 *
 * @return void
 */
	public function testMatchPrefixSpecificity() {
		$context = [
			'_base' => '/',
			'_scheme' => 'http',
			'_host' => 'example.org',
		];
		$routes = new RouteBuilder($this->collection, '/');
		$routes->connect('/:action/*', ['controller' => 'Users']);
		$routes->connect('/admin/:controller', ['prefix' => 'admin', 'action' => 'index']);

		$url = [
			'plugin' => null,
			'prefix' => 'admin',
			'controller' => 'Users',
			'action' => 'index'
		];
		$result = $this->collection->match($url, $context);
		$this->assertEquals('admin/Users', $result);

		$url = [
			'plugin' => null,
			'controller' => 'Users',
			'action' => 'index'
		];
		$result = $this->collection->match($url, $context);
		$this->assertEquals('index', $result);
	}

/**
 * Test getting named routes.
 *
 * @return void
 */
	public function testNamed() {
		$routes = new RouteBuilder($this->collection, '/l');
		$routes->connect('/:controller', ['action' => 'index'], ['_name' => 'cntrl']);
		$routes->connect('/:controller/:action/*');

		$all = $this->collection->named();
		$this->assertCount(1, $all);
		$this->assertInstanceOf('Cake\Routing\Route\Route', $all['cntrl']);
		$this->assertEquals('/l/:controller', $all['cntrl']->template);
	}

/**
 * Test the add() and routes() method.
 *
 * @return void
 */
	public function testAddingRoutes() {
		$one = new Route('/pages/*', ['controller' => 'Pages', 'action' => 'display']);
		$two = new Route('/', ['controller' => 'Dashboards', 'action' => 'display']);
		$this->collection->add($one);
		$this->collection->add($two);

		$routes = $this->collection->routes();
		$this->assertCount(2, $routes);
		$this->assertSame($one, $routes[0]);
		$this->assertSame($two, $routes[1]);
	}

}