Ujian Penyepaduan dalam 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 rahsia kepada sesiapa tentang kepentingan ujian automatik untuk mengekalkan kualiti dan integriti perisian anda dan kami biasanya banyak bercakap tentang ujian unit, namun, hari ini, kami akan lebih menumpukan pada ujian penyepaduan dalam Rangka Kerja Symfony.

Saya sudah kehabisan kesabaran, tunjukkan saya kod!

Okay okay! Jika anda tidak mempunyai kesabaran untuk membaca artikel ini, saya mempunyai projek ujian yang melaksanakan artikel ini di pautan di bawah.

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

Ujian Rangka Kerja dan Penyepaduan Symfony

Hari ini, Rangka Kerja Symfony ialah salah satu rangka kerja yang paling matang dalam alam semesta PHP dan ia mempunyai beberapa penyelesaian yang dilaksanakan dengan baik, seperti untuk ujian penyepaduan, contohnya. Walau bagaimanapun, secara peribadi saya sentiasa mendapati bahawa walaupun mudah untuk melakukan ujian penyepaduan sendiri, menyediakan kebergantungan luaran untuk ujian tidak selalunya begitu mudah, seperti pangkalan data misalnya.

Walaupun dengan kemunculan Docker, saya masih menyedari keperluan untuk menyediakan kebergantungan luaran dalam beberapa cara untuk ujian, namun, terdapat 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 lebih mudah sebarang pergantungan luaran yang anda perlukan menggunakan Docker, seperti pangkalan data, broker mesej, sistem caching atau hampir mana-mana pergantungan kontena.

Perbezaan besar antara Testcontainers berhubung dengan Docker compose atau sebarang bentuk peruntukan kontena yang lain ialah anda boleh memprogramkan peruntukan kontena dan hari ini ia sudah mempunyai sokongan untuk Golang, Java, .NET, Node.js, Python , Rust, beberapa bahasa lain, dan sudah tentu, PHP!

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

Symfony + Testcontainers = ❤️

Salah satu kelebihan hebat Symfony ialah sokongan untuk ujian dalam PHPUnit dengan menyediakan Kernel berfungsi sepenuhnya untuk melaksanakan bootstrap yang diperlukan untuk ujian.

Walaupun Testcontainers menyokong PHP, pelaksanaannya lebih baharu dan anda boleh menyemaknya di https://github.com/testcontainers/testcontainers-php.

Di bawah ini kami mempunyai pelaksanaan bekas MySQL 8.0, yang merupakan pergantungan luaran projek ini, selain daripada but Symfony Kernel, mencipta 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 sebenarnya akan melaksanakan ujian, seperti dalam 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 suite ujian, anda akan melihat kelewatan dalam menyelesaikan ujian, walau bagaimanapun, ini adalah perkara biasa, kerana semasa proses ini, Testcontainers menyediakan bekas yang anda tentukan untuk digunakan dalam ujian.

Akhir sekali, dengan kemudahan ini, anda juga boleh cuba melakukan perkara gila, seperti liputan 100%. tak percaya? Anda boleh melihatnya sendiri di https://joubertredrat.github.io/symfony-testcontainers.

Jadi itu sahaja, sehingga lain kali!

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