-
-
Notifications
You must be signed in to change notification settings - Fork 273
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add Firebird SQL module (#1073)
Co-authored-by: Jasper Park <[email protected]> Co-authored-by: Andre Hofmeister <[email protected]>
- Loading branch information
3 people
authored
Jan 2, 2024
1 parent
1e88fe9
commit 8857c60
Showing
11 changed files
with
420 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| root = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| namespace Testcontainers.FirebirdSql; | ||
|
|
||
| /// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" /> | ||
| [PublicAPI] | ||
| public sealed class FirebirdSqlBuilder : ContainerBuilder<FirebirdSqlBuilder, FirebirdSqlContainer, FirebirdSqlConfiguration> | ||
| { | ||
| public const string FirebirdSqlImage = "jacobalberty/firebird:v4.0"; | ||
|
|
||
| public const ushort FirebirdSqlPort = 3050; | ||
|
|
||
| public const string DefaultDatabase = "test"; | ||
|
|
||
| public const string DefaultUsername = "test"; | ||
|
|
||
| public const string DefaultPassword = "test"; | ||
|
|
||
| public const string DefaultSysdbaPassword = "masterkey"; | ||
|
|
||
| private const string TestQueryString = "SELECT 1 FROM RDB$DATABASE;"; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlBuilder" /> class. | ||
| /// </summary> | ||
| public FirebirdSqlBuilder() | ||
| : this(new FirebirdSqlConfiguration()) | ||
| { | ||
| DockerResourceConfiguration = Init().DockerResourceConfiguration; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlBuilder" /> class. | ||
| /// </summary> | ||
| /// <param name="resourceConfiguration">The Docker resource configuration.</param> | ||
| public FirebirdSqlBuilder(FirebirdSqlConfiguration resourceConfiguration) | ||
| : base(resourceConfiguration) | ||
| { | ||
| DockerResourceConfiguration = resourceConfiguration; | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override FirebirdSqlConfiguration DockerResourceConfiguration { get; } | ||
|
|
||
| /// <summary> | ||
| /// Sets the FirebirdSql database. | ||
| /// </summary> | ||
| /// <param name="database">The FirebirdSql database.</param> | ||
| /// <returns>A configured instance of <see cref="FirebirdSqlBuilder" />.</returns> | ||
| public FirebirdSqlBuilder WithDatabase(string database) | ||
| { | ||
| return Merge(DockerResourceConfiguration, new FirebirdSqlConfiguration(database: database)) | ||
| .WithEnvironment("FIREBIRD_DATABASE", database); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the FirebirdSql username. | ||
| /// </summary> | ||
| /// <param name="username">The FirebirdSql username.</param> | ||
| /// <returns>A configured instance of <see cref="FirebirdSqlBuilder" />.</returns> | ||
| public FirebirdSqlBuilder WithUsername(string username) | ||
| { | ||
| return Merge(DockerResourceConfiguration, new FirebirdSqlConfiguration(username: username)) | ||
| .WithEnvironment("FIREBIRD_USER", "sysdba".Equals(username, StringComparison.OrdinalIgnoreCase) ? string.Empty : username); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the FirebirdSql password. | ||
| /// </summary> | ||
| /// <param name="password">The FirebirdSql password.</param> | ||
| /// <returns>A configured instance of <see cref="FirebirdSqlBuilder" />.</returns> | ||
| public FirebirdSqlBuilder WithPassword(string password) | ||
| { | ||
| return Merge(DockerResourceConfiguration, new FirebirdSqlConfiguration(password: password)) | ||
| .WithEnvironment("FIREBIRD_PASSWORD", password) | ||
| .WithEnvironment("ISC_PASSWORD", password); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| public override FirebirdSqlContainer Build() | ||
| { | ||
| Validate(); | ||
| return new FirebirdSqlContainer(DockerResourceConfiguration, TestcontainersSettings.Logger); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override FirebirdSqlBuilder Init() | ||
| { | ||
| return base.Init() | ||
| .WithImage(FirebirdSqlImage) | ||
| .WithPortBinding(FirebirdSqlPort, true) | ||
| .WithDatabase(DefaultDatabase) | ||
| .WithUsername(DefaultUsername) | ||
| .WithPassword(DefaultPassword) | ||
| .WithResourceMapping(Encoding.Default.GetBytes(TestQueryString), "/home/firebird_check.sql") | ||
| .WithWaitStrategy(Wait.ForUnixContainer().UntilContainerIsHealthy()); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override void Validate() | ||
| { | ||
| base.Validate(); | ||
|
|
||
| _ = Guard.Argument(DockerResourceConfiguration.Password, nameof(DockerResourceConfiguration.Password)) | ||
| .NotNull() | ||
| .NotEmpty(); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override FirebirdSqlBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration) | ||
| { | ||
| return Merge(DockerResourceConfiguration, new FirebirdSqlConfiguration(resourceConfiguration)); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override FirebirdSqlBuilder Clone(IContainerConfiguration resourceConfiguration) | ||
| { | ||
| return Merge(DockerResourceConfiguration, new FirebirdSqlConfiguration(resourceConfiguration)); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override FirebirdSqlBuilder Merge(FirebirdSqlConfiguration oldValue, FirebirdSqlConfiguration newValue) | ||
| { | ||
| return new FirebirdSqlBuilder(new FirebirdSqlConfiguration(oldValue, newValue)); | ||
| } | ||
| } |
82 changes: 82 additions & 0 deletions
82
src/Testcontainers.FirebirdSql/FirebirdSqlConfiguration.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| namespace Testcontainers.FirebirdSql; | ||
|
|
||
| /// <inheritdoc cref="ContainerConfiguration" /> | ||
| [PublicAPI] | ||
| public sealed class FirebirdSqlConfiguration : ContainerConfiguration | ||
| { | ||
| private readonly string _database; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlConfiguration" /> class. | ||
| /// </summary> | ||
| /// <param name="database">The FirebirdSql database.</param> | ||
| /// <param name="username">The FirebirdSql username.</param> | ||
| /// <param name="password">The FirebirdSql password.</param> | ||
| public FirebirdSqlConfiguration( | ||
| string database = null, | ||
| string username = null, | ||
| string password = null) | ||
| { | ||
| _database = database; | ||
| Username = username; | ||
| Password = password; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlConfiguration" /> class. | ||
| /// </summary> | ||
| /// <param name="resourceConfiguration">The Docker resource configuration.</param> | ||
| public FirebirdSqlConfiguration(IResourceConfiguration<CreateContainerParameters> resourceConfiguration) | ||
| : base(resourceConfiguration) | ||
| { | ||
| // Passes the configuration upwards to the base implementations to create an updated immutable copy. | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlConfiguration" /> class. | ||
| /// </summary> | ||
| /// <param name="resourceConfiguration">The Docker resource configuration.</param> | ||
| public FirebirdSqlConfiguration(IContainerConfiguration resourceConfiguration) | ||
| : base(resourceConfiguration) | ||
| { | ||
| // Passes the configuration upwards to the base implementations to create an updated immutable copy. | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlConfiguration" /> class. | ||
| /// </summary> | ||
| /// <param name="resourceConfiguration">The Docker resource configuration.</param> | ||
| public FirebirdSqlConfiguration(FirebirdSqlConfiguration resourceConfiguration) | ||
| : this(new FirebirdSqlConfiguration(), resourceConfiguration) | ||
| { | ||
| // Passes the configuration upwards to the base implementations to create an updated immutable copy. | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlConfiguration" /> class. | ||
| /// </summary> | ||
| /// <param name="oldValue">The old Docker resource configuration.</param> | ||
| /// <param name="newValue">The new Docker resource configuration.</param> | ||
| public FirebirdSqlConfiguration(FirebirdSqlConfiguration oldValue, FirebirdSqlConfiguration newValue) | ||
| : base(oldValue, newValue) | ||
| { | ||
| _database = BuildConfiguration.Combine(oldValue._database, newValue._database); | ||
| Username = BuildConfiguration.Combine(oldValue.Username, newValue.Username); | ||
| Password = BuildConfiguration.Combine(oldValue.Password, newValue.Password); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the FirebirdSql database. | ||
| /// </summary> | ||
| public string Database => Image.Tag.StartsWith("2.5") || Image.Tag.StartsWith("v2.5") ? string.Join("/", "/firebird/data", _database) : _database; | ||
|
|
||
| /// <summary> | ||
| /// Gets the FirebirdSql username. | ||
| /// </summary> | ||
| public string Username { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets the FirebirdSql password. | ||
| /// </summary> | ||
| public string Password { get; } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| namespace Testcontainers.FirebirdSql; | ||
|
|
||
| /// <inheritdoc cref="DockerContainer" /> | ||
| [PublicAPI] | ||
| public sealed class FirebirdSqlContainer : DockerContainer, IDatabaseContainer | ||
| { | ||
| private readonly FirebirdSqlConfiguration _configuration; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FirebirdSqlContainer" /> class. | ||
| /// </summary> | ||
| /// <param name="configuration">The container configuration.</param> | ||
| /// <param name="logger">The logger.</param> | ||
| public FirebirdSqlContainer(FirebirdSqlConfiguration configuration, ILogger logger) | ||
| : base(configuration, logger) | ||
| { | ||
| _configuration = configuration; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the FirebirdSql connection string. | ||
| /// </summary> | ||
| /// <returns>The FirebirdSql connection string.</returns> | ||
| public string GetConnectionString() | ||
| { | ||
| var properties = new Dictionary<string, string>(); | ||
| properties.Add("DataSource", Hostname); | ||
| properties.Add("Port", GetMappedPublicPort(FirebirdSqlBuilder.FirebirdSqlPort).ToString()); | ||
| properties.Add("Database", _configuration.Database); | ||
| properties.Add("User", _configuration.Username); | ||
| properties.Add("Password", _configuration.Password); | ||
| return string.Join(";", properties.Select(property => string.Join("=", property.Key, property.Value))); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Executes the SQL script in the FirebirdSql container. | ||
| /// </summary> | ||
| /// <param name="scriptContent">The content of the SQL script to execute.</param> | ||
| /// <param name="ct">Cancellation token.</param> | ||
| /// <returns>Task that completes when the SQL script has been executed.</returns> | ||
| public async Task<ExecResult> ExecScriptAsync(string scriptContent, CancellationToken ct = default) | ||
| { | ||
| var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName()); | ||
|
|
||
| await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct) | ||
| .ConfigureAwait(false); | ||
|
|
||
| return await ExecAsync(new[] { "/usr/local/firebird/bin/isql", "-i", scriptFilePath, "-user", _configuration.Username, "-pass", _configuration.Password, _configuration.Database }, ct) | ||
| .ConfigureAwait(false); | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
src/Testcontainers.FirebirdSql/Testcontainers.FirebirdSql.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks> | ||
| <LangVersion>latest</LangVersion> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" PrivateAssets="All"/> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="$(SolutionDir)src/Testcontainers/Testcontainers.csproj"/> | ||
| </ItemGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| global using System; | ||
| global using System.Collections.Generic; | ||
| global using System.IO; | ||
| global using System.Linq; | ||
| global using System.Text; | ||
| global using System.Threading; | ||
| global using System.Threading.Tasks; | ||
| global using Docker.DotNet.Models; | ||
| global using DotNet.Testcontainers; | ||
| global using DotNet.Testcontainers.Builders; | ||
| global using DotNet.Testcontainers.Configurations; | ||
| global using DotNet.Testcontainers.Containers; | ||
| global using JetBrains.Annotations; | ||
| global using Microsoft.Extensions.Logging; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| root = true |
Oops, something went wrong.