Merge branch 'microcks:main' into main

SebastienDegodez · web-flow · commit 8a2909ab01fd · 2025-09-23T23:41:52.000+02:00
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "husky": {
-      "version": "0.7.1",
+      "version": "0.7.2",
       "commands": [
         "husky"
       ],
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -63,21 +63,4 @@ jobs:
       - build_test
     if: ${{ needs.build_test.outputs.publish-package != false && github.actor != 'dependabot[bot]' }}
     uses: ./.github/workflows/steps.dotnet-nuget-publish.yml
-    secrets: inherit
-
-  release_drafter:
-    name: 📖 Draft Release
-    permissions:
-      # write permission is required to create a github release
-      contents: write
-      # write permission is required for autolabeler
-      # otherwise, read permission is required at least
-      pull-requests: read
-    if: ${{ needs.build_test.outputs.publish-package != false && github.actor != 'dependabot[bot]' && !needs.version.outputs.preReleaseTag }}
-    needs: 
-      - version
-      - nuget_publish
-    uses: ./.github/workflows/steps.github-release-draft.yml
-    with:
-      version: ${{ needs.version.outputs.version }}
-    secrets: inherit
+    secrets: inherit
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -22,15 +22,15 @@ jobs:
       id-token: write
     steps:
       - name: Checkout Code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5.0.0
         with:
           ssh-key: ${{ secrets.RELEASE_DEPLOY_KEY }}
           lfs: true
           fetch-depth: 0
           ref: ${{ github.event.inputs.branch }}
 
       - name: 🛠️ Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 #v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d #v5.0.0
         with:
           global-json-file: global.json
 
diff --git a/.github/workflows/stale-issues-prs.yml b/.github/workflows/stale-issues-prs.yml
@@ -17,7 +17,7 @@ jobs:
     name: Mark issue or PR as stale
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # To pin v9.1.0
+      - uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # To pin v10.0.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           stale-issue-message: |
@@ -46,4 +46,4 @@ jobs:
           stale-pr-label: stale
           exempt-issue-labels: keep-open
           exempt-pr-labels: keep-open
-          close-issue-reason: not_planned
+          close-issue-reason: not_planned
diff --git a/.github/workflows/steps.dotnet-nuget-publish.yml b/.github/workflows/steps.dotnet-nuget-publish.yml
@@ -16,7 +16,7 @@ jobs:
     runs-on: ${{ inputs.runs-on }}
     steps:
     - name: 📥 Download artifact
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v5
       with:
         name: nugets_${{ inputs.runs-on }}
         path: nuget_packages
diff --git a/.github/workflows/steps.dotnet-version.yml b/.github/workflows/steps.dotnet-version.yml
@@ -15,7 +15,8 @@
       majorMinorPatch:
         description: 'majorMinorPatch (gitversion)'
         value: ${{ jobs.define_version.outputs.majorMinorPatch }}
-permissions: read-all
+permissions:
+  contents: read
 
 jobs:
   define_version:
diff --git a/.github/workflows/steps.github-release-draft.yml b/.github/workflows/steps.github-release-draft.yml
diff --git a/ADOPTERS.md b/ADOPTERS.md
@@ -45,3 +45,4 @@ This document also lists the organizations using Microcks based on public inform
 |[Michelin](https://www.michelin.fr/) | [Alex Picarle](https://github.com/AlexP63) | `End-User` | We use Microcks to elaborate our PoCs, to offer api sandbox or discovery trials and overall promote #DesignFirst approach.|
 |[Amway](https://www.amway.com/) | [Brian Hibma](https://www.linkedin.com/in/brianhibma/) [Sai Bommakanti](https://www.linkedin.com/in/saiabhinay-bommakanti-31014943/) | `end user` | We use Microcks primarily as a platform for API and Event mocking and discovery, integrating it into our DevOps and CI/CD practices, and unblocking parallel, contract-based development from teams. |
 |[BITMARCK](https://www.bitmarck.de) | [Michael Goll](https://github.com/goll-michael) | `end user` | We use Microcks to mock the APIs that correspond to the generated or manually created OpenAPI contracts.|
+|[Agile Actors](https://www.agileactors.com/) | [Stelios Gkiokas](https://github.com/sgkiokas) | `Consultancy` | Microcks is used for speeding up the development time of multiple microservices, both locally and on CI, by leveraging the ability of auto-generating (dynamic) mocks via OpenAPI specs, gRPC contracts and GraphQL schemas in our case. We managed to bridge the gap we had in our client between developers, SETs and Manual QAs in the best possible manner.|
diff --git a/README.md b/README.md
@@ -232,7 +232,7 @@ The list of supported features is the following:
 -   Mocking and contract-testing of GraphQL APIs,
 -   Mocking and contract-testing of gRPC APIs.
 
-To support features like Asynchronous contract-testing, we introduced `MicrocksContainersEnsemble` that allows managing
+To support features like Asynchronous API and `POSTMAN`contract-testing, we introduced `MicrocksContainersEnsemble` that allows managing
 additional Microcks services. `MicrocksContainersEnsemble` allow you to implement
 [Different levels of API contract testing](https://medium.com/@lbroudoux/different-levels-of-api-contract-testing-with-microcks-ccc0847f8c97)
 in the Inner Loop with Testcontainers!
@@ -242,7 +242,8 @@ You can create and build an ensemble that way:
 
 ```csharp
 MicrocksContainersEnsemble ensemble = new MicrocksContainerEnsemble(network, MicrocksImage)
-    .WithMainArtifacts("pastry-orders-asyncapi.yml");
+    .WithMainArtifacts("apipastries-openapi.yaml")
+    .WithSecondaryArtifacts("apipastries-postman-collection.json");
 
 await ensemble.StartAsync();
 ```
@@ -265,6 +266,29 @@ MicrocksContainersEnsemble ensemble = new MicrocksContainerEnsemble(network, Mic
 await ensemble.StartAsync();
 ```
 
+#### Postman contract-testing
+
+On this `ensemble` you may want to enable additional features such as Postman contract-testing:
+
+```csharp
+ensemble.WithPostman();
+await ensemble.StartAsync();
+```
+
+You can execute a `POSTMAN` test using an ensemble that way:
+
+```csharp
+var testRequest = new TestRequest
+{
+    ServiceId = "API Pastries:0.0.1",
+    RunnerType = TestRunnerType.POSTMAN,
+    TestEndpoint = "http://good-impl:3003",
+    Timeout = TimeSpan.FromSeconds(3)
+};
+
+TestResult testResult = await _ensemble.MicrocksContainer.TestEndpointAsync(testRequest);
+```
+
 #### Asynchronous API support
 
 Asynchronous API feature needs to be explicitly enabled as well.
diff --git a/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj b/src/Microcks.Testcontainers/Microcks.Testcontainers.csproj
@@ -7,7 +7,7 @@
     <ItemGroup>
 		<PackageReference Include="Testcontainers" Version="4.0.0" />
         <PackageReference Include="System.Net.Http.Json" Version="8.0.1" />
-        <PackageReference Include="Microsoft.Sbom.Targets" Version="4.0.2">
+        <PackageReference Include="Microsoft.Sbom.Targets" Version="4.1.2">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
         </PackageReference>
diff --git a/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs b/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs
@@ -30,8 +30,14 @@ public class MicrocksContainerEnsemble : IAsyncDisposable, IArtifactAndSnapshotM
 {
     private readonly MicrocksBuilder _microcksBuilder;
 
+    private ContainerBuilder _postmanBuilder;
     private MicrocksAsyncMinionBuilder _asyncMinionBuilder;
 
+    /// <summary>
+    /// Gets the Postman runtime container.
+    /// </summary>
+    public IContainer PostmanContainer { get; private set; }
+
     /// <summary>
     /// Gets the Microcks asynchronous minion container.
     /// </summary>
@@ -75,6 +81,7 @@ public MicrocksContainerEnsemble(INetwork network, string microcksImage)
             .WithExposedPort(MicrocksBuilder.MicrocksGrpcPort)
             .WithImage(this._microcksImage)
             .WithEnvironment(MacOSHelper.GetJavaOptions())
+            .WithEnvironment("POSTMAN_RUNNER_URL", "http://postman:3000")
             .WithEnvironment("TEST_CALLBACK_URL", "http://microcks:" + MicrocksBuilder.MicrocksHttpPort)
             .WithEnvironment("ASYNC_MINION_URL", "http://microcks-async-minion:" + MicrocksAsyncMinionBuilder.MicrocksAsyncMinionHttpPort);
     }
@@ -108,6 +115,30 @@ public MicrocksContainerEnsemble WithSnapshots(params string[] snapshots)
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble to include a Postman runtime container.
+    /// </summary>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns
+    public MicrocksContainerEnsemble WithPostman()
+    {
+        return this.WithPostman("quay.io/microcks/microcks-postman-runtime:latest");
+    }
+
+    /// <summary>
+    /// Configures the Microcks container ensemble to include a Postman runtime container with the specified image
+    /// </summary>
+    /// <param name="image">The Postman runtime image to be used.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
+    public MicrocksContainerEnsemble WithPostman(string image)
+    {
+        this._postmanBuilder = new ContainerBuilder()
+            .WithImage(image)
+            .WithNetwork(this._network)
+            .WithNetworkAliases("postman")
+            .WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged(".*postman-runtime wrapper listening on port.*"));
+        return this;
+    }
+
     /// <summary>
     /// Configures the Microcks container ensemble to use the asynchronous feature.
     /// </summary>
@@ -179,6 +210,13 @@ public async Task StartAsync()
         this.MicrocksContainer = this._microcksBuilder.Build();
         await this.MicrocksContainer.StartAsync();
 
+        if (this._postmanBuilder != null)
+        {
+            this.PostmanContainer = this._postmanBuilder
+                .Build();
+
+            await this.PostmanContainer.StartAsync();
+        }
         if (this._asyncMinionBuilder != null)
         {
             this.AsyncMinionContainer = this._asyncMinionBuilder
@@ -194,6 +232,10 @@ public async Task StartAsync()
     /// <returns>A task that represents the asynchronous dispose operation.</returns>
     public async ValueTask DisposeAsync()
     {
+        if (this.PostmanContainer != null)
+        {
+            await this.PostmanContainer.DisposeAsync();
+        }
         if (this.AsyncMinionContainer != null)
         {
             await this.AsyncMinionContainer.DisposeAsync();
diff --git a/tests/Microcks.Testcontainers.Tests/Microcks.Testcontainers.Tests.csproj b/tests/Microcks.Testcontainers.Tests/Microcks.Testcontainers.Tests.csproj
@@ -10,15 +10,15 @@
     <PackageReference Include="coverlet.collector" Version="6.0.4" />
     <PackageReference Include="RabbitMQ.Client" Version="7.1.2" />
     <PackageReference Include="RestAssured.Net" Version="4.7.0" />
-    <PackageReference Include="Confluent.Kafka" Version="2.6.1" />
+    <PackageReference Include="Confluent.Kafka" Version="2.11.1" />
     <PackageReference Include="TestContainers.Kafka" Version="4.4.0" />
     <PackageReference Include="TestContainers.Keycloak" Version="4.4.0" />
     <PackageReference Include="Testcontainers.RabbitMq" Version="4.4.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="3.1.0">
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.1.4">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="xunit.v3" Version="2.0.2" />
+    <PackageReference Include="xunit.v3" Version="3.0.1" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\src\Microcks.Testcontainers\Microcks.Testcontainers.csproj" />
diff --git a/tests/Microcks.Testcontainers.Tests/PostmanContractTestingFunctionalityTests.cs b/tests/Microcks.Testcontainers.Tests/PostmanContractTestingFunctionalityTests.cs
@@ -0,0 +1,117 @@
+//
+// Copyright The Microcks Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//
+
+using System;
+using DotNet.Testcontainers.Builders;
+using DotNet.Testcontainers.Containers;
+using DotNet.Testcontainers.Networks;
+using Microcks.Testcontainers.Model;
+using TestResult = Microcks.Testcontainers.Model.TestResult;
+
+namespace Microcks.Testcontainers.Tests;
+
+public sealed class PostmanContractTestingFunctionalityTests : IAsyncLifetime
+{
+    private static readonly string BAD_PASTRY_IMAGE = "quay.io/microcks/contract-testing-demo:02";
+    private static readonly string GOOD_PASTRY_IMAGE = "quay.io/microcks/contract-testing-demo:03";
+
+    private readonly INetwork _network = new NetworkBuilder().Build();
+
+    private readonly IContainer _badImpl;
+    private readonly IContainer _goodImpl;
+    private readonly MicrocksContainerEnsemble _ensemble;
+
+
+    public PostmanContractTestingFunctionalityTests()
+    {
+        _badImpl = new ContainerBuilder()
+            .WithImage(BAD_PASTRY_IMAGE)
+            .WithNetwork(_network)
+            .WithNetworkAliases("bad-impl")
+            .WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged(".*Example app listening on port 3002.*"))
+            .Build();
+
+        _goodImpl = new ContainerBuilder()
+            .WithImage(GOOD_PASTRY_IMAGE)
+            .WithNetwork(_network)
+            .WithNetworkAliases("good-impl")
+            .WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged(".*Example app listening on port 3003.*"))
+            .Build();
+
+        _ensemble = new MicrocksContainerEnsemble(_network, "quay.io/microcks/microcks-uber:1.12.1")
+            .WithMainArtifacts("apipastries-openapi.yaml")
+            .WithSecondaryArtifacts("apipastries-postman-collection.json")
+            .WithPostman();
+    }
+
+    public async ValueTask InitializeAsync()
+    {
+        await _ensemble.StartAsync();
+        await _badImpl.StartAsync();
+        await _goodImpl.StartAsync();
+    }
+
+    public async ValueTask DisposeAsync()
+    {
+        await _badImpl.DisposeAsync();
+        await _goodImpl.DisposeAsync();
+        await _ensemble.DisposeAsync();
+    }
+
+    [Fact]
+    public async Task ShouldFail_WhenBadImplementation()
+    {
+        var testRequest = new TestRequest
+        {
+            ServiceId = "API Pastries:0.0.1",
+            RunnerType = TestRunnerType.POSTMAN,
+            TestEndpoint = "http://bad-impl:3002",
+            Timeout = TimeSpan.FromSeconds(3)
+        };
+
+        // Test should fail with validation failure messages.
+        TestResult badTestResult = await _ensemble.MicrocksContainer.TestEndpointAsync(testRequest);
+        Assert.False(badTestResult.Success);
+        Assert.Equal("http://bad-impl:3002", badTestResult.TestedEndpoint);
+        Assert.Equal(3, badTestResult.TestCaseResults.Count);
+        // Postman runner stop at first failure so there's just 1 testStepResult per testCaseResult
+        Assert.Single(badTestResult.TestCaseResults[0].TestStepResults);
+        // Order is not deterministic so it could be a matter of invalid size, invalid name or invalid price.
+        Assert.True(badTestResult.TestCaseResults[0].TestStepResults[0].Message.Contains("Valid size in response pastries")
+            || badTestResult.TestCaseResults[0].TestStepResults[0].Message.Contains("Valid name in response pastry")
+            || badTestResult.TestCaseResults[0].TestStepResults[0].Message.Contains("Valid price in response pastry"));
+    }
+
+    [Fact]
+    public async Task ShouldSucceed_WhenGoodImplementation()
+    {
+        var testRequest = new TestRequest
+        {
+            ServiceId = "API Pastries:0.0.1",
+            RunnerType = TestRunnerType.POSTMAN,
+            TestEndpoint = "http://good-impl:3003",
+            Timeout = TimeSpan.FromSeconds(3)
+        };
+
+        // Test should succeed with no validation failure messages.
+        TestResult goodTestResult = await _ensemble.MicrocksContainer.TestEndpointAsync(testRequest);
+        Assert.True(goodTestResult.Success);
+        Assert.Equal("http://good-impl:3003", goodTestResult.TestedEndpoint);
+        Assert.Equal(3, goodTestResult.TestCaseResults.Count);
+        Assert.Null(goodTestResult.TestCaseResults[0].TestStepResults[0].Message);
+    }
+}
