Merge branch '1.3' of ezsystems/ezplatform-kernel into 4.2

src/contracts/Test/IbexaKernelTestCase.php

@@ -8,32 +8,15 @@
 
 namespace Ibexa\Contracts\Core\Test;
 
-use Doctrine\DBAL\Connection;
-use Ibexa\Contracts\Core\Persistence\TransactionHandler;
-use Ibexa\Contracts\Core\Repository\ContentService;
-use Ibexa\Contracts\Core\Repository\ContentTypeService;
-use Ibexa\Contracts\Core\Repository\LanguageService;
-use Ibexa\Contracts\Core\Repository\LocationService;
-use Ibexa\Contracts\Core\Repository\ObjectStateService;
-use Ibexa\Contracts\Core\Repository\PermissionResolver;
-use Ibexa\Contracts\Core\Repository\RoleService;
-use Ibexa\Contracts\Core\Repository\SearchService;
-use Ibexa\Contracts\Core\Repository\SectionService;
-use Ibexa\Contracts\Core\Repository\UserService;
-use Ibexa\Contracts\Core\Test\Persistence\Fixture\FixtureImporter;
-use Ibexa\Core\Repository\Values\User\UserReference;
-use Ibexa\Tests\Core\Repository\LegacySchemaImporter;
 use LogicException;
-use RuntimeException;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 
 /**
  * @experimental
  */
 abstract class IbexaKernelTestCase extends KernelTestCase
 {
-    private const FIXTURE_USER_ADMIN_ID = 14;
-    private const FIXTURE_USER_ANONYMOUS_ID = 10;
+    use IbexaKernelTestTrait;
 
     protected static function getKernelClass(): string
     {
@@ -43,147 +26,4 @@ protected static function getKernelClass(): string
             return IbexaTestKernel::class;
         }
     }
-
-    final protected static function loadSchema(): void
-    {
-        $schemaImporter = self::getContainer()->get(LegacySchemaImporter::class);
-        foreach (static::getSchemaFiles() as $schemaFile) {
-            $schemaImporter->importSchema($schemaFile);
-        }
-    }
-
-    /**
-     * @return iterable<string>
-     */
-    protected static function getSchemaFiles(): iterable
-    {
-        yield from self::$kernel->getSchemaFiles();
-    }
-
-    final protected static function loadFixtures(): void
-    {
-        $fixtureImporter = self::getContainer()->get(FixtureImporter::class);
-        foreach (static::getFixtures() as $fixture) {
-            $fixtureImporter->import($fixture);
-        }
-
-        static::postLoadFixtures();
-    }
-
-    protected static function postLoadFixtures(): void
-    {
-    }
-
-    /**
-     * @return iterable<\Ibexa\Contracts\Core\Test\Persistence\Fixture>
-     */
-    protected static function getFixtures(): iterable
-    {
-        yield from self::$kernel->getFixtures();
-    }
-
-    /**
-     * @template T of object
-     * @phpstan-param class-string<T> $className
-     *
-     * @return T
-     */
-    final protected static function getServiceByClassName(string $className, ?string $id = null): object
-    {
-        if (!self::$booted) {
-            static::bootKernel();
-        }
-
-        $serviceId = self::getTestServiceId($id, $className);
-        $service = self::getContainer()->get($serviceId);
-        assert(is_object($service) && is_a($service, $className));
-
-        return $service;
-    }
-
-    protected static function getTestServiceId(?string $id, string $className): string
-    {
-        $kernel = self::$kernel;
-        if (!$kernel instanceof IbexaTestKernel) {
-            throw new RuntimeException(sprintf(
-                'Expected %s to be an instance of %s.',
-                get_class($kernel),
-                IbexaTestKernel::class,
-            ));
-        }
-
-        $id = $id ?? $className;
-
-        return $kernel::getAliasServiceId($id);
-    }
-
-    protected static function getDoctrineConnection(): Connection
-    {
-        return self::getServiceByClassName(Connection::class);
-    }
-
-    protected static function getContentTypeService(): ContentTypeService
-    {
-        return self::getServiceByClassName(ContentTypeService::class);
-    }
-
-    protected static function getContentService(): ContentService
-    {
-        return self::getServiceByClassName(ContentService::class);
-    }
-
-    protected static function getLocationService(): LocationService
-    {
-        return self::getServiceByClassName(LocationService::class);
-    }
-
-    protected static function getPermissionResolver(): PermissionResolver
-    {
-        return self::getServiceByClassName(PermissionResolver::class);
-    }
-
-    protected static function getRoleService(): RoleService
-    {
-        return self::getServiceByClassName(RoleService::class);
-    }
-
-    protected static function getSearchService(): SearchService
-    {
-        return self::getServiceByClassName(SearchService::class);
-    }
-
-    protected static function getTransactionHandler(): TransactionHandler
-    {
-        return self::getServiceByClassName(TransactionHandler::class);
-    }
-
-    protected static function getUserService(): UserService
-    {
-        return self::getServiceByClassName(UserService::class);
-    }
-
-    protected static function getObjectStateService(): ObjectStateService
-    {
-        return self::getServiceByClassName(ObjectStateService::class);
-    }
-
-    protected static function getLanguageService(): LanguageService
-    {
-        return self::getServiceByClassName(LanguageService::class);
-    }
-
-    protected static function getSectionService(): SectionService
-    {
-        return self::getServiceByClassName(SectionService::class);
-    }
-
-    protected static function setAnonymousUser(): void
-    {
-        self::getPermissionResolver()->setCurrentUserReference(new UserReference(self::FIXTURE_USER_ANONYMOUS_ID));
-    }
-
-    protected static function setAdministratorUser(): void
-    {
-        self::getPermissionResolver()->setCurrentUserReference(new UserReference(self::FIXTURE_USER_ADMIN_ID));
-    }
 }

