RouteCollectionTest.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Routing\Tests;

use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;
use Symfony\Component\Config\Resource\FileResource;
class RouteCollectionTest extends \PHPUnit_Framework_TestCase {
  public function testRoute() {
    $collection = new RouteCollection();
    $route = new Route('/foo');
    $collection
      ->add('foo', $route);
    $this
      ->assertEquals(array(
      'foo' => $route,
    ), $collection
      ->all(), '->add() adds a route');
    $this
      ->assertEquals($route, $collection
      ->get('foo'), '->get() returns a route by name');
    $this
      ->assertNull($collection
      ->get('bar'), '->get() returns null if a route does not exist');
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testAddInvalidRoute() {
    $collection = new RouteCollection();
    $route = new Route('/foo');
    $collection
      ->add('f o o', $route);
  }
  public function testOverriddenRoute() {
    $collection = new RouteCollection();
    $collection
      ->add('foo', new Route('/foo'));
    $collection
      ->add('foo', new Route('/foo1'));
    $this
      ->assertEquals('/foo1', $collection
      ->get('foo')
      ->getPattern());
  }
  public function testDeepOverriddenRoute() {
    $collection = new RouteCollection();
    $collection
      ->add('foo', new Route('/foo'));
    $collection1 = new RouteCollection();
    $collection1
      ->add('foo', new Route('/foo1'));
    $collection2 = new RouteCollection();
    $collection2
      ->add('foo', new Route('/foo2'));
    $collection1
      ->addCollection($collection2);
    $collection
      ->addCollection($collection1);
    $this
      ->assertEquals('/foo2', $collection1
      ->get('foo')
      ->getPattern());
    $this
      ->assertEquals('/foo2', $collection
      ->get('foo')
      ->getPattern());
  }
  public function testIteratorWithOverriddenRoutes() {
    $collection = new RouteCollection();
    $collection
      ->add('foo', new Route('/foo'));
    $collection1 = new RouteCollection();
    $collection
      ->addCollection($collection1);
    $collection1
      ->add('foo', new Route('/foo1'));
    $this
      ->assertEquals('/foo1', $this
      ->getFirstNamedRoute($collection, 'foo')
      ->getPattern());
  }
  public function testCount() {
    $collection = new RouteCollection();
    $collection
      ->add('foo', new Route('/foo'));
    $collection1 = new RouteCollection();
    $collection
      ->addCollection($collection1);
    $collection1
      ->add('foo1', new Route('/foo1'));
    $this
      ->assertCount(2, $collection);
  }
  protected function getFirstNamedRoute(RouteCollection $routeCollection, $name) {
    foreach ($routeCollection as $key => $route) {
      if ($route instanceof RouteCollection) {
        return $this
          ->getFirstNamedRoute($route, $name);
      }
      if ($name === $key) {
        return $route;
      }
    }
  }
  public function testAddCollection() {
    if (!class_exists('Symfony\\Component\\Config\\Resource\\FileResource')) {
      $this
        ->markTestSkipped('The "Config" component is not available');
    }
    $collection = new RouteCollection();
    $collection
      ->add('foo', $foo = new Route('/foo'));
    $collection1 = new RouteCollection();
    $collection1
      ->add('foo', $foo1 = new Route('/foo1'));
    $collection1
      ->add('bar', $bar1 = new Route('/bar1'));
    $collection
      ->addCollection($collection1);
    $this
      ->assertEquals(array(
      'foo' => $foo1,
      'bar' => $bar1,
    ), $collection
      ->all(), '->addCollection() adds routes from another collection');
    $collection = new RouteCollection();
    $collection
      ->add('foo', $foo = new Route('/foo'));
    $collection1 = new RouteCollection();
    $collection1
      ->add('foo', $foo1 = new Route('/foo1'));
    $collection
      ->addCollection($collection1, '/{foo}', array(
      'foo' => 'foo',
    ), array(
      'foo' => '\\d+',
    ), array(
      'foo' => 'bar',
    ));
    $this
      ->assertEquals('/{foo}/foo1', $collection
      ->get('foo')
      ->getPattern(), '->addCollection() can add a prefix to all merged routes');
    $this
      ->assertEquals(array(
      'foo' => 'foo',
    ), $collection
      ->get('foo')
      ->getDefaults(), '->addCollection() can add a prefix to all merged routes');
    $this
      ->assertEquals(array(
      'foo' => '\\d+',
    ), $collection
      ->get('foo')
      ->getRequirements(), '->addCollection() can add a prefix to all merged routes');
    $this
      ->assertEquals(array(
      'foo' => 'bar',
      'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler',
    ), $collection
      ->get('foo')
      ->getOptions(), '->addCollection() can add an option to all merged routes');
    $collection = new RouteCollection();
    $collection
      ->addResource($foo = new FileResource(__DIR__ . '/Fixtures/foo.xml'));
    $collection1 = new RouteCollection();
    $collection1
      ->addResource($foo1 = new FileResource(__DIR__ . '/Fixtures/foo1.xml'));
    $collection
      ->addCollection($collection1);
    $this
      ->assertEquals(array(
      $foo,
      $foo1,
    ), $collection
      ->getResources(), '->addCollection() merges resources');
  }
  public function testAddPrefix() {
    $collection = new RouteCollection();
    $collection
      ->add('foo', $foo = new Route('/foo'));
    $collection
      ->add('bar', $bar = new Route('/bar'));
    $collection
      ->addPrefix('/{admin}', array(
      'admin' => 'admin',
    ), array(
      'admin' => '\\d+',
    ), array(
      'foo' => 'bar',
    ));
    $this
      ->assertEquals('/{admin}/foo', $collection
      ->get('foo')
      ->getPattern(), '->addPrefix() adds a prefix to all routes');
    $this
      ->assertEquals('/{admin}/bar', $collection
      ->get('bar')
      ->getPattern(), '->addPrefix() adds a prefix to all routes');
    $this
      ->assertEquals(array(
      'admin' => 'admin',
    ), $collection
      ->get('foo')
      ->getDefaults(), '->addPrefix() adds a prefix to all routes');
    $this
      ->assertEquals(array(
      'admin' => 'admin',
    ), $collection
      ->get('bar')
      ->getDefaults(), '->addPrefix() adds a prefix to all routes');
    $this
      ->assertEquals(array(
      'admin' => '\\d+',
    ), $collection
      ->get('foo')
      ->getRequirements(), '->addPrefix() adds a prefix to all routes');
    $this
      ->assertEquals(array(
      'admin' => '\\d+',
    ), $collection
      ->get('bar')
      ->getRequirements(), '->addPrefix() adds a prefix to all routes');
    $this
      ->assertEquals(array(
      'foo' => 'bar',
      'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler',
    ), $collection
      ->get('foo')
      ->getOptions(), '->addPrefix() adds an option to all routes');
    $this
      ->assertEquals(array(
      'foo' => 'bar',
      'compiler_class' => 'Symfony\\Component\\Routing\\RouteCompiler',
    ), $collection
      ->get('bar')
      ->getOptions(), '->addPrefix() adds an option to all routes');
    $collection
      ->addPrefix('0');
    $this
      ->assertEquals('/0/{admin}', $collection
      ->getPrefix(), '->addPrefix() ensures a prefix must start with a slash and must not end with a slash');
  }
  public function testAddPrefixOverridesDefaultsAndRequirements() {
    $collection = new RouteCollection();
    $collection
      ->add('foo', $foo = new Route('/foo'));
    $collection
      ->add('bar', $bar = new Route('/bar', array(), array(
      '_scheme' => 'http',
    )));
    $collection
      ->addPrefix('/admin', array(), array(
      '_scheme' => 'https',
    ));
    $this
      ->assertEquals('https', $collection
      ->get('foo')
      ->getRequirement('_scheme'), '->addPrefix() overrides existing requirements');
    $this
      ->assertEquals('https', $collection
      ->get('bar')
      ->getRequirement('_scheme'), '->addPrefix() overrides existing requirements');
  }
  public function testAddCollectionOverridesDefaultsAndRequirements() {
    $imported = new RouteCollection();
    $imported
      ->add('foo', $foo = new Route('/foo'));
    $imported
      ->add('bar', $bar = new Route('/bar', array(), array(
      '_scheme' => 'http',
    )));
    $collection = new RouteCollection();
    $collection
      ->addCollection($imported, null, array(), array(
      '_scheme' => 'https',
    ));
    $this
      ->assertEquals('https', $collection
      ->get('foo')
      ->getRequirement('_scheme'), '->addCollection() overrides existing requirements');
    $this
      ->assertEquals('https', $collection
      ->get('bar')
      ->getRequirement('_scheme'), '->addCollection() overrides existing requirements');
  }
  public function testResource() {
    if (!class_exists('Symfony\\Component\\Config\\Resource\\FileResource')) {
      $this
        ->markTestSkipped('The "Config" component is not available');
    }
    $collection = new RouteCollection();
    $collection
      ->addResource($foo = new FileResource(__DIR__ . '/Fixtures/foo.xml'));
    $this
      ->assertEquals(array(
      $foo,
    ), $collection
      ->getResources(), '->addResources() adds a resource');
  }
  public function testUniqueRouteWithGivenName() {
    $collection1 = new RouteCollection();
    $collection1
      ->add('foo', new Route('/old'));
    $collection2 = new RouteCollection();
    $collection3 = new RouteCollection();
    $collection3
      ->add('foo', $new = new Route('/new'));
    $collection1
      ->addCollection($collection2);
    $collection2
      ->addCollection($collection3);
    $collection1
      ->add('stay', new Route('/stay'));
    $iterator = $collection1
      ->getIterator();
    $this
      ->assertSame($new, $collection1
      ->get('foo'), '->get() returns new route that overrode previous one');

    // size of 2 because collection1 contains collection2 and /stay but not /old anymore
    $this
      ->assertCount(2, $iterator, '->addCollection() removes previous routes when adding new routes with the same name');
    $this
      ->assertInstanceOf('Symfony\\Component\\Routing\\RouteCollection', $iterator
      ->current(), '->getIterator returns both Routes and RouteCollections');
    $iterator
      ->next();
    $this
      ->assertInstanceOf('Symfony\\Component\\Routing\\Route', $iterator
      ->current(), '->getIterator returns both Routes and RouteCollections');
  }
  public function testGet() {
    $collection1 = new RouteCollection();
    $collection1
      ->add('a', $a = new Route('/a'));
    $collection2 = new RouteCollection();
    $collection2
      ->add('b', $b = new Route('/b'));
    $collection1
      ->addCollection($collection2);
    $this
      ->assertSame($b, $collection1
      ->get('b'), '->get() returns correct route in child collection');
    $this
      ->assertNull($collection2
      ->get('a'), '->get() does not return the route defined in parent collection');
    $this
      ->assertNull($collection1
      ->get('non-existent'), '->get() returns null when route does not exist');
    $this
      ->assertNull($collection1
      ->get(0), '->get() does not disclose internal child RouteCollection');
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testCannotSelfJoinCollection() {
    $collection = new RouteCollection();
    $collection
      ->addCollection($collection);
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testCannotAddExistingCollectionToTree() {
    $collection1 = new RouteCollection();
    $collection2 = new RouteCollection();
    $collection3 = new RouteCollection();
    $collection1
      ->addCollection($collection2);
    $collection1
      ->addCollection($collection3);
    $collection2
      ->addCollection($collection3);
  }
  public function testPatternDoesNotChangeWhenDefinitionOrderChanges() {
    $collection1 = new RouteCollection();
    $collection1
      ->add('a', new Route('/a...'));
    $collection2 = new RouteCollection();
    $collection2
      ->add('b', new Route('/b...'));
    $collection3 = new RouteCollection();
    $collection3
      ->add('c', new Route('/c...'));
    $rootCollection_A = new RouteCollection();
    $collection2
      ->addCollection($collection3, '/c');
    $collection1
      ->addCollection($collection2, '/b');
    $rootCollection_A
      ->addCollection($collection1, '/a');

    // above should mean the same as below
    $collection1 = new RouteCollection();
    $collection1
      ->add('a', new Route('/a...'));
    $collection2 = new RouteCollection();
    $collection2
      ->add('b', new Route('/b...'));
    $collection3 = new RouteCollection();
    $collection3
      ->add('c', new Route('/c...'));
    $rootCollection_B = new RouteCollection();
    $collection1
      ->addCollection($collection2, '/b');
    $collection2
      ->addCollection($collection3, '/c');
    $rootCollection_B
      ->addCollection($collection1, '/a');

    // test it now
    $this
      ->assertEquals($rootCollection_A, $rootCollection_B);
  }

}