WireMock.Net.ProtoBuf

WireMock.Net Solution.sln

@@ -118,6 +118,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.GraphQL", "src
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.MimeKitLite", "src\WireMock.Net.MimeKitLite\WireMock.Net.MimeKitLite.csproj", "{F8B4A93E-46EF-4237-88FE-15FDAB7635C2}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.ProtoBuf", "src\WireMock.Net.ProtoBuf\WireMock.Net.ProtoBuf.csproj", "{B47413CD-55D3-49A7-896A-17ADBFF72407}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -280,6 +282,10 @@ Global
 		{F8B4A93E-46EF-4237-88FE-15FDAB7635C2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F8B4A93E-46EF-4237-88FE-15FDAB7635C2}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{F8B4A93E-46EF-4237-88FE-15FDAB7635C2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B47413CD-55D3-49A7-896A-17ADBFF72407}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B47413CD-55D3-49A7-896A-17ADBFF72407}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B47413CD-55D3-49A7-896A-17ADBFF72407}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B47413CD-55D3-49A7-896A-17ADBFF72407}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -326,6 +332,7 @@ Global
 		{B1580A38-84E7-44BE-8FE7-3EE5031D74A1} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 		{B6269AAC-170A-4346-8B9A-444DED3D9A45} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
 		{F8B4A93E-46EF-4237-88FE-15FDAB7635C2} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
+		{B47413CD-55D3-49A7-896A-17ADBFF72407} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

src/WireMock.Net.Abstractions/WireMock.Net.Abstractions.csproj

@@ -30,10 +30,6 @@
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     </PropertyGroup>
 
-    <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1'">
-        <DefineConstants>$(DefineConstants);PROTOBUF</DefineConstants>
-    </PropertyGroup>
-
     <ItemGroup>
         <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" PrivateAssets="All" />
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />

src/WireMock.Net.MimeKitLite/WireMock.Net.MimeKitLite.csproj

@@ -2,11 +2,11 @@
 
     <PropertyGroup>
         <Description>MultiPart Mime support for WireMock.Net</Description>
-        <AssemblyTitle>WireMock.Net.Matchers.GraphQL</AssemblyTitle>
+        <AssemblyTitle>WireMock.Net.MimeKitLite</AssemblyTitle>
         <Authors>Stef Heyenrath</Authors>
         <TargetFrameworks>netstandard2.0;netstandard2.1;net462;net47;net48;net6.0;net8.0</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
-        <PackageTags>wiremock;matchers;matcher;graphql</PackageTags>
+        <PackageTags>wiremock;matchers;matcher;mime;multipart;mimekit</PackageTags>
         <RootNamespace>WireMock</RootNamespace>
         <ProjectGuid>{F8B4A93E-46EF-4237-88FE-15FDAB7635D4}</ProjectGuid>
         <PublishRepositoryUrl>true</PublishRepositoryUrl>

src/WireMock.Net/Matchers/ProtoBufMatcher.cs → src/WireMock.Net.ProtoBuf/Matchers/ProtoBufMatcher.cs

@@ -1,4 +1,3 @@
-#if PROTOBUF
 using System;
 using System.Threading;
 using System.Threading.Tasks;
@@ -22,19 +21,13 @@ public class ProtoBufMatcher : IProtoBufMatcher
     /// <inheritdoc />
     public MatchBehaviour MatchBehaviour { get; }
 
-    /// <summary>
-    /// The Func to define The proto definition as text.
-    /// </summary>
+    /// <inheritdoc />
     public Func<IdOrText> ProtoDefinition { get; }
 
-    /// <summary>
-    /// The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".
-    /// </summary>
+    /// <inheritdoc />
     public string MessageType { get; }
 
-    /// <summary>
-    /// The Matcher to use (optional).
-    /// </summary>
+    /// <inheritdoc />
     public IObjectMatcher? Matcher { get; }
 
     private static readonly Converter ProtoBufToJsonConverter = SingletonFactory<Converter>.GetInstance();
@@ -110,5 +103,4 @@ public async Task<MatchResult> IsMatchAsync(byte[]? input, CancellationToken can
             return null;
         }
     }
-}
-#endif
+}

src/WireMock.Net/Matchers/Request/RequestMessageProtoBufMatcher.cs → src/WireMock.Net.ProtoBuf/Matchers/Request/RequestMessageProtoBufMatcher.cs

@@ -6,7 +6,7 @@ namespace WireMock.Matchers.Request;
 /// <summary>
 /// The request body Grpc ProtoBuf matcher.
 /// </summary>
