15040977736

Committed 15 May 2025 09:02AM UTC coverage: 21.754% (+13.3%) from 8.423%

Build # 15040977736

Build Type

Pull #6960

github

Committed by

web-flow

Commit Message

Merge 7a7a13526 into 1862d03b7

Pull Request Pull Request #6960: feat(json-schema): mutualize json schema between formats

Run Details

320 of 460 new or added lines in 24 files covered. (69.57%)

1863 existing lines in 109 files now uncovered.

11069 of 50882 relevant lines covered (21.75%)

29.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/JsonSchema/Tests/SchemaFactoryTest.php

<?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\JsonSchema\Tests;

use ApiPlatform\JsonSchema\DefinitionNameFactory;
use ApiPlatform\JsonSchema\Schema;
use ApiPlatform\JsonSchema\SchemaFactory;
use ApiPlatform\JsonSchema\Tests\Fixtures\ApiResource\OverriddenOperationDummy;
use ApiPlatform\JsonSchema\Tests\Fixtures\DummyResourceInterface;
use ApiPlatform\JsonSchema\Tests\Fixtures\Enum\GenderTypeEnum;
use ApiPlatform\JsonSchema\Tests\Fixtures\NotAResource;
use ApiPlatform\JsonSchema\Tests\Fixtures\NotAResourceWithUnionIntersectTypes;
use ApiPlatform\JsonSchema\Tests\Fixtures\Serializable;
use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Property\PropertyNameCollection;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use PHPUnit\Framework\Attributes\IgnoreDeprecations;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Symfony\Component\PropertyInfo\Type as LegacyType;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
use Symfony\Component\TypeInfo\Type;

class SchemaFactoryTest extends TestCase
{
    use ProphecyTrait;

