Added support for readonly/writeonly properties

Author: lvoogd-infopact

Diff for: src/OpenAPIFaker.php

@@ -84,7 +84,7 @@ public function mockRequest(
             throw NoRequest::forPathAndMethodAndContentType($path, $method, $contentType);
         }
 
-        return (new SchemaFaker($contents[$contentType]->schema, $this->options))->generate();
+        return (new SchemaFaker($contents[$contentType]->schema, $this->options, true))->generate();
     }
 
     /**

Diff for: src/SchemaFaker/ObjectFaker.php

@@ -22,7 +22,7 @@ final class ObjectFaker
     /**
      * @return array<mixed>
      */
-    public static function generate(Schema $schema, Options $options): array
+    public static function generate(Schema $schema, Options $options, bool $request = false): array
     {
         $result = [];
 
@@ -33,6 +33,12 @@ public static function generate(Schema $schema, Options $options): array
         $allPropertyKeys = array_merge($requiredKeys, $selectedOptionalKeys);
 
         foreach ($schema->properties as $key => $property) {
+            if ($property instanceof Schema) {
+                if (($request && $property->readOnly) || (! $request && $property->writeOnly)) {
+                    continue;
+                }
+            }
+
             if (! $options->getAlwaysFakeOptionals() && ! in_array($key, $allPropertyKeys, true)) {
                 continue;
             }

Diff for: src/SchemaFaker/SchemaFaker.php

@@ -23,12 +23,14 @@ final class SchemaFaker
 {
     private Schema $schema;
     private Options $options;
+    private bool $request;
 
-    public function __construct(Schema $schema, Options $options)
+    public function __construct(Schema $schema, Options $options, bool $request = false)
     {
         $schemaData    = json_decode(json_encode($schema->getSerializableData()), true);
         $this->schema  = new Schema($this->resolveOfConstraints($schemaData));
         $this->options = $options;
+        $this->request = $request;
     }
 
     /**
@@ -41,7 +43,7 @@ public function generate()
         }
 
         if ($this->schema->type === 'object') {
-            return ObjectFaker::generate($this->schema, $this->options);
+            return ObjectFaker::generate($this->schema, $this->options, $this->request);
         }
 
         if ($this->schema->type === 'string') {

Diff for: tests/Unit/SchemaFaker/ObjectFakerTest.php

@@ -135,4 +135,64 @@ function it_can_fake_all_properties_if_always_fake_optionals_option_is_set()
 
         $this->assertMatchesJsonSnapshot($fakeData);
     }
+
+    /** @test */
+    function it_does_not_inlcude_readonly_properties_when_type_is_request()
+    {
+        $yaml = <<<YAML
+type: object
+properties:
+  id:
+    type: integer
+    readOnly: true
+  username:
+    type: string
+  password:
+    type: string
+    writeOnly: true
+required:
+  - id
+  - username
+  - password
+YAML;
+
+        $fakeData = ObjectFaker::generate(SchemaFactory::fromYaml($yaml), $this->options, true);
+
+        self::assertIsArray($fakeData);
+        self::assertArrayNotHasKey('id', $fakeData);
+        self::assertArrayHasKey('username', $fakeData);
+        self::assertArrayHasKey('password', $fakeData);
+
+        $this->assertMatchesJsonSnapshot($fakeData);
+    }
+
+    /** @test */
+    function it_does_not_inlcude_writeonly_properties_when_type_is_response()
+    {
+        $yaml = <<<YAML
+type: object
+properties:
+  id:
+    type: integer
+    readOnly: true
+  username:
+    type: string
+  password:
+    type: string
+    writeOnly: true
+required:
+  - id
+  - username
+  - password
+YAML;
+
+        $fakeData = ObjectFaker::generate(SchemaFactory::fromYaml($yaml), $this->options);
+
+        self::assertIsArray($fakeData);
+        self::assertArrayHasKey('id', $fakeData);
+        self::assertArrayHasKey('username', $fakeData);
+        self::assertArrayNotHasKey('password', $fakeData);
+
+        $this->assertMatchesJsonSnapshot($fakeData);
+    }
 }

Diff for: tests/Unit/SchemaFaker/__snapshots__/ObjectFakerTest__it_does_not_inlcude_readonly_properties_when_type_is_request__1.json

@@ -0,0 +1,4 @@
+{
+    "username": "laborum",
+    "password": "in"
+}

Diff for: tests/Unit/SchemaFaker/__snapshots__/ObjectFakerTest__it_does_not_inlcude_writeonly_properties_when_type_is_response__1.json

@@ -0,0 +1,4 @@
+{
+    "id": 488690146,
+    "username": "in"
+}