#28267

pending completion

Build # #28267

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/dc04996ee9f0b6e5d4505442dc725d5b78952e94">dc04996ee<a href="https://github.com/api-platform/core/commit/dc04996ee9f0b6e5d4505442dc725d5b78952e94">">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/db027c8a34b172f0c50f8c599542ab5d70b1847b">db027c8a3</a>">db027c8a3</a><a href="https://github.com/api-platform/core/commit/dc04996ee9f0b6e5d4505442dc725d5b78952e94"> into 57ff81ffd">57ff81ffd</a>

Run Details

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

7573 of 11666 relevant lines covered (64.92%)

88.36 hits per line

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

0.0

/src/Test/DoctrineOrmFilterTestCase.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\Test;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\FilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
use Doctrine\ORM\EntityRepository;
use Doctrine\Persistence\ManagerRegistry;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @internal
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
abstract class DoctrineOrmFilterTestCase extends KernelTestCase
{
    /**
     * @var ManagerRegistry
     */
    protected $managerRegistry;

    /**
     * @var EntityRepository
     */
    protected $repository;

    /**
     * @var string
     */
    protected $resourceClass = Dummy::class;

    /**
     * @var string
     */
    protected $alias = 'o';

    /**
     * @var string
     */
    protected $filterClass;

    protected function setUp(): void
    {
        self::bootKernel();

        $this->managerRegistry = self::$kernel->getContainer()->get('doctrine');
        $this->repository = $this->managerRegistry->getManagerForClass(Dummy::class)->getRepository(Dummy::class);
    }

    /**
     * @dataProvider provideApplyTestData
     */
    public function testApply(?array $properties, array $filterParameters, string $expectedDql, array $expectedParameters = null, callable $factory = null, string $resourceClass = null)
    {
        $this->doTestApply(false, $properties, $filterParameters, $expectedDql, $expectedParameters, $factory, $resourceClass);
    }

    /**
     * @group legacy
     * @dataProvider provideApplyTestData
     */
    public function testApplyRequest(?array $properties, array $filterParameters, string $expectedDql, array $expectedParameters = null, callable $factory = null, string $resourceClass = null)
    {
        $this->doTestApply(true, $properties, $filterParameters, $expectedDql, $expectedParameters, $factory, $resourceClass);
    }

    protected function doTestApply(bool $request, ?array $properties, array $filterParameters, string $expectedDql, array $expectedParameters = null, callable $filterFactory = null, string $resourceClass = null)
    {
        if (null === $filterFactory) {
            $filterFactory = function (ManagerRegistry $managerRegistry, array $properties = null, RequestStack $requestStack = null): FilterInterface {
                $filterClass = $this->filterClass;

                return new $filterClass($managerRegistry, $requestStack, null, $properties);
            };
        }

        $requestStack = null;
        if ($request) {
            $requestStack = new RequestStack();
            $requestStack->push(Request::create('/api/dummies', 'GET', $filterParameters));
        }

        $repository = $this->repository;
        if ($resourceClass) {
            /** @var EntityRepository $repository */
            $repository = $this->managerRegistry->getManagerForClass($resourceClass)->getRepository($resourceClass);
        }
        $resourceClass = $resourceClass ?: $this->resourceClass;
        $queryBuilder = $repository->createQueryBuilder($this->alias);
        $filterCallable = $filterFactory($this->managerRegistry, $properties, $requestStack);
        $filterCallable->apply($queryBuilder, new QueryNameGenerator(), $resourceClass, null, $request ? [] : ['filters' => $filterParameters]);

        $this->assertEquals($expectedDql, $queryBuilder->getQuery()->getDQL());

        if (null === $expectedParameters) {
            return;
        }

        foreach ($expectedParameters as $parameterName => $expectedParameterValue) {
            $queryParameter = $queryBuilder->getQuery()->getParameter($parameterName);

            $this->assertNotNull($queryParameter, sprintf('Expected query parameter "%s" to be set', $parameterName));
            $this->assertEquals($expectedParameterValue, $queryParameter->getValue(), sprintf('Expected query parameter "%s" to be "%s"', $parameterName, var_export($expectedParameterValue, true)));
        }
    }

    protected function buildFilter(?array $properties = null)
    {
        return new $this->filterClass($this->managerRegistry, null, null, $properties);
    }

