Ujian integrasi pada Symfony dengan Testcontainers

Penafian: Saya bukan entiti ketuhanan. Apa yang saya katakan bukanlah kebenaran mutlak. Jangan takut untuk mempersoalkan walaupun dunia, kerana ia mungkin salah, bukan anda.

Hari ini bukan satu rahsia bagi sesiapa pun tentang kepentingan ujian automatik untuk mengekalkan kualiti dan integriti perisian anda dan biasanya kami banyak bercakap tentang ujian unit, tetapi, hari ini, kami akan lebih memfokuskan dalam ujian penyepaduan ke dalam Symfony Framework.

Saya tidak mempunyai kesabaran, tunjukkan saya kod!

Okay okay! Jika anda tidak mempunyai kesabaran untuk membaca artikel itu, saya mempunyai projek ujian dengan pelaksanaan artikel ini dalam pautan di bawah.

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

Rangka Kerja Symfony dan ujian integrasi

Hari ini Symfony Framework ialah salah satu rangka kerja yang paling matang dan stabil dalam PHP universe dan ia mempunyai pelbagai penyelesaian yang baik dilaksanakan, sebagai contoh ujian integrasi. Tetapi, secara peribadi saya selalu berfikir bahawa walaupun mudah untuk melakukan ujian integrasi itu sendiri, untuk menyediakan kebergantungan luaran untuk ujian Ia tidak selalu begitu mudah, seperti pangkalan data contohnya.

Walaupun dengan penyelesaian seperti Docker, saya masih menyedari keperluan untuk menyediakan kebergantungan luaran dengan cara untuk ujian, tetapi, wujud penyelesaian yang sangat menarik yang boleh menjadikan langkah ini lebih mudah, Testcontainers.

Bekas ujian

Testcontainers ialah rangka kerja sumber terbuka yang membolehkan anda menyediakan dengan cara mudah sebarang pergantungan luaran yang anda perlukan menggunakan Docker, sebagai pangkalan data, broker mesej, sistem cache atau pergantungan dalam bekas.

Kelebihan besar Testcontainers berhubung dengan Docker compose atau cara lain orkestrasi kontena ialah anda boleh mengodkan peruntukan kontena, dan hari ini sudah mempunyai sokongan untuk Golang, Java, .NET, Node.js, Python, Rust, pelbagai bahasa lain dan sudah tentu, PHP juga!

Hubungan pertama saya dengan Testcontainers adalah dalam projek di Golang dan saya sangat menyukai kemudahan menyediakan bekas MongoDB untuk melakukan ujian repositori dan selepas itu, saya memutuskan untuk melakukan perkara yang sama dalam projek peribadi saya dalam PHP menggunakan Symfony Framework.

Symfony + Testcontainers = ❤️

Salah satu kelebihan terbesar Symfony ialah sokongan untuk melakukan ujian yang disepadukan dengan PHPUnit dan dengan kernel berfungsi untuk melakukan bootstrap yang diperlukan untuk ujian.

Walaupun Testcontainers mempunyai sokongan kepada PHP, pelaksanaannya adalah terkini dan anda boleh melihatnya di https://github.com/testcontainers/testcontainers-php.

Di bawah ini kami mempunyai pelaksanaan bekas MySQL 8.0, yang merupakan pergantungan luaran projek ini, dan but kernel Symfony, penciptaan pangkalan data dan skema.

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();
        }
    }

Dengan ini, kami mempunyai kelas asas untuk kelas yang akan melaksanakan ujian itu sendiri, seperti contoh di bawah.

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);
    }
}

Apabila menjalankan set ujian, anda boleh melihat bahawa ujian akan dilaksanakan secara perlahan berbanding ujian unit ujian dengan hanya tingkah laku yang dipermainkan, tetapi ini adalah perkara biasa, kerana semasa proses ini, Testcontainers menyediakan bekas yang anda tentukan untuk digunakan dalam ujian .

Akhirnya, dengan kemudahan ini, boleh melakukan perkara gila, seperti 100% perlindungan. tak percaya? Anda boleh lihat sendiri di https://joubertredrat.github.io/symfony-testcontainers.

Itu sahaja, jumpa lagi!

Atas ialah kandungan terperinci Ujian integrasi pada Symfony dengan Testcontainers. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!