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/DefinitionNameFactoryTest.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\SchemaFactory;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\DtoOutput;
use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Dummy;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;

final class DefinitionNameFactoryTest extends TestCase
{
    public static function providerDefinitions(): iterable
    {
        yield ['Dummy', Dummy::class, 'json'];
        yield ['Dummy.jsonapi', Dummy::class, 'jsonapi'];
        yield ['Dummy.jsonhal', Dummy::class, 'jsonhal'];
        yield ['Dummy.jsonld', Dummy::class, 'jsonld'];

        yield ['Dummy.DtoOutput', Dummy::class, 'json', DtoOutput::class];
        yield ['Dummy.DtoOutput.jsonapi', Dummy::class, 'jsonapi', DtoOutput::class];
        yield ['Dummy.DtoOutput.jsonhal', Dummy::class, 'jsonhal', DtoOutput::class];
        yield ['Dummy.DtoOutput.jsonld', Dummy::class, 'jsonld', DtoOutput::class];

        yield ['Bar', Dummy::class, 'json', null, new Get(shortName: 'Bar')];
        yield ['Bar.jsonapi', Dummy::class, 'jsonapi', null, new Get(shortName: 'Bar')];
        yield ['Bar.jsonhal', Dummy::class, 'jsonhal', null, new Get(shortName: 'Bar')];
        yield ['Bar.jsonld', Dummy::class, 'jsonld', null, new Get(shortName: 'Bar')];

        yield ['Dummy-Baz', Dummy::class, 'json', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];
        yield ['Dummy.jsonapi-Baz', Dummy::class, 'jsonapi', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];
        yield ['Dummy.jsonhal-Baz', Dummy::class, 'jsonhal', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];
        yield ['Dummy.jsonld-Baz', Dummy::class, 'jsonld', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];

        yield ['Dummy-read', Dummy::class, 'json', null, null, [AbstractNormalizer::GROUPS => ['read']]];
        yield ['Dummy.jsonapi-read', Dummy::class, 'jsonapi', null, null, [AbstractNormalizer::GROUPS => ['read']]];
        yield ['Dummy.jsonhal-read', Dummy::class, 'jsonhal', null, null, [AbstractNormalizer::GROUPS => ['read']]];
        yield ['Dummy.jsonld-read', Dummy::class, 'jsonld', null, null, [AbstractNormalizer::GROUPS => ['read']]];

        yield ['Dummy-read_write', Dummy::class, 'json', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];
        yield ['Dummy.jsonapi-read_write', Dummy::class, 'jsonapi', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];
        yield ['Dummy.jsonhal-read_write', Dummy::class, 'jsonhal', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];
        yield ['Dummy.jsonld-read_write', Dummy::class, 'jsonld', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];

        yield ['Bar.DtoOutput-read_write', Dummy::class, 'json', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];
        yield ['Bar.DtoOutput.jsonapi-read_write', Dummy::class, 'jsonapi', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];
        yield ['Bar.DtoOutput.jsonhal-read_write', Dummy::class, 'jsonhal', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];
        yield ['Bar.DtoOutput.jsonld-read_write', Dummy::class, 'jsonld', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('providerDefinitions')]
    public function testCreate(string $expected, string $className, string $format = 'json', ?string $inputOrOutputClass = null, ?Operation $operation = null, array $serializerContext = []): void
    {
        $definitionNameFactory = new DefinitionNameFactory();

        static::assertSame($expected, $definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext));
    }

    public function testCreateDifferentPrefixesForClassesWithTheSameShortName(): void
    {
        $definitionNameFactory = new DefinitionNameFactory();

        self::assertEquals(
            'DummyClass.jsonapi',
            $definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceA\Module\DummyClass::class, 'jsonapi')
        );

