DotNet.Testcontainers.Containers.ResourceReaperException : Initialization has been cancelled.

[dpraimeyuu]

Hi @HofmeisterAn!

First and foremost, thanks for your this package and great effort in maintaining it! ❤️

I wanted to use dotnet-testcontainers in e2e tests with combination of WebApplicationFactory from net5.0 so I created the following extension method:

public static async Task<IServiceProvider> StartSqlServerTestContainerAsync(this IServiceProvider serviceProvider)
{
    var maintenanceContext = serviceProvider.GetRequiredService<MaintenanceContext>();
    string connectionString = maintenanceContext.Database.GetConnectionString();
    var dbConnectionStringBuilder = new SqlConnectionStringBuilder(connectionString);
    int portNumber = int.Parse(dbConnectionStringBuilder.DataSource.Split(",")[1]);

    ITestcontainersBuilder<MsSqlTestcontainer> testContainersBuilder
        = new TestcontainersBuilder<MsSqlTestcontainer>()
                .WithDatabase(new MsSqlTestcontainerConfiguration
                {
                    Password = dbConnectionStringBuilder.Password,
                    Port = portNumber
                })
                .WithName("maintenance")
                .WithImage("mcr.microsoft.com/mssql/server:2019-CU15-ubuntu-20.04");

    MsSqlTestcontainer dbTestContainer = testContainersBuilder.Build();
    try
    {
        await dbTestContainer.StartAsync();
    }
    catch (Exception)
    {
        throw;
    }

    return serviceProvider;
}

Then used in the following method:

public async Task Setup()
{
    await Services.StartSqlServerTestContainerAsync();
    Services.RunEfCoreMigrations();
}

When running Setup in the test method, after a period of time such exception is thrown:
DotNet.Testcontainers.Containers.ResourceReaperException : Initialization has been cancelled. Stack Trace: at DotNet.Testcontainers.Containers.ResourceReaper.GetAndStartNewAsync(Guid sessionId, String ryukImage, TimeSpan initTimeout, CancellationToken ct) at DotNet.Testcontainers.Containers.ResourceReaper.GetAndStartNewAsync(Guid sessionId, String ryukImage, TimeSpan initTimeout, CancellationToken ct) at DotNet.Testcontainers.Containers.ResourceReaper.GetAndStartDefaultAsync(CancellationToken ct) at DotNet.Testcontainers.Clients.TestcontainersClient.RunAsync(ITestcontainersConfiguration configuration, CancellationToken ct) at DotNet.Testcontainers.Containers.TestcontainersContainer.Create(CancellationToken ct) at DotNet.Testcontainers.Containers.TestcontainersContainer.StartAsync(CancellationToken ct)
From time to time I see tests running properly and two containers are available in the Docker Desktop panel, but in most cases only one is visible:

My setup is: Docker Desktop, Linux containers, WSL2.

I assume that when a container with MSSQL tries to be created something "bad" happens, but I don't know how to inspect it so that I am able to provide some more insights.

What's more interesting, when there's no image of MSSQL available locally - so docker pulls it for the first time - then tests pass with success.

I wonder about the possible cause of such a scenario?

[HofmeisterAn]

It seems like you're having an issue I saw a few times in the past too. Until now, I couldn't reproduce it. Maybe we can figure it out together. Do you use the latest beta release?

When running Setup in the test method, after a period of time such exception is thrown:
How much time is in between?

You'll get this exception if Testcontainers can't establish a connection to the Resource Reaper (Ryuk) within 10 seconds.
https://github.com/HofmeisterAn/dotnet-testcontainers/blob/b99957969f1bf8d1615196f1a77899cb5d51c76e/src/DotNet.Testcontainers/Containers/ResourceReaper.cs#L229

Testcontainers starts with the first container, the Resource Reaper, in the background. Can you start the Resource Reaper in advance:

await ResourceReaper.GetAndStartDefaultAsync()
  .ConfigureAwait(false);

to check if the connection works at all?

This may cancel your test:

https://github.com/HofmeisterAn/dotnet-testcontainers/blob/b99957969f1bf8d1615196f1a77899cb5d51c76e/src/DotNet.Testcontainers/Containers/ResourceReaper.cs#L156

[dpraimeyuu]

@srollinet thanks for your reply! Might be, I haven't checked that. Then a natural question comes to my mind whether a specific port declaration will solve the issue? Did you manage to try it?

[srollinet]

@dpraimeyuu Yes, using a specific port solved the problem. I don't know if the option exists in dotnet-testcontainers.
For the other lib, I authored a PR to allow setting the Ryuk port

[HofmeisterAn]

@srollinet Interesting, I was not aware of this issue. Unfortunately, using a specific port (default configuration) might be a problem for others. However, we could support specific ports with GetAndStartNewAsync. In that case, the developer has to configure the resource reaper and pass its session ID to each resource (instead of using the default configuration).

We need to extend GetAndStartNewAsync then:
https://github.com/HofmeisterAn/dotnet-testcontainers/blob/ba7d87befb0ece496d94ec9f350d503a264a372c/src/DotNet.Testcontainers/Containers/ResourceReaper.cs#L123

[srollinet]

@HofmeisterAn In testcontainers-dotnet, it is possible to define an env variable with the Ryuk port. It might also be a possibility, or to define a static variable.
But this kind of solution doesn't seem very clean and may be quite confusing (It must be set before the first container is started, otherwise it has no effect)

Another solution is maybe to find an open port using c# code, so we ensure the port is open in Windows.

[davidpetric]

Had the same issue, updating the Testcontainers NuGet package from 2.1.0 to 2.2.0-beta solved the issue for me.

Thanks!