Skip to content

Commit fe62d05

Browse files
committed
chore: Apply repo standards
1 parent 977d348 commit fe62d05

File tree

6 files changed

+24
-25
lines changed

6 files changed

+24
-25
lines changed

docs/modules/servicebus.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,9 @@ The Service Bus module depends on an MSSQL container instance. The module automa
4444

4545
## Use a custom Config.json
4646

47-
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:
47+
The Azure Service Bus Emulator provides a [default](https://learn.microsoft.com/en-us/azure/service-bus-messaging/test-locally-with-service-bus-emulator?tabs=automated-script#interact-with-the-emulator) configuration. If a custom configuration is desired, you can use the following method to provide a custom JSON file to the builder accordingly:
4848

4949
=== "Use Custom Configuration"
50-
```csharp
51-
--8<-- "tests/Testcontainers.ServiceBus.Tests/ServiceBusContainerTest.cs:UseCustomConfiguration"
52-
```
53-
See Azure Service Bus emulator documentation for information on creating that json file.
50+
```csharp
51+
--8<-- "tests/Testcontainers.ServiceBus.Tests/ServiceBusContainerTest.cs:UseCustomConfiguration"
52+
```

src/Testcontainers.ServiceBus/ServiceBusBuilder.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
using System.IO;
2-
31
namespace Testcontainers.ServiceBus;
42

53
/// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
@@ -87,16 +85,18 @@ public ServiceBusBuilder WithMsSqlContainer(
8785
.WithEnvironment("SQL_SERVER", networkAlias)
8886
.WithEnvironment("MSSQL_SA_PASSWORD", password);
8987
}
90-
88+
9189
/// <summary>
92-
/// Sets the configuration file for the Azure Service Bus Emulator.
90+
/// Sets the configuration for the Azure Service Bus Emulator.
9391
/// </summary>
94-
/// <param name="customConfigFile">The JSON file containing desired Azure Service Bus configuration</param>
92+
/// <remarks>
93+
/// Default emulator configuration: https://learn.microsoft.com/en-us/azure/service-bus-messaging/test-locally-with-service-bus-emulator?tabs=automated-script#interact-with-the-emulator.
94+
/// </remarks>
95+
/// <param name="configFilePath">The path to the JSON file containing the Azure Service Bus Emulator configuration.</param>
9596
/// <returns>A configured instance of <see cref="ServiceBusBuilder" />.</returns>
96-
public ServiceBusBuilder WithConfig(string customConfigFile)
97+
public ServiceBusBuilder WithConfig(string configFilePath)
9798
{
98-
return WithResourceMapping(new FileInfo(customConfigFile),
99-
new FileInfo("/ServiceBus_Emulator/ConfigFiles/Config.json"));
99+
return WithResourceMapping(new FileInfo(configFilePath), new FileInfo("/ServiceBus_Emulator/ConfigFiles/Config.json"));
100100
}
101101

102102
/// <inheritdoc />

src/Testcontainers.ServiceBus/Usings.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
global using System;
22
global using System.Collections.Generic;
3+
global using System.IO;
34
global using System.Linq;
45
global using System.Threading;
56
global using System.Threading.Tasks;

tests/Testcontainers.ServiceBus.Tests/ServiceBusContainerTest.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ private ServiceBusContainerTest(ServiceBusContainer serviceBusContainer)
99
_serviceBusContainer = serviceBusContainer;
1010
}
1111

12+
protected virtual string QueueName => "queue.1";
13+
1214
// # --8<-- [start:UseServiceBusContainer]
1315
public Task InitializeAsync()
1416
{
@@ -20,8 +22,6 @@ public Task DisposeAsync()
2022
return _serviceBusContainer.DisposeAsync().AsTask();
2123
}
2224

23-
protected virtual string QueueName => "queue.1";
24-
2525
[Fact]
2626
[Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
2727
public async Task ReceiveMessageReturnsSentMessage()
@@ -82,21 +82,21 @@ public ServiceBusCustomMsSqlConfiguration(DatabaseFixture fixture)
8282
{
8383
}
8484
}
85-
85+
8686
[UsedImplicitly]
87-
public sealed class ServiceBusCustomConfig : ServiceBusContainerTest, IClassFixture<DatabaseFixture>
87+
public sealed class ServiceBusCustomQueueConfiguration : ServiceBusContainerTest, IClassFixture<DatabaseFixture>
8888
{
89-
protected override string QueueName => "custom-queue.1";
90-
91-
public ServiceBusCustomConfig()
89+
public ServiceBusCustomQueueConfiguration()
9290
: base(new ServiceBusBuilder()
9391
.WithAcceptLicenseAgreement(true)
9492
// # --8<-- [start:UseCustomConfiguration]
95-
.WithConfig("customConfig.json")
93+
.WithConfig("custom-queue-config.json")
9694
// # --8<-- [end:UseCustomConfiguration]
9795
.Build())
9896
{
9997
}
98+
99+
protected override string QueueName => "custom-queue.1";
100100
}
101101

102102
[UsedImplicitly]

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@
1818
<ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
1919
</ItemGroup>
2020
<ItemGroup>
21-
<None Remove="customConfig.json" />
22-
<Content Include="customConfig.json">
23-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
24-
</Content>
21+
<None Update="custom-queue-config.json">
22+
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
23+
</None>
2524
</ItemGroup>
2625
</Project>

tests/Testcontainers.ServiceBus.Tests/customConfig.json renamed to tests/Testcontainers.ServiceBus.Tests/custom-queue-config.json

File renamed without changes.

0 commit comments

Comments
 (0)