Merge pull request #6286 from kenjis/refactor-exception-exit-code

refactor: Exception exit code

Author: kenjis

system/Database/Exceptions/DatabaseException.php

@@ -20,5 +20,5 @@ class DatabaseException extends Error implements ExceptionInterface
      *
      * @var int
      */
-    protected $code = 8;
+    protected $code = EXIT_DATABASE;
 }

system/Entity/Exceptions/CastException.php

@@ -15,6 +15,10 @@
 
 /**
  * CastException is thrown for invalid cast initialization and management.
+ *
+ * @TODO CodeIgniter\Exceptions\CastException is deprecated and this class is used.
+ *      CodeIgniter\Exceptions\CastException has the property $code = EXIT_CONFIG,
+ *      but this class does not have the code.
  */
 class CastException extends FrameworkException
 {

system/Exceptions/CastException.php

@@ -23,11 +23,11 @@ class CastException extends CriticalError
     use DebugTraceableTrait;
 
     /**
-     * Error code
+     * Exit status code
      *
      * @var int
      */
-    protected $code = 3;
+    protected $code = EXIT_CONFIG;
 
     public static function forInvalidJsonFormatException(int $error)
     {

system/Exceptions/ConfigException.php

@@ -19,11 +19,11 @@ class ConfigException extends CriticalError
     use DebugTraceableTrait;
 
     /**
-     * Error code
+     * Exit status code
      *
      * @var int
      */
-    protected $code = 3;
+    protected $code = EXIT_CONFIG;
 
     public static function forDisabledMigrations()
     {

system/Exceptions/PageNotFoundException.php

@@ -19,7 +19,7 @@ class PageNotFoundException extends OutOfBoundsException implements ExceptionInt
     use DebugTraceableTrait;
 
     /**
-     * Error code
+     * HTTP status code
      *
      * @var int
      */

system/Router/Exceptions/RedirectException.php

@@ -19,7 +19,7 @@
 class RedirectException extends Exception
 {
     /**
-     * Status code for redirects
+     * HTTP status code for redirects
      *
      * @var int
      */

tests/system/Debug/ExceptionsTest.php

@@ -11,6 +11,9 @@
 
 namespace CodeIgniter\Debug;
 
+use CodeIgniter\Database\Exceptions\DatabaseException;
+use CodeIgniter\Entity\Exceptions\CastException;
+use CodeIgniter\Exceptions\ConfigException;
 use CodeIgniter\Exceptions\PageNotFoundException;
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\ReflectionHelper;
@@ -57,9 +60,16 @@ public function testDetermineCodes(): void
     {
         $determineCodes = $this->getPrivateMethodInvoker($this->exception, 'determineCodes');
 
-        $this->assertSame([500, 9], $determineCodes(new RuntimeException('This.')));
-        $this->assertSame([500, 1], $determineCodes(new RuntimeException('That.', 600)));
-        $this->assertSame([404, 1], $determineCodes(new RuntimeException('There.', 404)));
+        $this->assertSame([500, EXIT__AUTO_MIN], $determineCodes(new RuntimeException('This.')));
+        $this->assertSame([500, EXIT_ERROR], $determineCodes(new RuntimeException('That.', 600)));
+        $this->assertSame([404, EXIT_ERROR], $determineCodes(new RuntimeException('There.', 404)));
+        $this->assertSame([167, EXIT_ERROR], $determineCodes(new RuntimeException('This.', 167)));
+        // @TODO This exit code should be EXIT_CONFIG.
+        $this->assertSame([500, 12], $determineCodes(new ConfigException('This.')));
+        // @TODO This exit code should be EXIT_CONFIG.
+        $this->assertSame([500, 9], $determineCodes(new CastException('This.')));
+        // @TODO This exit code should be EXIT_DATABASE.
+        $this->assertSame([500, 17], $determineCodes(new DatabaseException('This.')));
     }
 
     public function testRenderBacktrace(): void