#28253

pending completion

Build # #28253

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/73902b63fad0cf2145b1bd3cf4058d0f5e6b2692">73902b63f<a href="https://github.com/api-platform/core/commit/73902b63fad0cf2145b1bd3cf4058d0f5e6b2692">">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/e6feee7bd1437439721e5d7536a36fda88881b66">e6feee7bd</a>">e6feee7bd</a><a href="https://github.com/api-platform/core/commit/73902b63fad0cf2145b1bd3cf4058d0f5e6b2692"> into b733ebcec">b733ebcec</a>

Run Details

24 of 24 new or added lines in 9 files covered. (100.0%)

9776 of 11691 relevant lines covered (83.62%)

14.83 hits per line

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

72.0

/src/Bridge/Symfony/Bundle/Test/ApiTestCase.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 Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\BrowserKit\AbstractBrowser;
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
use Symfony\Component\HttpClient\HttpClientTrait;

/**
 * Base class for functional API tests.
 *
 * @experimental
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
abstract class ApiTestCase extends KernelTestCase
{
    use ApiTestAssertionsTrait;

    /**
     * {@inheritdoc}
     */
    protected function tearDown(): void
    {
        parent::tearDown();

        self::getClient(null);
    }

    /**
     * Creates a Client.
     *
     * @param array $kernelOptions  Options to pass to the createKernel method
     * @param array $defaultOptions Default options for the requests
     */
    protected static function createClient(array $kernelOptions = [], array $defaultOptions = []): Client
    {
        $kernel = static::bootKernel($kernelOptions);

        try {
            /**
             * @var Client
             */
            $client = $kernel->getContainer()->get('test.api_platform.client');
        } catch (ServiceNotFoundException $e) {
            if (!class_exists(AbstractBrowser::class) || !trait_exists(HttpClientTrait::class)) {
                throw new \LogicException('You cannot create the client used in functional tests if the BrowserKit and HttpClient components are not available. Try running "composer require --dev symfony/browser-kit symfony/http-client".');
            }

            throw new \LogicException('You cannot create the client used in functional tests if the "framework.test" config is not set to true.');
        }

        $client->setDefaultOptions($defaultOptions);

        self::getHttpClient($client);
        self::getClient($client->getKernelBrowser());

        return $client;
    }

    /**
     * Finds the IRI of a resource item matching the resource class and the specified criteria.
     */
    protected function findIriBy(string $resourceClass, array $criteria): ?string
    {
        $container = method_exists(static::class, 'getContainer') ? static::getContainer() : static::$container; // @phpstan-ignore-line

        if (!isset(static::$container) && !method_exists(static::class, 'getContainer')) {
            throw new \RuntimeException(sprintf('The container is not available. You must call "bootKernel()" or "createClient()" before calling "%s".', __METHOD__));
        }

        if (
            (
                !$container->has('doctrine') ||
                null === $objectManager = $container->get('doctrine')->getManagerForClass($resourceClass)
            ) &&
            (
                !$container->has('doctrine_mongodb') ||
                null === $objectManager = $container->get('doctrine_mongodb')->getManagerForClass($resourceClass)
            )
        ) {
            throw new \RuntimeException(sprintf('"%s" only supports classes managed by Doctrine ORM or Doctrine MongoDB ODM. Override this method to implement your own retrieval logic if you don\'t use those libraries.', __METHOD__));
        }

        $item = $objectManager->getRepository($resourceClass)->findOneBy($criteria);
        if (null === $item) {
            return null;
        }

        return $container->get('api_platform.iri_converter')->getIriFromItem($item);
    }
}

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 Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
17	use Symfony\Component\BrowserKit\AbstractBrowser;
18	use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
19	use Symfony\Component\HttpClient\HttpClientTrait;
20
21	/**
22	* Base class for functional API tests.
23	*
24	* @experimental
25	*
26	* @author Kévin Dunglas <dunglas@gmail.com>
27	*/
28	abstract class ApiTestCase extends KernelTestCase
29	{
30	use ApiTestAssertionsTrait;
31
32	/**
33	* {@inheritdoc}
34	*/
35	protected function tearDown(): void
36	{
37	parent::tearDown();	20✔
38
39	self::getClient(null);	20✔
40	}	20✔
41
42	/**
43	* Creates a Client.
44	*
45	* @param array $kernelOptions Options to pass to the createKernel method
46	* @param array $defaultOptions Default options for the requests
47	*/
48	protected static function createClient(array $kernelOptions = [], array $defaultOptions = []): Client
49	{
50	$kernel = static::bootKernel($kernelOptions);	18✔
51
52	try {
53	/**
54	* @var Client
55	*/
56	$client = $kernel->getContainer()->get('test.api_platform.client');	18✔
57	} catch (ServiceNotFoundException $e) {	×
58	if (!class_exists(AbstractBrowser::class) \|\| !trait_exists(HttpClientTrait::class)) {	×
59	throw new \LogicException('You cannot create the client used in functional tests if the BrowserKit and HttpClient components are not available. Try running "composer require --dev symfony/browser-kit symfony/http-client".');	×
60	}
61
62	throw new \LogicException('You cannot create the client used in functional tests if the "framework.test" config is not set to true.');	×
63	}
64
65	$client->setDefaultOptions($defaultOptions);	18✔
66
67	self::getHttpClient($client);	18✔
68	self::getClient($client->getKernelBrowser());	18✔
69
70	return $client;	18✔
71	}
72
73	/**
74	* Finds the IRI of a resource item matching the resource class and the specified criteria.
75	*/
76	protected function findIriBy(string $resourceClass, array $criteria): ?string
77	{
78	$container = method_exists(static::class, 'getContainer') ? static::getContainer() : static::$container; // @phpstan-ignore-line	1✔
79
80	if (!isset(static::$container) && !method_exists(static::class, 'getContainer')) {	1✔
81	throw new \RuntimeException(sprintf('The container is not available. You must call "bootKernel()" or "createClient()" before calling "%s".', __METHOD__));	×
82	}
83
84	if (
85	(
86	!$container->has('doctrine') \|\|	1✔
87	null === $objectManager = $container->get('doctrine')->getManagerForClass($resourceClass)	1✔
88	) &&
89	(
90	!$container->has('doctrine_mongodb') \|\|	×
91	null === $objectManager = $container->get('doctrine_mongodb')->getManagerForClass($resourceClass)	1✔
92	)
93	) {
94	throw new \RuntimeException(sprintf('"%s" only supports classes managed by Doctrine ORM or Doctrine MongoDB ODM. Override this method to implement your own retrieval logic if you don\'t use those libraries.', __METHOD__));	×
95	}
96
97	$item = $objectManager->getRepository($resourceClass)->findOneBy($criteria);	1✔
98	if (null === $item) {	1✔
99	return null;	1✔
100	}
101
102	return $container->get('api_platform.iri_converter')->getIriFromItem($item);	1✔
103	}
104	}

api-platform / core / #28253

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