src/contracts/Test/IbexaKernelTestTrait.php

@@ -0,0 +1,177 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Test;
+
+use Doctrine\DBAL\Connection;
+use Ibexa\Contracts\Core\Persistence\TransactionHandler;
+use Ibexa\Contracts\Core\Repository\ContentService;
+use Ibexa\Contracts\Core\Repository\ContentTypeService;
+use Ibexa\Contracts\Core\Repository\LanguageService;
+use Ibexa\Contracts\Core\Repository\LocationService;
+use Ibexa\Contracts\Core\Repository\ObjectStateService;
+use Ibexa\Contracts\Core\Repository\PermissionResolver;
+use Ibexa\Contracts\Core\Repository\RoleService;
+use Ibexa\Contracts\Core\Repository\SearchService;
+use Ibexa\Contracts\Core\Repository\SectionService;
+use Ibexa\Contracts\Core\Repository\UserService;
+use Ibexa\Contracts\Core\Test\Persistence\Fixture\FixtureImporter;
+use Ibexa\Core\Repository\Values\User\UserReference;
+use Ibexa\Tests\Core\Repository\LegacySchemaImporter;
+use RuntimeException;
+
+/**
+ *  @experimental
+ */
+trait IbexaKernelTestTrait
+{
+    final protected static function loadSchema(): void
+    {
+        $schemaImporter = self::getContainer()->get(LegacySchemaImporter::class);
+        foreach (static::getSchemaFiles() as $schemaFile) {
+            $schemaImporter->importSchema($schemaFile);
+        }
+    }
+
+    /**
+     * @return iterable<string>
+     */
+    protected static function getSchemaFiles(): iterable
+    {
+        yield from self::$kernel->getSchemaFiles();
+    }
+
+    final protected static function loadFixtures(): void
+    {
+        $fixtureImporter = self::getContainer()->get(FixtureImporter::class);
+        foreach (static::getFixtures() as $fixture) {
+            $fixtureImporter->import($fixture);
+        }
+
+        static::postLoadFixtures();
+    }
+
+    protected static function postLoadFixtures(): void
+    {
+    }
+
+    /**
+     * @return iterable<\Ibexa\Contracts\Core\Test\Persistence\Fixture>
+     */
+    protected static function getFixtures(): iterable
+    {
+        yield from self::$kernel->getFixtures();
+    }
+
+    /**
+     * @template T of object
+     * @phpstan-param class-string<T> $className
+     *
+     * @return T
+     */
+    final protected static function getServiceByClassName(string $className, ?string $id = null): object
+    {
+        if (!self::$booted) {
+            static::bootKernel();
+        }
+
+        $serviceId = self::getTestServiceId($id, $className);
+        $service = self::getContainer()->get($serviceId);
+        assert(is_object($service) && is_a($service, $className));
+
+        return $service;
+    }
+
+    protected static function getTestServiceId(?string $id, string $className): string
+    {
+        $kernel = self::$kernel;
+        if (!$kernel instanceof IbexaTestKernel) {
+            throw new RuntimeException(sprintf(
+                'Expected %s to be an instance of %s.',
+                get_class($kernel),
+                IbexaTestKernel::class,
+            ));
+        }
+
+        $id = $id ?? $className;
+
+        return $kernel->getAliasServiceId($id);
+    }
+
+    protected static function getDoctrineConnection(): Connection
+    {
+        return self::getServiceByClassName(Connection::class);
+    }
+
+    protected static function getContentTypeService(): ContentTypeService
+    {
+        return self::getServiceByClassName(ContentTypeService::class);
+    }
+
+    protected static function getContentService(): ContentService
+    {
+        return self::getServiceByClassName(ContentService::class);
+    }
+
+    protected static function getLocationService(): LocationService
+    {
+        return self::getServiceByClassName(LocationService::class);
+    }
+
+    protected static function getPermissionResolver(): PermissionResolver
+    {
+        return self::getServiceByClassName(PermissionResolver::class);
+    }
+
+    protected static function getRoleService(): RoleService
+    {
+        return self::getServiceByClassName(RoleService::class);
+    }
+
+    protected static function getSearchService(): SearchService
+    {
+        return self::getServiceByClassName(SearchService::class);
+    }
+
+    protected static function getTransactionHandler(): TransactionHandler
+    {
+        return self::getServiceByClassName(TransactionHandler::class);
+    }
+
+    protected static function getUserService(): UserService
+    {
+        return self::getServiceByClassName(UserService::class);
+    }
+
+    protected static function getObjectStateService(): ObjectStateService
+    {
+        return self::getServiceByClassName(ObjectStateService::class);
+    }
+
+    protected static function getLanguageService(): LanguageService
+    {
+        return self::getServiceByClassName(LanguageService::class);
+    }
+
+    protected static function getSectionService(): SectionService
+    {
+        return self::getServiceByClassName(SectionService::class);
+    }
+
+    protected static function setAnonymousUser(): void
+    {
+        $anonymousUserId = 10;
+        self::getPermissionResolver()->setCurrentUserReference(new UserReference($anonymousUserId));
+    }
+
+    protected static function setAdministratorUser(): void
+    {
+        $adminUserId = 14;
+        self::getPermissionResolver()->setCurrentUserReference(new UserReference($adminUserId));
+    }
+}

src/contracts/Test/IbexaTestKernel.php

@@ -229,4 +229,27 @@ private static function setUpTestLogger(ContainerBuilder $container): void
     {
         $container->setDefinition('logger', new Definition(NullLogger::class));
     }
+
+    /**
+     * Creates synthetic services in container, allowing compilation of container when some services are missing.
+     * Additionally, those services can be replaced with mock implementations at runtime, allowing integration testing.
+     *
+     * You can set them up in KernelTestCase by calling `self::getContainer()->set($id, $this->createMock($class));`
+     *
+     * @phpstan-param class-string $class
+     */
+    protected static function addSyntheticService(ContainerBuilder $container, string $class, ?string $id = null): void
+    {
+        $id = $id ?? $class;
+        if ($container->has($id)) {
+            throw new LogicException(sprintf(
+                'Expected test kernel to not contain "%s" service. A real service should not be overwritten by a mock',
+                $id,
+            ));
+        }
+
+        $definition = new Definition($class);
+        $definition->setSynthetic(true);
+        $container->setDefinition($id, $definition);
+    }
 }