        self::assertEquals(
            'Module.DummyClass.jsonapi',
            $definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceB\Module\DummyClass::class, 'jsonapi')
        );

        self::assertEquals(
            'NamespaceC.Module.DummyClass.jsonapi',
            $definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceC\Module\DummyClass::class, 'jsonapi')
        );

        self::assertEquals(
            'DummyClass.jsonhal',
            $definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceA\Module\DummyClass::class, 'jsonhal')
        );
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\JsonSchema\Tests;
15
16	use ApiPlatform\JsonSchema\DefinitionNameFactory;
17	use ApiPlatform\JsonSchema\SchemaFactory;
18	use ApiPlatform\Metadata\Get;
19	use ApiPlatform\Metadata\Operation;
20	use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\DtoOutput;
21	use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Dummy;
22	use PHPUnit\Framework\TestCase;
23	use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
24
25	final class DefinitionNameFactoryTest extends TestCase
26	{
27	public static function providerDefinitions(): iterable
28	{
29	yield ['Dummy', Dummy::class, 'json'];	×
30	yield ['Dummy.jsonapi', Dummy::class, 'jsonapi'];	×
31	yield ['Dummy.jsonhal', Dummy::class, 'jsonhal'];	×
32	yield ['Dummy.jsonld', Dummy::class, 'jsonld'];	×
33
34	yield ['Dummy.DtoOutput', Dummy::class, 'json', DtoOutput::class];	×
35	yield ['Dummy.DtoOutput.jsonapi', Dummy::class, 'jsonapi', DtoOutput::class];	×
36	yield ['Dummy.DtoOutput.jsonhal', Dummy::class, 'jsonhal', DtoOutput::class];	×
37	yield ['Dummy.DtoOutput.jsonld', Dummy::class, 'jsonld', DtoOutput::class];	×
38
39	yield ['Bar', Dummy::class, 'json', null, new Get(shortName: 'Bar')];	×
40	yield ['Bar.jsonapi', Dummy::class, 'jsonapi', null, new Get(shortName: 'Bar')];	×
41	yield ['Bar.jsonhal', Dummy::class, 'jsonhal', null, new Get(shortName: 'Bar')];	×
42	yield ['Bar.jsonld', Dummy::class, 'jsonld', null, new Get(shortName: 'Bar')];	×
43
44	yield ['Dummy-Baz', Dummy::class, 'json', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];	×
45	yield ['Dummy.jsonapi-Baz', Dummy::class, 'jsonapi', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];	×
46	yield ['Dummy.jsonhal-Baz', Dummy::class, 'jsonhal', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];	×
47	yield ['Dummy.jsonld-Baz', Dummy::class, 'jsonld', null, null, [SchemaFactory::OPENAPI_DEFINITION_NAME => 'Baz']];	×
48
49	yield ['Dummy-read', Dummy::class, 'json', null, null, [AbstractNormalizer::GROUPS => ['read']]];	×
50	yield ['Dummy.jsonapi-read', Dummy::class, 'jsonapi', null, null, [AbstractNormalizer::GROUPS => ['read']]];	×
51	yield ['Dummy.jsonhal-read', Dummy::class, 'jsonhal', null, null, [AbstractNormalizer::GROUPS => ['read']]];	×
52	yield ['Dummy.jsonld-read', Dummy::class, 'jsonld', null, null, [AbstractNormalizer::GROUPS => ['read']]];	×
53
54	yield ['Dummy-read_write', Dummy::class, 'json', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
55	yield ['Dummy.jsonapi-read_write', Dummy::class, 'jsonapi', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
56	yield ['Dummy.jsonhal-read_write', Dummy::class, 'jsonhal', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
57	yield ['Dummy.jsonld-read_write', Dummy::class, 'jsonld', null, null, [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
58
59	yield ['Bar.DtoOutput-read_write', Dummy::class, 'json', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
60	yield ['Bar.DtoOutput.jsonapi-read_write', Dummy::class, 'jsonapi', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
61	yield ['Bar.DtoOutput.jsonhal-read_write', Dummy::class, 'jsonhal', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
62	yield ['Bar.DtoOutput.jsonld-read_write', Dummy::class, 'jsonld', DtoOutput::class, new Get(shortName: 'Bar'), [AbstractNormalizer::GROUPS => ['read', 'write']]];	×
63	}
64
65	#[\PHPUnit\Framework\Attributes\DataProvider('providerDefinitions')]
66	public function testCreate(string $expected, string $className, string $format = 'json', ?string $inputOrOutputClass = null, ?Operation $operation = null, array $serializerContext = []): void
67	{
NEW 68	$definitionNameFactory = new DefinitionNameFactory();	×
69
70	static::assertSame($expected, $definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext));	×
71	}
72
73	public function testCreateDifferentPrefixesForClassesWithTheSameShortName(): void
74	{
NEW 75	$definitionNameFactory = new DefinitionNameFactory();	×
76
77	self::assertEquals(	×
78	'DummyClass.jsonapi',	×
NEW 79	$definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceA\Module\DummyClass::class, 'jsonapi')	×
80	);	×
81
82	self::assertEquals(	×
83	'Module.DummyClass.jsonapi',	×
NEW 84	$definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceB\Module\DummyClass::class, 'jsonapi')	×
85	);	×
86
87	self::assertEquals(	×
88	'NamespaceC.Module.DummyClass.jsonapi',	×
NEW 89	$definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceC\Module\DummyClass::class, 'jsonapi')	×
90	);	×
91
92	self::assertEquals(	×
93	'DummyClass.jsonhal',	×
NEW 94	$definitionNameFactory->create(Fixtures\DefinitionNameFactory\NamespaceA\Module\DummyClass::class, 'jsonhal')	×
95	);	×
96	}
97	}

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