Add WireMock.Net.TUnit project (#1179)

* Add WireMock.Net.TUnit project

* fix

* .

* fix

* bd

* 0.1.812

* dotnet test

* 0.1.817

* cat

* type

* type2

* find

* -- --diagnostic

* --no-build

* fix?

.github/workflows/ci.yml

@@ -20,7 +20,9 @@ jobs:
     - uses: actions/checkout@v4
 
     - name: 'Execute Tests'
-      run: dotnet test './test/WireMock.Net.Tests/WireMock.Net.Tests.csproj' -c Release --framework net8.0    
+      run: |
+        dotnet test './test/WireMock.Net.Tests/WireMock.Net.Tests.csproj' -c Release --framework net8.0
+        dotnet test './test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj' -c Release --framework net8.0
 
   linux-build-and-run:
     name: Run Tests on Linux
@@ -33,7 +35,9 @@ jobs:
     - uses: actions/checkout@v4
 
     - name: 'Execute Tests'
-      run: dotnet test './test/WireMock.Net.Tests/WireMock.Net.Tests.csproj' -c Release --framework net8.0
+      run: |
+        dotnet test './test/WireMock.Net.Tests/WireMock.Net.Tests.csproj' -c Release --framework net8.0
+        dotnet test './test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj' -c Release --framework net8.0
 
     - name: Install .NET Aspire workload
       run: dotnet workload install aspire

WireMock.Net Solution.sln

@@ -131,6 +131,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.Aspire.TestApp
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AspireApp1.AppHostOriginal", "examples-Aspire\AspireApp1.AppHostOriginal\AspireApp1.AppHostOriginal.csproj", "{C9210DA3-F390-4598-8512-349A473FE9C9}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WireMock.Net.TUnit", "src\WireMock.Net.TUnit\WireMock.Net.TUnit.csproj", "{91024A93-848F-4A02-AF53-5EBE5834E23C}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.TUnitTests", "test\WireMock.Net.TUnitTests\WireMock.Net.TUnitTests.csproj", "{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -317,6 +321,14 @@ Global
 		{C9210DA3-F390-4598-8512-349A473FE9C9}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C9210DA3-F390-4598-8512-349A473FE9C9}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C9210DA3-F390-4598-8512-349A473FE9C9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{91024A93-848F-4A02-AF53-5EBE5834E23C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{91024A93-848F-4A02-AF53-5EBE5834E23C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{91024A93-848F-4A02-AF53-5EBE5834E23C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{91024A93-848F-4A02-AF53-5EBE5834E23C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -369,6 +381,8 @@ Global
 		{CE602F57-FEF8-4559-A9E0-6200BE1BF398} = {0BB8B634-407A-4610-A91F-11586990767A}
 		{F1B5999D-D22E-48A6-AB86-18A7876BD32E} = {0BB8B634-407A-4610-A91F-11586990767A}
 		{C9210DA3-F390-4598-8512-349A473FE9C9} = {AD474543-0715-49F2-A284-936B060BF736}
+		{91024A93-848F-4A02-AF53-5EBE5834E23C} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
+		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE} = {0BB8B634-407A-4610-A91F-11586990767A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

azure-pipelines-ci.yml

@@ -38,7 +38,7 @@ jobs:
   
   # See: https://docs.sonarsource.com/sonarcloud/enriching/test-coverage/dotnet-test-coverage
   - script: |
-      dotnet sonarscanner begin /k:"WireMock-Net_WireMock.Net" /o:"wiremock-net" /d:sonar.branch.name=$(Build.SourceBranchName) /d:sonar.host.url="https://sonarcloud.io" /d:sonar.token="$(SONAR_TOKEN)" /d:sonar.pullrequest.provider=github /d:sonar.dotnet.excludeTestProjects=true /d:sonar.cs.vscoveragexml.reportsPaths=**/wiremock-coverage-*.xml /d:sonar.verbose=true
+      dotnet sonarscanner begin /k:"WireMock-Net_WireMock.Net" /o:"wiremock-net" /d:sonar.branch.name=$(Build.SourceBranchName) /d:sonar.host.url="https://sonarcloud.io" /d:sonar.token="$(SONAR_TOKEN)" /d:sonar.pullrequest.provider=github /d:sonar.cs.vscoveragexml.reportsPaths=**/wiremock-coverage-*.xml /d:sonar.verbose=true
     displayName: 'Begin analysis on SonarCloud'
     condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) # Do not run for PullRequests
   
@@ -52,13 +52,14 @@ jobs:
   - task: CmdLine@2
     inputs:
       script: |
-          dotnet-coverage collect "dotnet test ./test/WireMock.Net.Tests/WireMock.Net.Tests.csproj --configuration Debug --no-build --framework net8.0" -f xml -o "wiremock-coverage-1.xml"
+          dotnet-coverage collect "dotnet test ./test/WireMock.Net.Tests/WireMock.Net.Tests.csproj --configuration Debug --no-build --framework net8.0" -f xml -o "wiremock-coverage-xunit.xml"
-      displayName: 'Execute WireMock.Net.Tests with Coverage'
+          dotnet-coverage collect "dotnet test ./test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj --configuration Debug --no-build --framework net8.0" -f xml -o "wiremock-coverage-tunit.xml"
+    displayName: 'Execute WireMock.Net.Tests with Coverage'
 
   - task: CmdLine@2
     inputs:
       script: |
-          dotnet-coverage collect "dotnet test ./test/WireMock.Net.Aspire.Tests/WireMock.Net.Aspire.Tests.csproj --configuration Debug --no-build" -f xml -o "wiremock-coverage-2.xml"
+          dotnet-coverage collect "dotnet test ./test/WireMock.Net.Aspire.Tests/WireMock.Net.Aspire.Tests.csproj --configuration Debug --no-build" -f xml -o "wiremock-coverage-aspire.xml"
     displayName: 'Execute WireMock.Net.Aspire.Tests with Coverage'
 
   - task: CmdLine@2

src/WireMock.Net.TUnit/TUnitWireMockLogger.cs

@@ -0,0 +1,80 @@
+// Copyright © WireMock.Net
+
+using System;
+using Newtonsoft.Json;
+using Stef.Validation;
+using TUnit.Core.Logging;
+using WireMock.Admin.Requests;
+using WireMock.Logging;
+
+namespace WireMock.Net.TUnit;
+
+/// <summary>
+/// When using TUnit, this class enables to log the output from WireMock.Net to the <see cref="TUnitLogger"/>.
+/// </summary>
+// ReSharper disable once InconsistentNaming
+public sealed class TUnitWireMockLogger : IWireMockLogger
+{
+    private readonly TUnitLogger _tUnitLogger;
+
+    /// <summary>
+    /// Create a new instance on the <see cref="TUnitWireMockLogger"/>.
+    /// </summary>
+    /// <param name="tUnitLogger">Represents a class which can be used to provide test output.</param>
+    public TUnitWireMockLogger(TUnitLogger tUnitLogger)
+    {
+        _tUnitLogger = Guard.NotNull(tUnitLogger);
+    }
+
+    /// <inheritdoc />
+    public void Debug(string formatString, params object[] args)
+    {
+        _tUnitLogger.LogDebug(Format("Debug", formatString, args));
+    }
+
+    /// <inheritdoc />
+    public void Info(string formatString, params object[] args)
+    {
+        _tUnitLogger.LogInformation(Format("Info", formatString, args));
+    }
+
+    /// <inheritdoc />
+    public void Warn(string formatString, params object[] args)
+    {
+        _tUnitLogger.LogWarning(Format("Warning", formatString, args));
+    }
+
+    /// <inheritdoc />
+    public void Error(string formatString, params object[] args)
+    {
+        _tUnitLogger.LogError(Format("Error", formatString, args));
+    }
+
+    /// <inheritdoc />
+    public void Error(string formatString, Exception exception)
+    {
+        _tUnitLogger.LogError(Format("Error", formatString, exception.Message), exception);
+
+        if (exception is AggregateException ae)
+        {
+            ae.Handle(ex =>
+            {
+                _tUnitLogger.LogError(Format("Error", "Exception {0}", ex.Message), exception);
+                return true;
+            });
+        }
+    }
+
+    /// <inheritdoc />
+    public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest)
+    {
+        var message = JsonConvert.SerializeObject(logEntryModel, Formatting.Indented);
+        _tUnitLogger.LogDebug(Format("DebugRequestResponse", "Admin[{0}] {1}", isAdminRequest, message));
+    }
+
+    private static string Format(string level, string formatString, params object[] args)
+    {
+        var message = args.Length > 0 ? string.Format(formatString, args) : formatString;
+        return $"{DateTime.UtcNow} [{level}] : {message}";
+    }
+}

src/WireMock.Net.TUnit/WireMock.Net.TUnit.csproj

@@ -0,0 +1,38 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <Description>Some extensions for TUnit (TUnitLogger)</Description>
+        <AssemblyTitle>WireMock.Net.TUnit</AssemblyTitle>
+        <Authors>Stef Heyenrath</Authors>
+        <TargetFrameworks>net8.0</TargetFrameworks>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <AssemblyName>WireMock.Net.TUnit</AssemblyName>
+        <RootNamespace>WireMock.Net.Tunit</RootNamespace>
+        <PackageId>WireMock.Net.TUnit</PackageId>
+        <PackageTags>tdd;wiremock;test;unittest;TUnit</PackageTags>
+        <ProjectGuid>{0DE0954F-8C00-4E8D-B94A-4361FC1CB34A}</ProjectGuid>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
+        <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
+        <SignAssembly>true</SignAssembly>
+        <AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
+        <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+        <PackageReference Include="Stef.Validation" Version="0.1.1" />
+        <PackageReference Include="TUnit.Core" Version="0.1.817" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\WireMock.Net.Abstractions\WireMock.Net.Abstractions.csproj" />
+    </ItemGroup>
+
+</Project>

src/WireMock.Net.xUnit/TestOutputHelperWireMockLogger.cs

@@ -73,8 +73,6 @@ public sealed class TestOutputHelperWireMockLogger : IWireMockLogger
 
     private static string Format(string level, string formatString, params object[] args)
     {
-        Guard.NotNull(formatString);
-
         var message = args.Length > 0 ? string.Format(formatString, args) : formatString;
         return $"{DateTime.UtcNow} [{level}] : {message}";
     }

test/WireMock.Net.TUnitTests/TUnitTests.cs

@@ -0,0 +1,37 @@
+// Copyright © WireMock.Net
+
+using WireMock.Net.TUnit;
+using WireMock.RequestBuilders;
+using WireMock.ResponseBuilders;
+using WireMock.Server;
+using WireMock.Settings;
+
+namespace WireMock.Net.TUnitTests;
+
+// ReSharper disable once InconsistentNaming
+public class TUnitTests
+{
+    [Test]
+    public async Task Test_TUnitWireMockLogger()
+    {
+        // Assign
+        var path = $"/foo_{Guid.NewGuid()}";
+
+        using var server = WireMockServer.Start(new WireMockServerSettings
+        {
+            Logger = new TUnitWireMockLogger(TestContext.Current!.GetDefaultLogger())
+        });
+
+        server
+            .Given(Request.Create()
+                .WithPath(path)
+                .UsingGet())
+            .RespondWith(Response.Create().WithBody("TUnit"));
+
+        // Act
+        var response = await server.CreateClient().GetStringAsync($"{server.Url}{path}");
+
+        // Assert
+        await Assert.That(response).IsEqualTo("TUnit");
+    }
+}

test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="TUnit" Version="0.1.817" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\WireMock.Net.TUnit\WireMock.Net.TUnit.csproj" />
+    <ProjectReference Include="..\..\src\WireMock.Net\WireMock.Net.csproj" />
+  </ItemGroup>
+
+</Project>