test: add functional test for JsonSchema generation

Author: Maxcastel

tests/Fixtures/TestBundle/ApiResource/ChildAttribute.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource;
+
+use ApiPlatform\Metadata\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+#[ApiResource]
+class ChildAttribute
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
+    private ?int $id = null;
+
+    #[ORM\Column(length: 255)]
+    private ?string $label = null;
+
+    #[ORM\Column(length: 255)]
+    private ?string $hiddenData = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getLabel(): ?string
+    {
+        return $this->label;
+    }
+
+    public function setLabel(string $label): self
+    {
+        $this->label = $label;
+
+        return $this;
+    }
+
+    public function getHiddenData(): ?string
+    {
+        return $this->hiddenData;
+    }
+
+    public function setHiddenData(string $hiddenData): self
+    {
+        $this->hiddenData = $hiddenData;
+
+        return $this;
+    }
+}

tests/Fixtures/TestBundle/ApiResource/ParentAttribute.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+#[ApiResource(
+    operations: [
+        new Get(
+            normalizationContext: ['attributes' => ['name', 'child' => ['label']]]
+        ),
+    ]
+)]
+class ParentAttribute
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
+    private ?int $id = null;
+
+    #[ORM\Column(length: 255)]
+    private ?string $name = null;
+
+    #[ORM\Column(type: 'text')]
+    private ?string $description = null;
+
+    #[ORM\ManyToOne(targetEntity: ChildAttribute::class)]
+    private ?ChildAttribute $child = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    public function getDescription(): ?string
+    {
+        return $this->description;
+    }
+
+    public function setDescription(string $description): self
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
+    public function getChild(): ?ChildAttribute
+    {
+        return $this->child;
+    }
+
+    public function setChild(?ChildAttribute $child): self
+    {
+        $this->child = $child;
+
+        return $this;
+    }
+}

tests/Functional/JsonSchema/JsonSchemaTest.php

@@ -19,9 +19,11 @@
 use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
 use ApiPlatform\Symfony\Bundle\Test\Constraint\MatchesJsonSchema;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\AggregateRating;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\ChildAttribute;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5452\Book;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5501\BrokenDocs;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5501\Related;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\ParentAttribute;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Product;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\ResourceWithEnumProperty;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Issue5793\BagOfTests;
@@ -66,6 +68,8 @@ public static function getResources(): array
             JsonSchemaResourceRelated::class,
             Product::class,
             AggregateRating::class,
+            ParentAttribute::class,
+            ChildAttribute::class,
         ];
     }
 
@@ -223,4 +227,33 @@ public function testGenIdFalse()
         $schema = $this->schemaFactory->buildSchema(Product::class, 'jsonld', Schema::TYPE_OUTPUT, $this->operationMetadataFactory->create('_api_/json-stream-products_get_collection'));
         $this->assertThat(['member' => [['aggregateRating' => ['ratingValue' => '1.0', 'reviewCount' => 1]]]], new MatchesJsonSchema($schema));
     }
+
+    public function testSchemaWithAttributes(): void
+    {
+        $operation = $this->operationMetadataFactory->create('_api_/parent_attributes/{id}{._format}_get');
+        $context = $operation->getNormalizationContext() ?? [];
+
+        $schema = $this->schemaFactory->buildSchema(ParentAttribute::class, 'json', Schema::TYPE_OUTPUT, $operation, null, $context);
+
+        $parentDefinitionName = 'ParentAttribute-name_child.label';
+        $this->assertArrayHasKey($parentDefinitionName, $schema['definitions']);
+
+        $parentProperties = $schema['definitions'][$parentDefinitionName]['properties'];
+
+        $this->assertArrayHasKey('name', $parentProperties);
+        $this->assertArrayHasKey('child', $parentProperties);
+
+        $this->assertArrayNotHasKey('id', $parentProperties);
+        $this->assertArrayNotHasKey('description', $parentProperties);
+
+        $childDefinitionName = 'ChildAttribute-label';
+        $this->assertArrayHasKey($childDefinitionName, $schema['definitions']);
+
+        $childProperties = $schema['definitions'][$childDefinitionName]['properties'];
+
+        $this->assertArrayHasKey('label', $childProperties);
+
+        $this->assertArrayNotHasKey('hiddenData', $childProperties);
+        $this->assertArrayNotHasKey('id', $childProperties);
+    }
 }