Validate required properties which aren't defined in the properties section of a schema (fixes #44)

Author: wol-soft

docs/source/complexTypes/object.rst

@@ -158,9 +158,11 @@ Possible exceptions:
 
 * Missing required value for name
 
-.. warning::
+.. hint::
+
+    Properties defined in the `required` array but not defined in the `properties` will be added to the interface of the generated class.
 
-    Properties defined in the `required` array but not defined in the `properties` section of the object aren't validated. Consequently provided objects missing these fields may be considered valid.
+    A schema defining only the required property `example` consequently will provide the methods `getExample(): mixed` and `setExample(mixed $value): self`.
 
 Size
 ----

src/PropertyProcessor/Property/BaseProcessor.php

@@ -262,7 +262,14 @@ protected function addPropertiesToSchema(JsonSchema $propertySchema): void
             $json['dependencies'] ?? []
         );
 
-        foreach ($json['properties'] ?? [] as $propertyName => $propertyStructure) {
+        $json['properties'] = $json['properties'] ?? [];
+        // setup empty properties for required properties which aren't defined in the properties section of the schema
+        $json['properties'] += array_fill_keys(
+            array_diff($json['required'] ?? [], array_keys($json['properties'])),
+            []
+        );
+
+        foreach ($json['properties'] as $propertyName => $propertyStructure) {
             $this->schema->addProperty(
                 $propertyFactory->create(
                     $propertyMetaDataCollection,

tests/Objects/EnumPropertyTest.php

@@ -392,7 +392,13 @@ function ($item) {
 
         return $this->generateClassFromFileTemplate(
             'EnumProperty.json',
-            [$type, sprintf('[%s]', join(',', $enumValues)), $required ? 'property' : '']
+            [
+                $type,
+                str_replace("'", '"', sprintf('[%s]', join(',', $enumValues))),
+                $required ? ',"required": ["property"]' : '',
+            ],
+            null,
+            false
         );
     }
 }

tests/Objects/RequiredPropertyTest.php

@@ -26,41 +26,52 @@ class RequiredPropertyTest extends AbstractPHPModelGeneratorTest
      * @throws RenderException
      * @throws SchemaException
      */
-    public function testRequiredPropertyIsValidIfProvided(bool $implicitNull, string $propertyValue): void
+    public function testRequiredPropertyIsValidIfProvided(bool $implicitNull, string $file, string $propertyValue): void
     {
-        $className = $this->generateClassFromFile('RequiredStringProperty.json', null, false, $implicitNull);
+        $className = $this->generateClassFromFile($file, null, false, $implicitNull);
 
         $object = new $className(['property' => $propertyValue]);
         $this->assertSame($propertyValue, $object->getProperty());
     }
 
-    public function validStringPropertyValueProvider(): array
+    public function requiredDefinitionsDataProvider(): array
     {
         return $this->combineDataProvider(
             $this->implicitNullDataProvider(),
+            [
+                'Defined property' => ['RequiredStringProperty.json'],
+                'Undefined property' => ['RequiredUndefinedProperty.json'],
+            ]
+        );
+    }
+
+    public function validStringPropertyValueProvider(): array
+    {
+        return $this->combineDataProvider(
+            $this->requiredDefinitionsDataProvider(),
             [
                 'Hello' => ['Hello'],
-                'Empty string' => ['']
+                'Empty string' => [''],
             ]
         );
     }
 
     /**
-     * @dataProvider implicitNullDataProvider
+     * @dataProvider requiredDefinitionsDataProvider
      *
      * @param bool $implicitNull
      *
      * @throws FileSystemException
      * @throws RenderException
      * @throws SchemaException
      */
-    public function testNotProvidedRequiredPropertyThrowsAnException(bool $implicitNull): void
+    public function testNotProvidedRequiredPropertyThrowsAnException(bool $implicitNull, string $file): void
     {
         $this->expectException(ValidationException::class);
         $this->expectExceptionMessage("Missing required value for property");
 
         $className = $this->generateClassFromFile(
-            'RequiredStringProperty.json',
+            $file,
             (new GeneratorConfiguration())->setCollectErrors(false),
             false,
             $implicitNull
@@ -69,7 +80,6 @@ public function testNotProvidedRequiredPropertyThrowsAnException(bool $implicitN
         new $className([]);
     }
 
-
     /**
      * @dataProvider implicitNullDataProvider
      *
@@ -93,6 +103,27 @@ public function testRequiredPropertyType(bool $implicitNull): void
         $this->assertFalse($setType->allowsNull());
     }
 
+    /**
+     * @dataProvider implicitNullDataProvider
+     *
+     * @param bool $implicitNull
+     */
+    public function testUndefinedRequiredPropertyType(bool $implicitNull): void
+    {
+        $className = $this->generateClassFromFile(
+            'RequiredUndefinedProperty.json',
+            (new GeneratorConfiguration())->setImmutable(false),
+            false,
+            $implicitNull
+        );
+
+        $this->assertNull($this->getReturnType($className, 'getProperty'));
+        $this->assertSame('mixed', $this->getMethodReturnTypeAnnotation($className, 'getProperty'));
+
+        $this->assertNull($this->getParameterType($className, 'setProperty'));
+        $this->assertSame('mixed', $this->getMethodParameterTypeAnnotation($className, 'setProperty'));
+    }
+
     /**
      * @dataProvider implicitNullDataProvider
      *

tests/Schema/EnumPropertyTest/EnumProperty.json

@@ -5,6 +5,6 @@
       "type": "%s",
       "enum": %s
     }
-  },
-  "required": ["%s"]
+  }
+  %s
 }

tests/Schema/RequiredPropertyTest/RequiredUndefinedProperty.json

@@ -0,0 +1,6 @@
+{
+  "type": "object",
+  "required": [
+    "property"
+  ]
+}