#26577

pending completion

Build # #26577

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/94c684f0f062a50fd6c60903d0ba627cd1714bcb">94c684f0f<a href="https://github.com/api-platform/core/commit/94c684f0f062a50fd6c60903d0ba627cd1714bcb">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/92f9aa99ff3b1de7c6dd05fe7a4f02136f08f955">92f9aa99f</a>">92f9aa99f</a><a href="https://github.com/api-platform/core/commit/94c684f0f062a50fd6c60903d0ba627cd1714bcb"> into 0d784fd1d">0d784fd1d</a>

Run Details

3 of 3 new or added lines in 1 file covered. (100.0%)

9505 of 11453 relevant lines covered (82.99%)

14.92 hits per line

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

89.19

/src/Bridge/Symfony/Bundle/Test/ApiTestAssertionsTrait.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\Core\Bridge\Symfony\Bundle\Test;

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\ArraySubset;
use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\MatchesJsonSchema;
use ApiPlatform\Core\JsonSchema\Schema;
use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface;
use PHPUnit\Framework\ExpectationFailedException;
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
use Symfony\Contracts\HttpClient\ResponseInterface;

/**
 * @see \Symfony\Bundle\FrameworkBundle\Test\WebTestAssertionsTrait
 *
 * @experimental
 */
trait ApiTestAssertionsTrait
{
    use BrowserKitAssertionsTrait;

    /**
     * Asserts that the retrieved JSON contains the specified subset.
     *
     * This method delegates to static::assertArraySubset().
     *
     * @param array|string $subset
     *
     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
     */
    public static function assertJsonContains($subset, bool $checkForObjectIdentity = true, string $message = ''): void
    {
        if (\is_string($subset)) {
            $subset = json_decode($subset, true);
        }
        if (!\is_array($subset)) {
            throw new \InvalidArgumentException('$subset must be array or string (JSON array or JSON object)');
        }

        static::assertArraySubset($subset, self::getHttpResponse()->toArray(false), $checkForObjectIdentity, $message);
    }

    /**
     * Asserts that the retrieved JSON is equal to $json.
     *
     * Both values are canonicalized before the comparison.
     *
     * @param array|string $json
     */
    public static function assertJsonEquals($json, string $message = ''): void
    {
        if (\is_string($json)) {
            $json = json_decode($json, true);
        }
        if (!\is_array($json)) {
            throw new \InvalidArgumentException('$json must be array or string (JSON array or JSON object)');
        }

        static::assertEqualsCanonicalizing($json, self::getHttpResponse()->toArray(false), $message);
    }

    /**
     * Asserts that an array has a specified subset.
     *
     * Imported from dms/phpunit-arraysubset, because the original constraint has been deprecated.
     *
     * @copyright Sebastian Bergmann <sebastian@phpunit.de>
     * @copyright Rafael Dohms <rdohms@gmail.com>
     *
     * @see https://github.com/sebastianbergmann/phpunit/issues/3494
     *
     * @param iterable $subset
     * @param iterable $array
     *
     * @throws ExpectationFailedException
     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
     * @throws \Exception
     */
    public static function assertArraySubset($subset, $array, bool $checkForObjectIdentity = false, string $message = ''): void
    {
        $constraint = new ArraySubset($subset, $checkForObjectIdentity);

        static::assertThat($array, $constraint, $message);
    }

    /**
     * @param object|array|string $jsonSchema
     */
    public static function assertMatchesJsonSchema($jsonSchema, ?int $checkMode = null, string $message = ''): void
    {
        $constraint = new MatchesJsonSchema($jsonSchema, $checkMode);

        static::assertThat(self::getHttpResponse()->toArray(false), $constraint, $message);
    }

    public static function assertMatchesResourceCollectionJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
    {
        $schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::COLLECTION, $operationName, null);

