fix: PR review

Signed-off-by: SebastienDegodez <[email protected]>

Author: SebastienDegodez

.github/instructions/contract-testing-microcks-dotnet.instructions.md

@@ -41,7 +41,7 @@ public class OrderApiContractTest : BaseIntegrationTest
 {
     private readonly ITestOutputHelper TestOutputHelper;
 
-    public OrderApiContractTest(ITestOutputHelper testOutputHelper, MicrocksWebApplicationFactory<Program> factory)
+    public OrderApiContractTest(ITestOutputHelper testOutputHelper, OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;
@@ -73,14 +73,14 @@ public class OrderApiContractTest : BaseIntegrationTest
 
 ### Custom WebApplicationFactory: .NET 10+ and below
 
-For both .NET 10+ and below, you must call `UseKestrel()` in your `MicrocksWebApplicationFactory` to ensure real HTTP server testing for contract tests. The only difference is the base class:
+For both .NET 10+ and below, you must call `UseKestrel()` in your `OrderServiceWebApplicationFactory` to ensure real HTTP server testing for contract tests. The only difference is the base class:
 
 For .NET 10 and above, inherit from `WebApplicationFactory<TProgram>`:
 ```csharp
-public class MicrocksWebApplicationFactory<TProgram> : WebApplicationFactory<TProgram>
+public class OrderServiceWebApplicationFactory<TProgram> : WebApplicationFactory<TProgram>
     where TProgram : class
 {
-    public MicrocksWebApplicationFactory()
+    public OrderServiceWebApplicationFactory()
     {
         // Even in .NET 10+, call UseKestrel() for consistency and explicitness
         UseKestrel();
@@ -90,7 +90,7 @@ public class MicrocksWebApplicationFactory<TProgram> : WebApplicationFactory<TPr
 
 For .NET 9 and below, inherit from `KestrelWebApplicationFactory<TProgram>`:
 ```csharp
-public class MicrocksWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
+public class OrderServiceWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
     where TProgram : class
 {
     private const string MicrocksImage = "quay.io/microcks/microcks-uber:1.12.1";
@@ -158,14 +158,14 @@ public class MicrocksWebApplicationFactory<TProgram> : KestrelWebApplicationFact
 
 ### Base Integration Test with Proper Initialization
 ```csharp
-public class BaseIntegrationTest : IClassFixture<MicrocksWebApplicationFactory<Program>>
+public class BaseIntegrationTest : IClassFixture<OrderServiceWebApplicationFactory<Program>>
 {
     public WebApplicationFactory<Program> Factory { get; private set; }
     public ushort Port { get; private set; }
     public MicrocksContainerEnsemble MicrocksContainerEnsemble { get; }
     public MicrocksContainer MicrocksContainer => MicrocksContainerEnsemble.MicrocksContainer;
 
-    protected BaseIntegrationTest(MicrocksWebApplicationFactory<Program> factory)
+    protected BaseIntegrationTest(OrderServiceWebApplicationFactory<Program> factory)
     {
         Factory = factory;
         Port = factory.ActualPort;

README.md

@@ -16,7 +16,7 @@ You will work with a ASP.NET Core application and explore:
 - [Step 5: Write Tests for Async](step5-write-async-tests.md)
 
 Complementary Resources:
-- [Integration Testing Patterns](step-integration-testing-patterns.md)
+- [Integration Testing Patterns](explain-integration-testing-patterns.md)
 
 ## License Summary
 

explain-integration-testing-patterns.md

@@ -7,7 +7,7 @@ This guide explains two different approaches for setting up integration tests wi
 When writing integration tests that use Microcks and Kafka containers, you have two main architectural choices:
 
 1. **IClassFixture Pattern**: Multiple container instances, isolated per test class
-2. **ICollectionFixture Pattern**: Single shared container instance, optimized for performance
+2. **ICollectionFixture Pattern**: A set of shared container instances (e.g., one Microcks container and one Kafka container) used by all test classes for optimal performance and resource efficiency
 
 ## Pattern 1: IClassFixture - Isolated Test Classes
 
@@ -19,7 +19,7 @@ When writing integration tests that use Microcks and Kafka containers, you have
 
 ### Architecture
 ```csharp
-public class MyTestClass : IClassFixture<MicrocksWebApplicationFactory<Program>>
+public class MyTestClass : IClassFixture<OrderServiceWebApplicationFactory<Program>>
 {
     // Each test class gets its own factory instance
     // Each factory starts its own containers
@@ -34,8 +34,15 @@ public class MyTestClass : IClassFixture<MicrocksWebApplicationFactory<Program>>
 ### Implementation Example
 
 #### Step 1: WebApplicationFactory with Dynamic Ports
+
+> **Note:**
+> The implementation of `OrderServiceWebApplicationFactory` (or `OrderServiceWebApplicationFactory`) must be adapted depending on the fixture pattern:
+>
+> - With **IClassFixture**, each test class gets its own factory and containers. You must allocate **dynamic ports** for Kestrel, Kafka, and all services, because static port mapping (like `kafka:9092:9092`) is not possible—otherwise, you will have port conflicts if tests run in parallel. All port assignments must be programmatic and injected into your test server and mocks.
+>
+> - With **ICollectionFixture** (shared collection), a single factory and set of containers are shared for all tests. You allocate ports only once, which simplifies configuration and avoids conflicts. This is why the shared collection pattern is recommended for most test suites.
 ```csharp
-public class MicrocksWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
+public class OrderServiceWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
     where TProgram : class
 {
     public ushort ActualPort { get; private set; }
@@ -102,13 +109,13 @@ public class MicrocksWebApplicationFactory<TProgram> : KestrelWebApplicationFact
 
 #### Step 2: Test Class Implementation
 ```csharp
-public class OrderControllerTests : IClassFixture<MicrocksWebApplicationFactory<Program>>
+public class OrderControllerTests : IClassFixture<OrderServiceWebApplicationFactory<Program>>
 {
-    private readonly MicrocksWebApplicationFactory<Program> _factory;
+    private readonly OrderServiceWebApplicationFactory<Program> _factory;
     private readonly ITestOutputHelper _testOutput;
 
     public OrderControllerTests(
-        MicrocksWebApplicationFactory<Program> factory,
+        OrderServiceWebApplicationFactory<Program> factory,
         ITestOutputHelper testOutput)
     {
         _factory = factory;
@@ -153,15 +160,15 @@ public class OrderControllerTests : IClassFixture<MicrocksWebApplicationFactory<
 ### Architecture
 ```csharp
 [Collection(SharedTestCollection.Name)]
-public class MyTestClass : BaseIntegrationTest
+public class MyTestClass
 {
     // All test classes share the same factory instance
     // Single set of containers for all tests
 }
 ```
 
 ### Key Benefits
-- **Single Container Instance**: One Microcks + one Kafka container for all tests
+- **Single set of containers Instances**: One Microcks + one Kafka container for all tests
 - **Performance Optimized**: ~70% faster test execution
 - **Resource Efficient**: Lower memory and CPU usage
 - **Single Port Allocation**: One Kestrel port for the entire test suite
@@ -171,15 +178,15 @@ public class MyTestClass : BaseIntegrationTest
 #### Step 1: Shared Collection Definition
 ```csharp
 [CollectionDefinition(Name)]
-public class SharedTestCollection : ICollectionFixture<MicrocksWebApplicationFactory<Program>>
+public class SharedTestCollection : ICollectionFixture<OrderServiceWebApplicationFactory<Program>>
 {
     public const string Name = "SharedTestCollection";
 }
 ```
 
 #### Step 2: Enhanced WebApplicationFactory
 ```csharp
-public class MicrocksWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
+public class OrderServiceWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
     where TProgram : class
 {
     private static readonly SemaphoreSlim InitializationSemaphore = new(1, 1);
@@ -250,7 +257,7 @@ public abstract class BaseIntegrationTest
     public KafkaContainer KafkaContainer { get; }
     public HttpClient HttpClient { get; private set; }
 
-    protected BaseIntegrationTest(MicrocksWebApplicationFactory<Program> factory)
+    protected BaseIntegrationTest(OrderServiceWebApplicationFactory<Program> factory)
     {
         Factory = factory;
         HttpClient = factory.CreateClient();
@@ -274,7 +281,7 @@ public class OrderControllerTests : BaseIntegrationTest
 
     public OrderControllerTests(
         ITestOutputHelper testOutput,
-        MicrocksWebApplicationFactory<Program> factory)
+        OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         _testOutput = testOutput;

step4-write-rest-tests.md

@@ -9,7 +9,7 @@ Let's fix that!!
 
 For all the integration tests in our application, we need to start Kafka and use mocks provided by Microcks containers.
 
-### Review MicrocksWebApplicationFactory<Program> class under tests/Order.Service.Tests
+### Review OrderServiceWebApplicationFactory<Program> class under tests/Order.Service.Tests
 
 In .NET, we use a custom `WebApplicationFactory<Program>` to provision all required containers and inject configuration for local development and testing. This leverages the .NET Testcontainers library and ASP.NET Core's test infrastructure.
 
@@ -22,7 +22,7 @@ Here's how it works:
 
 Example:
 ```csharp
-public class MicrocksWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
+public class OrderServiceWebApplicationFactory<TProgram> : KestrelWebApplicationFactory<TProgram>, IAsyncLifetime
     where TProgram : class
 {
     // ...existing code...
@@ -74,7 +74,7 @@ This setup means you do not need to manually start Kafka, Microcks, or any other
 
 Let's understand what this configuration class does:
 
-* `MicrocksWebApplicationFactory` extends `KestrelWebApplicationFactory<TProgram>` to provide a custom test environment for our application. `KestrelWebApplicationFactory` is a solution to expose the application on the real host port. In the .NET 10 (under development), this class can be replaced by the `WebApplicationFactory<TProgram>` class.
+* `OrderServiceWebApplicationFactory` extends `KestrelWebApplicationFactory<TProgram>` to provide a custom test environment for our application. `KestrelWebApplicationFactory` is a solution to expose the application on the real host port. In the .NET 10 (under development), this class can be replaced by the `WebApplicationFactory<TProgram>` class.
 * `InitializeAsync` method is called to set up the test environment before running tests. It allocates a free port, starts the Kafka container, and initializes the Microcks container ensemble with the required artifacts.
 In detail:
    * We allocate a free port and expose it for container communication, in .NET it's possible to assign a dynamic port to the kestrel server but when we use Microcks Contract Testing, it's necessary to call the `ExposeHostPortsAsync` method to expose the port for host communication.
@@ -128,7 +128,7 @@ public class PastryAPIClientTests : BaseIntegrationTest
 
     public PastryAPIClientTests(
         ITestOutputHelper testOutputHelper,
-        MicrocksWebApplicationFactory<Program> factory)
+        OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;

step5-write-async-tests.md

@@ -25,7 +25,7 @@ public class OrderKafkaContractTests : BaseIntegrationTest
 
     public OrderKafkaContractTests(
         ITestOutputHelper testOutputHelper,
-        MicrocksWebApplicationFactory<Program> factory)
+        OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;
@@ -181,7 +181,7 @@ public class OrderEventListenerTests : BaseIntegrationTest
 
     public OrderEventListenerTests(
         ITestOutputHelper testOutputHelper,
-        MicrocksWebApplicationFactory<Program> factory) 
+        OrderServiceWebApplicationFactory<Program> factory) 
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;

tests/Order.Service.Tests/Api/OrderControllerContractTests.cs

@@ -34,7 +34,7 @@ public class OrderControllerContractTests : BaseIntegrationTest
 
     public OrderControllerContractTests(
         ITestOutputHelper testOutputHelper,
-        MicrocksWebApplicationFactory<Program> factory)
+        OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;

tests/Order.Service.Tests/Api/OrderControllerPostmanContractTests.cs

@@ -30,7 +30,7 @@ public class OrderControllerPostmanContractTests : BaseIntegrationTest
 
     public OrderControllerPostmanContractTests(
         ITestOutputHelper testOutputHelper,
-        MicrocksWebApplicationFactory<Program> factory)
+        OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;

tests/Order.Service.Tests/BaseIntegrationTest.cs

@@ -26,7 +26,7 @@
 namespace Order.Service.Tests;
 
 /// <summary>
-/// Base class for integration tests using a shared MicrocksWebApplicationFactory instance.
+/// Base class for integration tests using a shared OrderServiceWebApplicationFactory instance.
 /// All tests inheriting from this class will share the same factory instance across the entire test assembly.
 /// </summary>
 [Collection(SharedTestCollection.Name)]
@@ -41,7 +41,7 @@ public abstract class BaseIntegrationTest
     public KafkaContainer KafkaContainer { get; }
     public HttpClient? HttpClient { get; private set; }
 
-    protected BaseIntegrationTest(MicrocksWebApplicationFactory<Program> factory)
+    protected BaseIntegrationTest(OrderServiceWebApplicationFactory<Program> factory)
     {
         Factory = factory;
 

tests/Order.Service.Tests/Client/PastryAPIClientTests.cs

@@ -36,7 +36,7 @@ public class PastryAPIClientTests : BaseIntegrationTest
 
     public PastryAPIClientTests(
         ITestOutputHelper testOutputHelper,
-        MicrocksWebApplicationFactory<Program> factory)
+        OrderServiceWebApplicationFactory<Program> factory)
         : base(factory)
     {
         TestOutputHelper = testOutputHelper;

tests/Order.Service.Tests/Order.Service.Tests.csproj

@@ -6,6 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Awaitility.NET" Version="1.0.2" />
     <PackageReference Include="coverlet.collector" Version="6.0.4">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>