cakephp/tests/TestCase/Routing/RouteBuilderTest.php

<?php
declare(strict_types=1);

/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Routing;

use BadMethodCallException;
use Cake\Core\Exception\MissingPluginException;
use Cake\Core\Plugin;
use Cake\Http\ServerRequest;
use Cake\Routing\Route\InflectedRoute;
use Cake\Routing\Route\RedirectRoute;
use Cake\Routing\Route\Route;
use Cake\Routing\RouteBuilder;
use Cake\Routing\RouteCollection;
use Cake\Routing\Router;
use Cake\TestSuite\TestCase;
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\DataProvider;
use TestApp\Routing\Route\DashedRoute;

/**
 * RouteBuilder test case
 */
class RouteBuilderTest extends TestCase
{
    /**
     * @var \Cake\Routing\RouteCollection
     */
    protected $collection;

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

    /**
     * Teardown method
     */
    public function tearDown(): void
    {
        parent::tearDown();
        $this->clearPlugins();
    }

    /**
     * Test path()
     */
    public function testPath(): void
    {
        $routes = new RouteBuilder($this->collection, '/some/path');
        $this->assertSame('/some/path', $routes->path());

        $routes = new RouteBuilder($this->collection, '/{book_id}');
        $this->assertSame('/', $routes->path());

        $routes = new RouteBuilder($this->collection, '/path/{book_id}');
        $this->assertSame('/path/', $routes->path());

        $routes = new RouteBuilder($this->collection, '/path/book{book_id}');
        $this->assertSame('/path/book', $routes->path());
    }

    /**
     * Test params()
     */
    public function testParams(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $this->assertEquals(['prefix' => 'Api'], $routes->params());
    }

    /**
     * Test getting connected routes.
     */
    public function testRoutes(): void
    {
        $routes = new RouteBuilder($this->collection, '/l');
        $routes->connect('/{controller}', ['action' => 'index']);
        $routes->connect('/{controller}/{action}/*');

        $all = $this->collection->routes();
        $this->assertCount(2, $all);
        $this->assertInstanceOf(Route::class, $all[0]);
        $this->assertInstanceOf(Route::class, $all[1]);
    }

    /**
     * Test setting default route class
     */
    public function testRouteClass(): void
    {
        $routes = new RouteBuilder(
            $this->collection,
            '/l',
            [],
            ['routeClass' => 'InflectedRoute']
        );
        $routes->connect('/{controller}', ['action' => 'index']);
        $routes->connect('/{controller}/{action}/*');

        $all = $this->collection->routes();
        $this->assertInstanceOf(InflectedRoute::class, $all[0]);
        $this->assertInstanceOf(InflectedRoute::class, $all[1]);

        $this->collection = new RouteCollection();
        $routes = new RouteBuilder($this->collection, '/l');
        $this->assertSame($routes, $routes->setRouteClass(DashedRoute::class));
        $this->assertSame(DashedRoute::class, $routes->getRouteClass());

        $routes->connect('/{controller}', ['action' => 'index']);
        $all = $this->collection->routes();
        $this->assertInstanceOf(DashedRoute::class, $all[0]);
    }

    /**
     * Test connecting an instance routes.
     */
    public function testConnectInstance(): void
    {
        $routes = new RouteBuilder($this->collection, '/l', ['prefix' => 'Api']);

        $route = new Route('/{controller}');
        $this->assertSame($route, $routes->connect($route));

        $result = $this->collection->routes()[0];
        $this->assertSame($route, $result);
    }

    /**
     * Test connecting basic routes.
     */
    public function testConnectBasic(): void
    {
        $routes = new RouteBuilder($this->collection, '/l', ['prefix' => 'Api']);

        $route = $routes->connect('/{controller}');
        $this->assertInstanceOf(Route::class, $route);

        $this->assertSame($route, $this->collection->routes()[0]);
        $this->assertSame('/l/{controller}', $route->template);
        $expected = ['prefix' => 'Api', 'action' => 'index', 'plugin' => null];
        $this->assertEquals($expected, $route->defaults);
    }

    /**
     * Test that compiling a route results in an trailing / optional pattern.
     */
    public function testConnectTrimTrailingSlash(): void
    {
        $routes = new RouteBuilder($this->collection, '/articles', ['controller' => 'Articles']);
        $routes->connect('/', ['action' => 'index']);

        $expected = [
            'plugin' => null,
            'controller' => 'Articles',
            'action' => 'index',
            'pass' => [],
            '_matchedRoute' => '/articles',
        ];
        $result = $this->collection->parseRequest(new ServerRequest(['url' => '/articles']));
        unset($result['_route']);
        $this->assertEquals($expected, $result);

        $result = $this->collection->parseRequest(new ServerRequest(['url' => '/articles/']));
        unset($result['_route']);
        $this->assertEquals($expected, $result);
    }

