Merge remote-tracking branch 'upstream/develop' into 4.8

Author: paulbalandan

.github/workflows/test-phpunit.yml

@@ -11,7 +11,7 @@ on:
       - 'tests/**.php'
       - 'spark'
       - composer.json
-      - phpunit.xml.dist
+      - phpunit.dist.xml
       - .github/workflows/test-phpunit.yml
       - .github/workflows/reusable-phpunit-test.yml
 
@@ -25,7 +25,7 @@ on:
       - 'tests/**.php'
       - 'spark'
       - composer.json
-      - phpunit.xml.dist
+      - phpunit.dist.xml
       - .github/workflows/test-phpunit.yml
       - .github/workflows/reusable-phpunit-test.yml
 

.github/workflows/test-random-execution.yml

@@ -9,7 +9,7 @@ on:
       - '.github/scripts/run-random-tests.sh'
       - '.github/scripts/random-tests-config.txt'
       - '.github/workflows/test-random-execution.yml'
-      - 'phpunit.xml.dist'
+      - 'phpunit.dist.xml'
       - 'system/**.php'
       - 'tests/**.php'
 
@@ -21,7 +21,7 @@ on:
       - '.github/scripts/run-random-tests.sh'
       - '.github/scripts/random-tests-config.txt'
       - '.github/workflows/test-random-execution.yml'
-      - 'phpunit.xml.dist'
+      - 'phpunit.dist.xml'
       - 'system/**.php'
       - 'tests/**.php'
 

admin/starter/builds