-public class RequestMessageProtoBufMatcher : IRequestMatcher
+public class RequestMessageProtoBufMatcher : IRequestMessageProtoBufMatcher
 {
     /// <summary>
     /// The ProtoBufMatcher.
@@ -22,11 +22,7 @@ public class RequestMessageProtoBufMatcher : IRequestMatcher
     /// <param name="matcher">The optional matcher to use to match the ProtoBuf as (json) object.</param>
     public RequestMessageProtoBufMatcher(MatchBehaviour matchBehaviour, Func<IdOrText> protoDefinition, string messageType, IObjectMatcher? matcher = null)
     {
-#if PROTOBUF
         Matcher = new ProtoBufMatcher(protoDefinition, messageType, matchBehaviour, matcher);
-#else
-        throw new System.NotSupportedException("The ProtoBufMatcher can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
-#endif
     }
 
     /// <inheritdoc />

src/WireMock.Net.ProtoBuf/Properties/AssemblyInfo.cs

@@ -0,0 +1,6 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("WireMock.Net.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]
+
+// Needed for Moq in the UnitTest project
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]

src/WireMock.Net.ProtoBuf/RequestBuilders/IRequestBuilderExtensions.cs

@@ -0,0 +1,64 @@
+// ReSharper disable InconsistentNaming
+using Stef.Validation;
+using WireMock.Matchers;
+using WireMock.Matchers.Request;
+
+namespace WireMock.RequestBuilders;
+
+/// <summary>
+/// IRequestBuilderExtensions extensions for GraphQL.
+/// </summary>
+public static class IRequestBuilderExtensions
+{
+    /// <summary>
+    /// WithGrpcProto
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="protoDefinition">The proto definition as text.</param>
+    /// <param name="messageType">The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".</param>
+    /// <param name="matchBehaviour">The match behaviour. (default = "AcceptOnMatch")</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithBodyAsProtoBuf(this IRequestBuilder requestBuilder, string protoDefinition, string messageType, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageProtoBufMatcher(matchBehaviour, () => new(null, protoDefinition), messageType));
+    }
+
+    /// <summary>
+    /// WithGrpcProto
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="protoDefinition">The proto definition as text.</param>
+    /// <param name="messageType">The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".</param>
+    /// <param name="matcher">The matcher to use to match the ProtoBuf as (json) object.</param>
+    /// <param name="matchBehaviour">The match behaviour. (default = "AcceptOnMatch")</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithBodyAsProtoBuf(this IRequestBuilder requestBuilder, string protoDefinition, string messageType, IObjectMatcher matcher, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageProtoBufMatcher(matchBehaviour, () => new(null, protoDefinition), messageType, matcher));
+    }
+
+    /// <summary>
+    /// WithGrpcProto
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="messageType">The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".</param>
+    /// <param name="matchBehaviour">The match behaviour. (default = "AcceptOnMatch")</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithBodyAsProtoBuf(this IRequestBuilder requestBuilder, string messageType, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageProtoBufMatcher(matchBehaviour, () => requestBuilder.Mapping.ProtoDefinition!.Value, messageType));
+    }
+
+    /// <summary>
+    /// WithGrpcProto
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="messageType">The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".</param>
+    /// <param name="matcher">The matcher to use to match the ProtoBuf as (json) object.</param>
+    /// <param name="matchBehaviour">The match behaviour. (default = "AcceptOnMatch")</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithBodyAsProtoBuf(this IRequestBuilder requestBuilder, string messageType, IObjectMatcher matcher, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageProtoBufMatcher(matchBehaviour, () => requestBuilder.Mapping.ProtoDefinition!.Value, messageType, matcher));
+    }
+}

src/WireMock.Net/Util/ProtoBufUtils.cs → src/WireMock.Net.ProtoBuf/Util/ProtoBufUtils.cs

@@ -1,4 +1,3 @@
-#if PROTOBUF
 using System;
 using System.Threading;
 using System.Threading.Tasks;
@@ -8,9 +7,9 @@
 
 namespace WireMock.Util;
 
