https://github.com/microcks/microcks-testcontainers-dotnet
.NET lib for Testcontainers that enables embedding Microcks into your unit tests with lightweight, throwaway instance thanks to containers.
https://github.com/microcks/microcks-testcontainers-dotnet
api contract-testing csharp dotnet microcks mocking
Last synced: 11 months ago
JSON representation
.NET lib for Testcontainers that enables embedding Microcks into your unit tests with lightweight, throwaway instance thanks to containers.
- Host: GitHub
- URL: https://github.com/microcks/microcks-testcontainers-dotnet
- Owner: microcks
- License: apache-2.0
- Created: 2024-11-08T09:18:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-06T17:20:42.000Z (11 months ago)
- Last Synced: 2025-04-06T17:37:56.131Z (11 months ago)
- Topics: api, contract-testing, csharp, dotnet, microcks, mocking
- Language: C#
- Homepage: https://microcks.io
- Size: 179 KB
- Stars: 8
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY-INSIGHTS.yml
- Governance: GOVERNANCE.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# Microcks Testcontainers .NET
.NET library for Testcontainers that enables embedding Microcks into your unit tests with lightweight, throwaway instance thanks to containers.
[](https://github.com/microcks/microcks-testcontainers-dotnet/actions)
[](https://www.nuget.org/packages/Microcks.Testcontainers)
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://microcks.io/discord-invite/)
[](https://artifacthub.io/packages/search?repo=microcks-uber-image)
[](https://landscape.cncf.io/?item=app-definition-and-development--application-definition-image-build--microcks)
## Build Status
Latest released version is `0.2.0`.
Current development version is `0.3.0`.
#### Sonarcloud Quality metrics
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks-testcontainers-dotnet)
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks-testcontainers-dotnet)
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks-testcontainers-dotnet)
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks-testcontainers-dotnet)
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks-testcontainers-dotnet)
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks)
[](https://sonarcloud.io/summary/new_code?id=microcks_microcks-testcontainers-dotnet)
#### Fossa license and security scans
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-testcontainers-dotnet?ref=badge_shield&issueType=license)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-testcontainers-dotnet?ref=badge_shield&issueType=security)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-testcontainers-dotnet?ref=badge_small)
#### OpenSSF best practices on Microcks core
[](https://bestpractices.coreinfrastructure.org/projects/7513)
[](https://securityscorecards.dev/viewer/?uri=github.com/microcks/microcks)
## Community
* [Documentation](https://microcks.io/documentation/tutorials/getting-started/)
* [Microcks Community](https://github.com/microcks/community) and community meeting
* Join us on [Discord](https://microcks.io/discord-invite/), on [GitHub Discussions](https://github.com/orgs/microcks/discussions) or [CNCF Slack #microcks channel](https://cloud-native.slack.com/archives/C05BYHW1TNJ)
To get involved with our community, please make sure you are familiar with the project's [Code of Conduct](./CODE_OF_CONDUCT.md).
## How to use it?
### Include it into your project dependencies
```
dotnet add package Microcks.Testcontainers --version 0.2.0
```
### Startup the container
You just have to specify the container image you'd like to use. This library requires a Microcks `uber` distribution (with no MongoDB dependency).
```csharp
MicrocksContainer container = new MicrocksBuilder()
.WithImage("quay.io/microcks/microcks-uber:1.11.0")
.Build();
await container.StartAsync();
```
### Import content in Microcks
To use Microcks mocks or contract-testing features, you first need to import OpenAPI, Postman Collection, GraphQL or gRPC artifacts.
Artifacts can be imported as main/Primary ones or as secondary ones. See [Multi-artifacts support](https://microcks.io/documentation/using/importers/#multi-artifacts-support) for details.
You can do it before starting the container using simple paths:
```csharp
MicrocksContainer container = new MicrocksBuilder()
.WithMainArtifacts("apipastries-openapi.yaml")
.WithSecondaryArtifacts("apipastries-postman-collection.json")
.Build();
await container.StartAsync();
```
or once the container started using `File` arguments:
```csharp
container.ImportAsMainArtifact("apipastries-openapi.yaml");
container.ImportAsSecondaryArtifact("apipastries-postman-collection.json");
```
You can also import full [repository snapshots](https://microcks.io/documentation/administrating/snapshots/) at once:
```csharp
MicrocksContainer container = new MicrocksBuilder()
.WithSnapshots("microcks-repository.json")
.Build();
await container.StartAsync();
```
### Using mock endpoints for your dependencies
During your test setup, you'd probably need to retrieve mock endpoints provided by Microcks containers to
setup your base API url calls. You can do it like this:
```csharp
var baseApiUrl = container.GetRestMockEndpoint("API Pastries", "0.0.1");
```
The container provides methods for different supported API styles/protocols (Soap, GraphQL, gRPC,...).
The container also provides `GetHttpEndpoint()` for raw access to those API endpoints.
### Launching new contract-tests
If you want to ensure that your application under test is conformant to an OpenAPI contract (or other type of contract),
you can launch a Microcks contract/conformance test using the local server port you're actually running.
```csharp
private int port;
public async Task InitializeAsync()
{
container = new MicrocksBuilder()
.WithExposedPort(port)
.Build();
await container.StartAsync();
}
[Fact]
public async Task testOpenAPIContract()
{
var testRequest = new TestRequest
{
ServiceId = "API Pastries:0.0.1",
RunnerType = TestRunnerType.OPEN_API_SCHEMA,
TestEndpoint = $"http://host.testcontainers.internal:{port}",
Timeout = TimeSpan.FromMilliseconds(2000)
};
TestResult testResult = await container.TestEndpointAsync(testRequest);
testResult.Success.Should().BeTrue();
}
```
The `TestResult` gives you access to all details regarding success of failure on different test cases.
### Advanced features with MicrocksContainersEnsemble
The `MicrocksContainer` referenced above supports essential features of Microcks provided by the main Microcks container.
The list of supported features is the following:
* Mocking of REST APIs using different kinds of artifacts,
* Contract-testing of REST APIs using `OPEN_API_SCHEMA` runner/strategy,
* Mocking and contract-testing of SOAP WebServices,
* 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
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!
A `MicrocksContainersEnsemble` presents the same methods as a `MicrocksContainer`.
You can create and build an ensemble that way:
```csharp
MicrocksContainersEnsemble ensemble = new MicrocksContainerEnsemble(network, MicrocksImage)
.WithMainArtifacts("pastry-orders-asyncapi.yml");
ensemble.StartAsync();
```
A `MicrocksContainer` is wrapped by an ensemble and is still available to import artifacts and execute test methods.
You have to access it using:
```csharp
MicrocksContainer microcks = ensemble.MicrocksContainer;
microcks.ImportAsMainArtifact(...);
```
To activate async features (WebSocket), you can use `WithAsyncFeature()` method.
```csharp
MicrocksContainersEnsemble ensemble = new MicrocksContainerEnsemble(network, MicrocksImage)
.WithMainArtifacts("pastry-orders-asyncapi.yml")
.WithAsyncFeature();
ensemble.StartAsync();
```
#### Asynchronous API support
Asynchronous API feature needs to be explicitly enabled as well.
In case you want to use it for mocking purposes,
you'll have to specify additional connection details to the broker of your choice.
To add a note indicating that it is not necessary to call `WithAsyncFeature()` when an additional method exists.
See an example below with connection to a Kafka broker:
```csharp
MicrocksContainersEnsemble ensemble = new MicrocksContainerEnsemble(network, MicrocksImage)
.WithMainArtifacts("pastry-orders-asyncapi.yml")
.WithKafkaConnection(new KafkaConnection($"kafka:19092"));
ensemble.StartAsync();
```
##### Using mock endpoints for your dependencies
Once started, the `ensemble.AsyncMinionContainer` provides methods for retrieving mock endpoint names for the different
supported protocols (WebSocket, Kafka, etc. ...).
```csharp
string kafkaTopic = ensemble.AsyncMinionContainer
.GetKafkaMockTopic("Pastry orders API", "0.1.0", "SUBSCRIBE pastry/orders");
```
##### Launching new contract-tests
Using contract-testing techniques on Asynchronous endpoints may require a different style of interacting with the Microcks
container. For example, you may need to:
1. Start the test making Microcks listen to the target async endpoint,
2. Activate your System Under Tests so that it produces an event,
3. Finalize the Microcks tests and actually ensure you received one or many well-formed events.
For that the `MicrocksContainer` now provides a `TestEndpointAsync(TestRequest request)` method that actually returns a `Task`.
Once invoked, you may trigger your application events and then `await` the future result to assert like this:
```csharp
// Start the test, making Microcks listen the endpoint provided in testRequest
Task testResultFuture = ensemble.MicrocksContainer.TestEndpointAsync(testRequest);
// Here below: activate your app to make it produce events on this endpoint.
// myapp.InvokeBusinessMethodThatTriggerEvents();
// Now retrieve the final test result and assert.
TestResult testResult = await testResultFuture;
testResult.IsSuccess.Should().BeTrue();
```