Added tests for OpenAPIv3Provider

Author: wol-soft

docs/source/complexTypes/object.rst

@@ -37,7 +37,7 @@ Generated interface:
     public function setCar(?Car $name): self;
     public function getCar(): ?Car;
 
-    // class Person_Car
+    // class Car
     public function setModel(?string $name): self;
     public function getModel(): ?string;
     public function setPs(?int $name): self;

src/SchemaProvider/OpenAPIv3Provider.php

@@ -34,7 +34,9 @@ public function __construct(string $sourceFile)
             throw new SchemaException("Invalid JSON-Schema file $sourceFile");
         }
 
-        if (!isset($this->openAPIv3Spec['components']['schemas'])) {
+        if (!isset($this->openAPIv3Spec['components']['schemas']) ||
+            empty($this->openAPIv3Spec['components']['schemas'])
+        ) {
             throw new SchemaException("Open API v3 spec file $sourceFile doesn't contain any schemas to process");
         }
     }

tests/AbstractPHPModelGeneratorTest.php

@@ -2,7 +2,9 @@
 
 namespace PHPModelGenerator\Tests;
 
+use Exception;
 use FilesystemIterator;
+use PHPModelGenerator\SchemaProvider\OpenAPIv3Provider;
 use PHPModelGenerator\SchemaProvider\RecursiveDirectoryProvider;
 use PHPModelGenerator\Utils\ClassNameGenerator;
 use PHPModelGenerator\Exception\ErrorRegistryException;
@@ -52,6 +54,7 @@ public function setUp(): void
 
     /**
      * Check if the test has failed. In this case move all JSON files and generated classes in a directory for debugging
+     *
      * Additionally clear the test folder so the next test starts in an empty environment
      */
     public function tearDown(): void
@@ -105,6 +108,7 @@ private function copyExternalJSON(): void
      * @param string                      $file
      * @param GeneratorConfiguration|null $generatorConfiguration
      * @param bool                        $originalClassNames
+     * @param string                      $schemaProviderClass
      *
      * @return string
      *
@@ -115,12 +119,14 @@ private function copyExternalJSON(): void
     protected function generateClassFromFile(
         string $file,
         GeneratorConfiguration $generatorConfiguration = null,
-        bool $originalClassNames = false
+        bool $originalClassNames = false,
+        string $schemaProviderClass = RecursiveDirectoryProvider::class
     ): string {
         return $this->generateClass(
             file_get_contents(__DIR__ . '/Schema/' . $this->getStaticClassName() . '/' . $file),
             $generatorConfiguration,
-            $originalClassNames
+            $originalClassNames,
+            $schemaProviderClass
         );
     }
 