-internal static class ProtoBufUtils
+internal class ProtoBufUtils : IProtoBufUtils
 {
-    internal static async Task<byte[]> GetProtoBufMessageWithHeaderAsync(
+    public async Task<byte[]> GetProtoBufMessageWithHeaderAsync(
         string? protoDefinition,
         string? messageType,
         object? value,
@@ -37,5 +36,4 @@ internal static async Task<byte[]> GetProtoBufMessageWithHeaderAsync(
 
         return await SingletonFactory<Converter>.GetInstance().ConvertAsync(request, cancellationToken).ConfigureAwait(false);
     }
-}
-#endif
+}

src/WireMock.Net.ProtoBuf/WireMock.Net.ProtoBuf.csproj

@@ -0,0 +1,36 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <Description>ProtoBuf and gRPC support for WireMock.Net</Description>
+        <AssemblyTitle>WireMock.Net.ProtoBuf</AssemblyTitle>
+        <Authors>Stef Heyenrath</Authors>
+        <TargetFrameworks>netstandard2.0;netstandard2.1;net462;net6.0;net8.0</TargetFrameworks>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <PackageTags>wiremock;matchers;matcher;protobuf;grpc</PackageTags>
+        <RootNamespace>WireMock</RootNamespace>
+        <ProjectGuid>{B47413AA-55D3-49A7-896A-17ADBFF72407}</ProjectGuid>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
+        <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
+        <CodeAnalysisRuleSet>../WireMock.Net/WireMock.Net.ruleset</CodeAnalysisRuleSet>
+        <SignAssembly>true</SignAssembly>
+        <AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
+        <!--<DelaySign>true</DelaySign>-->
+        <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" PrivateAssets="All" />
+        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+        <PackageReference Include="ProtoBufJsonConverter" Version="0.2.0" />
+
+        <ProjectReference Include="..\WireMock.Net\WireMock.Net.csproj" />
+    </ItemGroup>
+
+</Project>

src/WireMock.Net/Matchers/IProtoBufMatcher.cs

@@ -1,8 +1,25 @@
+using System;
+using WireMock.Models;
+
 namespace WireMock.Matchers;
 
 /// <summary>
 /// IProtoBufMatcher
 /// </summary>
 public interface IProtoBufMatcher : IDecodeBytesMatcher, IBytesMatcher
 {
+    /// <summary>
+    /// The Func to define the proto definition as text or id.
+    /// </summary>
+    public Func<IdOrText> ProtoDefinition { get; }
+
+    /// <summary>
+    /// The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".
+    /// </summary>
+    public string MessageType { get; }
+
+    /// <summary>
+    /// The Matcher to use (optional).
+    /// </summary>
+    public IObjectMatcher? Matcher { get; }
 }

src/WireMock.Net/Matchers/Request/IRequestMessageProtoBufMatcher.cs

@@ -0,0 +1,12 @@
+namespace WireMock.Matchers.Request;
+
+/// <summary>
+/// The request body ProtoBuf matcher.
+/// </summary>
+public interface IRequestMessageProtoBufMatcher : IRequestMatcher
+{
+    /// <summary>
+    /// The ProtoBufMatcher.
+    /// </summary>
+    IProtoBufMatcher? Matcher { get; }
+}

src/WireMock.Net/Owin/Mappers/OwinResponseMapper.cs

@@ -142,11 +142,9 @@ private bool IsFault(IResponseMessage responseMessage)
                     var jsonBody = JsonConvert.SerializeObject(responseMessage.BodyData.BodyAsJson, new JsonSerializerSettings { Formatting = formatting, NullValueHandling = NullValueHandling.Ignore });
                     return (responseMessage.BodyData.Encoding ?? _utf8NoBom).GetBytes(jsonBody);
 
-#if PROTOBUF
                 case BodyType.ProtoBuf:
                     var protoDefinition = responseMessage.BodyData.ProtoDefinition?.Invoke().Text;
-                    return await ProtoBufUtils.GetProtoBufMessageWithHeaderAsync(protoDefinition, responseMessage.BodyData.ProtoBufMessageType, responseMessage.BodyData.BodyAsJson).ConfigureAwait(false);
-#endif
+                    return await TypeLoader.Load<IProtoBufUtils>().GetProtoBufMessageWithHeaderAsync(protoDefinition, responseMessage.BodyData.ProtoBufMessageType, responseMessage.BodyData.BodyAsJson).ConfigureAwait(false);
 
                 case BodyType.Bytes:
                     return responseMessage.BodyData.BodyAsBytes;

src/WireMock.Net/Properties/AssemblyInfo.cs

@@ -1,5 +1,6 @@
 using System.Runtime.CompilerServices;
 
+[assembly: InternalsVisibleTo("WireMock.Net.ProtoBuf, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]
 [assembly: InternalsVisibleTo("WireMock.Net.MimeKitLite, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]
 [assembly: InternalsVisibleTo("WireMock.Net.GraphQL, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]
 [assembly: InternalsVisibleTo("WireMock.Net.Matchers.CSharpCode, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]

src/WireMock.Net/RequestBuilders/IBodyRequestBuilder.cs

@@ -9,7 +9,7 @@ namespace WireMock.RequestBuilders;
 /// <summary>
 /// The BodyRequestBuilder interface.
 /// </summary>
-public interface IBodyRequestBuilder : IProtoBufRequestBuilder
+public interface IBodyRequestBuilder : IHttpVersionBuilder
 {
     /// <summary>
     /// WithBody: IMatcher

src/WireMock.Net/RequestBuilders/IRequestBuilder.cs

@@ -7,5 +7,10 @@ namespace WireMock.RequestBuilders;
 /// </summary>
 public interface IRequestBuilder : IClientIPRequestBuilder
 {
+    /// <summary>
+    /// The link back to the Mapping.
+    /// </summary>
+    internal IMapping Mapping { get; set; }
+
     internal IRequestBuilder Add<T>(T requestMatcher) where T : IRequestMatcher;
 }