13203378522

Committed 07 Feb 2025 03:56PM UTC coverage: 8.501% (+0.7%) from 7.837%

Build # 13203378522

Build Type

push

github

Committed by

soyuka

Commit Message

Merge 4.1

Run Details

111 of 490 new or added lines in 51 files covered. (22.65%)

5590 existing lines in 163 files now uncovered.

13345 of 156987 relevant lines covered (8.5%)

22.88 hits per line

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

0.0

/src/Metadata/Tests/Extractor/PropertyMetadataCompatibilityTest.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\Metadata\Tests\Extractor;

use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\Extractor\XmlPropertyExtractor;
use ApiPlatform\Metadata\Extractor\YamlPropertyExtractor;
use ApiPlatform\Metadata\Property\Factory\ExtractorPropertyMetadataFactory;
use ApiPlatform\Metadata\Tests\Extractor\Adapter\PropertyAdapterInterface;
use ApiPlatform\Metadata\Tests\Extractor\Adapter\XmlPropertyAdapter;
use ApiPlatform\Metadata\Tests\Extractor\Adapter\YamlPropertyAdapter;
use ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Comment;
use PHPUnit\Framework\AssertionFailedError;
use PHPUnit\Framework\TestCase;
use Symfony\Component\PropertyInfo\Type;

