How to use TestContainers and Postgres in creating tests for ABP's Application Services

[jflaga]

Please help me setup ABP's ApplicationTestModule so that I can use Test Containers and Postgres

Here is an article which has samples for "ASP.NET Core Integration Tests with Test Containers & Postgres". Can anyone point out how to modify ApplicationTestModule or EntityFrameworkCoreTestModule (or ApplicationTestBase or EntityFrameworkCoreTestBase) so it uses Test Containers instead of in memory Sqlite?

[jflaga]

I was able to successfully run my app service tests by modifying EntityFrameworkCoreTestModule into this:

[DependsOn(
    typeof(SampleTestBaseModule),
    typeof(SampleEntityFrameworkCoreModule),
    typeof(AbpEntityFrameworkCorePostgreSqlModule)
    )]
public class SampleEntityFrameworkCoreTestModule : AbpModule
{
    private readonly PostgreSqlContainer _postgreSqlContainer = new PostgreSqlBuilder().Build();

    public override void PreConfigureServices(ServiceConfigurationContext context)
    {
        _postgreSqlContainer.StartAsync().GetAwaiter().GetResult();
    }

    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        var connectionString = _postgreSqlContainer.GetConnectionString();
        new SampleDbContext(
            new DbContextOptionsBuilder<SampleDbContext>().UseNpgsql(connectionString).Options
        ).GetService<IRelationalDatabaseCreator>().CreateTables();

        Configure<AbpDbContextOptions>(options =>
        {
            options.Configure(abpDbContextConfigurationContext =>
            {
                abpDbContextConfigurationContext.DbContextOptions.UseNpgsql(connectionString);
            });
        });
    }

    public override void OnApplicationShutdown(ApplicationShutdownContext context)
    {
        _postgreSqlContainer.StopAsync().GetAwaiter().GetResult();
    }

(side note: I tried to use the async versions of the overridden methods, PreConfigureServicesAsync and OnApplicationShutdownAsync, but they were not working.)

If you think I'm doing something wrong please say so in the comments.

Thanks.

[ahmednfwela]

please note that this method is memory intensive, since each Fact instantiates a new instance of the concrete test class, which re-initializes the module, recreating the database for each fact.

Please read my comment below for a better way #17490 (comment)

[hishamco]

I know it's old but it might be helpful to anyone else

    private readonly PostgreSqlContainer _postgreSqlContainer = new PostgreSqlBuilder()
        .WithImage("postgres:15.2")
        .Build();

[ahmednfwela]

The best method I found is to follow the same architecture used in MongoDB tests, which is using xunit's Collection Fixtures:

for example: (make sure you replace {ModuleName})

in .TestBase

Add static class containing collection name

public static class {ModuleName}TestConsts
{
    public const string CollectionName = "{ModuleName} Test Collection";
}

in .EntityFrameworkCore.Tests

Add the collection definition and the fixture

file: EfCoreTestCollection.cs

using Xunit;

[CollectionDefinition({ModuleName}TestConsts.CollectionName)]
public class EfCoreTestCollection : ICollectionFixture<EfCoreFixture>
{
}

file: EfCoreFixture.cs

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Storage;
using Testcontainers.PostgreSql;
using Volo.Abp.Threading;

public class EfCoreFixture : IAsyncLifetime
{
    private static EfCoreFixture? _instance;
    public static EfCoreFixture Instance => _instance ?? throw new ArgumentNullException(nameof(_instance));

    public EfCoreFixture()
    {
        _instance = this;
    }

    private readonly PostgreSqlContainer container = new PostgreSqlBuilder()
        .WithImage("postgres:15.2")
        .Build();

    public string GetConnectionString()
    {
        return container.GetConnectionString();
    }

    public async Task InitializeAsync()
    {
        await container.StartAsync();

        var connectionString = container.GetConnectionString();
        await new {ModuleName}DbContext(
            new DbContextOptionsBuilder<{ModuleName}DbContext>()
                .UseNpgsql(connectionString)
                .Options
        ).Database.EnsureCreatedAsync();
    }

    public Task DisposeAsync()
    {
        return container.DisposeAsync().AsTask();
    }
}

module file:

[DependsOn(
    typeof({ModuleName}TestBaseModule),
    typeof({ModuleName}EntityFrameworkCoreModule),
    typeof(AbpEntityFrameworkCorePostgreSqlModule)
)]
public class {ModuleName}EntityFrameworkCoreTestModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        //configure all databases
        Configure<AbpDbContextOptions>(options =>
        {
            options.Configure(abpDbContextConfigurationContext =>
            {
                var connectionString = EfCoreFixture.Instance.GetConnectionString();
                abpDbContextConfigurationContext.DbContextOptions.UseNpgsql(connectionString);
            });
        });
    }
}

On each Concrete test class

add the annotation [Collection({ModuleName}TestConsts.CollectionName)]

Note that most concrete (non abstract) test classes exist in .EntityFrameworkCore.Tests in ABP V8
or .Application.Tests/.Domain.Tests layers in ABP V7

[ahmednfwela]

Updated EfCoreFixture.cs file to avoid using sync over async