serialization, injection of wrong enums, adopt changes for InvalidTypeException

wol-soft · wol-soft · commit dbac05ed1379 · 2023-10-17T11:47:29.000+02:00
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     ],
     "require": {
         "symfony/polyfill-php81": "^1.28",
-        "wol-soft/php-json-schema-model-generator-production": "dev-enumPostProcessor",
+        "wol-soft/php-json-schema-model-generator-production": "^0.19.0",
         "wol-soft/php-micro-template": "^1.9.0",
 
         "php": ">=7.2",
diff --git a/src/ModelGenerator.php b/src/ModelGenerator.php
@@ -50,10 +50,6 @@ public function __construct(GeneratorConfiguration $generatorConfiguration = nul
             ->addPostProcessor(new AdditionalPropertiesPostProcessor())
             ->addPostProcessor(new PatternPropertiesPostProcessor())
             ->addPostProcessor(new ExtendObjectPropertiesMatchingPatternPropertiesPostProcessor());
-
-        if ($this->generatorConfiguration->hasSerializationEnabled()) {
-            $this->addPostProcessor(new SerializationPostProcessor());
-        }
     }
 
     /**
@@ -113,6 +109,10 @@ public function generateModels(SchemaProviderInterface $schemaProvider, string $
             throw new FileSystemException("Destination directory '$destination' doesn't exist or is not empty");
         }
 
+        if ($this->generatorConfiguration->hasSerializationEnabled()) {
+            $this->addPostProcessor(new SerializationPostProcessor());
+        }
+
         $renderQueue = new RenderQueue();
         $schemaProcessor = new SchemaProcessor(
             $schemaProvider->getBaseDirectory(),
diff --git a/src/SchemaProcessor/PostProcessor/EnumPostProcessor.php b/src/SchemaProcessor/PostProcessor/EnumPostProcessor.php
@@ -6,6 +6,7 @@
 
 use Exception;
 use PHPMicroTemplate\Render;
+use PHPModelGenerator\Exception\Generic\InvalidTypeException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Filter\TransformingFilterInterface;
 use PHPModelGenerator\Model\GeneratorConfiguration;
@@ -16,6 +17,7 @@
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\EnumValidator;
 use PHPModelGenerator\Model\Validator\FilterValidator;
+use PHPModelGenerator\Model\Validator\PropertyValidator;
 use PHPModelGenerator\ModelGenerator;
 use PHPModelGenerator\PropertyProcessor\Filter\FilterProcessor;
 use PHPModelGenerator\Utils\ArrayHash;
@@ -124,6 +126,24 @@ public function process(Schema $schema, GeneratorConfiguration $generatorConfigu
             $property->filterValidators(static function (Validator $validator): bool {
                 return !is_a($validator->getValidator(), EnumValidator::class);
             });
+
+            // if an enum value is provided the transforming filter will add a value pass through. As the filter doesn't
+            // know the exact enum type the pass through allows every UnitEnum instance. Consequently add a validator to
+            // avoid wrong enums by validating against the generated enum
+            $property->addValidator(
+                new class ($property, $enumName) extends PropertyValidator {
+                    public function __construct(PropertyInterface $property, string $enumName)
+                    {
+                        parent::__construct(
+                            $property,
+                            sprintf('$value instanceof UnitEnum && !($value instanceof %s)', $enumName),
+                            InvalidTypeException::class,
+                            [$enumName]
+                        );
+                    }
+                },
+                0
+            );
         }
     }
 
diff --git a/tests/Basic/AdditionalPropertiesTest.php b/tests/Basic/AdditionalPropertiesTest.php
@@ -203,7 +203,7 @@ public function invalidTypedAdditionalPropertiesDataProvider(): array
                 ],
                 'invalid type for additional property (object)' => [
                     ['additional1' => new stdClass(), 'additional2' => 'Hello'],
-                    sprintf($exception, 'Invalid type for additional property. Requires string, got object')
+                    sprintf($exception, 'Invalid type for additional property. Requires string, got stdClass')
                 ],
                 'empty short string' => [
                     ['additional1' => '', 'additional2' => 'Hello'],
diff --git a/tests/Basic/PatternPropertiesTest.php b/tests/Basic/PatternPropertiesTest.php
@@ -33,7 +33,8 @@ public function testTypedPatternPropertyWithInvalidInputThrowsAnException(
     ): void {
         $this->expectValidationError(
             $configuration,
-            'Invalid type for pattern property. Requires string, got ' . gettype($propertyValue)
+            'Invalid type for pattern property. Requires string, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
         );
 
         $className = $this->generateClassFromFile('TypedPatternProperty.json', $configuration);
diff --git a/tests/Objects/ArrayPropertyTest.php b/tests/Objects/ArrayPropertyTest.php
@@ -234,7 +234,8 @@ public function testInvalidPropertyTypeThrowsAnException(
     ): void {
         $this->expectValidationError(
             $configuration,
-            'Invalid type for property. Requires array, got ' . gettype($propertyValue)
+            'Invalid type for property. Requires array, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
         );
 
         $className = $this->generateClassFromFile('ArrayProperty.json', $configuration);
diff --git a/tests/Objects/BooleanPropertyTest.php b/tests/Objects/BooleanPropertyTest.php
@@ -69,7 +69,10 @@ public function validInputProvider(): array
     public function testInvalidPropertyTypeThrowsAnException($propertyValue): void
     {
         $this->expectException(ValidationException::class);
-        $this->expectExceptionMessage('Invalid type for property. Requires bool, got ' . gettype($propertyValue));
+        $this->expectExceptionMessage(
+            'Invalid type for property. Requires bool, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
+        );
 
         $className = $this->generateClassFromFile('BooleanProperty.json');
 
diff --git a/tests/Objects/EnumPropertyTest.php b/tests/Objects/EnumPropertyTest.php
@@ -119,7 +119,10 @@ public function invalidEnumEntriesDataProvider(): array
     public function testInvalidItemTypeThrowsAnException($propertyValue): void
     {
         $this->expectException(ValidationException::class);
-        $this->expectExceptionMessage('Invalid type for property. Requires string, got ' . gettype($propertyValue));
+        $this->expectExceptionMessage(
+            'Invalid type for property. Requires string, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
+        );
 
         $className = $this->generateEnumClass('string', static::ENUM_STRING);
 
diff --git a/tests/Objects/IntegerPropertyTest.php b/tests/Objects/IntegerPropertyTest.php
@@ -69,7 +69,10 @@ public function validInputProvider(): array
     public function testInvalidPropertyTypeThrowsAnException($propertyValue): void
     {
         $this->expectException(ValidationException::class);
-        $this->expectExceptionMessage('Invalid type for property. Requires int, got ' . gettype($propertyValue));
+        $this->expectExceptionMessage(
+            'Invalid type for property. Requires int, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
+        );
 
         $className = $this->generateClassFromFile('IntegerProperty.json');
 
diff --git a/tests/Objects/MultiTypePropertyTest.php b/tests/Objects/MultiTypePropertyTest.php
@@ -129,7 +129,7 @@ public function invalidValueDataProvider(): array
     {
         return [
             'Bool' => [true, 'Invalid type for property. Requires [float, string, array], got boolean'],
-            'Object' => [new stdClass(), 'Invalid type for property. Requires [float, string, array], got object'],
+            'Object' => [new stdClass(), 'Invalid type for property. Requires [float, string, array], got stdClass'],
             'Invalid int' => [9, 'Value for property must not be smaller than 10'],
             'zero' => [0, 'Value for property must not be smaller than 10'],
             'Invalid float' => [9.9, 'Value for property must not be smaller than 10'],
diff --git a/tests/Objects/NullPropertyTest.php b/tests/Objects/NullPropertyTest.php
@@ -56,7 +56,10 @@ public function testProvidedOptionalNullPropertyIsValid(): void
     public function testInvalidPropertyTypeThrowsAnException($propertyValue): void
     {
         $this->expectException(ValidationException::class);
-        $this->expectExceptionMessage('Invalid type for property. Requires null, got ' . gettype($propertyValue));
+        $this->expectExceptionMessage(
+            'Invalid type for property. Requires null, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
+        );
 
         $className = $this->generateClassFromFile('NullProperty.json');
 
diff --git a/tests/Objects/NumberPropertyTest.php b/tests/Objects/NumberPropertyTest.php
@@ -85,7 +85,10 @@ public function validInputProvider(): array
     public function testInvalidPropertyTypeThrowsAnException($propertyValue): void
     {
         $this->expectException(ValidationException::class);
-        $this->expectExceptionMessage('Invalid type for property. Requires float, got ' . gettype($propertyValue));
+        $this->expectExceptionMessage(
+            'Invalid type for property. Requires float, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
+        );
 
         $className = $this->generateClassFromFile('NumberProperty.json');
 
diff --git a/tests/Objects/StringPropertyTest.php b/tests/Objects/StringPropertyTest.php
@@ -85,7 +85,8 @@ public function testInvalidPropertyTypeThrowsAnException(
     ): void {
         $this->expectValidationError(
             $configuration,
-            'Invalid type for property. Requires string, got ' . gettype($propertyValue)
+            'Invalid type for property. Requires string, got ' .
+                (is_object($propertyValue) ? get_class($propertyValue) : gettype($propertyValue))
         );
 
         $className = $this->generateClassFromFile('StringProperty.json', $configuration);
diff --git a/tests/Objects/TupleArrayPropertyTest.php b/tests/Objects/TupleArrayPropertyTest.php
@@ -285,7 +285,7 @@ public function invalidAdditionalItemsDataProvider(): array
                 ],
                 'invalid type for additional item (object)' => [
                     [3, 'Avenue', new stdClass()],
-                    sprintf($exception, 'Invalid type for additional item. Requires string, got object')
+                    sprintf($exception, 'Invalid type for additional item. Requires string, got stdClass')
                 ],
                 'invalid type for additional item (array)' => [
                     [3, 'Avenue', [1, 2]],
diff --git a/tests/PostProcessor/EnumPostProcessorTest.php b/tests/PostProcessor/EnumPostProcessorTest.php
@@ -7,6 +7,7 @@
 use BackedEnum;
 use Exception;
 use PHPModelGenerator\Exception\Generic\EnumException;
+use PHPModelGenerator\Exception\Generic\InvalidTypeException;
 use PHPModelGenerator\Exception\Object\RequiredValueException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
@@ -39,7 +40,10 @@ public function testStringOnlyEnum(): void
         $className = $this->generateClassFromFileTemplate(
             'EnumProperty.json',
             ['["hans", "dieter"]'],
-            (new GeneratorConfiguration())->setImmutable(false)->setCollectErrors(false),
+            (new GeneratorConfiguration())
+                ->setImmutable(false)
+                ->setCollectErrors(false)
+                ->setSerialization(true),
             false
         );
 
@@ -48,6 +52,7 @@ public function testStringOnlyEnum(): void
         $object = new $className(['property' => 'hans', 'stringProperty' => 'abc']);
         $this->assertSame('hans', $object->getProperty()->value);
         $this->assertSame('abc', $object->getStringProperty());
+        $this->assertSame(['property' => 'hans', 'stringProperty' => 'abc'], $object->toArray());
 
         $object->setProperty('dieter');
         $this->assertSame('dieter', $object->getProperty()->value);
@@ -96,7 +101,7 @@ public function testStringOnlyEnum(): void
     /**
      * @requires PHP >= 8.1
      */
-    public function testInvalidStringOnlyEnumValue(): void
+    public function testInvalidStringOnlyEnumValueThrowsAnException(): void
     {
         $this->addPostProcessor();
         $className = $this->generateClassFromFileTemplate('EnumProperty.json', ['["Hans", "Dieter"]'], null, false);
@@ -108,6 +113,20 @@ public function testInvalidStringOnlyEnumValue(): void
         new $className(['property' => 'Meier']);
     }
 
+    public function testInvalidEnumThrowsAnException(): void
+    {
+        $this->addPostProcessor();
+
+        $className = $this->generateClassFromFileTemplate('EnumProperty.json', ['["Hans", "Dieter"]'], null, false);
+
+        $this->expectException(InvalidTypeException::class);
+        $this->expectExceptionMessageMatches(
+            '/Invalid type for property\. Requires EnumPostProcessorTest_.*Property, got PHPModelGenerator\\\\Tests\\\\PostProcessor\\\\IntEnum/'
+        );
+
+        new $className(['property' => IntEnum::A]);
+    }
+
     /**
      * @requires PHP >= 8.1
      */
@@ -118,7 +137,10 @@ public function testMappedStringOnlyEnum(): void
         $className = $this->generateClassFromFileTemplate(
             'EnumPropertyMapped.json',
             ['["Hans", "Dieter"]', '{"Ceo": "Hans", "Cto": "Dieter"}'],
-            (new GeneratorConfiguration())->setImmutable(false)->setCollectErrors(false),
+            (new GeneratorConfiguration())
+                ->setImmutable(false)
+                ->setCollectErrors(false)
+                ->setSerialization(true),
             false
         );
 
@@ -127,6 +149,7 @@ public function testMappedStringOnlyEnum(): void
         $object = new $className(['property' => 'Hans']);
         $this->assertSame('Hans', $object->getProperty()->value);
         $this->assertSame('Ceo', $object->getProperty()->name);
+        $this->assertSame(['property' => 'Hans'], $object->toArray());
 
         $object->setProperty('Dieter');
         $this->assertSame('Dieter', $object->getProperty()->value);
@@ -238,14 +261,18 @@ public function testIntOnlyEnum(): void
         $className = $this->generateClassFromFileTemplate(
             'EnumPropertyMapped.json',
             ['[10, 100]', '{"a": 10, "b": 100}'],
-            (new GeneratorConfiguration())->setImmutable(false)->setCollectErrors(false),
+            (new GeneratorConfiguration())
+                ->setImmutable(false)
+                ->setCollectErrors(false)
+                ->setSerialization(true),
             false
         );
 
         $this->includeGeneratedEnums(1);
 
         $object = new $className(['property' => 10]);
         $this->assertSame(10, $object->getProperty()->value);
+        $this->assertSame(['property' => 10], $object->toArray());
 
         $object->setProperty(100);
         $this->assertSame(100, $object->getProperty()->value);
@@ -301,20 +328,23 @@ public function testMixedEnum(): void
         $className = $this->generateClassFromFileTemplate(
             'EnumPropertyMapped.json',
             ['["Hans", 100, true]', '{"a": "Hans", "b": 100, "c": true}'],
-            (new GeneratorConfiguration())->setImmutable(false)->setCollectErrors(false),
+            (new GeneratorConfiguration())->setImmutable(false)->setCollectErrors(false)->setSerialization(true),
             false
         );
 
         $this->includeGeneratedEnums(1);
 
         $object = new $className(['property' => 'Hans']);
         $this->assertSame('Hans', $object->getProperty()->value());
+        $this->assertSame(['property' => 'Hans'], $object->toArray());
 
         $object->setProperty(100);
         $this->assertSame(100, $object->getProperty()->value());
+        $this->assertSame(['property' => 100], $object->toArray());
 
         $object->setProperty(null);
         $this->assertNull($object->getProperty());
+        $this->assertSame(['property' => null], $object->toArray());
 
         $returnType = $this->getReturnType($object, 'getProperty');
         $this->assertTrue($returnType->allowsNull());
@@ -575,6 +605,7 @@ public function normalizedNamesDataProvider(): array
             'numeric' => ['100', '_100'],
         ];
     }
+
     private function addPostProcessor(): void
     {
         $this->modifyModelGenerator = static function (ModelGenerator $generator): void {
diff --git a/tests/PostProcessor/IntEnum.php b/tests/PostProcessor/IntEnum.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace PHPModelGenerator\Tests\PostProcessor;
+
+enum IntEnum: int
+{
+    case A = 1;
+    case B = 2;
+}

Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ public function invalidValueDataProvider(): array`
`129`	`129`	`{`
`130`	`130`	`return [`
`131`	`131`	`'Bool' => [true, 'Invalid type for property. Requires [float, string, array], got boolean'],`
`132`		`- 'Object' => [new stdClass(), 'Invalid type for property. Requires [float, string, array], got object'],`
	`132`	`+ 'Object' => [new stdClass(), 'Invalid type for property. Requires [float, string, array], got stdClass'],`
`133`	`133`	`'Invalid int' => [9, 'Value for property must not be smaller than 10'],`
`134`	`134`	`'zero' => [0, 'Value for property must not be smaller than 10'],`
`135`	`135`	`'Invalid float' => [9.9, 'Value for property must not be smaller than 10'],`