Integration testing against mock server

Tsingis · Tsingis · commit ff39f560ba10 · 2025-08-31T04:14:13.000+03:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -37,6 +37,8 @@ jobs:
         run: |
           dotnet test -c Release --no-restore --no-build -- \
           --coverage --coverage-output-format xml --coverage-output ${{ github.workspace }}/coverage.xml
+        env:
+          USE_MOCKING: ${{ vars.USE_MOCKING }}
       - name: Find coverage files and generate report
         run: |
           reportgenerator -reports:"${{ github.workspace }}/**/coverage.xml" \
diff --git a/app.slnx b/app.slnx
@@ -1,6 +1,7 @@
 <Solution>
   <Folder Name="/src/">
     <Project Path="src/Api/Api.csproj" />
+    <Project Path="src/Common/Common.csproj" />
     <Project Path="src/Services/Services.csproj" />
   </Folder>
   <Folder Name="/tests/">
diff --git a/src/Api/Api.csproj b/src/Api/Api.csproj
@@ -1,6 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <ItemGroup>
+    <ProjectReference Include="..\Common\Common.csproj" />
     <ProjectReference Include="..\Services\Services.csproj" />
+  </ItemGroup>
+  <ItemGroup>
     <PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" />
     <PackageReference Include="Azure.Identity" />
     <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" />
diff --git a/src/Api/Program.cs b/src/Api/Program.cs
@@ -1,6 +1,7 @@
 using System.Globalization;
 using Api.Setup;
 using Azure.Identity;
+using Common;
 using Serilog;
 
 DotNetEnv.Env.TraversePath().Load();
@@ -24,7 +25,7 @@
 
     var builder = WebApplication.CreateBuilder(args);
 
-    var keyVaultName = builder.Configuration.GetValue<string>("KEY_VAULT_NAME");
+    var keyVaultName = builder.Configuration.GetValue<string>(EnvironmentVariable.KeyVaultName);
     if (builder.Environment.IsProduction() && !string.IsNullOrEmpty(keyVaultName))
     {
         var keyVaultUri = new Uri($"https://{keyVaultName}.vault.azure.net/");
diff --git a/src/Api/packages.lock.json b/src/Api/packages.lock.json
@@ -1589,9 +1589,13 @@
           "System.Xml.ReaderWriter": "4.3.0"
         }
       },
