Testcontainer를 사용한 Symfony의 통합 테스트

면책조항: 나는 신성한 존재가 아닙니다. 내가 말하는 것은 절대적인 진실은 아니다. 세상이라도 의심하는 것을 두려워하지 마세요. 당신이 아니라 틀릴 수도 있으니까요.

오늘날 소프트웨어의 품질과 무결성을 유지하기 위한 자동화된 테스트의 중요성은 누구에게도 비밀이 아니며 일반적으로 단위 테스트에 대해 많이 이야기하지만 오늘은 Symfony Framework의 통합 테스트에 더 중점을 둘 것입니다.

인내심이 부족합니다. 코드를 보여주세요!

알았어 알았어! 이 글을 읽을 용기가 없으시다면 아래 링크에서 이 글을 구현하는 테스트 프로젝트를 진행해 보겠습니다.

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

Symfony 프레임워크 및 통합 테스트

현재 Symfony Framework는 PHP 세계에서 가장 성숙한 프레임워크 중 하나이며, 예를 들어 통합 테스트와 같이 잘 구현된 여러 솔루션을 갖추고 있습니다. 하지만 개인적으로 통합 테스트 자체를 수행하는 것은 쉽지만 데이터베이스와 같이 테스트에 외부 종속성을 제공하는 것이 항상 쉬운 것은 아니라는 것을 알았습니다.

Docker가 등장했음에도 불구하고 테스트를 위해 어떤 방식으로든 외부 종속성을 프로비저닝해야 할 필요성을 깨달았습니다. 하지만 이 단계를 훨씬 쉽게 만들어 주는 매우 흥미로운 솔루션인 Testcontainers가 있습니다.

테스트 컨테이너

Testcontainers는 데이터베이스, 메시지 브로커, 캐싱 시스템 또는 거의 모든 컨테이너 종속성과 같이 Docker를 사용하여 필요한 외부 종속성을 보다 쉽게 ​​프로비저닝할 수 있는 오픈 소스 프레임워크입니다.

Docker compose 또는 다른 형태의 컨테이너 프로비저닝과 관련된 Testcontainers의 가장 큰 차이점은 컨테이너 프로비저닝을 프로그래밍할 수 있다는 점이며 현재 이미 Golang, Java, .NET, Node.js, Python, Rust를 지원하고 있습니다. 다른 여러 언어는 물론 PHP까지!

Testcontainers와 처음 접촉한 것은 Golang 프로젝트였으며 MongoDB 컨테이너를 쉽게 프로비저닝하여 리포지토리에서 테스트를 수행할 수 있다는 점이 정말 마음에 들었습니다. 그 후 제가 가지고 있는 개인 프로젝트에서도 동일한 작업을 수행하기로 결정했습니다. Symfony Framework를 사용하는 PHP.

Symfony + 테스트 컨테이너 = ❤️

Symfony의 가장 큰 장점 중 하나는 테스트에 필요한 부트스트랩을 수행하기 위해 완전한 기능을 갖춘 커널을 제공함으로써 PHPUnit에서 테스트를 지원한다는 것입니다.

Testcontainers는 PHP를 지원하지만 구현이 더 최신이며 https://github.com/testcontainers/testcontainers-php에서 확인할 수 있습니다.

아래에는 Symfony 커널을 부팅하고 데이터베이스와 스키마를 생성하는 것 외에도 이 프로젝트의 외부 종속성인 MySQL 8.0 컨테이너를 구현했습니다.

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에서 직접 확인하실 수 있습니다.

그럼 다음 시간까지!

위 내용은 Testcontainer를 사용한 Symfony의 통합 테스트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!