    abstract public function provideApplyTestData(): array;
}

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\Test;
15
16	use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\FilterInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
18	use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
19	use Doctrine\ORM\EntityRepository;
20	use Doctrine\Persistence\ManagerRegistry;
21	use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
22	use Symfony\Component\HttpFoundation\Request;
23	use Symfony\Component\HttpFoundation\RequestStack;
24
25	/**
26	* @internal
27	*
28	* @author Kévin Dunglas <dunglas@gmail.com>
29	*/
30	abstract class DoctrineOrmFilterTestCase extends KernelTestCase
31	{
32	/**
33	* @var ManagerRegistry
34	*/
35	protected $managerRegistry;
36
37	/**
38	* @var EntityRepository
39	*/
40	protected $repository;
41
42	/**
43	* @var string
44	*/
45	protected $resourceClass = Dummy::class;
46
47	/**
48	* @var string
49	*/
50	protected $alias = 'o';
51
52	/**
53	* @var string
54	*/
55	protected $filterClass;
56
57	protected function setUp(): void
58	{
59	self::bootKernel();	×
60
61	$this->managerRegistry = self::$kernel->getContainer()->get('doctrine');	×
62	$this->repository = $this->managerRegistry->getManagerForClass(Dummy::class)->getRepository(Dummy::class);	×
63	}
64
65	/**
66	* @dataProvider provideApplyTestData
67	*/
68	public function testApply(?array $properties, array $filterParameters, string $expectedDql, array $expectedParameters = null, callable $factory = null, string $resourceClass = null)
69	{
70	$this->doTestApply(false, $properties, $filterParameters, $expectedDql, $expectedParameters, $factory, $resourceClass);	×
71	}
72
73	/**
74	* @group legacy
75	* @dataProvider provideApplyTestData
76	*/
77	public function testApplyRequest(?array $properties, array $filterParameters, string $expectedDql, array $expectedParameters = null, callable $factory = null, string $resourceClass = null)
78	{
79	$this->doTestApply(true, $properties, $filterParameters, $expectedDql, $expectedParameters, $factory, $resourceClass);	×
80	}
81
82	protected function doTestApply(bool $request, ?array $properties, array $filterParameters, string $expectedDql, array $expectedParameters = null, callable $filterFactory = null, string $resourceClass = null)
83	{
84	if (null === $filterFactory) {	×
85	$filterFactory = function (ManagerRegistry $managerRegistry, array $properties = null, RequestStack $requestStack = null): FilterInterface {	×
86	$filterClass = $this->filterClass;	×
87
88	return new $filterClass($managerRegistry, $requestStack, null, $properties);	×
89	};
90	}
91
92	$requestStack = null;	×
93	if ($request) {	×
94	$requestStack = new RequestStack();	×
95	$requestStack->push(Request::create('/api/dummies', 'GET', $filterParameters));	×
96	}
97
98	$repository = $this->repository;	×
99	if ($resourceClass) {	×
100	/** @var EntityRepository $repository */
101	$repository = $this->managerRegistry->getManagerForClass($resourceClass)->getRepository($resourceClass);	×
102	}
103	$resourceClass = $resourceClass ?: $this->resourceClass;	×
104	$queryBuilder = $repository->createQueryBuilder($this->alias);	×
105	$filterCallable = $filterFactory($this->managerRegistry, $properties, $requestStack);	×
106	$filterCallable->apply($queryBuilder, new QueryNameGenerator(), $resourceClass, null, $request ? [] : ['filters' => $filterParameters]);	×
107
108	$this->assertEquals($expectedDql, $queryBuilder->getQuery()->getDQL());	×
109
110	if (null === $expectedParameters) {	×
111	return;	×
112	}
113
114	foreach ($expectedParameters as $parameterName => $expectedParameterValue) {	×
115	$queryParameter = $queryBuilder->getQuery()->getParameter($parameterName);	×
116
117	$this->assertNotNull($queryParameter, sprintf('Expected query parameter "%s" to be set', $parameterName));	×
118	$this->assertEquals($expectedParameterValue, $queryParameter->getValue(), sprintf('Expected query parameter "%s" to be "%s"', $parameterName, var_export($expectedParameterValue, true)));	×
119	}
120	}
121
122	protected function buildFilter(?array $properties = null)
123	{
124	return new $this->filterClass($this->managerRegistry, null, null, $properties);	×
125	}
126
127	abstract public function provideApplyTestData(): array;
128	}

api-platform / core / #28267

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