@@ -94,7 +94,7 @@ if (is_file($file)) {
 
 $files = [
     __DIR__ . DIRECTORY_SEPARATOR . 'app/Config/Paths.php',
-    __DIR__ . DIRECTORY_SEPARATOR . 'phpunit.xml.dist',
+    __DIR__ . DIRECTORY_SEPARATOR . 'phpunit.dist.xml',
     __DIR__ . DIRECTORY_SEPARATOR . 'phpunit.xml',
 ];
 

admin/starter/tests/README.md

@@ -80,11 +80,11 @@ The HTML files can be viewed by opening **tests/coverage/index.html** in your fa
 
 ## PHPUnit XML Configuration
 
-The repository has a ``phpunit.xml.dist`` file in the project root that's used for
+The repository has a ``phpunit.dist.xml`` file in the project root that's used for
 PHPUnit configuration. This is used to provide a default configuration if you
 do not have your own configuration file in the project root.
 
-The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml``
+The normal practice would be to copy ``phpunit.dist.xml`` to ``phpunit.xml``
 (which is git ignored), and to tailor it as you see fit.
 For instance, you might wish to exclude database tests, or automatically generate
 HTML code coverage reports.

admin/starter/tests/unit/HealthTest.php

@@ -27,7 +27,7 @@ public function testBaseUrlHasBeenSet(): void
 
         if ($env) {
             // BaseURL in .env is a valid URL?
-            // phpunit.xml.dist sets app.baseURL in $_SERVER
+            // phpunit.dist.xml sets app.baseURL in $_SERVER
             // So if you set app.baseURL in .env, it takes precedence
             $config = new App();
             $this->assertTrue(
@@ -37,7 +37,7 @@ public function testBaseUrlHasBeenSet(): void
         }
 
         // Get the baseURL in app/Config/App.php
-        // You can't use Config\App, because phpunit.xml.dist sets app.baseURL
+        // You can't use Config\App, because phpunit.dist.xml sets app.baseURL
         $reader = new ConfigReader();
 
         // BaseURL in app/Config/App.php is a valid URL?

system/CLI/CLI.php

@@ -237,6 +237,7 @@ public static function prompt(string $field, $options = null, $validation = null
         }
 
         static::fwrite(STDOUT, $field . (trim($field) !== '' ? ' ' : '') . $extraOutput . ': ');
+        static::$lastWrite = 'write';
 
         // Read the input from keyboard.
         $input = trim(static::$io->input());
@@ -440,7 +441,8 @@ public static function write(string $text = '', ?string $foreground = null, ?str
         }
 
         if (static::$lastWrite !== 'write') {
-            $text              = PHP_EOL . $text;
+            $text = PHP_EOL . $text;
+
             static::$lastWrite = 'write';
         }
 
@@ -455,13 +457,20 @@ public static function write(string $text = '', ?string $foreground = null, ?str
     public static function error(string $text, string $foreground = 'light_red', ?string $background = null)
     {
         // Check color support for STDERR
-        $stdout            = static::$isColored;
+        $stdout = static::$isColored;
+
         static::$isColored = static::hasColorSupport(STDERR);
 
         if ($foreground !== '' || (string) $background !== '') {
             $text = static::color($text, $foreground, $background);
         }
 
+        if (static::$lastWrite !== 'write') {
+            $text = PHP_EOL . $text;
+
+            static::$lastWrite = 'write';
+        }
+
         static::fwrite(STDERR, $text . PHP_EOL);
 
         // return STDOUT color support

system/Commands/Utilities/Environment.php

@@ -85,7 +85,7 @@ final class Environment extends BaseCommand
      */
     public function run(array $params)
     {
-        if ($params === []) {
+        if (! isset($params[0])) {
             CLI::write(sprintf('Your environment is currently set as %s.', CLI::color(service('superglobals')->server('CI_ENVIRONMENT', ENVIRONMENT), 'green')));
             CLI::newLine();
 

system/Commands/Utilities/Routes.php

@@ -73,17 +73,26 @@ class Routes extends BaseCommand
      * @var array<string, string>
      */
     protected $options = [
-        '-h'     => 'Sort by Handler.',
-        '--host' => 'Specify hostname in request URI.',
+        '--handler' => 'Sort by Handler.',
+        '--host'    => 'Specify hostname in request URI.',
     ];
 
     /**
      * Displays the help for the spark cli script itself.
      */
     public function run(array $params)
     {
-        $sortByHandler = array_key_exists('h', $params);
-        $host          = $params['host'] ?? null;
+        $sortByHandler = array_key_exists('handler', $params);
+
+        if (! $sortByHandler && array_key_exists('h', $params)) {
+            // Support -h as a shortcut but print a warning that it is not the intended use of -h.
+            CLI::write('Warning: -h will be used as shortcut for --help in v4.8.0. Please use --handler to sort by handler.', 'yellow');
+            CLI::newLine();
+
+            $sortByHandler = true;
+        }
+
+        $host = $params['host'] ?? null;
 
         // Set HTTP_HOST
         if ($host !== null) {

tests/README.md

@@ -172,11 +172,11 @@ as a comprehensive collection of HTML files that show the status of every line o
 
 ## PHPUnit XML Configuration
 
-The repository has a ``phpunit.xml.dist`` file in the project root that's used for
+The repository has a ``phpunit.dist.xml`` file in the project root that's used for
 PHPUnit configuration. This is used to provide a default configuration if you
 do not have your own configuration file in the project root.
 
-The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml``
+The normal practice would be to copy ``phpunit.dist.xml`` to ``phpunit.xml``
 (which is git ignored), and to tailor it as you see fit.
 For instance, you might wish to exclude database tests, or automatically generate
 HTML code coverage reports.

tests/system/CLI/CLITest.php

@@ -37,6 +37,7 @@ protected function setUp(): void
 
         Services::injectMock('superglobals', new Superglobals());
 
+        CLI::reset();
         CLI::init();
     }
 
@@ -393,24 +394,41 @@ public function testError(): void
     {
         CLI::error('test');
 
-        // red expected cuz stderr
-        $expected = "\033[1;31mtest\033[0m" . PHP_EOL;
+        $expected = PHP_EOL . "\033[1;31mtest\033[0m" . PHP_EOL;
         $this->assertSame($expected, $this->getStreamFilterBuffer());
     }
 
+    public function testMixedWriteError(): void
+    {
+        CLI::write('test 1');
+        CLI::error('test 2');
+        CLI::write('test 3');
+
+        $this->assertSame(
+            <<<'EOT'
+
+                test 1
+                test 2
+                test 3
+
+                EOT,
+            preg_replace('/\e\[[^m]+m/u', '', $this->getStreamFilterBuffer()),
+        );
+    }
+
     public function testErrorForeground(): void
     {
         CLI::error('test', 'purple');
 
-        $expected = "\033[0;35mtest\033[0m" . PHP_EOL;
+        $expected = PHP_EOL . "\033[0;35mtest\033[0m" . PHP_EOL;
         $this->assertSame($expected, $this->getStreamFilterBuffer());
     }
 
     public function testErrorBackground(): void
     {
         CLI::error('test', 'purple', 'green');
 
-        $expected = "\033[0;35m\033[42mtest\033[0m" . PHP_EOL;
+        $expected = PHP_EOL . "\033[0;35m\033[42mtest\033[0m" . PHP_EOL;
         $this->assertSame($expected, $this->getStreamFilterBuffer());
     }