Testcontainers

Od dawna zmierzam się z problemem zarządzania ciężkich zależności takich jak np. bazy danych podczas tworzenia testów integracyjnych. Gdzie je postawić? W Jaki sposób? Jak zapewnić odpowiedni flow, aby proces był odpowiednio lekki na środowisku lokalnym, jak i na CI. Nie ma łatwej odpowiedzi na to pytanie.

Zainteresowała mnie biblioteka TestContainers Służy do zarządzania kontenerami w kontekście testów. Powinna ona nam umożliwić uruchomienie części infrastruktury, które są wymagane na potrzeby testów z poziomu kodu. Wydaję się, że może rozwiązać mój problem. Biblioteka umożliwia użycie predefiniowanych kontenerów lub innych, customowych obrazów.

W moim przypadku najczęściej potrzebuję bazy MSSQL, jeżeli chcę przeprowadzić testy z zapisem do bazy danych. Dlatego w tym poście spróbuję uruchomić taki kontener z sewerem MSSQL w kontekście testu. Obraz taki znajduję się w predefiniwoanej kolekcji, dlatego zadanie wydaję się proste.

Poprzedni post znajdziesz tutaj: Wiadomość Slack z wynikami testów po zakończonym procesie budowania na CI

Tworzenie nowego projektu .NET

Tworzę nowy projekt z testami Xunit

$ mkdir TestContainersXUnitExample
$ cd TestContainersXUnitExample
$ dotnet new xunit

Następnie dodaję NuGet DotNet.Testcontainers:

$ dotnet add package DotNet.Testcontainers

Oraz zależności związane z samą bazą danych:

dotnet add package System.Data.SqlClient

W ten sposób mam gotowe środowisko, na którym mogę rozpocząć pracę.

Otwieram projekt i istniejącą już klasę testową. Rozkręcenie takiej instancji okazuję się niezwykle proste. Oto całość testu

[Fact]
public async Task InitContainerTest()
{
    var testcontainersBuilder = new TestcontainersBuilder<MsSqlTestcontainer>()
        .WithDatabase(new MsSqlTestcontainerConfiguration
        {
            Password = "yourStrong(!)Password123",
        });

    await using (var testcontainer = testcontainersBuilder.Build())
    {
        await testcontainer.StartAsync();

        await using (var connection = new SqlConnection(testcontainer.ConnectionString))
        {
            connection.Open();

            await using (var cmd = new SqlCommand())
            {
                cmd.Connection = connection;
                cmd.CommandText = "SELECT 1";
                cmd.ExecuteReader();
            }
        }
    }
}

Changeset na githubie:

https://github.com/12masta/TestContainersXUnitExample/pull/1/files

Wnioski

Jak widać, uruchomienie takiej bazy danych jest bardzo prostym zadaniem. Pierwsze uruchomienie testu trwa dosyć długo. W moim przypadku około 3 minut. Na już rozgrzanym środowisku trwa to już 10 sekund, należy jednak wziąć pod uwagę, że możemy rozkręcić instancję, a potem jej reużyć dla więcej niż jednego testu. Dlatego też podejrzewam, że dla większego zestawu testów wynik ten nie będzie problemem.

Na horyzoncie pojawia się też problem utworzenia bardziej skomplikowanego setupu z odtworzeniem backupu lub predefiniowanego obrazu z gotowym backupem bazy danych do przeprowadzenia testu. Poruszę ten problem w następnym poście dotyczącego tego narzędzia.

Chcesz zobaczyć jak rozwiązać zadanie na pozycję testera automatyzującego?

Nagranie znajdziesz tutaj, lub klikając na obrazek poniżej: