Add static generation strategy (#122)

Author: cschindl

README.md

@@ -22,12 +22,12 @@ composer require --dev canvural/php-openapi-faker
 
 ## Usage
 
-First you need to create an instance of `OpenAPIFaker` with your schema that you want to fake data from.
+First you need to create an instance of `OpenAPIFaker` with your schema that you want to fake data from. You can use `createFromJson`, `createFromYaml` or `createFromSchema` to create an instance of `OpenAPIFaker`.
 ```php
 $faker = \Vural\OpenAPIFaker\OpenAPIFaker::createFromJson($yourSchemaAsJson);
 ```
 
-Then you can use `mockResponse`, `mockRequest` and `mockSchema` methods on it to generate fake data for your requests, responses and schemas. Like so:
+Then you can use `mockResponse`, `mockResponseForExample`, `mockRequest`, `mockRequestForExample` and `mockComponentSchema` methods on it to generate fake data for your requests, responses and schemas. Like so:
 
 ```php
 $fakeData = $faker->mockResponse('/todos','GET');
@@ -54,6 +54,10 @@ Override `maxItems` if it's greater than this value.
 
 If enabled, every property or item will be generated regardless if they are required or not. **Default**: `false`
 
+### `strategy`
+By default, `OpenAPIFaker` uses a dynamic generation strategy. You can enable the static examples generation by using the `static` strategy.
+**Default**: `dynamic`
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

composer.json

@@ -51,11 +51,23 @@
         "sort-packages": true
     },
     "scripts": {
+        "check": [
+            "@codestyle",
+            "@phpstan",
+            "@test"
+        ],
+        "ci:check": [
+            "@codestyle",
+            "@phpstan",
+            "@test-coverage",
+            "@test-mutation"
+        ],
         "codestyle": "vendor/bin/phpcs",
         "phpstan": "vendor/bin/phpstan analyse --ansi",
         "test": "vendor/bin/phpunit",
-        "test-coverage": "vendor/bin/phpunit --coverage-clover=.build/phpunit/clover.xml",
+        "test-coverage": "vendor/bin/phpunit --coverage-clover=.build/phpunit/clover.xml --coverage-html=.build/phpunit",
         "test-fast": "vendor/bin/phpunit --color=always --exclude Integration",
+        "test-fast-coverage": "vendor/bin/phpunit --exclude Integration --coverage-clover=.build/phpunit/clover.xml --coverage-html=.build/phpunit",
         "test-mutation": "vendor/bin/infection --ignore-msi-with-no-mutations --min-covered-msi=89 --min-msi=89"
     }
 }

infection.json.dist

@@ -10,7 +10,11 @@
     "mutators": {
         "@default": true,
         "global-ignore": [
-            "Vural\\OpenAPIFaker\\SchemaFaker\\BooleanFaker"
+            "Vural\\OpenAPIFaker\\SchemaFaker\\BooleanFaker",
+            "Vural\\OpenAPIFaker\\Utils\\RegexUtils::generateSample",
+            "Vural\\OpenAPIFaker\\Utils\\StringUtils::convertToBinary",
+            "Vural\\OpenAPIFaker\\Utils\\StringUtils::ensureLength",
+            "Vural\\OpenAPIFaker\\Utils\\NumberUtils::ensureRange"
         ],
         "LessThan": {
             "ignore": [
@@ -24,9 +28,34 @@
         },
         "CastInt": {
             "ignore": [
-                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generate"
+                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generateDynamic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generateStatic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generateStaticFromFormat"
+            ]
+        },
+        "CastFloat": {
+            "ignore": [
+                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generateDynamic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generateStatic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\NumberFaker::generateStaticFromFormat"
+            ]
+        },
+        "IncrementInteger": {
+            "ignore": [
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateStatic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateDynamic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateStaticFromFormat",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateDynamicFromFormat"
+            ]
+        },
+        "DecrementInteger": {
+            "ignore": [
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateStatic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateDynamic",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateStaticFromFormat",
+                "Vural\\OpenAPIFaker\\SchemaFaker\\StringFaker::generateDynamicFromFormat"
             ]
         }
     },
-    "timeout": 20
+    "timeout": 5
 }

phpstan-baseline.neon

@@ -2,16 +2,15 @@ parameters:
 	ignoreErrors:
 		-
 			message: "#^Parameter \\#1 \\$schema of class Vural\\\\OpenAPIFaker\\\\SchemaFaker\\\\SchemaFaker constructor expects cebe\\\\openapi\\\\spec\\\\Schema, cebe\\\\openapi\\\\spec\\\\Reference\\|cebe\\\\openapi\\\\spec\\\\Schema\\|null given\\.$#"
-			count: 2
-			path: src/OpenAPIFaker.php
-
+			count: 1
+			path: src/SchemaFaker/RequestFaker.php
+		
 		-
 			message: "#^Parameter \\#1 \\$schema of class Vural\\\\OpenAPIFaker\\\\SchemaFaker\\\\SchemaFaker constructor expects cebe\\\\openapi\\\\spec\\\\Schema, cebe\\\\openapi\\\\spec\\\\Reference\\|cebe\\\\openapi\\\\spec\\\\Schema\\|null given\\.$#"
 			count: 1
-			path: src/SchemaFaker/ArrayFaker.php
+			path: src/SchemaFaker/ResponseFaker.php
 
 		-
-			message: "#^Parameter \\#1 \\$schema of class Vural\\\\OpenAPIFaker\\\\SchemaFaker\\\\SchemaFaker constructor expects cebe\\\\openapi\\\\spec\\\\Schema, cebe\\\\openapi\\\\spec\\\\Reference\\|cebe\\\\openapi\\\\spec\\\\Schema given\\.$#"
+			message: "#^Parameter \\#1 \\$schema of class Vural\\\\OpenAPIFaker\\\\SchemaFaker\\\\SchemaFaker constructor expects cebe\\\\openapi\\\\spec\\\\Schema, cebe\\\\openapi\\\\spec\\\\Reference\\|cebe\\\\openapi\\\\spec\\\\Schema\\|null given\\.$#"
 			count: 1
-			path: src/SchemaFaker/ObjectFaker.php
-
+			path: src/SchemaFaker/ArrayFaker.php

src/Exception/NoExample.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vural\OpenAPIFaker\Exception;
+
+use Exception;
+
+use function Safe\sprintf;
+
+class NoExample extends Exception
+{
+    protected string $example;
+
+    public static function forRequest(string $example): self
+    {
+        $e          = new self(sprintf('OpenAPI spec does not have a example "%s" request', $example));
+        $e->example = $example;
+
+        return $e;
+    }
+
+    public static function forResponse(string $example): self
+    {
+        $e          = new self(sprintf('OpenAPI spec does not have a example "%s" response', $example));
+        $e->example = $example;
+
+        return $e;
+    }
+}

src/OpenAPIFaker.php

@@ -14,10 +14,13 @@
 use cebe\openapi\spec\Schema;
 use Exception;
 use League\OpenAPIValidation\PSR7 as LeagueOpenAPI;
+use Vural\OpenAPIFaker\Exception\NoExample;
 use Vural\OpenAPIFaker\Exception\NoPath;
 use Vural\OpenAPIFaker\Exception\NoRequest;
 use Vural\OpenAPIFaker\Exception\NoResponse;
 use Vural\OpenAPIFaker\Exception\NoSchema;
+use Vural\OpenAPIFaker\SchemaFaker\RequestFaker;
+use Vural\OpenAPIFaker\SchemaFaker\ResponseFaker;
 use Vural\OpenAPIFaker\SchemaFaker\SchemaFaker;
 
 use function array_key_exists;
@@ -59,6 +62,14 @@ public static function createFromYaml(string $yaml): self
         return $instance;
     }
 
+    public static function createFromSchema(OpenApi $schema): self
+    {
+        $instance                = new static();
+        $instance->openAPISchema = $schema;
+
+        return $instance;
+    }
+
     /**
      * @throws NoPath
      * @throws NoRequest
@@ -68,21 +79,25 @@ public function mockRequest(
         string $method,
         string $contentType = 'application/json',
     ): mixed {
-        $operation = $this->findOperation($path, $method);
+        $content = $this->findContentForRequest($path, $method, $contentType);
 
-        if ($operation->requestBody === null) {
-            throw NoRequest::forPathAndMethod($path, $method);
-        }
-
-        /** @var RequestBody $requestBody */
-        $requestBody = $operation->requestBody;
-        $contents    = $requestBody->content;
+        return (new RequestFaker($content, $this->options))->generate();
+    }
 
-        if (! array_key_exists($contentType, $contents)) {
-            throw NoRequest::forPathAndMethodAndContentType($path, $method, $contentType);
-        }
+    /**
+     * @throws NoPath
+     * @throws NoRequest
+     * @throws NoExample
+     */
+    public function mockRequestForExample(
+        string $path,
+        string $method,
+        string $exampleName,
+        string $contentType = 'application/json',
+    ): mixed {
+        $content = $this->findContentForRequest($path, $method, $contentType);
 
-        return (new SchemaFaker($contents[$contentType]->schema, $this->options, true))->generate();
+        return (new RequestFaker($content, $this->options))->generate($exampleName);
     }
 
     /**
@@ -95,28 +110,26 @@ public function mockResponse(
         string $statusCode = '200',
         string $contentType = 'application/json',
     ): mixed {
-        $operation = $this->findOperation($path, $method);
-
-        if ($operation->responses === null) {
-            throw NoResponse::forPathAndMethod($path, $method);
-        }
-
-        if (! $operation->responses->hasResponse($statusCode)) {
-            throw NoResponse::forPathAndMethodAndStatusCode($path, $method, $statusCode);
-        }
+        $content = $this->findContentForResponse($path, $method, $statusCode, $contentType);
 
-        /** @var Response $response */
-        $response = $operation->responses->getResponse($statusCode);
-        $contents = $response->content;
-
-        if (! array_key_exists($contentType, $contents)) {
-            throw NoResponse::forPathAndMethodAndStatusCode($path, $method, $statusCode);
-        }
+        return (new ResponseFaker($content, $this->options))->generate();
+    }
 
-        /** @var MediaType $content */
-        $content = $contents[$contentType];
+    /**
+     * @throws NoPath
+     * @throws NoResponse
+     * @throws NoExample
+     */
+    public function mockResponseForExample(
+        string $path,
+        string $method,
+        string $exampleName,
+        string $statusCode = '200',
+        string $contentType = 'application/json',
+    ): mixed {
+        $content = $this->findContentForResponse($path, $method, $statusCode, $contentType);
 
-        return (new SchemaFaker($content->schema, $this->options))->generate();
+        return (new ResponseFaker($content, $this->options))->generate($exampleName);
     }
 
     /** @throws Exception */
@@ -136,7 +149,7 @@ public function mockComponentSchema(string $schemaName): mixed
         return (new SchemaFaker($schema, $this->options))->generate();
     }
 
-    /** @param array{minItems?:?int, maxItems?:?int, alwaysFakeOptionals?:bool} $options */
+    /** @param array{minItems?:?int, maxItems?:?int, alwaysFakeOptionals?:bool, strategy?:string} $options */
     public function setOptions(array $options): self
     {
         foreach ($options as $key => $value) {
@@ -162,4 +175,67 @@ private function findOperation(string $path, string $method): Operation
 
         return $operation;
     }
+
+    /**
+     * @throws NoPath
+     * @throws NoRequest
+     */
+    private function findContentForRequest(
+        string $path,
+        string $method,
+        string $contentType = 'application/json',
+    ): MediaType {
+        $operation = $this->findOperation($path, $method);
+
+        if ($operation->requestBody === null) {
+            throw NoRequest::forPathAndMethod($path, $method);
+        }
+
+        /** @var RequestBody $requestBody */
+        $requestBody = $operation->requestBody;
+        $contents    = $requestBody->content;
+
+        if (! array_key_exists($contentType, $contents)) {
+            throw NoRequest::forPathAndMethodAndContentType($path, $method, $contentType);
+        }
+
+        /** @var MediaType $content */
+        $content = $contents[$contentType];
+
+        return $content;
+    }
+
+    /**
+     * @throws NoPath
+     * @throws NoResponse
+     */
+    private function findContentForResponse(
+        string $path,
+        string $method,
+        string $statusCode = '200',
+        string $contentType = 'application/json',
+    ): MediaType {
+        $operation = $this->findOperation($path, $method);
+
+        if ($operation->responses === null) {
+            throw NoResponse::forPathAndMethod($path, $method);
+        }
+
+        if (! $operation->responses->hasResponse($statusCode)) {
+            throw NoResponse::forPathAndMethodAndStatusCode($path, $method, $statusCode);
+        }
+
+        /** @var Response $response */
+        $response = $operation->responses->getResponse($statusCode);
+        $contents = $response->content;
+
+        if (! array_key_exists($contentType, $contents)) {
+            throw NoResponse::forPathAndMethodAndStatusCode($path, $method, $statusCode);
+        }
+
+        /** @var MediaType $content */
+        $content = $contents[$contentType];
+
+        return $content;
+    }
 }