        static::assertMatchesJsonSchema($schema->getArrayCopy());
    }

    public static function assertMatchesResourceItemJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
    {
        $schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::ITEM, $operationName, null);

        static::assertMatchesJsonSchema($schema->getArrayCopy());
    }

    private static function getHttpClient(Client $newClient = null): ?Client
    {
        static $client;

        if (0 < \func_num_args()) {
            return $client = $newClient;
        }

        if (!$client instanceof Client) {
            static::fail(sprintf('A client must be set to make assertions on it. Did you forget to call "%s::createClient()"?', __CLASS__));
        }

        return $client;
    }

    private static function getHttpResponse(): ResponseInterface
    {
        if (!$response = self::getHttpClient()->getResponse()) {
            static::fail('A client must have an HTTP Response to make assertions. Did you forget to make an HTTP request?');
        }

        return $response;
    }

    private static function getSchemaFactory(): SchemaFactoryInterface
    {
        try {
            /** @var SchemaFactoryInterface $schemaFactory */
            $schemaFactory = static::$container->get('api_platform.json_schema.schema_factory');
        } catch (ServiceNotFoundException $e) {
            throw new \LogicException('You cannot use the resource JSON Schema assertions if the "api_platform.swagger.versions" config is null or empty.');
        }

        return $schemaFactory;
    }
}

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\Core\Bridge\Symfony\Bundle\Test;
15
16	use ApiPlatform\Core\Api\OperationType;
17	use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\ArraySubset;
18	use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint\MatchesJsonSchema;
19	use ApiPlatform\Core\JsonSchema\Schema;
20	use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface;
21	use PHPUnit\Framework\ExpectationFailedException;
22	use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
23	use Symfony\Contracts\HttpClient\ResponseInterface;
24
25	/**
26	* @see \Symfony\Bundle\FrameworkBundle\Test\WebTestAssertionsTrait
27	*
28	* @experimental
29	*/
30	trait ApiTestAssertionsTrait
31	{
32	use BrowserKitAssertionsTrait;
33
34	/**
35	* Asserts that the retrieved JSON contains the specified subset.
36	*
37	* This method delegates to static::assertArraySubset().
38	*
39	* @param array\|string $subset
40	*
41	* @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
42	* @throws \Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface
43	* @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
44	* @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
45	* @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
46	*/
47	public static function assertJsonContains($subset, bool $checkForObjectIdentity = true, string $message = ''): void
48	{
49	if (\is_string($subset)) {	4✔
50	$subset = json_decode($subset, true);	2✔
51	}
52	if (!\is_array($subset)) {	4✔
53	throw new \InvalidArgumentException('$subset must be array or string (JSON array or JSON object)');	1✔
54	}
55
56	static::assertArraySubset($subset, self::getHttpResponse()->toArray(false), $checkForObjectIdentity, $message);	3✔
57	}	3✔
58
59	/**
60	* Asserts that the retrieved JSON is equal to $json.
61	*
62	* Both values are canonicalized before the comparison.
63	*
64	* @param array\|string $json
65	*/
66	public static function assertJsonEquals($json, string $message = ''): void
67	{
68	if (\is_string($json)) {	4✔
69	$json = json_decode($json, true);	2✔
70	}
71	if (!\is_array($json)) {	4✔
72	throw new \InvalidArgumentException('$json must be array or string (JSON array or JSON object)');	1✔
73	}
74
75	static::assertEqualsCanonicalizing($json, self::getHttpResponse()->toArray(false), $message);	3✔
76	}	3✔
77
78	/**
79	* Asserts that an array has a specified subset.
80	*
81	* Imported from dms/phpunit-arraysubset, because the original constraint has been deprecated.
82	*
83	* @copyright Sebastian Bergmann <sebastian@phpunit.de>
84	* @copyright Rafael Dohms <rdohms@gmail.com>
85	*
86	* @see https://github.com/sebastianbergmann/phpunit/issues/3494
87	*
88	* @param iterable $subset
89	* @param iterable $array
90	*
91	* @throws ExpectationFailedException
92	* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
93	* @throws \Exception
94	*/
95	public static function assertArraySubset($subset, $array, bool $checkForObjectIdentity = false, string $message = ''): void
96	{
97	$constraint = new ArraySubset($subset, $checkForObjectIdentity);	5✔
98
99	static::assertThat($array, $constraint, $message);	5✔
100	}	4✔
101
102	/**
103	* @param object\|array\|string $jsonSchema
104	*/
105	public static function assertMatchesJsonSchema($jsonSchema, ?int $checkMode = null, string $message = ''): void
106	{
107	$constraint = new MatchesJsonSchema($jsonSchema, $checkMode);	4✔
108
109	static::assertThat(self::getHttpResponse()->toArray(false), $constraint, $message);	4✔
110	}	4✔
111
112	public static function assertMatchesResourceCollectionJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
113	{
114	$schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::COLLECTION, $operationName, null);	1✔
115
116	static::assertMatchesJsonSchema($schema->getArrayCopy());	1✔
117	}	1✔
118
119	public static function assertMatchesResourceItemJsonSchema(string $resourceClass, ?string $operationName = null, string $format = 'jsonld'): void
120	{
121	$schema = self::getSchemaFactory()->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, OperationType::ITEM, $operationName, null);	1✔
122
123	static::assertMatchesJsonSchema($schema->getArrayCopy());	1✔
124	}	1✔
125
126	private static function getHttpClient(Client $newClient = null): ?Client
127	{
128	static $client;	17✔
129
130	if (0 < \func_num_args()) {	17✔
131	return $client = $newClient;	17✔
132	}
133
134	if (!$client instanceof Client) {	8✔
135	static::fail(sprintf('A client must be set to make assertions on it. Did you forget to call "%s::createClient()"?', __CLASS__));	×
136	}
137
138	return $client;	8✔
139	}
140
141	private static function getHttpResponse(): ResponseInterface
142	{
143	if (!$response = self::getHttpClient()->getResponse()) {	8✔
144	static::fail('A client must have an HTTP Response to make assertions. Did you forget to make an HTTP request?');	×
145	}
146
147	return $response;	8✔
148	}
149
150	private static function getSchemaFactory(): SchemaFactoryInterface
151	{
152	try {
153	/** @var SchemaFactoryInterface $schemaFactory */
154	$schemaFactory = static::$container->get('api_platform.json_schema.schema_factory');	2✔
155	} catch (ServiceNotFoundException $e) {	×
156	throw new \LogicException('You cannot use the resource JSON Schema assertions if the "api_platform.swagger.versions" config is null or empty.');	×
157	}
158
159	return $schemaFactory;	2✔
160	}
161	}

api-platform / core / #26577

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