Add Grpc ProtoBuf support (request-response) (#1047)

* ProtoBuf

* .

* x

* ---

* x

* fx

* ...

* sc

* ...

* .

* groen

* x

* fix tests

* ok!?

* fix tests

* fix tests

* !

* x

* 6

* .

* x

* ivaluematcher

* transformer

* .

* sc

* .

* mapping

* x

* tra

* com

* ...

* .

* .

* .

* AddProtoDefinition

* .

* set

* grpahj

* .

* .

* IdOrText

* ...

* async

* async2

* .

* t

* nuget

* <PackageReference Include="ProtoBufJsonConverter" Version="0.2.0-preview-04" />

* http version

* tests

* .WithHttpVersion("2")

* <PackageReference Include="ProtoBufJsonConverter" Version="0.2.0" />

* HttpVersionParser

WireMock.Net Solution.sln

@@ -112,6 +112,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.Console.NET8",
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMockAzureQueueProxy", "examples\WireMockAzureQueueProxy\WireMockAzureQueueProxy.csproj", "{7FC0B409-2682-40EE-B3B9-3930D6769D01}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.Console.GrpcClient", "examples\WireMock.Net.Console.GrpcClient\WireMock.Net.Console.GrpcClient.csproj", "{B1580A38-84E7-44BE-8FE7-3EE5031D74A1}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -262,6 +264,10 @@ Global
 		{7FC0B409-2682-40EE-B3B9-3930D6769D01}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7FC0B409-2682-40EE-B3B9-3930D6769D01}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{7FC0B409-2682-40EE-B3B9-3930D6769D01}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B1580A38-84E7-44BE-8FE7-3EE5031D74A1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B1580A38-84E7-44BE-8FE7-3EE5031D74A1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B1580A38-84E7-44BE-8FE7-3EE5031D74A1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B1580A38-84E7-44BE-8FE7-3EE5031D74A1}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -305,6 +311,7 @@ Global
 		{941229D6-191B-4B5E-AC81-0905EBF4F19D} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 		{1EA72C0F-92E9-486B-8FFE-53F992BFC4AA} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 		{7FC0B409-2682-40EE-B3B9-3930D6769D01} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
+		{B1580A38-84E7-44BE-8FE7-3EE5031D74A1} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

WireMock.Net Solution.sln.DotSettings

@@ -25,12 +25,14 @@
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=XUA/@EntryIndexedValue">XUA</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Flurl/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=funcs/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Grpc/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=guidb/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Guids/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Heyenrath/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Jmes/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=openapi/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Pacticipant/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=protobuf/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Raml/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=randomizer/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Scriban/@EntryIndexedValue">True</s:Boolean>

examples/WireMock.Net.Console.GrpcClient/Program.cs

@@ -0,0 +1,21 @@
+using Greet;
+using Grpc.Net.Client;
+
+namespace WireMock.Net.Console.GrpcClient;
+
+internal class Program
+{
+    static async Task Main(string[] args)
+    {
+        var channel = GrpcChannel.ForAddress("http://localhost:9093/grpc3", new GrpcChannelOptions
+        {
+            Credentials = Grpc.Core.ChannelCredentials.Insecure
+        });
+
+        var client = new Greeter.GreeterClient(channel);
+
+        var reply = await client.SayHelloAsync(new HelloRequest { Name = "stef" });
+
+        System.Console.WriteLine("Greeting: " + reply.Message);
+    }
+}

examples/WireMock.Net.Console.GrpcClient/WireMock.Net.Console.GrpcClient.csproj

@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Google.Protobuf" Version="3.25.1" />
+        <PackageReference Include="Grpc.Net.Client" Version="2.59.0" />
+        <PackageReference Include="Grpc.Tools" Version="2.60.0">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+    <ItemGroup>
+        <Protobuf Include="greet.proto" GrpcServices="Client" />
+    </ItemGroup>
+
+</Project>

examples/WireMock.Net.Console.GrpcClient/greet.proto

@@ -0,0 +1,33 @@
+// Copyright 2019 The gRPC 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.
+
+syntax = "proto3";
+
+package greet;
+
+// The greeting service definition.
+service Greeter {
+  // Sends a greeting
+  rpc SayHello (HelloRequest) returns (HelloReply);
+}
+
+// The request message containing the user's name.
+message HelloRequest {
+  string name = 1;
+}
+
+// The response message containing the greetings
+message HelloReply {
+  string message = 1;
+}

examples/WireMock.Net.Console.NET8/WireMock.Net.Console.NET8.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>net8.0</TargetFramework>
-      <DefineConstants>$(DefineConstants);GRAPHQL;MIMEKIT</DefineConstants>
+      <DefineConstants>$(DefineConstants);GRAPHQL;MIMEKIT;PROTOBUF</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>

