Prevent serialization of non-backed enums (#6796)

innerfly · innerfly · web-flow · commit 14c7ebe988ca · 2026-03-11T08:11:15.000-05:00
* #6753 Prevent serialization of non-backed enums * add normalization for json encoding * enum serialization test * add string and array serialization * add string and array serialization * prettify * fix indendation * enum processing optimization --------- Co-authored-by: innerfly <you@example.com>
diff --git a/src/Codeception/Test/Descriptor.php b/src/Codeception/Test/Descriptor.php
@@ -4,10 +4,12 @@
 
 namespace Codeception\Test;
 
+use BackedEnum;
 use Codeception\Test\Interfaces\Descriptive;
 use Codeception\Test\Interfaces\Plain;
 use Codeception\TestInterface;
 use PHPUnit\Framework\SelfDescribing;
+use UnitEnum;
 
 use function codecept_relative_path;
 use function json_encode;
@@ -34,6 +36,7 @@ public static function getTestSignatureUnique(SelfDescribing $testCase): string
             $signature .= ':' . $env;
         }
         if (method_exists($testCase, 'getMetadata') && $example = $testCase->getMetadata()->getCurrent('example')) {
+            $example = self::normalizeForJsonEncoding($example);
             $encoded = json_encode($example, JSON_THROW_ON_ERROR | JSON_INVALID_UTF8_SUBSTITUTE);
             $signature .= ':' . substr(sha1($encoded), 0, 7);
         }
@@ -85,4 +88,13 @@ public static function getTestDataSetIndex(SelfDescribing $testCase): string
             default          => '',
         };
     }
+
+    private static function normalizeForJsonEncoding(mixed $value): mixed
+    {
+        return match (true) {
+            is_array($value) => array_map(self::normalizeForJsonEncoding(...), $value),
+            $value instanceof UnitEnum && !($value instanceof BackedEnum) => $value->name,
+            default => $value,
+        };
+    }
 }
diff --git a/tests/unit/Codeception/Test/DescriptorTest.php b/tests/unit/Codeception/Test/DescriptorTest.php
@@ -0,0 +1,124 @@
+<?php
+
+declare(strict_types=1);
+
+namespace unit\Codeception\Test;
+
+use Codeception\Test\Descriptor;
+use Codeception\Test\Interfaces\Descriptive;
+use PHPUnit\Framework\TestCase as PHPUnitTestCase;
+
+enum UnitEnumExample
+{
+    case FOO;
+    case BAR;
+}
+
+enum BackedEnumExample: string
+{
+    case FOO = 'one';
+    case BAR = 'two';
+}
+
+class TestCase implements Descriptive
+{
+    public function toString(): string
+    {
+        return 'TestCase';
+    }
+
+    public function getFileName(): string
+    {
+        return __FILE__;
+    }
+
+    public function getSignature(): string
+    {
+        return 'TestCaseSignature';
+    }
+}
+
+class DescriptorTest extends PHPUnitTestCase
+{
+    public function testUnitEnumSerialization(): void
+    {
+        $testCase = new class extends TestCase {
+            public function getMetadata(): object
+            {
+                return new class {
+                    public function getCurrent(string $key): mixed
+                    {
+                        return ['enum' => UnitEnumExample::FOO];
+                    }
+                };
+            }
+        };
+
+        $signature = Descriptor::getTestSignatureUnique($testCase);
+        $this->assertSame($testCase->getSignature() . ':41e8901', $signature);
+    }
+
+    public function testBackedEnumSerialization(): void
+    {
+        $testCase = new class extends TestCase {
+            public function getMetadata(): object
+            {
+                return new class {
+                    public function getCurrent(string $key): mixed
+                    {
+                        return ['enum' => BackedEnumExample::FOO];
+                    }
+                };
+            }
+        };
+
+        $signature = Descriptor::getTestSignatureUnique($testCase);
+        $this->assertSame($testCase->getSignature() . ':f863384', $signature);
+    }
+
+    public function testStringSerialization(): void
+    {
+        $testCase = new class extends TestCase {
+            public function getMetadata(): object
+            {
+                return new class {
+                    public function getCurrent(string $key): mixed
+                    {
+                        return ['string' => 'test value'];
+                    }
+                };
+            }
+        };
+
+        $signature = Descriptor::getTestSignatureUnique($testCase);
+        $this->assertSame($testCase->getSignature() . ':5cf307a', $signature);
+    }
+
+    public function testArraySerialization(): void
+    {
+        $testCase = new class extends TestCase {
+            public function getMetadata(): object
+            {
+                return new class {
+                    public function getCurrent(string $key): mixed
+                    {
+                        return [
+                            'array' => [
+                                'one',
+                                'two',
+                                'three' => [
+                                    'key' => 'value',
+                                    'enum1' => UnitEnumExample::FOO,
+                                    'enum2' => BackedEnumExample::BAR,
+                                ]
+                            ],
+                        ];
+                    }
+                };
+            }
+        };
+
+        $signature = Descriptor::getTestSignatureUnique($testCase);
+        $this->assertSame($testCase->getSignature() . ':8aed566', $signature);
+    }
+}