    /**
     * Test connect() with short string syntax
     */
    public function testConnectShortStringInvalid(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $routes = new RouteBuilder($this->collection, '/');
        $routes->connect('/my-articles/view', 'Articles:no');
    }

    /**
     * Test connect() with short string syntax
     */
    public function testConnectShortString(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->connect('/my-articles/view', 'Articles::view');
        $expected = [
            'pass' => [],
            'controller' => 'Articles',
            'action' => 'view',
            'plugin' => null,
            '_matchedRoute' => '/my-articles/view',
        ];
        $result = $this->collection->parseRequest(new ServerRequest(['url' => '/my-articles/view']));
        unset($result['_route']);
        $this->assertEquals($expected, $result);

        $url = $expected['_matchedRoute'];
        unset($expected['_matchedRoute']);
        $this->assertSame($url, '/' . $this->collection->match($expected, []));
    }

    /**
     * Test connect() with short string syntax
     */
    public function testConnectShortStringPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->connect('/admin/bookmarks', 'Admin/Bookmarks::index');
        $expected = [
            'pass' => [],
            'plugin' => null,
            'prefix' => 'Admin',
            'controller' => 'Bookmarks',
            'action' => 'index',
            '_matchedRoute' => '/admin/bookmarks',
        ];
        $result = $this->collection->parseRequest(new ServerRequest(['url' => '/admin/bookmarks']));
        unset($result['_route']);
        $this->assertEquals($expected, $result);