/**
 * Ensures XML and YAML mappings are fully compatible with ApiPlatform\Metadata\ApiProperty.
 *
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class PropertyMetadataCompatibilityTest extends TestCase
{
    private const RESOURCE_CLASS = Comment::class;
    private const PROPERTY = 'comment';
    private const FIXTURES = [
        'description' => 'Comment message',
        'readable' => true,
        'writable' => true,
        'readableLink' => true,
        'writableLink' => true,
        'default' => 'Plop',
        'deprecationReason' => 'Foo',
        'schema' => ['https://schema.org/Thing'],
        'required' => true,
        'identifier' => false,
        'example' => 'Lorem ipsum dolor sit amet',
        'fetchable' => true,
        'fetchEager' => true,
        'jsonldContext' => [
            'bar' => [
                'foo' => [
                    'bar' => 'baz',
                ],
            ],
        ],
        'openapiContext' => [
            'foo' => 'bar',
        ],
        'jsonSchemaContext' => [
            'lorem' => 'ipsum',
        ],
        'push' => true,
        'security' => 'is_granted(\'IS_AUTHENTICATED_ANONYMOUSLY\')',
        'securityPostDenormalize' => 'is_granted(\'ROLE_CUSTOM_ADMIN\')',
        'types' => ['someirischema', 'anotheririschema'],
        'builtinTypes' => ['string'],
        'initializable' => true,
        'extraProperties' => [
            'custom_property' => 'Lorem ipsum dolor sit amet',
            SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED => true,
        ],
        'iris' => ['https://schema.org/totalPrice'],
        'genId' => true,
        'uriTemplate' => '/sub-resource-get-collection',
        'property' => 'test',
        'hydra' => false,
    ];

    #[\PHPUnit\Framework\Attributes\DataProvider('getExtractors')]
    public function testValidMetadata(string $extractorClass, PropertyAdapterInterface $adapter): void
    {
        $reflClass = new \ReflectionClass(ApiProperty::class);
        $parameters = $reflClass->getConstructor()->getParameters();

        try {
            $extractor = new $extractorClass($adapter(self::RESOURCE_CLASS, self::PROPERTY, $parameters, self::FIXTURES));
            $factory = new ExtractorPropertyMetadataFactory($extractor);
            $property = $factory->create(self::RESOURCE_CLASS, self::PROPERTY);
        } catch (\Exception $exception) {
            throw new AssertionFailedError('Failed asserting that the schema is valid according to '.ApiProperty::class, 0, $exception);
        }

        $this->assertEquals($this->buildApiProperty(), $property);
    }

    public static function getExtractors(): array
    {
        return [
            [XmlPropertyExtractor::class, new XmlPropertyAdapter()],
            [YamlPropertyExtractor::class, new YamlPropertyAdapter()],
        ];
    }

    private function buildApiProperty(): ApiProperty
    {
        $property = new ApiProperty();

        foreach (self::FIXTURES as $parameter => $value) {
            if (method_exists($this, 'with'.ucfirst($parameter))) {
                $value = $this->{'with'.ucfirst($parameter)}($value, self::FIXTURES);
            }

            if (method_exists($property, 'with'.ucfirst($parameter))) {
                $property = $property->{'with'.ucfirst($parameter)}($value, self::FIXTURES);
                continue;
            }

            throw new \RuntimeException(\sprintf('Unknown ApiProperty parameter "%s".', $parameter));
        }

        return $property;
    }

    private function withBuiltinTypes(array $values, array $fixtures): array
    {
        return array_map(fn (string $builtinType): Type => new Type($builtinType), $values);
    }
}

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\Metadata\Tests\Extractor;
15
16	use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
17	use ApiPlatform\Metadata\ApiProperty;
18	use ApiPlatform\Metadata\Extractor\XmlPropertyExtractor;
19	use ApiPlatform\Metadata\Extractor\YamlPropertyExtractor;
20	use ApiPlatform\Metadata\Property\Factory\ExtractorPropertyMetadataFactory;
21	use ApiPlatform\Metadata\Tests\Extractor\Adapter\PropertyAdapterInterface;
22	use ApiPlatform\Metadata\Tests\Extractor\Adapter\XmlPropertyAdapter;
23	use ApiPlatform\Metadata\Tests\Extractor\Adapter\YamlPropertyAdapter;
24	use ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Comment;
25	use PHPUnit\Framework\AssertionFailedError;
26	use PHPUnit\Framework\TestCase;
27	use Symfony\Component\PropertyInfo\Type;
28
29	/**
30	* Ensures XML and YAML mappings are fully compatible with ApiPlatform\Metadata\ApiProperty.
31	*
32	* @author Vincent Chalamon <vincentchalamon@gmail.com>
33	*/
34	final class PropertyMetadataCompatibilityTest extends TestCase
35	{
36	private const RESOURCE_CLASS = Comment::class;
37	private const PROPERTY = 'comment';
38	private const FIXTURES = [
39	'description' => 'Comment message',
40	'readable' => true,
41	'writable' => true,
42	'readableLink' => true,
43	'writableLink' => true,
44	'default' => 'Plop',
45	'deprecationReason' => 'Foo',
46	'schema' => ['https://schema.org/Thing'],
47	'required' => true,
48	'identifier' => false,
49	'example' => 'Lorem ipsum dolor sit amet',
50	'fetchable' => true,
51	'fetchEager' => true,
52	'jsonldContext' => [
53	'bar' => [
54	'foo' => [
55	'bar' => 'baz',
56	],
57	],
58	],
59	'openapiContext' => [
60	'foo' => 'bar',
61	],
62	'jsonSchemaContext' => [
63	'lorem' => 'ipsum',
64	],
65	'push' => true,
66	'security' => 'is_granted(\'IS_AUTHENTICATED_ANONYMOUSLY\')',
67	'securityPostDenormalize' => 'is_granted(\'ROLE_CUSTOM_ADMIN\')',
68	'types' => ['someirischema', 'anotheririschema'],
69	'builtinTypes' => ['string'],
70	'initializable' => true,
71	'extraProperties' => [
72	'custom_property' => 'Lorem ipsum dolor sit amet',
73	SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED => true,
74	],
75	'iris' => ['https://schema.org/totalPrice'],
76	'genId' => true,
77	'uriTemplate' => '/sub-resource-get-collection',
78	'property' => 'test',
79	'hydra' => false,
80	];
81
82	#[\PHPUnit\Framework\Attributes\DataProvider('getExtractors')]
83	public function testValidMetadata(string $extractorClass, PropertyAdapterInterface $adapter): void
84	{
85	$reflClass = new \ReflectionClass(ApiProperty::class);	×
UNCOV 86	$parameters = $reflClass->getConstructor()->getParameters();	×
87
88	try {
89	$extractor = new $extractorClass($adapter(self::RESOURCE_CLASS, self::PROPERTY, $parameters, self::FIXTURES));	×
90	$factory = new ExtractorPropertyMetadataFactory($extractor);	×
91	$property = $factory->create(self::RESOURCE_CLASS, self::PROPERTY);	×
92	} catch (\Exception $exception) {	×
UNCOV 93	throw new AssertionFailedError('Failed asserting that the schema is valid according to '.ApiProperty::class, 0, $exception);	×
94	}
95
UNCOV 96	$this->assertEquals($this->buildApiProperty(), $property);	×
97	}
98
99	public static function getExtractors(): array
100	{
101	return [	×
102	[XmlPropertyExtractor::class, new XmlPropertyAdapter()],	×
103	[YamlPropertyExtractor::class, new YamlPropertyAdapter()],	×
UNCOV 104	];	×
105	}
106
107	private function buildApiProperty(): ApiProperty
108	{
UNCOV 109	$property = new ApiProperty();	×
110
111	foreach (self::FIXTURES as $parameter => $value) {	×
112	if (method_exists($this, 'with'.ucfirst($parameter))) {	×
UNCOV 113	$value = $this->{'with'.ucfirst($parameter)}($value, self::FIXTURES);	×
114	}
115
116	if (method_exists($property, 'with'.ucfirst($parameter))) {	×
117	$property = $property->{'with'.ucfirst($parameter)}($value, self::FIXTURES);	×
UNCOV 118	continue;	×
119	}
120
UNCOV 121	throw new \RuntimeException(\sprintf('Unknown ApiProperty parameter "%s".', $parameter));	×
122	}
123
UNCOV 124	return $property;	×
125	}
126
127	private function withBuiltinTypes(array $values, array $fixtures): array
128	{
UNCOV 129	return array_map(fn (string $builtinType): Type => new Type($builtinType), $values);	×
130	}
131	}

api-platform / core / 13203378522

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