    #[IgnoreDeprecations]
    public function testBuildSchemaForNonResourceClassLegacy(): void
    {
        $this->expectUserDeprecationMessage('Since api-platform/metadata 4.2: The "ApiPlatform\Metadata\ApiProperty::withBuiltinTypes()" method is deprecated, use "ApiPlatform\Metadata\ApiProperty::withNativeType()" instead.');
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(NotAResource::class, Argument::cetera())->willReturn(new PropertyNameCollection(['foo', 'bar', 'genderType']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'foo', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_STRING)])
                ->withReadable(true)
                ->withSchema(['type' => 'string'])
        );
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'bar', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_INT)])
                ->withReadable(true)
                ->withDefault('default_bar')
                ->withExample('example_bar')
                ->withSchema(['type' => 'integer', 'default' => 'default_bar', 'example' => 'example_bar'])
        );
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'genderType', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_OBJECT)])
                ->withReadable(true)
                ->withDefault('male')
                ->withSchema(['type' => 'object', 'default' => 'male', 'example' => 'male'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(NotAResource::class);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(NotAResource::class))->getShortName(), $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
        $this->assertArrayNotHasKey('additionalProperties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('foo', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertArrayNotHasKey('default', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertArrayNotHasKey('example', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['foo']['type']);
        $this->assertArrayHasKey('bar', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertArrayHasKey('default', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertArrayHasKey('example', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertSame('integer', $definitions[$rootDefinitionKey]['properties']['bar']['type']);
        $this->assertSame('default_bar', $definitions[$rootDefinitionKey]['properties']['bar']['default']);
        $this->assertSame('example_bar', $definitions[$rootDefinitionKey]['properties']['bar']['example']);

        $this->assertArrayHasKey('genderType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayHasKey('default', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayHasKey('example', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['genderType']['type']);
        $this->assertSame('male', $definitions[$rootDefinitionKey]['properties']['genderType']['default']);
        $this->assertSame('male', $definitions[$rootDefinitionKey]['properties']['genderType']['example']);
    }

    public function testBuildSchemaForNonResourceClass(): void
    {
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(NotAResource::class, Argument::cetera())->willReturn(new PropertyNameCollection(['foo', 'bar', 'genderType']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'foo', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::string())
                ->withReadable(true)
                ->withSchema(['type' => 'string'])
        );
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'bar', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::int())
                ->withReadable(true)
                ->withDefault('default_bar')
                ->withExample('example_bar')
                ->withSchema(['type' => 'integer', 'default' => 'default_bar', 'example' => 'example_bar'])
        );
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'genderType', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::object())
                ->withReadable(true)
                ->withDefault('male')
                ->withSchema(['type' => 'object', 'default' => 'male', 'example' => 'male'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(NotAResource::class);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(NotAResource::class))->getShortName(), $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
        $this->assertArrayNotHasKey('additionalProperties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('foo', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertArrayNotHasKey('default', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertArrayNotHasKey('example', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['foo']['type']);
        $this->assertArrayHasKey('bar', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertArrayHasKey('default', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertArrayHasKey('example', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertSame('integer', $definitions[$rootDefinitionKey]['properties']['bar']['type']);
        $this->assertSame('default_bar', $definitions[$rootDefinitionKey]['properties']['bar']['default']);
        $this->assertSame('example_bar', $definitions[$rootDefinitionKey]['properties']['bar']['example']);

        $this->assertArrayHasKey('genderType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayHasKey('default', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayHasKey('example', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['genderType']['type']);
        $this->assertSame('male', $definitions[$rootDefinitionKey]['properties']['genderType']['default']);
        $this->assertSame('male', $definitions[$rootDefinitionKey]['properties']['genderType']['example']);
    }

    #[IgnoreDeprecations]
    public function testBuildSchemaForNonResourceClassWithUnionIntersectTypesLegacy(): void
    {
        $this->expectUserDeprecationMessage('Since api-platform/metadata 4.2: The "ApiPlatform\Metadata\ApiProperty::withBuiltinTypes()" method is deprecated, use "ApiPlatform\Metadata\ApiProperty::withNativeType()" instead.');
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, Argument::cetera())->willReturn(new PropertyNameCollection(['ignoredProperty', 'unionType', 'intersectType']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, 'ignoredProperty', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_STRING, nullable: true)])
                ->withReadable(true)
                ->withSchema(['type' => ['string', 'null']])
        );
        $propertyMetadataFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, 'unionType', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_STRING, nullable: true), new LegacyType(LegacyType::BUILTIN_TYPE_INT, nullable: true), new LegacyType(LegacyType::BUILTIN_TYPE_FLOAT, nullable: true)])
                ->withReadable(true)
                ->withSchema(['oneOf' => [
                    ['type' => ['string', 'null']],
                    ['type' => ['integer', 'null']],
                ]])
        );
        $propertyMetadataFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, 'intersectType', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_OBJECT, class: Serializable::class), new LegacyType(LegacyType::BUILTIN_TYPE_OBJECT, class: DummyResourceInterface::class)])
                ->withReadable(true)
                ->withSchema(['type' => 'object'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(NotAResourceWithUnionIntersectTypes::class)->willReturn(false);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(NotAResourceWithUnionIntersectTypes::class);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(NotAResourceWithUnionIntersectTypes::class))->getShortName(), $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
        $this->assertArrayNotHasKey('additionalProperties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);

        $this->assertArrayHasKey('ignoredProperty', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['ignoredProperty']);
        $this->assertSame(['string', 'null'], $definitions[$rootDefinitionKey]['properties']['ignoredProperty']['type']);

        $this->assertArrayHasKey('unionType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('oneOf', $definitions[$rootDefinitionKey]['properties']['unionType']);
        $this->assertCount(2, $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf'][0]);
        $this->assertSame(['string', 'null'], $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf'][0]['type']);
        $this->assertSame(['integer', 'null'], $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf'][1]['type']);

        $this->assertArrayHasKey('intersectType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['intersectType']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['intersectType']['type']);
    }

    public function testBuildSchemaForNonResourceClassWithUnionIntersectTypes(): void
    {
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, Argument::cetera())->willReturn(new PropertyNameCollection(['ignoredProperty', 'unionType', 'intersectType']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, 'ignoredProperty', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::nullable(Type::string())) // @phpstan-ignore-line
                ->withReadable(true)
                ->withSchema(['type' => ['string', 'null']])
        );
        $propertyMetadataFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, 'unionType', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::union(Type::string(), Type::int(), Type::float(), Type::null()))
                ->withReadable(true)
                ->withSchema(['oneOf' => [
                    ['type' => ['string', 'null']],
                    ['type' => ['integer', 'null']],
                ]])
        );
        $propertyMetadataFactoryProphecy->create(NotAResourceWithUnionIntersectTypes::class, 'intersectType', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::intersection(Type::object(Serializable::class), Type::object(DummyResourceInterface::class)))
                ->withReadable(true)
                ->withSchema(['type' => 'object'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(NotAResourceWithUnionIntersectTypes::class)->willReturn(false);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(NotAResourceWithUnionIntersectTypes::class);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(NotAResourceWithUnionIntersectTypes::class))->getShortName(), $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
        $this->assertArrayNotHasKey('additionalProperties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);

        $this->assertArrayHasKey('ignoredProperty', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['ignoredProperty']);
        $this->assertSame(['string', 'null'], $definitions[$rootDefinitionKey]['properties']['ignoredProperty']['type']);

        $this->assertArrayHasKey('unionType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('oneOf', $definitions[$rootDefinitionKey]['properties']['unionType']);
        $this->assertCount(2, $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf'][0]);
        $this->assertSame(['string', 'null'], $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf'][0]['type']);
        $this->assertSame(['integer', 'null'], $definitions[$rootDefinitionKey]['properties']['unionType']['oneOf'][1]['type']);

        $this->assertArrayHasKey('intersectType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['intersectType']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['intersectType']['type']);
    }

    #[IgnoreDeprecations]
    public function testBuildSchemaWithSerializerGroupsLegacy(): void
    {
        $this->expectUserDeprecationMessage('Since api-platform/metadata 4.2: The "ApiPlatform\Metadata\ApiProperty::withBuiltinTypes()" method is deprecated, use "ApiPlatform\Metadata\ApiProperty::withNativeType()" instead.');
        $shortName = (new \ReflectionClass(OverriddenOperationDummy::class))->getShortName();
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
        $operation = (new Put())->withName('put')->withNormalizationContext([
            'groups' => 'overridden_operation_dummy_put',
            AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
        ])->withShortName($shortName)->withValidationContext(['groups' => ['validation_groups_dummy_put']]);
        $resourceMetadataFactoryProphecy->create(OverriddenOperationDummy::class)
            ->willReturn(
                new ResourceMetadataCollection(OverriddenOperationDummy::class, [
                    (new ApiResource())->withOperations(new Operations(['put' => $operation])),
                ])
            );

        $serializerGroup = 'custom_operation_dummy';

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(OverriddenOperationDummy::class, Argument::type('array'))->willReturn(new PropertyNameCollection(['alias', 'description', 'genderType']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'alias', Argument::type('array'))->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_STRING)])
                ->withReadable(true)
                ->withSchema(['type' => 'string'])
        );
        $propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'description', Argument::type('array'))->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_STRING)])
                ->withReadable(true)
                ->withSchema(['type' => 'string'])
        );
        $propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'genderType', Argument::type('array'))->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_OBJECT, false, GenderTypeEnum::class)])
                ->withReadable(true)
                ->withDefault(GenderTypeEnum::MALE)
                ->withSchema(['type' => 'object'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(OverriddenOperationDummy::class)->willReturn(true);
        $resourceClassResolverProphecy->isResourceClass(GenderTypeEnum::class)->willReturn(true);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(OverriddenOperationDummy::class, 'json', Schema::TYPE_OUTPUT, null, null, ['groups' => $serializerGroup, AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false]);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(OverriddenOperationDummy::class))->getShortName().'-'.$serializerGroup, $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
        $this->assertFalse($definitions[$rootDefinitionKey]['additionalProperties']);
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('alias', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['alias']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['alias']['type']);
        $this->assertArrayHasKey('description', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['description']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['description']['type']);
        $this->assertArrayHasKey('genderType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayNotHasKey('default', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayNotHasKey('example', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['genderType']['type']);
    }

    public function testBuildSchemaWithSerializerGroups(): void
    {
        $shortName = (new \ReflectionClass(OverriddenOperationDummy::class))->getShortName();
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
        $operation = (new Put())->withName('put')->withNormalizationContext([
            'groups' => 'overridden_operation_dummy_put',
            AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
        ])->withShortName($shortName)->withValidationContext(['groups' => ['validation_groups_dummy_put']]);
        $resourceMetadataFactoryProphecy->create(OverriddenOperationDummy::class)
            ->willReturn(
                new ResourceMetadataCollection(OverriddenOperationDummy::class, [
                    (new ApiResource())->withOperations(new Operations(['put' => $operation])),
                ])
            );

        $serializerGroup = 'custom_operation_dummy';

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(OverriddenOperationDummy::class, Argument::type('array'))->willReturn(new PropertyNameCollection(['alias', 'description', 'genderType']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'alias', Argument::type('array'))->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::string())
                ->withReadable(true)
                ->withSchema(['type' => 'string'])
        );
        $propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'description', Argument::type('array'))->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::string())
                ->withReadable(true)
                ->withSchema(['type' => 'string'])
        );
        $propertyMetadataFactoryProphecy->create(OverriddenOperationDummy::class, 'genderType', Argument::type('array'))->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::enum(GenderTypeEnum::class))
                ->withReadable(true)
                ->withDefault(GenderTypeEnum::MALE)
                ->withSchema(['type' => 'object'])
        );
        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(OverriddenOperationDummy::class)->willReturn(true);
        $resourceClassResolverProphecy->isResourceClass(GenderTypeEnum::class)->willReturn(true);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(OverriddenOperationDummy::class, 'json', Schema::TYPE_OUTPUT, null, null, ['groups' => $serializerGroup, AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false]);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(OverriddenOperationDummy::class))->getShortName().'-'.$serializerGroup, $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
        $this->assertFalse($definitions[$rootDefinitionKey]['additionalProperties']);
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('alias', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['alias']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['alias']['type']);
        $this->assertArrayHasKey('description', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['description']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['description']['type']);
        $this->assertArrayHasKey('genderType', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayNotHasKey('default', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertArrayNotHasKey('example', $definitions[$rootDefinitionKey]['properties']['genderType']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['genderType']['type']);
    }

    #[IgnoreDeprecations]
    public function testBuildSchemaForAssociativeArrayLegacy(): void
    {
        $this->expectUserDeprecationMessage('Since api-platform/metadata 4.2: The "ApiPlatform\Metadata\ApiProperty::withBuiltinTypes()" method is deprecated, use "ApiPlatform\Metadata\ApiProperty::withNativeType()" instead.');
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(NotAResource::class, Argument::cetera())->willReturn(new PropertyNameCollection(['foo', 'bar']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'foo', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_ARRAY, false, null, true, new LegacyType(LegacyType::BUILTIN_TYPE_INT), new LegacyType(LegacyType::BUILTIN_TYPE_STRING))])
                ->withReadable(true)
                ->withSchema(['type' => 'array', 'items' => ['string', 'int']])
        );
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'bar', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withBuiltinTypes([new LegacyType(LegacyType::BUILTIN_TYPE_ARRAY, false, null, true, new LegacyType(LegacyType::BUILTIN_TYPE_STRING), new LegacyType(LegacyType::BUILTIN_TYPE_STRING))])
                ->withReadable(true)
                ->withSchema(['type' => 'object', 'additionalProperties' => 'string'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(NotAResource::class);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(NotAResource::class))->getShortName(), $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('foo', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertArrayNotHasKey('additionalProperties', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertSame('array', $definitions[$rootDefinitionKey]['properties']['foo']['type']);
        $this->assertArrayHasKey('bar', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertArrayHasKey('additionalProperties', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['bar']['type']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['bar']['additionalProperties']);
    }

    public function testBuildSchemaForAssociativeArray(): void
    {
        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);

        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
        $propertyNameCollectionFactoryProphecy->create(NotAResource::class, Argument::cetera())->willReturn(new PropertyNameCollection(['foo', 'bar']));

        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'foo', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::list(Type::string()))
                ->withReadable(true)
                ->withSchema(['type' => 'array', 'items' => ['string', 'int']])
        );
        $propertyMetadataFactoryProphecy->create(NotAResource::class, 'bar', Argument::cetera())->willReturn(
            (new ApiProperty())
                ->withNativeType(Type::dict(Type::string()))
                ->withReadable(true)
                ->withSchema(['type' => 'object', 'additionalProperties' => 'string'])
        );

        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
        $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);

        $definitionNameFactory = new DefinitionNameFactory();

        $schemaFactory = new SchemaFactory(
            resourceMetadataFactory: $resourceMetadataFactoryProphecy->reveal(),
            propertyNameCollectionFactory: $propertyNameCollectionFactoryProphecy->reveal(),
            propertyMetadataFactory: $propertyMetadataFactoryProphecy->reveal(),
            resourceClassResolver: $resourceClassResolverProphecy->reveal(),
            definitionNameFactory: $definitionNameFactory,
        );
        $resultSchema = $schemaFactory->buildSchema(NotAResource::class);

        $rootDefinitionKey = $resultSchema->getRootDefinitionKey();
        $definitions = $resultSchema->getDefinitions();

        $this->assertSame((new \ReflectionClass(NotAResource::class))->getShortName(), $rootDefinitionKey);
        $this->assertTrue(isset($definitions[$rootDefinitionKey]));
        $this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
        $this->assertArrayHasKey('foo', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertArrayNotHasKey('additionalProperties', $definitions[$rootDefinitionKey]['properties']['foo']);
        $this->assertSame('array', $definitions[$rootDefinitionKey]['properties']['foo']['type']);
        $this->assertArrayHasKey('bar', $definitions[$rootDefinitionKey]['properties']);
        $this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertArrayHasKey('additionalProperties', $definitions[$rootDefinitionKey]['properties']['bar']);
        $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['bar']['type']);
        $this->assertSame('string', $definitions[$rootDefinitionKey]['properties']['bar']['additionalProperties']);
    }
}

api-platform / core / 15040977736

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous