ResetDatabase.php

<?php

/*
 * This file is part of the zenstruck/foundry package.
 *
 * (c) Kevin Bond <kevinbond@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zenstruck\Foundry\Test;

use PHPUnit\Framework\Attributes\Before;
use PHPUnit\Framework\Attributes\BeforeClass;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\HttpKernel\KernelInterface;
use Zenstruck\Foundry\Attribute\ResetDatabase as ResetDatabaseAttribute;
use Zenstruck\Foundry\Configuration;
use Zenstruck\Foundry\Persistence\ResetDatabase\ResetDatabaseManager;
use Zenstruck\Foundry\PHPUnit\FoundryExtension;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
if (!\method_exists(Before::class, '__construct')) { // @phpstan-ignore function.alreadyNarrowedType
    trait ResetDatabase
    {
        use CommonResetDatabase;

        /**
         * @internal
         * @before
         */
        #[Before]
        public static function _resetDatabaseBeforeEachTest(): void
        {
            self::_commonResetDatabaseBeforeEachTest();
        }
    }
} else {
    trait ResetDatabase
    {
        use CommonResetDatabase;

        /** @internal */
        #[Before(10)]
        public static function _resetDatabaseBeforeEachTest(): void
        {
            self::_commonResetDatabaseBeforeEachTest();
        }
    }
}

/** @internal */
trait CommonResetDatabase
{
    /**
     * @internal
     * @beforeClass
     */
    #[BeforeClass]
    public static function _resetDatabaseBeforeFirstTest(): void
    {
        if (FoundryExtension::isEnabled()) {
            trigger_deprecation('zenstruck/foundry', '2.9', \sprintf('Trait "%s" is deprecated and will be removed in Foundry 3. Use attribute "%s" instead. See https://github.com/zenstruck/foundry/blob/2.x/UPGRADE-2.9.md to upgrade.', ResetDatabase::class, ResetDatabaseAttribute::class));

            return;
        }

        $kernel = static::_boot(); // @phpstan-ignore staticClassAccess.privateMethod

        ResetDatabaseManager::resetBeforeFirstTest($kernel);

        static::_shutdown(); // @phpstan-ignore staticClassAccess.privateMethod
    }

    /** @internal */
    private static function _boot(): KernelInterface
    {
        if (!\is_subclass_of(static::class, KernelTestCase::class)) { // @phpstan-ignore function.alreadyNarrowedType
            throw new \RuntimeException(\sprintf('The "%s" trait can only be used on TestCases that extend "%s".', __TRAIT__, KernelTestCase::class));
        }

        $kernel = static::bootKernel();

        if (!$kernel->getContainer()->has('.zenstruck_foundry.configuration')) {
            throw new \LogicException('ZenstruckFoundryBundle is not enabled. Ensure it is added to your config/bundles.php.');
        }

        Configuration::boot($kernel->getContainer()->get('.zenstruck_foundry.configuration')); // @phpstan-ignore argument.type

        return $kernel;
    }

    /** @internal */
    private static function _shutdown(): void
    {
        if (!\is_subclass_of(static::class, KernelTestCase::class)) { // @phpstan-ignore function.alreadyNarrowedType
            throw new \RuntimeException(\sprintf('The "%s" trait can only be used on TestCases that extend "%s".', __TRAIT__, KernelTestCase::class));
        }

        Configuration::shutdown();
        static::ensureKernelShutdown();
    }

    /** @internal */
    private static function _commonResetDatabaseBeforeEachTest(): void
    {
        if (FoundryExtension::isEnabled()) {
            return;
        }

        if (ResetDatabaseManager::canSkipSchemaReset()) {
            // can fully skip booting the kernel
            return;
        }

        $kernel = static::_boot(); // @phpstan-ignore staticClassAccess.privateMethod

        ResetDatabaseManager::resetBeforeEachTest($kernel);

        static::_shutdown(); // @phpstan-ignore staticClassAccess.privateMethod
    }
}