RFC: Allowed schema & fixture files be accessed from Kernel #242

Steveb-p · 2021-10-10T14:24:31Z

Question	Answer
JIRA issue	N/A
Type	improvement
Target Ibexa version	`v3.3`
BC breaks	no

Request for comments

This change proposes one of possible ways of exposing schema & fixture files for consumption in our & third party packages, so they can be coupled with https://github.com/dmaicher/doctrine-test-bundle, and subsequently improve the performance of database-related tests.

This solution directly provides new methods to IbexaTestKernel. A different solution I've come up would be to provide schema & fixture registry as a test service.

I have created a local test to change the performance impact on testing for a MySQL database (mind you, using a normal filesystem). The results are as follows:

without transaction bundle & database bootstraping

with transaction bundle & database bootstraping
(8 second execution)

Note that these include ~2-3 sec of container compilation & database setup, which means that each tests is reduced from ~300ms to a few ms in execution.

Samples bootstrapping (executed in context of ibexa migrations, used for result above)

<?php

use eZ\Publish\API\Repository\Tests\LegacySchemaImporter;
use eZ\Publish\SPI\Tests\Persistence\FixtureImporter;
use eZ\Publish\SPI\Tests\Persistence\YamlFixture;

require_once __DIR__.'/../vendor/autoload.php';

function bootstrap(): void
{
    $kernel = new \Ibexa\Platform\Tests\Bundle\Migration\IbexaTestKernel('test', true);
    $kernel->boot();

    $application = new \Symfony\Bundle\FrameworkBundle\Console\Application($kernel);
    $application->setAutoExit(false);

    $application->run(new \Symfony\Component\Console\Input\ArrayInput([
        'command' => 'doctrine:database:drop',
        '--if-exists' => '1',
        '--force' => '1',
    ]));

    $application->run(new \Symfony\Component\Console\Input\ArrayInput([
        'command' => 'doctrine:database:create',
    ]));

    /** @var \eZ\Publish\API\Repository\Tests\LegacySchemaImporter $schemaImporter */
    $schemaImporter = $kernel->getContainer()->get(LegacySchemaImporter::class);
    foreach ($kernel->getSchemaFiles() as $schemaFile) {
        $schemaImporter->importSchema($schemaFile);
    }

    /** @var \eZ\Publish\SPI\Tests\Persistence\FixtureImporter $fixtureImporter */
    $fixtureImporter = $kernel->getContainer()->get(FixtureImporter::class);
    foreach ($kernel->getFixtures() as $fixture) {
        $fixtureImporter->import($fixture);
    }

    $kernel->shutdown();
}

bootstrap();

Checklist:

Provided PR description.
Tested the solution manually.
Provided automated test coverage.
Checked that target branch is set correctly (master for features, the oldest supported for bugs).
Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
Asked for a review (ping @ezsystems/engineering-team).