Allow to load fixtures for integration tests

FixtureAwareTestCaseTrait.php

<?php
declare(strict_types=1);

namespace Tests;

use Doctrine\Common\DataFixtures\{
    Executor\ORMExecutor, FixtureInterface, Purger\ORMPurger, SharedFixtureInterface
};
use Doctrine\Common\Persistence\ObjectManager;
use Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader;

/**
 * Class FixtureAwareTestCaseTrait
 * @package Tests
 * @author Dmytro Paiareli <[email protected]>
 */
trait FixtureAwareTestCaseTrait
{
    /**
     * @var ORMExecutor
     */
    private $fixtureExecutor;

    /**
     * @var ContainerAwareLoader
     */
    private $fixtureLoader;

    /**
     * @param FixtureInterface $fixture
     * @return self
     */
    protected function addFixture(FixtureInterface $fixture)
    {
        $this->getFixtureLoader()->addFixture($fixture);
        return $this;
    }

    /**
     * Executes all the fixtures that have been loaded so far.
     * @param bool $append
     */
    protected function executeFixtures(bool $append = false)
    {
        $this->getFixtureExecutor()->execute($this->getFixtureLoader()->getFixtures(), $append);
    }

    /**
     * Purges loaded fixtures from DB
     */
    protected function purgeFixtures()
    {
        $this->getFixtureExecutor()->getPurger()->purge();
    }

    /**
     * @return ORMExecutor
     */
    private function getFixtureExecutor()
    {
        if (!$this->fixtureExecutor) {
            /**
             * @var \Doctrine\ORM\EntityManager $entityManager
             */
            $entityManager = self::$kernel->getContainer()->get('doctrine')->getManager();
            $this->fixtureExecutor = new class ($entityManager, new ORMPurger($entityManager)) extends ORMExecutor
            {
                /**
                 * @inheritDoc
                 */
                public function load(ObjectManager $manager, FixtureInterface $fixture)
                {
                    if ($fixture instanceof SharedFixtureInterface) {
                        $fixture->setReferenceRepository($this->referenceRepository);
                    }

                    $fixture->load($manager);
                }

            };
        }
        return $this->fixtureExecutor;
    }

    /**
     * @return ContainerAwareLoader
     */
    private function getFixtureLoader()
    {
        if (!$this->fixtureLoader) {
            $this->fixtureLoader = new ContainerAwareLoader(self::$kernel->getContainer());
        }
        return $this->fixtureLoader;
    }
}

Test case class should extends Symfony\Bundle\FrameworkBundle\Test\KernelTestCase to able get access to service container.

class FooTest extends Symfony\Bundle\FrameworkBundle\Test\KernelTestCase
{
    use Tests\FixtureAwareTestCaseTrait;

    public function setUp()
    {
        self::bootKernel();

        // Base fixture for all tests
        $this
                ->addFixture(new FirstFixture())
                ->addFixture(new SecondFixture())
                ->executeFixtures();

        // Fixtures are now loaded in a clean DB
    }
}