+      "common": {
+        "type": "Project"
+      },
       "services": {
         "type": "Project",
         "dependencies": {
+          "Common": "[1.0.0, )",
           "Microsoft.AspNetCore.WebUtilities": "[9.0.8, )",
           "Microsoft.Extensions.Http": "[9.0.8, )",
           "Microsoft.Extensions.Logging": "[9.0.8, )"
diff --git a/src/Common/Common.csproj b/src/Common/Common.csproj
@@ -0,0 +1,9 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>
diff --git a/src/Common/EnvironmentVariable.cs b/src/Common/EnvironmentVariable.cs
@@ -0,0 +1,8 @@
+namespace Common;
+
+public static class EnvironmentVariable
+{
+    public const string KeyVaultName = "KEY_VAULT_NAME";
+    public const string MarketClientUrl = "MARKET_CLIENT_URL";
+    public const string UseMocking = "USE_MOCKING";
+}
diff --git a/src/Common/packages.lock.json b/src/Common/packages.lock.json
@@ -0,0 +1,13 @@
+{
+  "version": 2,
+  "dependencies": {
+    "net9.0": {
+      "SonarAnalyzer.CSharp": {
+        "type": "Direct",
+        "requested": "[10.15.0.120848, )",
+        "resolved": "10.15.0.120848",
+        "contentHash": "1hM3HVRl5jdC/ZBDu+G7CCYLXRGe/QaP01Zy+c9ETPhY7lWD8g8HiefY6sGaH0T3CJ4wAy0/waGgQTh0TYy0oQ=="
+      }
+    }
+  }
+}
diff --git a/src/Services/MarketClient.cs b/src/Services/MarketClient.cs
@@ -1,4 +1,5 @@
 using System.Text.Json;
+using Common;
 using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
@@ -24,7 +25,7 @@ public class MarketClient(ILogger<MarketClient> logger, IConfiguration configura
 
         using (var httpClient = _httpClientFactory.CreateClient())
         {
-            httpClient.BaseAddress = new Uri(configuration.GetValue("MARKET_CLIENT_URL", "https://api.coingecko.com"));
+            httpClient.BaseAddress = new Uri(configuration.GetValue(EnvironmentVariable.MarketClientUrl, "https://api.coingecko.com"));
             var response = await httpClient.SendAsync(request).ConfigureAwait(false);
             if (response.IsSuccessStatusCode)
             {
diff --git a/src/Services/Services.csproj b/src/Services/Services.csproj
@@ -1,4 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Common.csproj" />
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.WebUtilities" />
     <PackageReference Include="Microsoft.Extensions.Http" />
diff --git a/src/Services/packages.lock.json b/src/Services/packages.lock.json
@@ -140,6 +140,9 @@
         "dependencies": {
           "Microsoft.Extensions.Primitives": "9.0.8"
         }
+      },
+      "common": {
+        "type": "Project"
       }
     }
   }
diff --git a/tests/Directory.Packages.props b/tests/Directory.Packages.props
@@ -9,7 +9,8 @@
     <PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="17.14.2" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />
     <PackageVersion Include="Shouldly" Version="4.3.0" />
-    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.15.0.120848"/>
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.15.0.120848" />
+    <PackageVersion Include="Testcontainers" Version="4.7.0" />
     <PackageVersion Include="xunit.v3" Version="3.0.1" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.4" />
   </ItemGroup>
diff --git a/tests/IntegrationTests/ApiEndpointsTests.cs b/tests/IntegrationTests/ApiEndpointsTests.cs
@@ -3,20 +3,24 @@
 using System.Net.Http.Json;
 using System.Text.Json;
 using Api.Setup;
+using IntegrationTests.Setup;
 using Shouldly;
 using Xunit;
 
 namespace IntegrationTests;
 
-public sealed class ApiEndpointsTests(ApplicationFactory factory) : IntegrationTestBase(factory)
+public sealed class ApiEndpointsTests(Fixture fixture) : IntegrationTestBase(fixture)
 {
+    private const string DateFormat = "yyyy-MM-dd";
     private const string BaseUrl = "/api/v1";
 
+    private static readonly DateTime s_mockCutOffDate = new(2024, 8, 29, 0, 0, 0, DateTimeKind.Utc);
+
     public static TheoryData<string?, string?, HttpStatusCode> Cases =>
-    new TheoryData<string?, string?, HttpStatusCode>
+    new()
     {
-        {DateTime.Now.AddMonths(-1).ToString("yyyy-MM-dd", CultureInfo.InvariantCulture), DateTime.Now.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture), HttpStatusCode.OK},
-        {DateTime.Now.AddMonths(-13).ToString("yyyy-MM-dd", CultureInfo.InvariantCulture), DateTime.Now.AddMonths(-12).ToString("yyyy-MM-dd", CultureInfo.InvariantCulture), HttpStatusCode.Unauthorized}, //Unauthorized for over 365 days old queries
+        {DateTime.Now.AddMonths(-1).ToString(DateFormat, CultureInfo.InvariantCulture), DateTime.Now.ToString(DateFormat, CultureInfo.InvariantCulture), HttpStatusCode.OK},
+        {s_mockCutOffDate.ToString(DateFormat, CultureInfo.InvariantCulture), s_mockCutOffDate.AddYears(1).AddDays(1).ToString(DateFormat, CultureInfo.InvariantCulture), HttpStatusCode.Unauthorized}, //Unauthorized for over 365 days old queries
         {"", null, HttpStatusCode.BadRequest},
     };
 
diff --git a/tests/IntegrationTests/ApplicationFactory.cs b/tests/IntegrationTests/ApplicationFactory.cs
diff --git a/tests/IntegrationTests/IntegrationTests.csproj b/tests/IntegrationTests/IntegrationTests.csproj
@@ -11,6 +11,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="Microsoft.Testing.Extensions.CodeCoverage" />
     <PackageReference Include="Shouldly" />
+    <PackageReference Include="Testcontainers" />
     <PackageReference Include="xunit.v3" />
     <PackageReference Include="xunit.runner.visualstudio">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
@@ -19,5 +20,9 @@
   </ItemGroup>
   <ItemGroup>
     <Content Include="..\xunit.runner.json" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="..\..\wiremock\**\*">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Link>wiremock\%(RecursiveDir)%(Filename)%(Extension)</Link>
+    </Content>
   </ItemGroup>
 </Project>
diff --git a/tests/IntegrationTests/Setup/ApplicationFactory.cs b/tests/IntegrationTests/Setup/ApplicationFactory.cs
@@ -0,0 +1,16 @@
+using Common;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Testing;
+
+namespace IntegrationTests.Setup;
+
+public sealed class ApplicationFactory(Fixture fixture) : WebApplicationFactory<Program>
+{
+    protected override void ConfigureWebHost(IWebHostBuilder builder)
+    {
+        if (bool.Parse(Environment.GetEnvironmentVariable(EnvironmentVariable.UseMocking) ?? "false"))
+        {
+            Environment.SetEnvironmentVariable(EnvironmentVariable.MarketClientUrl, $"http://localhost:{fixture.GetPort()}");
+        }
+    }
+}
diff --git a/tests/IntegrationTests/Setup/Fixture.cs b/tests/IntegrationTests/Setup/Fixture.cs
@@ -0,0 +1,64 @@
+
+using Common;
+using DotNet.Testcontainers.Builders;
+using DotNet.Testcontainers.Containers;
+using IntegrationTests.Setup;
+using Xunit;
+
+[assembly: AssemblyFixture(typeof(Fixture))]
+
+namespace IntegrationTests.Setup;
+
+public class Fixture : IAsyncLifetime
+{
+    private readonly IContainer? _wireMockContainer;
+
+    public Fixture()
+    {
+        DotNetEnv.Env.TraversePath().Load();
+
+        if (bool.Parse(Environment.GetEnvironmentVariable(EnvironmentVariable.UseMocking) ?? "false"))
+        {
+            _wireMockContainer = new ContainerBuilder()
+                .WithCleanUp(true)
+                .WithAutoRemove(true)
+                .WithImage("wiremock/wiremock:3x-alpine")
+                .WithName("wiremock")
+                .WithPortBinding(8080, true)
+                .WithBindMount(Path.Join(Environment.CurrentDirectory, "wiremock"), "/home/wiremock/mappings")
+                .WithWaitStrategy(Wait.ForUnixContainer()
+                    .UntilHttpRequestIsSucceeded(request => request
+                        .ForPort(8080)
+                        .ForPath("/__admin/mappings")
+                        .ForStatusCode(System.Net.HttpStatusCode.OK)))
+                .Build();
+
+            TestContext.Current.SendDiagnosticMessage("Creating Wiremock container");
+        }
+    }
+
+    public async ValueTask InitializeAsync()
+    {
+        if (_wireMockContainer is not null)
+        {
+            TestContext.Current.SendDiagnosticMessage("Starting Wiremock container");
+            await _wireMockContainer.StartAsync(TestContext.Current.CancellationToken).ConfigureAwait(false);
+        }
+    }
+
+    public async ValueTask DisposeAsync()
+    {
+        if (_wireMockContainer is not null)
+        {
+            TestContext.Current.SendDiagnosticMessage("Stopping Wiremock container");
+            await _wireMockContainer.StopAsync(TestContext.Current.CancellationToken).ConfigureAwait(false);
+            await _wireMockContainer.DisposeAsync().ConfigureAwait(false);
+        }
+        GC.SuppressFinalize(this);
+    }
+
+    public ushort? GetPort()
+    {
+        return _wireMockContainer?.GetMappedPublicPort();
+    }
+}
diff --git a/tests/IntegrationTests/Setup/IntegrationTestBase.cs b/tests/IntegrationTests/Setup/IntegrationTestBase.cs
@@ -1,15 +1,15 @@
 using Xunit;
 
-namespace IntegrationTests;
+namespace IntegrationTests.Setup;
 
-public abstract class IntegrationTestBase : IClassFixture<ApplicationFactory>, IAsyncLifetime
+public abstract class IntegrationTestBase : IAsyncLifetime
 {
     internal readonly ApplicationFactory _factory;
     internal readonly HttpClient _client;
 
-    protected IntegrationTestBase(ApplicationFactory factory)
+    protected IntegrationTestBase(Fixture fixture)
     {
-        _factory = factory;
+        _factory = new ApplicationFactory(fixture);
         _client = _factory.CreateClient();
     }
 
@@ -21,6 +21,7 @@ public virtual ValueTask InitializeAsync()
     public virtual ValueTask DisposeAsync()
     {
         _client.Dispose();
+        _factory.Dispose();
         GC.SuppressFinalize(this);
         return ValueTask.CompletedTask;
     }
diff --git a/tests/IntegrationTests/packages.lock.json b/tests/IntegrationTests/packages.lock.json
diff --git a/tests/UnitTests/packages.lock.json b/tests/UnitTests/packages.lock.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System.Text.Json;`
	`2`	`+using Common;`
`2`	`3`	`using Microsoft.AspNetCore.WebUtilities;`
`3`	`4`	`using Microsoft.Extensions.Configuration;`
`4`	`5`	`using Microsoft.Extensions.Logging;`
`@@ -24,7 +25,7 @@ public class MarketClient(ILogger<MarketClient> logger, IConfiguration configura`
`24`	`25`
`25`	`26`	`using (var httpClient = _httpClientFactory.CreateClient())`
`26`	`27`	`{`
`27`		`- httpClient.BaseAddress = new Uri(configuration.GetValue("MARKET_CLIENT_URL", "https://api.coingecko.com"));`
	`28`	`+ httpClient.BaseAddress = new Uri(configuration.GetValue(EnvironmentVariable.MarketClientUrl, "https://api.coingecko.com"));`
`28`	`29`	`var response = await httpClient.SendAsync(request).ConfigureAwait(false);`
`29`	`30`	`if (response.IsSuccessStatusCode)`
`30`	`31`	`{`