examples/WireMock.Net.Console.Net452.Classic/MainApp.cs

@@ -42,6 +42,24 @@ public class Todo
 
     public static class MainApp
     {
+        private const string ProtoDefinition = @"
+syntax = ""proto3"";
+
+package greet;
+
+service Greeter {
+  rpc SayHello (HelloRequest) returns (HelloReply);
+}
+
+message HelloRequest {
+  string name = 1;
+}
+
+message HelloReply {
+  string message = 1;
+}
+";
+
         private const string TestSchema = @"
   scalar DateTime
   scalar MyCustomScalar
@@ -115,17 +133,14 @@ public static void Run()
                     .WithBodyAsJson(rm => todos[int.Parse(rm.Query!["id"].ToString())])
                 );
 
-            var httpClient = server.CreateClient();
-            //server.Stop();
-
-            var httpAndHttpsWithPort = WireMockServer.Start(new WireMockServerSettings
+            using var httpAndHttpsWithPort = WireMockServer.Start(new WireMockServerSettings
             {
                 HostingScheme = HostingScheme.HttpAndHttps,
                 Port = 12399
             });
             httpAndHttpsWithPort.Stop();
 
-            var httpAndHttpsFree = WireMockServer.Start(new WireMockServerSettings
+            using var httpAndHttpsFree = WireMockServer.Start(new WireMockServerSettings
             {
                 HostingScheme = HostingScheme.HttpAndHttps
             });
@@ -134,11 +149,14 @@ public static void Run()
             string url1 = "http://localhost:9091/";
             string url2 = "http://localhost:9092/";
             string url3 = "https://localhost:9443/";
+            string urlGrpc = "grpc://localhost:9093/";
+            string urlGrpcSSL = "grpcs://localhost:9094/";
 
             server = WireMockServer.Start(new WireMockServerSettings
             {
+                // CorsPolicyOptions = CorsPolicyOptions.AllowAll,
                 AllowCSharpCodeMatcher = true,
-                Urls = new[] { url1, url2, url3 },
+                Urls = new[] { url1, url2, url3, urlGrpc, urlGrpcSSL },
                 StartAdminInterface = true,
                 ReadStaticMappings = true,
                 SaveUnmatchedRequests = true,
@@ -171,17 +189,91 @@ public static void Run()
             //server.SetAzureADAuthentication("6c2a4722-f3b9-4970-b8fc-fac41e29stef", "8587fde1-7824-42c7-8592-faf92b04stef");
 
             // server.AllowPartialMapping();
+
+#if PROTOBUF
+            var protoBufJsonMatcher = new JsonPartialWildcardMatcher(new { name = "*" });
+            server
+                .Given(Request.Create()
+                    .UsingPost()
+                    .WithHttpVersion("2")
+                    .WithPath("/grpc/greet.Greeter/SayHello")
+                    .WithBodyAsProtoBuf(ProtoDefinition, "greet.HelloRequest", protoBufJsonMatcher)
+                )
+                .RespondWith(Response.Create()
+                    .WithHeader("Content-Type", "application/grpc")
+                    .WithBodyAsProtoBuf(ProtoDefinition, "greet.HelloReply",
+                        new
+                        {
+                            message = "hello {{request.BodyAsJson.name}}"
+                        }
+                    )
+                    .WithTrailingHeader("grpc-status", "0")
+                    .WithTransformer()
+                );
+
+            server
+                .Given(Request.Create()
+                    .UsingPost()
+                    .WithHttpVersion("2")
+                    .WithPath("/grpc2/greet.Greeter/SayHello")
+                    .WithBodyAsProtoBuf("greet.HelloRequest", protoBufJsonMatcher)
+                )
+                .WithProtoDefinition(ProtoDefinition)
+                .RespondWith(Response.Create()
+                    .WithHeader("Content-Type", "application/grpc")
+                    .WithBodyAsProtoBuf("greet.HelloReply",
+                        new
+                        {
+                            message = "hello {{request.BodyAsJson.name}}"
+                        }
+                    )
+                    .WithTrailingHeader("grpc-status", "0")
+                    .WithTransformer()
+                );
+
+            server
+                .AddProtoDefinition("my-greeter", ProtoDefinition)
+                .Given(Request.Create()
+                    .UsingPost()
+                    .WithPath("/grpc3/greet.Greeter/SayHello")
+                    .WithBodyAsProtoBuf("greet.HelloRequest", protoBufJsonMatcher)
+                )
+                .WithProtoDefinition("my-greeter")
+                .RespondWith(Response.Create()
+                    .WithHeader("Content-Type", "application/grpc")
+                    .WithBodyAsProtoBuf("greet.HelloReply",
+                        new
+                        {
+                            message = "hello {{request.BodyAsJson.name}}"
+                        }
+                    )
+                    .WithTrailingHeader("grpc-status", "0")
+                    .WithTransformer()
+                );
+#endif
+
 #if GRAPHQL
             var customScalars = new Dictionary<string, Type> { { "MyCustomScalar", typeof(int) } };
             server
                 .Given(Request.Create()
                     .WithPath("/graphql")
                     .UsingPost()
-                    .WithGraphQLSchema(TestSchema, customScalars)
+                    .WithBodyAsGraphQL(TestSchema, customScalars)
                 )
                 .RespondWith(Response.Create()
                     .WithBody("GraphQL is ok")
                 );
+
+            //server
+            //    .AddGraphQLSchema("my-graphql", TestSchema, customScalars)
+            //    .Given(Request.Create()
+            //        .WithPath("/graphql2")
+            //        .UsingPost()
+            //    )
+            //    .WithGraphQLSchema("my-graphql")
+            //    .RespondWith(Response.Create()
+            //        .WithBody("GraphQL is ok")
+            //    );
 #endif
 
 #if MIMEKIT
@@ -336,8 +428,8 @@ public static void Run()
                         Url = "http://localhost:9999",
                         ReplaceSettings = new ProxyUrlReplaceSettings
                         {
-                           OldValue = "old",
-                           NewValue = "new"
+                            OldValue = "old",
+                            NewValue = "new"
                         }
                     })
                 );

src/WireMock.Net.Abstractions/Admin/Mappings/MappingModel.cs

@@ -98,4 +98,9 @@ public class MappingModel
     /// The probability when this request should be matched. Value is between 0 and 1. [Optional]
     /// </summary>
     public double? Probability { get; set; }
+
+    /// <summary>
+    /// The Grpc ProtoDefinition which is used for this mapping (request and response). [Optional]
+    /// </summary>
+    public string? ProtoDefinition { get; set; }
 }