@@ -164,20 +170,23 @@ function ($item) use ($escape) {
     /**
      * Generate a class from a given JSON schema string and return the FQCN
      *
-     * @param string                 $jsonSchema
-     * @param GeneratorConfiguration $generatorConfiguration
-     * @param bool                   $originalClassNames
+     * @param string                      $jsonSchema
+     * @param GeneratorConfiguration|null $generatorConfiguration
+     * @param bool                        $originalClassNames
+     * @param string                      $schemaProviderClass
      *
      * @return string
      *
+     * @throws Exception
      * @throws FileSystemException
      * @throws RenderException
      * @throws SchemaException
      */
     protected function generateClass(
         string $jsonSchema,
         GeneratorConfiguration $generatorConfiguration = null,
-        bool $originalClassNames = false
+        bool $originalClassNames = false,
+        string $schemaProviderClass = RecursiveDirectoryProvider::class
     ): string {
         $generatorConfiguration = ($generatorConfiguration ?? (new GeneratorConfiguration())->setCollectErrors(false))
             ->setPrettyPrint(false)
@@ -213,11 +222,22 @@ public function getClassName(
             $jsonSchema = json_encode($jsonSchemaArray);
         }
 
-        file_put_contents($baseDir . DIRECTORY_SEPARATOR . $className . '.json', $jsonSchema);
+        $mainFile = $baseDir . DIRECTORY_SEPARATOR . $className . '.json';
+        file_put_contents($mainFile, $jsonSchema);
         $this->copyExternalJSON();
 
+        switch ($schemaProviderClass) {
+            case RecursiveDirectoryProvider::class:
+                $schemaProvider = new RecursiveDirectoryProvider($baseDir);
+                break;
+            case OpenAPIv3Provider::class:
+                $schemaProvider = new OpenAPIv3Provider($mainFile);
+                break;
+            default: throw new Exception("Schema provider $schemaProviderClass not supported");
+        }
+
         $generatedFiles = (new ModelGenerator($generatorConfiguration))->generateModels(
-            new RecursiveDirectoryProvider($baseDir),
+            $schemaProvider,
             $baseDir . DIRECTORY_SEPARATOR . 'Models' . DIRECTORY_SEPARATOR
         );
 

tests/Schema/OpenAPIv3ProviderTest/EmptySchemas.json

@@ -0,0 +1,6 @@
+{
+  "components": {
+    "schemas": {
+    }
+  }
+}

tests/Schema/OpenAPIv3ProviderTest/InvalidJSONSchema.json

@@ -0,0 +1,5 @@
+{
+  "components": {
+    "schemas": {
+  }
+}

tests/Schema/OpenAPIv3ProviderTest/MultipleSchemaDefinitions.json

@@ -0,0 +1,26 @@
+{
+  "components": {
+    "schemas": {
+      "OpenApiPerson": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "age": {
+            "type": "integer"
+          }
+        }
+      },
+      "OpenApiCar": {
+        "type": "object",
+        "$id": "OpenApiCarWithCustomId",
+        "properties": {
+          "ps": {
+            "type": "integer"
+          }
+        }
+      }
+    }
+  }
+}

tests/Schema/OpenAPIv3ProviderTest/NoComponents.json

@@ -0,0 +1,3 @@
+{
+  "id": "Demo"
+}

tests/Schema/OpenAPIv3ProviderTest/NoSchemas.json

@@ -0,0 +1,4 @@
+{
+  "components": {
+  }
+}

tests/SchemaProvider/OpenAPIv3ProviderTest.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace PHPModelGenerator\Tests\SchemaProvider;
+
+use PHPModelGenerator\Exception\SchemaException;
+use PHPModelGenerator\SchemaProvider\OpenAPIv3Provider;
+use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
+
+/**
+ * Class OpenAPIv3ProviderTest
+ *
+ * @package PHPModelGenerator\Tests\SchemaProvider
+ */
+class OpenAPIv3ProviderTest extends AbstractPHPModelGeneratorTest
+{
+    public function testInvalidJSONSchemaFileThrowsAnException(): void
+    {
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessageMatches('/^Invalid JSON-Schema file (.*)\.json$/');
+
+        $this->generateClassFromFile('InvalidJSONSchema.json', null, false, OpenAPIv3Provider::class);
+    }
+
+    /**
+     * @dataProvider missingSchemasDataProvider
+     */
+    public function testOpenAPIv3JSONSchemaFileWithoutSchemasThrowsAnException(string $file): void
+    {
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessageMatches(
+            "/^Open API v3 spec file (.*)\.json doesn't contain any schemas to process$/"
+        );
+
+        $this->generateClassFromFile($file, null, false, OpenAPIv3Provider::class);
+    }
+
+    public function missingSchemasDataProvider(): array
+    {
+        return [
+            'No components section defined' => ['NoComponents.json'],
+            'No schemas section defined' => ['NoSchemas.json'],
+            'Empty schemas section' => ['EmptySchemas.json'],
+        ];
+    }
+
+    public function testOpenAPIv3SchemaProvider(): void
+    {
+        $this->generateClassFromFile('MultipleSchemaDefinitions.json', null, false, OpenAPIv3Provider::class);
+
+        $person = new \OpenApiPerson(['name' => 'Hannes']);
+        $this->assertSame('Hannes', $person->getName());
+        $this->assertNull($person->getAge());
+
+        // test if the custom ID is preferred over the object key
+        $car = new \OpenApiCarWithCustomId(['ps' => 150]);
+        $this->assertSame(150, $car->getPs());
+    }
+}