feat: Custom configuration option for Azure Service Bus

Author: cwbmx

docs/modules/servicebus.md

@@ -40,4 +40,14 @@ The Service Bus module depends on an MSSQL container instance. The module automa
 === "Reuse Existing Resources"
     ```csharp
     --8<-- "tests/Testcontainers.ServiceBus.Tests/ServiceBusContainerTest.cs:ReuseExistingMsSqlContainer"
-    ```
+    ```
+
+## Use a custom Config.json
+
+The Azure Service Bus Emulator provides a default configuration. If a custom configuration is desired, you can use the following method to provide the custom json file to the builder accordingly:
+
+=== "Use Custom Configuration"
+```csharp
+--8<-- "tests/Testcontainers.ServiceBus.Tests/ServiceBusContainerTest.cs:UseCustomConfiguration"
+```
+See Azure Service Bus emulator documentation for information on creating that json file.

src/Testcontainers.ServiceBus/ServiceBusBuilder.cs

@@ -1,3 +1,5 @@
+using System.IO;
+
 namespace Testcontainers.ServiceBus;
 
 /// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
@@ -85,6 +87,17 @@ public ServiceBusBuilder WithMsSqlContainer(
             .WithEnvironment("SQL_SERVER", networkAlias)
             .WithEnvironment("MSSQL_SA_PASSWORD", password);
     }
+    
+    /// <summary>
+    /// Sets the configuration file for the Azure Service Bus Emulator.
+    /// </summary>
+    /// <param name="customConfigFile">The JSON file containing desired Azure Service Bus configuration</param>
+    /// <returns>A configured instance of <see cref="ServiceBusBuilder" />.</returns>
+    public ServiceBusBuilder WithConfig(string customConfigFile)
+    {
+        return WithResourceMapping(new FileInfo(customConfigFile),
+            new FileInfo("/ServiceBus_Emulator/ConfigFiles/Config.json"));
+    }
 
     /// <inheritdoc />
     public override ServiceBusContainer Build()

tests/Testcontainers.ServiceBus.Tests/ServiceBusContainerTest.cs

@@ -20,6 +20,8 @@ public Task DisposeAsync()
         return _serviceBusContainer.DisposeAsync().AsTask();
     }
 
+    protected virtual string QueueName => "queue.1";
+
     [Fact]
     [Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
     public async Task ReceiveMessageReturnsSentMessage()
@@ -33,15 +35,14 @@ public async Task ReceiveMessageReturnsSentMessage()
         // Upload a custom configuration before the container starts using the
         // `WithResourceMapping(string, string)` API or one of its overloads:
         // `WithResourceMapping("Config.json", "/ServiceBus_Emulator/ConfigFiles/")`.
-        const string queueName = "queue.1";
 
         var message = new ServiceBusMessage(helloServiceBus);
 
         await using var client = new ServiceBusClient(_serviceBusContainer.GetConnectionString());
 
-        var sender = client.CreateSender(queueName);
+        var sender = client.CreateSender(QueueName);
 
-        var receiver = client.CreateReceiver(queueName);
+        var receiver = client.CreateReceiver(QueueName);
 
         // When
         await sender.SendMessageAsync(message)
@@ -81,6 +82,22 @@ public ServiceBusCustomMsSqlConfiguration(DatabaseFixture fixture)
         {
         }
     }
+    
+    [UsedImplicitly]
+    public sealed class ServiceBusCustomConfig : ServiceBusContainerTest, IClassFixture<DatabaseFixture>
+    {
+        protected override string QueueName => "custom-queue.1";
+
+        public ServiceBusCustomConfig()
+            : base(new ServiceBusBuilder()
+                .WithAcceptLicenseAgreement(true)
+                // # --8<-- [start:UseCustomConfiguration]
+                .WithConfig("customConfig.json")
+                // # --8<-- [end:UseCustomConfiguration]
+                .Build())
+        {
+        }
+    }
 
     [UsedImplicitly]
     public sealed class DatabaseFixture

tests/Testcontainers.ServiceBus.Tests/Testcontainers.ServiceBus.Tests.csproj

@@ -17,4 +17,10 @@
         <ProjectReference Include="../../src/Testcontainers.ServiceBus/Testcontainers.ServiceBus.csproj"/>
         <ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
     </ItemGroup>
+    <ItemGroup>
+      <None Remove="customConfig.json" />
+      <Content Include="customConfig.json">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      </Content>
+    </ItemGroup>
 </Project>

tests/Testcontainers.ServiceBus.Tests/customConfig.json

@@ -0,0 +1,28 @@
+{
+  "UserConfig": {
+    "Namespaces": [
+      {
+        "Name": "sbemulatorns",
+        "Queues": [
+          {
+            "Name": "custom-queue.1",
+            "Properties": {
+              "DeadLetteringOnMessageExpiration": false,
+              "DefaultMessageTimeToLive": "PT1H",
+              "DuplicateDetectionHistoryTimeWindow": "PT20S",
+              "ForwardDeadLetteredMessagesTo": "",
+              "ForwardTo": "",
+              "LockDuration": "PT1M",
+              "MaxDeliveryCount": 3,
+              "RequiresDuplicateDetection": false,
+              "RequiresSession": false
+            }
+          }
+        ]
+      }
+    ],
+    "Logging": {
+      "Type": "File"
+    }
+  }
+}