feat: Add connection string provider (#1588)

Author: HofmeisterAn

docs/api/connection_string_provider.md

@@ -0,0 +1,82 @@
+# Connection String Provider
+
+The Connection String Provider API provides a standardized way to access and manage connection information for Testcontainers (modules). It allows developers to customize module-provided connection strings or add their own, and to access module-specific connection strings or endpoints (e.g., database connection strings, HTTP API base addresses) in a uniform way.
+
+!!!note
+
+    Testcontainers modules do not yet implement this feature. Developers can use the provider to define and manage their own connection strings or endpoints. Providers will be integrated by modules in future releases.
+
+## Example
+
+Register a custom connection string provider via the container builder:
+
+```csharp
+IContainer container = new ContainerBuilder()
+  .WithConnectionStringProvider(new MyProvider1())
+  .Build();
+
+// Implicit host connection string (default)
+var hostConnectionStringImplicit = container.GetConnectionString();
+
+// Explicit host connection string
+var hostConnectionStringExplicit = container.GetConnectionString(ConnectionMode.Host);
+
+// Container-to-container connection string
+var containerConnectionString = container.GetConnectionString(ConnectionMode.Container);
+```
+
+## Implementing a custom provider
+
+To create a custom provider, implement the generic interface: `IConnectionStringProvider<TContainer, TConfiguration>`. The `Configure(TContainer, TConfiguration)` method is invoked after the container has successfully started, ensuring that all runtime-assigned values are available.
+
+=== "Generic builder"
+    ```csharp
+    public sealed class MyProvider1 : IConnectionStringProvider<IContainer, IContainerConfiguration>
+    {
+      public void Configure(IContainer container, IContainerConfiguration configuration)
+      {
+        // Initialize provider with container information.
+      }
+
+      public string GetConnectionString(ConnectionMode connectionMode = ConnectionMode.Host)
+      {
+        // This method returns a default connection string. The connection mode argument
+        // lets you choose between a host connection or a container-to-container connection.
+        return "...";
+      }
+
+      public string GetConnectionString(string name, ConnectionMode connectionMode = ConnectionMode.Host)
+      {
+        // This method returns a connection string for the given name. Useful for modules
+        // with multiple endpoints (e.g., Azurite blob, queue, or table).
+        return "...";
+      }
+    }
+    ```
+
+=== "Module builder"
+    ```csharp
+    public sealed class MyProvider2 : IConnectionStringProvider<PostgreSqlContainer, PostgreSqlConfiguration>
+    {
+      private string _host;
+
+      private ushort _port;
+
+      public void Configure(PostgreSqlContainer container, PostgreSqlConfiguration configuration)
+      {
+        // Initialize provider with container information.
+        _host = container.Hostname;
+        _port = container.GetMappedPublicPort(PostgreSqlBuilder.PostgreSqlPort);
+      }
+
+      public string GetConnectionString(ConnectionMode connectionMode = ConnectionMode.Host)
+      {
+        return $"Host={_host};Port={_port};...";
+      }
+
+      public string GetConnectionString(string name, ConnectionMode connectionMode = ConnectionMode.Host)
+      {
+        return $"Host={_host};Port={_port};...;SSL Mode=Require";
+      }
+    }
+    ```

mkdocs.yml

@@ -40,6 +40,7 @@ nav:
   - api/resource_reaper.md
   - api/resource_reuse.md
   - api/wait_strategies.md
+  - api/connection_string_provider.md
   - api/best_practices.md
   - dind/index.md
   - full_framework/index.md

src/Testcontainers.Couchbase/CouchbaseBuilder.cs

@@ -179,7 +179,7 @@ private CouchbaseBuilder WithBucket(params CouchbaseBucket[] bucket)
     /// <summary>
     /// Configures the Couchbase node.
     /// </summary>
-    /// <param name="container">The container.</param>
+    /// <param name="container">The Couchbase container.</param>
     /// <param name="ct">Cancellation token.</param>
     private async Task ConfigureCouchbaseAsync(IContainer container, CancellationToken ct = default)
     {

src/Testcontainers/Builders/ContainerBuilder`3.cs

@@ -396,6 +396,12 @@ public TBuilderEntity WithStartupCallback(Func<TContainerEntity, TConfigurationE
       return Clone(new ContainerConfiguration(startupCallback: (container, configuration, ct) => startupCallback((TContainerEntity)container, (TConfigurationEntity)configuration, ct)));
     }
 
+    /// <inheritdoc />
+    public TBuilderEntity WithConnectionStringProvider(IConnectionStringProvider<TContainerEntity, TConfigurationEntity> connectionStringProvider)
+    {
+      return Clone(new ContainerConfiguration(connectionStringProvider: new ConnectionStringProvider<TContainerEntity, TConfigurationEntity>(connectionStringProvider)));
+    }
+
     /// <inheritdoc />
     protected override TBuilderEntity Init()
     {

src/Testcontainers/Builders/IContainerBuilder`2.cs

@@ -21,6 +21,8 @@ namespace DotNet.Testcontainers.Builders
   /// <typeparam name="TConfigurationEntity">The configuration entity.</typeparam>
   [PublicAPI]
   public interface IContainerBuilder<out TBuilderEntity, out TContainerEntity, out TConfigurationEntity> : IAbstractBuilder<TBuilderEntity, TContainerEntity, CreateContainerParameters>
+    where TContainerEntity : IContainer
+    where TConfigurationEntity : IContainerConfiguration
   {
     /// <summary>
     /// Accepts the license agreement.
@@ -500,5 +502,13 @@ public interface IContainerBuilder<out TBuilderEntity, out TContainerEntity, out
     /// <returns>A configured instance of <typeparamref name="TBuilderEntity" />.</returns>
     [PublicAPI]
     TBuilderEntity WithStartupCallback(Func<TContainerEntity, TConfigurationEntity, CancellationToken, Task> startupCallback);
+
+    /// <summary>
+    /// Sets the connection string provider.
+    /// </summary>
+    /// <param name="connectionStringProvider">The connection string provider.</param>
+    /// <returns>A configured instance of <typeparamref name="TBuilderEntity" />.</returns>
+    [PublicAPI]
+    TBuilderEntity WithConnectionStringProvider(IConnectionStringProvider<TContainerEntity, TConfigurationEntity> connectionStringProvider);
   }
 }

src/Testcontainers/Configurations/Containers/ConnectionMode.cs

@@ -0,0 +1,21 @@
+namespace DotNet.Testcontainers.Configurations
+{
+  using JetBrains.Annotations;
+
+  /// <summary>
+  /// Represents the connection mode.
+  /// </summary>
+  [PublicAPI]
+  public enum ConnectionMode
+  {
+    /// <summary>
+    /// The connection string for the container.
+    /// </summary>
+    Container,
+
+    /// <summary>
+    /// The connection string for the host.
+    /// </summary>
+    Host,
+  }
+}

src/Testcontainers/Configurations/Containers/ConnectionStringProvider.cs

@@ -0,0 +1,39 @@
+namespace DotNet.Testcontainers.Configurations
+{
+  using DotNet.Testcontainers.Containers;
+
+  /// <inheritdoc cref="IConnectionStringProvider{TContainerEntity, TConfigurationEntity}" />
+  internal sealed class ConnectionStringProvider<TContainerEntity, TConfigurationEntity> : IConnectionStringProvider<IContainer, IContainerConfiguration>
+    where TContainerEntity : IContainer
+    where TConfigurationEntity : IContainerConfiguration
+  {
+    private readonly IConnectionStringProvider<TContainerEntity, TConfigurationEntity> _connectionStringProvider;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConnectionStringProvider{TContainerEntity, TConfigurationEntity}" /> class.
+    /// </summary>
+    /// <param name="connectionStringProvider">The connection string provider.</param>
+    public ConnectionStringProvider(IConnectionStringProvider<TContainerEntity, TConfigurationEntity> connectionStringProvider)
+    {
+      _connectionStringProvider = connectionStringProvider;
+    }
+
+    /// <inheritdoc />
+    public void Configure(IContainer container, IContainerConfiguration configuration)
+    {
+      _connectionStringProvider.Configure((TContainerEntity)container, (TConfigurationEntity)configuration);
+    }
+
+    /// <inheritdoc />
+    public string GetConnectionString(ConnectionMode connectionMode = ConnectionMode.Host)
+    {
+      return _connectionStringProvider.GetConnectionString(connectionMode);
+    }
+
+    /// <inheritdoc />
+    public string GetConnectionString(string name, ConnectionMode connectionMode = ConnectionMode.Host)
+    {
+      return _connectionStringProvider.GetConnectionString(name, connectionMode);
+    }
+  }
+}

src/Testcontainers/Configurations/Containers/ContainerConfiguration.cs

@@ -62,6 +62,7 @@ public ContainerConfiguration(
       IOutputConsumer outputConsumer = null,
       IEnumerable<WaitStrategy> waitStrategies = null,
       Func<IContainer, IContainerConfiguration, CancellationToken, Task> startupCallback = null,
+      IConnectionStringProvider<IContainer, IContainerConfiguration> connectionStringProvider = null,
       bool? autoRemove = null,
       bool? privileged = null)
     {
@@ -87,6 +88,7 @@ public ContainerConfiguration(
       OutputConsumer = outputConsumer;
       WaitStrategies = waitStrategies;
       StartupCallback = startupCallback;
+      ConnectionStringProvider = connectionStringProvider;
     }
 
     /// <summary>
@@ -135,6 +137,7 @@ public ContainerConfiguration(IContainerConfiguration oldValue, IContainerConfig
       OutputConsumer = BuildConfiguration.Combine(oldValue.OutputConsumer, newValue.OutputConsumer);
       WaitStrategies = BuildConfiguration.Combine<IEnumerable<WaitStrategy>>(oldValue.WaitStrategies, newValue.WaitStrategies);
       StartupCallback = BuildConfiguration.Combine(oldValue.StartupCallback, newValue.StartupCallback);
+      ConnectionStringProvider = BuildConfiguration.Combine(oldValue.ConnectionStringProvider, newValue.ConnectionStringProvider);
       AutoRemove = (oldValue.AutoRemove.HasValue && oldValue.AutoRemove.Value) || (newValue.AutoRemove.HasValue && newValue.AutoRemove.Value);
       Privileged = (oldValue.Privileged.HasValue && oldValue.Privileged.Value) || (newValue.Privileged.HasValue && newValue.Privileged.Value);
     }
@@ -217,5 +220,9 @@ public ContainerConfiguration(IContainerConfiguration oldValue, IContainerConfig
     /// <inheritdoc />
     [JsonIgnore]
     public Func<IContainer, IContainerConfiguration, CancellationToken, Task> StartupCallback { get; }
+
+    /// <inheritdoc />
+    [JsonIgnore]
+    public IConnectionStringProvider<IContainer, IContainerConfiguration> ConnectionStringProvider { get; }
   }
 }

src/Testcontainers/Configurations/Containers/IConnectionStringProvider.cs

@@ -0,0 +1,31 @@
+namespace DotNet.Testcontainers.Configurations
+{
+  using DotNet.Testcontainers.Containers;
+  using JetBrains.Annotations;
+
+  /// <summary>
+  /// A connection string provider.
+  /// </summary>
+  [PublicAPI]
+  public interface IConnectionStringProvider
+  {
+    /// <summary>
+    /// Gets the connection string.
+    /// </summary>
+    /// <param name="connectionMode">The connection mode.</param>
+    /// <returns>The connection string.</returns>
+    /// <exception cref="ConnectionStringProviderNotConfiguredException">Thrown when the connection string provider is not configured.</exception>
+    [NotNull]
+    string GetConnectionString(ConnectionMode connectionMode = ConnectionMode.Host);
+
+    /// <summary>
+    /// Gets the connection string.
+    /// </summary>
+    /// <param name="name">The connection string name.</param>
+    /// <param name="connectionMode">The connection mode.</param>
+    /// <returns>The connection string.</returns>
+    /// <exception cref="ConnectionStringProviderNotConfiguredException">Thrown when the connection string provider is not configured.</exception>
+    [NotNull]
+    string GetConnectionString(string name, ConnectionMode connectionMode = ConnectionMode.Host);
+  }
+}

src/Testcontainers/Configurations/Containers/IConnectionStringProvider`2.cs

@@ -0,0 +1,19 @@
+namespace DotNet.Testcontainers.Configurations
+{
+  using DotNet.Testcontainers.Containers;
+  using JetBrains.Annotations;
+
+  /// <inheritdoc cref="IConnectionStringProvider" />
+  [PublicAPI]
+  public interface IConnectionStringProvider<in TContainerEntity, in TConfigurationEntity> : IConnectionStringProvider
+    where TContainerEntity : IContainer
+    where TConfigurationEntity : IContainerConfiguration
+  {
+    /// <summary>
+    /// Configures the connection string provider.
+    /// </summary>
+    /// <param name="container">The container instance.</param>
+    /// <param name="configuration">The container configuration.</param>
+    void Configure(TContainerEntity container, TConfigurationEntity configuration);
+  }
+}