Merge pull request #7213 from kenjis/feat-spark-routes-host

feat: add `--host` option to `spark routes`
codeigniter4 · Feb 5, 2023 · 0b989f1 · 0b989f1
2 parents c682fc6 + 15c3528
commit 0b989f1
Show file tree

Hide file tree

Showing 6 changed files with 99 additions and 6 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -125,8 +125,7 @@
     </UndefinedGlobalVariable>
   </file>
   <file src="tests/_support/Config/Routes.php">
-    <UndefinedGlobalVariable occurrences="2">
-      <code>$routes</code>
+    <UndefinedGlobalVariable occurrences="5">
       <code>$routes</code>
     </UndefinedGlobalVariable>
   </file>

diff --git a/system/Commands/Utilities/Routes.php b/system/Commands/Utilities/Routes.php
@@ -69,7 +69,8 @@ class Routes extends BaseCommand
      * @var array<string, string>
      */
     protected $options = [
-        '-h' => 'Sort by Handler.',
+        '-h'     => 'Sort by Handler.',
+        '--host' => 'Specify hostname in request URI.',
     ];
 
     /**
@@ -78,9 +79,24 @@ class Routes extends BaseCommand
     public function run(array $params)
     {
         $sortByHandler = array_key_exists('h', $params);
+        $host          = $params['host'] ?? null;
+
+        // Set HTTP_HOST
+        if ($host) {
+            $request              = Services::request();
+            $_SERVER              = $request->getServer();
+            $_SERVER['HTTP_HOST'] = $host;
+            $request->setGlobal('server', $_SERVER);
+        }
 
         $collection = Services::routes()->loadRoutes();
-        $methods    = [
+
+        // Reset HTTP_HOST
+        if ($host) {
+            unset($_SERVER['HTTP_HOST']);
+        }
+
+        $methods = [
             'get',
             'head',
             'post',
@@ -171,6 +187,10 @@ public function run(array $params)
             usort($tbody, static fn ($handler1, $handler2) => strcmp($handler1[3], $handler2[3]));
         }
 
+        if ($host) {
+            CLI::write('Host: ' . $host);
+        }
+
         CLI::table($tbody, $thead);
     }
 }
diff --git a/tests/_support/Config/Routes.php b/tests/_support/Config/Routes.php
@@ -14,3 +14,6 @@
 // This is a simple file to include for testing the RouteCollection class.
 $routes->add('testing', 'TestController::index', ['as' => 'testing-index']);
 $routes->get('closure', static fn () => 'closure test');
+$routes->get('/', 'Blog::index', ['hostname' => 'blog.example.com']);
+$routes->get('/', 'Sub::index', ['subdomain' => 'sub']);
+$routes->get('/all', 'AllDomain::index', ['subdomain' => '*']);
diff --git a/tests/system/Commands/RoutesTest.php b/tests/system/Commands/RoutesTest.php
@@ -53,7 +53,7 @@ private function getCleanRoutes(): RouteCollection
 
     public function testRoutesCommand()
     {
-        $this->getCleanRoutes();
+        Services::injectMock('routes', null);
 
         command('routes');
 
@@ -79,7 +79,7 @@ public function testRoutesCommand()
 
     public function testRoutesCommandSortByHandler()
     {
-        $this->getCleanRoutes();
+        Services::injectMock('routes', null);
 
         command('routes -h');
 
@@ -103,6 +103,62 @@ public function testRoutesCommandSortByHandler()
         $this->assertStringContainsString($expected, $this->getBuffer());
     }
 
+    public function testRoutesCommandHostHostname()
+    {
+        Services::injectMock('routes', null);
+
+        command('routes --host blog.example.com');
+
+        $expected = <<<'EOL'
+            Host: blog.example.com
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            | Method  | Route   | Name          | Handler                                | Before Filters | After Filters |
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            | GET     | /       | »             | \App\Controllers\Blog::index           |                | toolbar       |
+            | GET     | closure | »             | (Closure)                              |                | toolbar       |
+            | GET     | all     | »             | \App\Controllers\AllDomain::index      |                | toolbar       |
+            | GET     | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | HEAD    | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | POST    | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | PUT     | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | DELETE  | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | OPTIONS | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | TRACE   | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | CONNECT | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | CLI     | testing | testing-index | \App\Controllers\TestController::index |                |               |
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            EOL;
+        $this->assertStringContainsString($expected, $this->getBuffer());
+    }
+
+    public function testRoutesCommandHostSubdomain()
+    {
+        Services::injectMock('routes', null);
+
+        command('routes --host sub.example.com');
+
+        $expected = <<<'EOL'
+            Host: sub.example.com
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            | Method  | Route   | Name          | Handler                                | Before Filters | After Filters |
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            | GET     | /       | »             | \App\Controllers\Sub::index            |                | toolbar       |
+            | GET     | closure | »             | (Closure)                              |                | toolbar       |
+            | GET     | all     | »             | \App\Controllers\AllDomain::index      |                | toolbar       |
+            | GET     | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | HEAD    | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | POST    | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | PUT     | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | DELETE  | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | OPTIONS | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | TRACE   | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | CONNECT | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | CLI     | testing | testing-index | \App\Controllers\TestController::index |                |               |
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            EOL;
+        $this->assertStringContainsString($expected, $this->getBuffer());
+    }
+
     public function testRoutesCommandAutoRouteImproved()
     {
         $routes = $this->getCleanRoutes();
@@ -139,6 +195,7 @@ public function testRoutesCommandAutoRouteImproved()
     public function testRoutesCommandRouteLegacy()
     {
         $routes = $this->getCleanRoutes();
+        $routes->loadRoutes();
 
         $routes->setAutoRoute(true);
         $namespace = 'Tests\Support\Controllers';

diff --git a/user_guide_src/source/changelogs/v4.4.0.rst b/user_guide_src/source/changelogs/v4.4.0.rst
@@ -32,6 +32,9 @@ Enhancements
 Commands
 ========
 
+- Now ``spark routes`` command can specify the host in the request URL.
+  See :ref:`routing-spark-routes-specify-host`.
+
 Testing
 =======
 

diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst
@@ -868,3 +868,14 @@ Sort by Handler
 You can sort the routes by *Handler*::
 
     > php spark routes -h
+
+.. _routing-spark-routes-specify-host:
+
+Specify Host
+------------
+
+.. versionadded:: 4.4.0
+
+You can specify the host in the request URL with the ``--host`` option::
+
+    > php spark routes --host accounts.example.com