        $url = $expected['_matchedRoute'];
        unset($expected['_matchedRoute']);
        $this->assertSame($url, '/' . $this->collection->match($expected, []));
    }

    /**
     * Test connect() with short string syntax
     */
    public function testConnectShortStringPlugin(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->connect('/blog/articles/view', 'Blog.Articles::view');
        $expected = [
            'pass' => [],
            'plugin' => 'Blog',
            'controller' => 'Articles',
            'action' => 'view',
            '_matchedRoute' => '/blog/articles/view',
        ];
        $result = $this->collection->parseRequest(new ServerRequest(['url' => '/blog/articles/view']));
        unset($result['_route']);
        $this->assertEquals($expected, $result);

        $url = $expected['_matchedRoute'];
        unset($expected['_matchedRoute']);
        $this->assertSame($url, '/' . $this->collection->match($expected, []));
    }

    /**
     * Test connect() with short string syntax
     */
    public function testConnectShortStringPluginPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->connect('/admin/blog/articles/view', 'Vendor/Blog.Management/Admin/Articles::view');
        $expected = [
            'pass' => [],
            'plugin' => 'Vendor/Blog',
            'prefix' => 'Management/Admin',
            'controller' => 'Articles',
            'action' => 'view',
            '_matchedRoute' => '/admin/blog/articles/view',
        ];
        $result = $this->collection->parseRequest(new ServerRequest(['url' => '/admin/blog/articles/view']));
        unset($result['_route']);
        $this->assertEquals($expected, $result);

        $url = $expected['_matchedRoute'];
        unset($expected['_matchedRoute']);
        $this->assertSame($url, '/' . $this->collection->match($expected, []));
    }

    /**
     * Test if a route name already exist
     */
    public function testNameExists(): void
    {
        $routes = new RouteBuilder($this->collection, '/l', ['prefix' => 'Api']);
        $this->assertFalse($routes->nameExists('myRouteName'));

        $routes->connect('myRouteUrl', ['action' => 'index'], ['_name' => 'myRouteName']);
        $this->assertTrue($routes->nameExists('myRouteName'));
    }

    /**
     * Test setExtensions() and getExtensions().
     */
    public function testExtensions(): void
    {
        $routes = new RouteBuilder($this->collection, '/l');
        $this->assertSame($routes, $routes->setExtensions(['html']));
        $this->assertSame(['html'], $routes->getExtensions());
    }

    /**
     * Test extensions being connected to routes.
     */
    public function testConnectExtensions(): void
    {
        $routes = new RouteBuilder(
            $this->collection,
            '/l',
            [],
            ['extensions' => ['json']]
        );
        $this->assertEquals(['json'], $routes->getExtensions());

        $routes->connect('/{controller}');
        $route = $this->collection->routes()[0];

        $this->assertEquals(['json'], $route->options['_ext']);
        $routes->setExtensions(['xml', 'json']);

        $routes->connect('/{controller}/{action}');
        $new = $this->collection->routes()[1];
        $this->assertEquals(['json'], $route->options['_ext']);
        $this->assertEquals(['xml', 'json'], $new->options['_ext']);
    }

    /**
     * Test adding additional extensions will be merged with current.
     */
    public function testConnectExtensionsAdd(): void
    {
        $routes = new RouteBuilder(
            $this->collection,
            '/l',
            [],
            ['extensions' => ['json']]
        );
        $this->assertEquals(['json'], $routes->getExtensions());

        $routes->addExtensions(['xml']);
        $this->assertEquals(['json', 'xml'], $routes->getExtensions());

        $routes->addExtensions('csv');
        $this->assertEquals(['json', 'xml', 'csv'], $routes->getExtensions());
    }

    /**
     * test that setExtensions() accepts a string.
     */
    public function testExtensionsString(): void
    {
        $routes = new RouteBuilder($this->collection, '/l');
        $routes->setExtensions('json');

        $this->assertEquals(['json'], $routes->getExtensions());
    }

    /**
     * Test conflicting parameters raises an exception.
     */
    public function testConnectConflictingParameters(): void
    {
        $this->expectException(BadMethodCallException::class);
        $this->expectExceptionMessage('You cannot define routes that conflict with the scope.');
        $routes = new RouteBuilder($this->collection, '/admin', ['plugin' => 'TestPlugin']);
        $routes->connect('/', ['plugin' => 'TestPlugin2', 'controller' => 'Dashboard', 'action' => 'view']);
    }

    /**
     * Test connecting redirect routes.
     */
    public function testRedirect(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->redirect('/p/{id}', ['controller' => 'Posts', 'action' => 'view'], ['status' => 301]);
        $route = $this->collection->routes()[0];

        $this->assertInstanceOf(RedirectRoute::class, $route);

        $routes->redirect('/old', '/forums', ['status' => 301]);
        $route = $this->collection->routes()[1];

        $this->assertInstanceOf(RedirectRoute::class, $route);
        $this->assertSame('/forums', $route->redirect[0]);

        $route = $routes->redirect('/old', '/forums');
        $this->assertInstanceOf(RedirectRoute::class, $route);
        $this->assertSame($route, $this->collection->routes()[2]);
    }

    /**
     * Test using a custom route class for redirect routes.
     */
    public function testRedirectWithCustomRouteClass(): void
    {
        $routes = new RouteBuilder($this->collection, '/');

        $routes->redirect('/old', '/forums', ['status' => 301, 'routeClass' => 'InflectedRoute']);
        $route = $this->collection->routes()[0];

        $this->assertInstanceOf(InflectedRoute::class, $route);
    }

    /**
     * Test creating sub-scopes with prefix()
     */
    public function testPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/path', ['key' => 'value']);
        $res = $routes->prefix('admin', ['param' => 'value'], function (RouteBuilder $r): void {
            $this->assertInstanceOf(RouteBuilder::class, $r);
            $this->assertCount(0, $this->collection->routes());
            $this->assertSame('/path/admin', $r->path());
            $this->assertEquals(['prefix' => 'Admin', 'key' => 'value', 'param' => 'value'], $r->params());
        });
        $this->assertSame($routes, $res);
    }

    /**
     * Test creating sub-scopes with prefix()
     */
    public function testPrefixWithNoParams(): void
    {
        $routes = new RouteBuilder($this->collection, '/path', ['key' => 'value']);
        $res = $routes->prefix('admin', function (RouteBuilder $r): void {
            $this->assertInstanceOf(RouteBuilder::class, $r);
            $this->assertCount(0, $this->collection->routes());
            $this->assertSame('/path/admin', $r->path());
            $this->assertEquals(['prefix' => 'Admin', 'key' => 'value'], $r->params());
        });
        $this->assertSame($routes, $res);
    }

    /**
     * Test creating sub-scopes with prefix()
     */
    public function testNestedPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/admin', ['prefix' => 'Admin']);
        $res = $routes->prefix('api', ['_namePrefix' => 'api:'], function (RouteBuilder $r): void {
            $this->assertSame('/admin/api', $r->path());
            $this->assertEquals(['prefix' => 'Admin/Api'], $r->params());
            $this->assertSame('api:', $r->namePrefix());
        });
        $this->assertSame($routes, $res);
    }

    /**
     * Test creating sub-scopes with prefix()
     */
    public function testPathWithDotInPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/admin', ['prefix' => 'Admin']);
        $res = $routes->prefix('Api', function (RouteBuilder $r): void {
            $r->prefix('v10', ['path' => '/v1.0'], function (RouteBuilder $r2): void {
                $this->assertSame('/admin/api/v1.0', $r2->path());
                $this->assertEquals(['prefix' => 'Admin/Api/V10'], $r2->params());
                $r2->prefix('b1', ['path' => '/beta.1'], function (RouteBuilder $r3): void {
                    $this->assertSame('/admin/api/v1.0/beta.1', $r3->path());
                    $this->assertEquals(['prefix' => 'Admin/Api/V10/B1'], $r3->params());
                });
            });
        });
        $this->assertSame($routes, $res);
    }

    /**
     * Test creating sub-scopes with plugin()
     */
    public function testPlugin(): void
    {
        $routes = new RouteBuilder($this->collection, '/b', ['key' => 'value']);
        $res = $routes->plugin('Contacts', function (RouteBuilder $r): void {
            $this->assertSame('/b/contacts', $r->path());
            $this->assertEquals(['plugin' => 'Contacts', 'key' => 'value'], $r->params());

            $r->connect('/{controller}');
            $route = $this->collection->routes()[0];
            $this->assertEquals(
                ['key' => 'value', 'plugin' => 'Contacts', 'action' => 'index'],
                $route->defaults
            );
        });
        $this->assertSame($routes, $res);
    }

    /**
     * Test creating sub-scopes with plugin() + path option
     */
    public function testPluginPathOption(): void
    {
        $routes = new RouteBuilder($this->collection, '/b', ['key' => 'value']);
        $routes->plugin('Contacts', ['path' => '/people'], function (RouteBuilder $r): void {
            $this->assertSame('/b/people', $r->path());
            $this->assertEquals(['plugin' => 'Contacts', 'key' => 'value'], $r->params());
        });
    }

    /**
     * Test creating sub-scopes with plugin() + namePrefix option
     */
    public function testPluginNamePrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/b', ['key' => 'value']);
        $routes->plugin('Contacts', ['_namePrefix' => 'contacts.'], function (RouteBuilder $r): void {
            $this->assertEquals('contacts.', $r->namePrefix());
        });

        $routes = new RouteBuilder($this->collection, '/b', ['key' => 'value']);
        $routes->namePrefix('default.');
        $routes->plugin('Blog', ['_namePrefix' => 'blog.'], function (RouteBuilder $r): void {
            $this->assertEquals('default.blog.', $r->namePrefix(), 'Should combine nameprefix');
        });
    }

    /**
     * Test connecting resources.
     */
    public function testResources(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->resources('Articles', ['_ext' => 'json']);

        $all = $this->collection->routes();
        $this->assertCount(5, $all);

        $this->assertSame('/api/articles', $all[4]->template);
        $this->assertEquals(
            ['controller', 'action', '_method', 'prefix', 'plugin'],
            array_keys($all[0]->defaults)
        );
        $this->assertSame('json', $all[0]->options['_ext']);
        $this->assertSame('Articles', $all[0]->defaults['controller']);
    }

    /**
     * Test connecting resources with a path
     */
    public function testResourcesPathOption(): void
    {
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->resources('Articles', ['path' => 'posts'], function (RouteBuilder $routes): void {
            $routes->resources('Comments');
        });
        $all = $this->collection->routes();
        $this->assertSame('Articles', $all[8]->defaults['controller']);
        $this->assertSame('/api/posts', $all[8]->template);
        $this->assertSame('/api/posts/{id}', $all[1]->template);
        $this->assertSame(
            '/api/posts/{article_id}/comments',
            $all[4]->template,
            'parameter name should reflect resource name'
        );
    }

    /**
     * Test connecting resources with a prefix
     */
    public function testResourcesPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->resources('Articles', ['prefix' => 'Rest']);
        $all = $this->collection->routes();
        $this->assertSame('Rest', $all[0]->defaults['prefix']);
    }

    /**
     * Test that resource prefixes work within a prefixed scope.
     */
    public function testResourcesNestedPrefix(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->resources('Articles', ['prefix' => 'Rest']);

        $all = $this->collection->routes();
        $this->assertCount(5, $all);

        $this->assertSame('/api/articles', $all[4]->template);
        foreach ($all as $route) {
            $this->assertSame('Api/Rest', $route->defaults['prefix']);
            $this->assertSame('Articles', $route->defaults['controller']);
        }
    }

    /**
     * Test connecting resources with the inflection option
     */
    public function testResourcesInflection(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->resources('BlogPosts', ['_ext' => 'json', 'inflect' => 'dasherize']);

        $all = $this->collection->routes();
        $this->assertCount(5, $all);

        $this->assertSame('/api/blog-posts', $all[4]->template);
        $this->assertEquals(
            ['controller', 'action', '_method', 'prefix', 'plugin'],
            array_keys($all[0]->defaults)
        );
        $this->assertSame('BlogPosts', $all[0]->defaults['controller']);
    }

    /**
     * Test connecting nested resources with the inflection option
     */
    public function testResourcesNestedInflection(): void
    {
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->resources(
            'NetworkObjects',
            ['inflect' => 'dasherize'],
            function (RouteBuilder $routes): void {
                $routes->resources('Attributes');
            }
        );

        $all = $this->collection->routes();
        $this->assertCount(10, $all);

        $this->assertSame('/api/network-objects', $all[8]->template);
        $this->assertSame('/api/network-objects/{id}', $all[2]->template);
        $this->assertSame('/api/network-objects/{network_object_id}/attributes', $all[4]->template);
    }

    /**
     * Test connecting resources with additional mappings
     */
    public function testResourcesMappings(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->resources('Articles', [
            '_ext' => 'json',
            'map' => [
                'delete_all' => ['action' => 'deleteAll', 'method' => 'DELETE'],
                'update_many' => ['action' => 'updateAll', 'method' => 'DELETE', 'path' => '/updateAll'],
            ],
        ]);

        $all = $this->collection->routes();
        $this->assertCount(7, $all);

        $this->assertSame('/api/articles/delete_all', $all[1]->template, 'Path defaults to key name.');
        $this->assertEquals(
            ['controller', 'action', '_method', 'prefix', 'plugin'],
            array_keys($all[5]->defaults)
        );
        $this->assertSame('Articles', $all[5]->defaults['controller']);
        $this->assertSame('deleteAll', $all[1]->defaults['action']);

        $this->assertSame('/api/articles/updateAll', $all[0]->template, 'Explicit path option');
        $this->assertEquals(
            ['controller', 'action', '_method', 'prefix', 'plugin'],
            array_keys($all[6]->defaults)
        );
        $this->assertSame('Articles', $all[6]->defaults['controller']);
        $this->assertSame('updateAll', $all[0]->defaults['action']);
    }

    /**
     * Test connecting resources with restricted mappings.
     */
    public function testResourcesWithMapOnly(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->resources('Articles', [
            'map' => [
                'conditions' => ['action' => 'conditions', 'method' => 'DeLeTe'],
            ],
            'only' => ['conditions'],
        ]);

        $all = $this->collection->routes();
        $this->assertCount(1, $all);
        $this->assertSame('DELETE', $all[0]->defaults['_method'], 'method should be normalized.');
        $this->assertSame('Articles', $all[0]->defaults['controller']);
        $this->assertSame('conditions', $all[0]->defaults['action']);

        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/api/articles/conditions',
            'environment' => [
                'REQUEST_METHOD' => 'DELETE',
            ],
        ]));
        $this->assertNotNull($result);
    }

    /**
     * Test connecting resources.
     */
    public function testResourcesInScope(): void
    {
        $builder = Router::createRouteBuilder('/');
        $builder->scope('/api', ['prefix' => 'Api'], function (RouteBuilder $routes): void {
            $routes->setExtensions(['json']);
            $routes->resources('Articles');
        });
        $url = Router::url([
            'prefix' => 'Api',
            'controller' => 'Articles',
            'action' => 'edit',
            '_method' => 'PUT',
            'id' => '99',
        ]);
        $this->assertSame('/api/articles/99', $url);

        $url = Router::url([
            'prefix' => 'Api',
            'controller' => 'Articles',
            'action' => 'edit',
            '_method' => 'PUT',
            '_ext' => 'json',
            'id' => '99',
        ]);
        $this->assertSame('/api/articles/99.json', $url);
    }

    /**
     * Test resource parsing.
     */
    public function testResourcesParsing(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->resources('Articles');

        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/articles',
            'environment' => [
                'REQUEST_METHOD' => 'GET',
            ],
        ]));
        $this->assertSame('Articles', $result['controller']);
        $this->assertSame('index', $result['action']);
        $this->assertEquals([], $result['pass']);

        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/articles/1',
            'environment' => [
                'REQUEST_METHOD' => 'GET',
            ],
        ]));
        $this->assertSame('Articles', $result['controller']);
        $this->assertSame('view', $result['action']);
        $this->assertEquals([1], $result['pass']);

        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/articles',
            'environment' => [
                'REQUEST_METHOD' => 'POST',
            ],
        ]));
        $this->assertSame('Articles', $result['controller']);
        $this->assertSame('add', $result['action']);
        $this->assertEquals([], $result['pass']);

        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/articles/1',
            'environment' => [
                'REQUEST_METHOD' => 'PUT',
            ],
        ]));
        $this->assertSame('Articles', $result['controller']);
        $this->assertSame('edit', $result['action']);
        $this->assertEquals([1], $result['pass']);

        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/articles/1',
            'environment' => [
                'REQUEST_METHOD' => 'DELETE',
            ],
        ]));
        $this->assertSame('Articles', $result['controller']);
        $this->assertSame('delete', $result['action']);
        $this->assertEquals([1], $result['pass']);
    }

    /**
     * Test the only option of RouteBuilder.
     */
    public function testResourcesOnlyString(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->resources('Articles', ['only' => 'index']);

        $result = $this->collection->routes();
        $this->assertCount(1, $result);
        $this->assertSame('/articles', $result[0]->template);
    }

    /**
     * Test the only option of RouteBuilder.
     */
    public function testResourcesOnlyArray(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->resources('Articles', ['only' => ['index', 'delete']]);

        $result = $this->collection->routes();
        $this->assertCount(2, $result);
        $this->assertSame('/articles', $result[1]->template);
        $this->assertSame('index', $result[1]->defaults['action']);
        $this->assertSame('GET', $result[1]->defaults['_method']);

        $this->assertSame('/articles/{id}', $result[0]->template);
        $this->assertSame('delete', $result[0]->defaults['action']);
        $this->assertSame('DELETE', $result[0]->defaults['_method']);
    }

    /**
     * Test the actions option of RouteBuilder.
     */
    public function testResourcesActions(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->resources('Articles', [
            'only' => ['index', 'delete'],
            'actions' => ['index' => 'showList'],
        ]);

        $result = $this->collection->routes();
        $this->assertCount(2, $result);
        $this->assertSame('/articles', $result[1]->template);
        $this->assertSame('showList', $result[1]->defaults['action']);

        $this->assertSame('/articles/{id}', $result[0]->template);
        $this->assertSame('delete', $result[0]->defaults['action']);
    }

    /**
     * Test nesting resources
     */
    public function testResourcesNested(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->resources('Articles', function (RouteBuilder $routes): void {
            $this->assertSame('/api/articles/', $routes->path());
            $this->assertEquals(['prefix' => 'Api'], $routes->params());

            $routes->resources('Comments');
            $route = $this->collection->routes()[3];
            $this->assertSame('/api/articles/{article_id}/comments', $route->template);
        });
    }

    /**
     * Test connecting fallback routes.
     */
    public function testFallbacks(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->fallbacks();

        $all = $this->collection->routes();
        $this->assertSame('/api/{controller}', $all[0]->template);
        $this->assertSame('/api/{controller}/{action}/*', $all[1]->template);
        $this->assertInstanceOf(Route::class, $all[0]);
    }

    /**
     * Test connecting fallback routes with specific route class
     */
    public function testFallbacksWithClass(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->fallbacks('InflectedRoute');

        $all = $this->collection->routes();
        $this->assertSame('/api/{controller}', $all[0]->template);
        $this->assertSame('/api/{controller}/{action}/*', $all[1]->template);
        $this->assertInstanceOf(InflectedRoute::class, $all[0]);
    }

    /**
     * Test connecting fallback routes after setting default route class.
     */
    public function testDefaultRouteClassFallbacks(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->setRouteClass(DashedRoute::class);
        $routes->fallbacks();

        $all = $this->collection->routes();
        $this->assertInstanceOf(DashedRoute::class, $all[0]);
    }

    /**
     * Test adding a scope.
     */
    public function testScope(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->scope('/v1', ['version' => 1], function (RouteBuilder $routes): void {
            $this->assertSame('/api/v1', $routes->path());
            $this->assertEquals(['prefix' => 'Api', 'version' => 1], $routes->params());
        });
    }

    /**
     * Test adding a scope with action in the scope
     */
    public function testScopeWithAction(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->scope('/prices', ['controller' => 'Prices', 'action' => 'view'], function (RouteBuilder $routes): void {
            $routes->connect('/shared', ['shared' => true]);
            $routes->get('/exclusive', ['exclusive' => true]);
        });
        $all = $this->collection->routes();
        $this->assertCount(2, $all);
        $this->assertSame('view', $all[0]->defaults['action']);
        $this->assertArrayHasKey('shared', $all[0]->defaults);

        $this->assertSame('view', $all[1]->defaults['action']);
        $this->assertArrayHasKey('exclusive', $all[1]->defaults);
    }

    /**
     * Test that exception is thrown if callback is not a valid callable.
     */
    public function testScopeException(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Need a valid Closure to connect routes.');

        $routes = new RouteBuilder($this->collection, '/api', ['prefix' => 'Api']);
        $routes->scope('/v1', ['fail'], null);
    }

    /**
     * Test that nested scopes inherit middleware.
     */
    public function testScopeInheritMiddleware(): void
    {
        $routes = new RouteBuilder(
            $this->collection,
            '/api',
            ['prefix' => 'Api'],
            ['middleware' => ['auth']]
        );
        $routes->scope('/v1', function (RouteBuilder $routes): void {
            $this->assertSame(['auth'], $routes->getMiddleware(), 'Should inherit middleware');
            $this->assertSame('/api/v1', $routes->path());
            $this->assertEquals(['prefix' => 'Api'], $routes->params());
        });
    }

    /**
     * Test using name prefixes.
     */
    public function testNamePrefixes(): void
    {
        $routes = new RouteBuilder($this->collection, '/api', [], ['namePrefix' => 'api:']);
        $routes->scope('/v1', ['version' => 1, '_namePrefix' => 'v1:'], function (RouteBuilder $routes): void {
            $this->assertSame('api:v1:', $routes->namePrefix());
            $routes->connect('/ping', ['controller' => 'Pings'], ['_name' => 'ping']);

            $routes->namePrefix('web:');
            $routes->connect('/pong', ['controller' => 'Pongs'], ['_name' => 'pong']);
        });

        $all = $this->collection->named();
        $this->assertArrayHasKey('api:v1:ping', $all);
        $this->assertArrayHasKey('web:pong', $all);
    }

    /**
     * Test adding middleware to the collection.
     */
    public function testRegisterMiddleware(): void
    {
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $result = $routes->registerMiddleware('test', $func);

        $this->assertSame($result, $routes);
        $this->assertTrue($this->collection->hasMiddleware('test'));
        $this->assertTrue($this->collection->middlewareExists('test'));
    }

    /**
     * Test middleware group
     */
    public function testMiddlewareGroup(): void
    {
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->registerMiddleware('test', $func);
        $routes->registerMiddleware('test_two', $func);
        $result = $routes->middlewareGroup('group', ['test', 'test_two']);

        $this->assertSame($result, $routes);
        $this->assertTrue($this->collection->hasMiddlewareGroup('group'));
        $this->assertTrue($this->collection->middlewareExists('group'));
    }

    /**
     * Test overlap between middleware name and group name
     */
    public function testMiddlewareGroupOverlap(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage("Cannot add middleware group 'test'. A middleware by this name has already been registered.");
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->registerMiddleware('test', $func);
        $routes->middlewareGroup('test', ['test']);
    }

    /**
     * Test applying middleware to a scope when it doesn't exist
     */
    public function testApplyMiddlewareInvalidName(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Cannot apply `bad` middleware or middleware group. Use `registerMiddleware()` to register middleware');
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->applyMiddleware('bad');
    }

    /**
     * Test applying middleware to a scope
     */
    public function testApplyMiddleware(): void
    {
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->registerMiddleware('test', $func)
            ->registerMiddleware('test2', $func);
        $result = $routes->applyMiddleware('test', 'test2');

        $this->assertSame($result, $routes);
    }

    /**
     * Test that applyMiddleware() merges with previous data.
     */
    public function testApplyMiddlewareMerges(): void
    {
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->registerMiddleware('test', $func)
            ->registerMiddleware('test2', $func);
        $routes->applyMiddleware('test');
        $routes->applyMiddleware('test2');

        $this->assertSame(['test', 'test2'], $routes->getMiddleware());
    }

    /**
     * Test that applyMiddleware() uses unique middleware set
     */
    public function testApplyMiddlewareUnique(): void
    {
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->registerMiddleware('test', $func)
            ->registerMiddleware('test2', $func);

        $routes->applyMiddleware('test', 'test2');
        $routes->applyMiddleware('test2', 'test');

        $this->assertEquals(['test', 'test2'], $routes->getMiddleware());
    }

    /**
     * Test applying middleware results in middleware attached to the route.
     */
    public function testApplyMiddlewareAttachToRoutes(): void
    {
        $func = function (): void {
        };
        $routes = new RouteBuilder($this->collection, '/api');
        $routes->registerMiddleware('test', $func)
            ->registerMiddleware('test2', $func);
        $routes->applyMiddleware('test', 'test2');
        $route = $routes->get('/docs', ['controller' => 'Docs']);

        $this->assertSame(['test', 'test2'], $route->getMiddleware());
    }

    /**
     * @return array
     */
    public static function httpMethodProvider(): array
    {
        return [
            ['GET'],
            ['POST'],
            ['PUT'],
            ['PATCH'],
            ['DELETE'],
            ['OPTIONS'],
            ['HEAD'],
        ];
    }

    /**
     * Test that the HTTP method helpers create the right kind of routes.
     */
    #[DataProvider('httpMethodProvider')]
    public function testHttpMethods(string $method): void
    {
        $routes = new RouteBuilder($this->collection, '/', [], ['namePrefix' => 'app:']);
        $route = $routes->{strtolower($method)}(
            '/bookmarks/{id}',
            ['controller' => 'Bookmarks', 'action' => 'view'],
            'route-name'
        );
        $this->assertInstanceOf(Route::class, $route, 'Should return a route');
        $this->assertSame($method, $route->defaults['_method']);
        $this->assertSame('app:route-name', $route->options['_name']);
        $this->assertSame('/bookmarks/{id}', $route->template);
        $this->assertEquals(
            ['plugin' => null, 'controller' => 'Bookmarks', 'action' => 'view', '_method' => $method],
            $route->defaults
        );
    }

    /**
     * Test that the HTTP method helpers create the right kind of routes.
     */
    #[DataProvider('httpMethodProvider')]
    public function testHttpMethodsStringTarget(string $method): void
    {
        $routes = new RouteBuilder($this->collection, '/', [], ['namePrefix' => 'app:']);
        $route = $routes->{strtolower($method)}(
            '/bookmarks/{id}',
            'Bookmarks::view',
            'route-name'
        );
        $this->assertInstanceOf(Route::class, $route, 'Should return a route');
        $this->assertSame($method, $route->defaults['_method']);
        $this->assertSame('app:route-name', $route->options['_name']);
        $this->assertSame('/bookmarks/{id}', $route->template);
        $this->assertEquals(
            ['plugin' => null, 'controller' => 'Bookmarks', 'action' => 'view', '_method' => $method],
            $route->defaults
        );
    }

    /**
     * Integration test for http method helpers and route fluent method
     */
    public function testHttpMethodIntegration(): void
    {
        $routes = new RouteBuilder($this->collection, '/');
        $routes->scope('/', function (RouteBuilder $routes): void {
            $routes->get('/faq/{page}', ['controller' => 'Pages', 'action' => 'faq'], 'faq')
                ->setPatterns(['page' => '[a-z0-9_]+'])
                ->setHost('docs.example.com');

            $routes->post('/articles/{id}', ['controller' => 'Articles', 'action' => 'update'], 'article:update')
                ->setPatterns(['id' => '[0-9]+'])
                ->setPass(['id']);
        });
        $this->assertCount(2, $this->collection->routes());
        $this->assertEquals(['faq', 'article:update'], array_keys($this->collection->named()));
        $this->assertNotEmpty($this->collection->parseRequest(new ServerRequest([
            'url' => '/faq/things_you_know',
            'environment' => [
                'REQUEST_METHOD' => 'GET',
                'HTTP_HOST' => 'docs.example.com',
            ],
        ])));
        $result = $this->collection->parseRequest(new ServerRequest([
            'url' => '/articles/123',
            'environment' => [
                'REQUEST_METHOD' => 'POST',
            ],
        ]));
        $this->assertEquals(['123'], $result['pass']);
    }

    /**
     * Test loading routes from a missing plugin
     */
    public function testLoadPluginBadPlugin(): void
    {
        $this->expectException(MissingPluginException::class);
        $routes = new RouteBuilder($this->collection, '/');
        $routes->loadPlugin('Nope');
    }

    /**
     * Test loading routes with success
     */
    public function testLoadPlugin(): void
    {
        $this->loadPlugins(['TestPlugin']);
        $routes = new RouteBuilder($this->collection, '/');
        $routes->loadPlugin('TestPlugin');
        $this->assertCount(1, $this->collection->routes());
        $this->assertNotEmpty($this->collection->parseRequest(new ServerRequest(['url' => '/test_plugin'])));

        $plugin = Plugin::getCollection()->get('TestPlugin');
        $this->assertFalse($plugin->isEnabled('routes'), 'Hook should be disabled preventing duplicate routes');
    }
}