src/WireMock.Net.Abstractions/Admin/Mappings/MatcherModel.cs

@@ -70,13 +70,22 @@ public class MatcherModel
     /// ContentTransferEncoding Matcher (base64)
     /// </summary>
     public MatcherModel? ContentTransferEncodingMatcher { get; set; }
+    #endregion
 
+    #region MimePartMatcher + ProtoBufMatcher
     /// <summary>
     /// Content Matcher
     /// </summary>
     public MatcherModel? ContentMatcher { get; set; }
     #endregion
 
+    #region ProtoBufMatcher
+    /// <summary>
+    /// The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".
+    /// </summary>
+    public string? ProtoBufMessageType { get; set; }
+    #endregion
+
     #region XPathMatcher
     /// <summary>
     /// Array of namespace prefix and uri. (optional)
@@ -86,7 +95,7 @@ public class MatcherModel
 
     #region GraphQLMatcher
     /// <summary>
-    /// Mapping of custom GraphQL Scalar name to ClrType.  (optional)
+    /// Mapping of custom GraphQL Scalar name to ClrType. (optional)
     /// </summary>
     public IDictionary<string, Type>? CustomScalars { get; set; }
     #endregion

src/WireMock.Net.Abstractions/Admin/Mappings/RequestModel.cs

@@ -28,6 +28,11 @@ public class RequestModel
     /// </summary>
     public string[]? Methods { get; set; }
 
+    /// <summary>
+    /// The HTTP Version
+    /// </summary>
+    public string? HttpVersion { get; set; }
+
     /// <summary>
     /// Reject on match for Methods.
     /// </summary>

src/WireMock.Net.Abstractions/Admin/Mappings/ResponseModel.cs

@@ -35,7 +35,7 @@ public class ResponseModel
     public bool? BodyAsJsonIndented { get; set; }
 
     /// <summary>
-    /// Gets or sets the body (as bytearray).
+    /// Gets or sets the body (as byte array).
     /// </summary>
     public byte[]? BodyAsBytes { get; set; }
 
@@ -84,6 +84,11 @@ public class ResponseModel
     /// </summary>
     public string? HeadersRaw { get; set; }
 
+    /// <summary>
+    /// Gets or sets the Trailing Headers.
+    /// </summary>
+    public IDictionary<string, object>? TrailingHeaders { get; set; }
+
     /// <summary>
     /// Gets or sets the delay in milliseconds.
     /// </summary>
@@ -123,4 +128,16 @@ public class ResponseModel
     /// Gets or sets the WebProxy settings.
     /// </summary>
     public WebProxyModel? WebProxy { get; set; }
+
+    #region ProtoBuf
+    /// <summary>
+    /// Gets or sets the proto definition.
+    /// </summary>
+    public string? ProtoDefinition { get; set; }
+
+    /// <summary>
+    /// Gets or sets the full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".
+    /// </summary>
+    public string? ProtoBufMessageType { get; set; }
+    #endregion
 }