[ApiTestCase] Add a helper method to find the IRI of a resource (#3085)

* [ApiTestCase] Add an helper method to find the IRI of a resource

* MongoDB support

* Better implem

* Update src/Bridge/Symfony/Bundle/Test/ApiTestCase.php

Co-Authored-By: Teoh Han Hui <[email protected]>

* Update src/Bridge/Symfony/Bundle/Test/ApiTestCase.php

Co-Authored-By: Teoh Han Hui <[email protected]>

* Better error message

* Review

* Update src/Bridge/Symfony/Bundle/Test/ApiTestCase.php

Co-Authored-By: Teoh Han Hui <[email protected]>

* Review

Author: dunglas

phpstan.neon.dist

@@ -85,6 +85,9 @@ parameters:
 		-
 			message: '#Service "api_platform\.json_schema\.schema_factory" is private\.#'
 			path: %currentWorkingDirectory%/src/Bridge/Symfony/Bundle/Test/ApiTestAssertionsTrait.php
+		-
+			message: '#Service "api_platform.iri_converter" is private\.#'
+			path:  %currentWorkingDirectory%/src/Bridge/Symfony/Bundle/Test/ApiTestCase.php
 
 		# Expected, due to optional interfaces
 		- '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryCollectionExtensionInterface::applyToCollection\(\) invoked with 5 parameters, 3-4 required\.#'

src/Bridge/Symfony/Bundle/Test/ApiTestCase.php

@@ -69,4 +69,34 @@ protected static function createClient(array $kernelOptions = [], array $default
 
         return $client;
     }
+
+    /**
+     * Finds the IRI of a resource item macthing the resource class and the specified criteria.
+     */
+    protected function findIriBy(string $resourceClass, array $criteria): ?string
+    {
+        if (null === static::$container) {
+            throw new \RuntimeException(sprintf('The container is not available. You must call "bootKernel()" or "createClient()" before calling "%s".', __METHOD__));
+        }
+
+        if (
+            (
+                !static::$container->has('doctrine') ||
+                null === $objectManager = static::$container->get('doctrine')->getManagerForClass($resourceClass)
+            ) &&
+            (
+                !static::$container->has('doctrine_mongodb') ||
+                null === $objectManager = static::$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 static::$container->get('api_platform.iri_converter')->getIriFromItem($item);
+    }
 }

tests/Bridge/Symfony/Bundle/Test/ApiTestCaseTest.php

@@ -14,7 +14,11 @@
 namespace ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test;
 
 use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Dummy as DummyDocument;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Model\ResourceInterface;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\SchemaTool;
 use PHPUnit\Framework\ExpectationFailedException;
 use PHPUnit\Runner\Version;
 
@@ -153,4 +157,31 @@ public function testAssertArraySubsetDoesNothingForValidScenario(): void
 
         $this->assertArraySubset([1, 2], [1, 2, 3]);
     }
+
+    public function testFindIriBy(): void
+    {
+        self::bootKernel();
+        /**
+         * @var EntityManagerInterface
+         */
+        $manager = self::$container->get('doctrine')->getManager();
+        $classes = $manager->getMetadataFactory()->getAllMetadata();
+        $schemaTool = new SchemaTool($manager);
+
+        $schemaTool->dropSchema($classes);
+        $schemaTool->createSchema($classes);
+
+        self::createClient()->request('POST', '/dummies', [
+            'headers' => [
+                'content-type' => 'application/json',
+                'accept' => 'text/xml',
+            ],
+            'body' => '{"name": "Kevin"}',
+        ]);
+        $this->assertResponseIsSuccessful();
+
+        $resource = 'mongodb' === self::$container->getParameter('kernel.environment') ? DummyDocument::class : Dummy::class;
+        $this->assertRegExp('~^/dummies/\d+~', self::findIriBy($resource, ['name' => 'Kevin']));
+        $this->assertNull(self::findIriBy($resource, ['name' => 'not-exist']));
+    }
 }