Symfony 中與 Testcontainers 的整合測試

免責聲明：我不是神聖實體。我所說的並不是絕對的真理。甚至不要害怕質疑世界，因為它可能是錯的，而不是你。

今天，自動化測試對於維護軟體的品質和完整性的重要性對於任何人來說都不是秘密，我們通常會談論很多單元測試，但是今天，我們將更多地關注Symfony 框架中的整合測試。

我沒耐心了，給我看代碼吧！

好吧好吧！如果您沒有耐心閱讀本文，我在下面的連結中有一個實現本文的測試項目。

https://github.com/joubertredrat/symfony-testcontainers

Symfony 框架和整合測試

如今，Symfony 框架是 PHP 領域最成熟的框架之一，它擁有多個實施良好的解決方案，例如整合測試。然而，我個人總是發現，雖然自己進行整合測試很容易，但為測試提供外部依賴項並不總是那麼容易，例如資料庫。

即使 Docker 出現了，我仍然意識到需要以某種方式提供外部依賴項來進行測試，但是，有一個非常有趣的解決方案可以使這一步變得更加容易，Testcontainers。

測試容器

Testcontainers 是一個開源框架，可讓您使用 Docker 更輕鬆地配置所需的任何外部依賴項，例如資料庫、訊息代理、快取系統或幾乎任何容器相依性。

Testcontainers 與Docker compose 或任何其他形式的容器配置相關的最大區別在於，您可以對容器配置進行編程，現在它已經支援Golang、Java、.NET、Node.js、Python、Rust、其他幾種語言，當然還有PHP！

我第一次接觸Testcontainers 是在一個Golang 專案中，我真的很喜歡設定MongoDB 容器來在儲存庫中執行測試的便利性，之後，我決定在我的個人專案中做同樣的事情使用Symfony 框架的PHP。

Symfony + 測試容器 = ❤️

Symfony 的一大優勢正是透過提供功能齊全的核心來執行測試所需的引導程式來支援 PHPUnit 中的測試。

雖然 Testcontainers 支援 PHP，但實作較新，您可以在 https://github.com/testcontainers/testcontainers-php 查看。

下面我們有一個 MySQL 8.0 容器的實現，它是這個專案的外部依賴，除了啟動 Symfony 核心、建立資料庫和模式之外。

class IntegrationTestCase extends KernelTestCase
{
    protected static ?MySQLContainer $container = null;

    public static function setUpBeforeClass(): void
    {
        parent::setUpBeforeClass();

        if (!static::$container) {
            static::$container = MySQLContainer::make('8.0', 'password');
            static::$container->withPort('19306', '3306');
            static::$container->run();

            $kernel = self::bootKernel();
            $container = $kernel->getContainer();

            $application = new Application($kernel);
            $application->setAutoExit(false);

            $application->run(
                new ArrayInput(['command' => 'doctrine:database:create', '--if-not-exists' => true])
            );

            $entityManager = $container->get('doctrine')->getManager();
            $metadata = $entityManager->getMetadataFactory()->getAllMetadata();
            $schemaTool = new SchemaTool($entityManager);
            $schemaTool->dropSchema($metadata);
            $schemaTool->createSchema($metadata);
        }
    }

    public static function tearDownAfterClass(): void
    {
        parent::tearDownAfterClass();

        if (static::$container instanceof MySQLContainer) {
            static::$container->remove();
        }
    }

有了這個，我們就有了實際執行測試的類別的基類，如下例所示。

class UserRepositoryTest extends IntegrationTestCase
{
    public function testSave(): void
    {
        $user = new User();
        $user->setName('John Doe');
        $user->setEmail('john@doe.local');

        $repo = $this->getRepository();
        $repo->save($user, true);

        self::assertNotNull($user->getId());
        self::assertIsInt($user->getId());
        self::assertTrue($user->getId() > 0);
    }

    public function testGetByEmail(): void
    {
        $user = new User();
        $user->setName('John Doe');
        $user->setEmail('john2@doe.local');

        $repo = $this->getRepository();
        $userNotFound = $repo->getByEmail($user->getEmail());
        self::assertNull($userNotFound);

        $repo->save($user, true);
        $userFound = $repo->getByEmail($user->getEmail());

        self::assertEquals($user->getEmail(), $userFound->getEmail());
    }

    protected function tearDown(): void
    {
        parent::tearDown();

        $connection = $this
            ->getContainer()
            ->get('doctrine')
            ->getManager()
            ->getConnection()
        ;
        $connection->executeStatement('TRUNCATE TABLE users');
    }

    protected function getRepository(): UserRepository
    {
        return $this->getContainer()->get(UserRepository::class);
    }
}

執行測試套件時，您會注意到完成測試的延遲，但是，這是正常的，因為在此過程中，Testcontainers 正在配置您定義在測試中使用的容器。

最後，透過這種輕鬆，您甚至可以嘗試做一些瘋狂的事情，例如 100% 覆蓋率。不相信嗎？您可以在 https://joubertredrat.github.io/symfony-testcontainers 上親自查看。

就這樣吧，下次再見！

以上是Symfony 中與 Testcontainers 的整合測試的詳細內容。更多資訊請關注PHP中文網其他相關文章！