Allow custom Database-name in MsSqlTestcontainerConfiguration

[FelixSFD]

Is your feature request related to a problem? Please describe.
I'm trying to switch all our tests to use Testcontainers instead of real databases on a server. However, at least one of our Entity Framework migrations contains code to alter the current database. This does not work, because MsSqlTestcontainerConfiguration defaults to the master-DB which may not be altered.

Microsoft.Data.SqlClient.SqlException : Cannot alter the database 'master' because it is a system database.

When I try to set the DB-name in the configuration, a NotImplementedException will be thrown.

TestcontainerDatabaseConfiguration containerConfig = new MsSqlTestcontainerConfiguration
{
  Password = Random.Shared.NextAlphaNumeric(16),
  Database = $"TestDb_{Random.Shared.NextAlphaNumeric(5)}"
};

System.NotImplementedException : The method or operation is not implemented.
MsSqlTestcontainerConfiguration.set_Database(String value)
TestStartupBase.GetTestDbContainer() line 174
TestStartupBase.StartTestDbContainer(Int32 timeout) line 142
TestStartupBase.GetTestDbConnectionString() line 156
Startup.ConfigureServices(IServiceCollection services) line 32

testcontainers-dotnet/src/Testcontainers/Configurations/Modules/Databases/MsSqlTestcontainerConfiguration.cs

Lines 34 to 38 in fff8c08

	public override string Database
	{
	get => "master";
	set => throw new NotImplementedException();
	}

Describe the solution you'd like
MsSqlTestcontainerConfiguration.Database should be customizeable.

Describe alternatives you've considered
I don't know any alternatives (yet).

Additional context
This is probably the migration that fails when using the master-DB:

migrationBuilder.AlterDatabase(collation: "Latin1_General_CS_AS");

[FelixSFD]

I should have checked the Pull-Requests before creating an issue... 🤦‍♂️
#521

[HofmeisterAn]

I should have checked the Pull-Requests before creating an issue... 🤦‍♂️ #521

Yep 😅. Would you like to take a look at that? Any help is more than welcome.

[mrpmorris]

You can achieve this by calling ExecuteScriptAsync on your MsSqlContainer to create a database, and then replacing Database=master with your own value.

Here is some code I use in my unit tests.

internal static class TestSqlServerDatabaseFactory
{
    private static readonly Lazy<ValueTask<MsSqlContainer>> GetServerInstance = new(CreateServerInstanceAsync);
    private static int? Port;

    public static async ValueTask<string> CreateDatabaseAndGetConnectionStringAsync()
    {
        MsSqlContainer serverInstance = await GetServerInstance.Value;
        string databaseName = "Test" + Guid.NewGuid().ToString().Replace("-", "");
        await serverInstance.ExecScriptAsync($"create database [{databaseName}]");
        string connectionString =
            serverInstance
                .GetConnectionString()
                .Replace("Database=master", $"Database={databaseName}");
        return connectionString;
    }

    public static void SetPort(int port)
    {
        if (Port is not null && Port != port)
            Port = port;
    }

    private static async ValueTask<MsSqlContainer> CreateServerInstanceAsync()
    {
        var result =
            new MsSqlBuilder()
                .WithAutoRemove(autoRemove: true)
                .WithExposedPort(Port ?? 54465)
                .Build();

        await result.StartAsync();
        return result;
    }
}