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

src/WireMock.Net/Serialization/LogEntryMapper.cs

@@ -32,6 +32,7 @@ internal class LogEntryMapper
             ProxyUrl = logEntry.RequestMessage.ProxyUrl,
             Query = logEntry.RequestMessage.Query,
             Method = logEntry.RequestMessage.Method,
+            HttpVersion = logEntry.RequestMessage.HttpVersion,
             Headers = logEntry.RequestMessage.Headers,
             Cookies = logEntry.RequestMessage.Cookies
         };

src/WireMock.Net/Serialization/MappingConverter.cs

@@ -14,7 +14,6 @@ using WireMock.Matchers.Request;
 using WireMock.Models;
 using WireMock.RequestBuilders;
 using WireMock.ResponseBuilders;
-using WireMock.Settings;
 using WireMock.Types;
 using WireMock.Util;
 
@@ -48,8 +47,10 @@ internal class MappingConverter
         var paramsMatchers = request.GetRequestMessageMatchers<RequestMessageParamMatcher>();
         var methodMatcher = request.GetRequestMessageMatcher<RequestMessageMethodMatcher>();
         var requestMessageBodyMatcher = request.GetRequestMessageMatcher<RequestMessageBodyMatcher>();
+        var requestMessageHttpVersionMatcher = request.GetRequestMessageMatcher<RequestMessageHttpVersionMatcher>();
         var requestMessageGraphQLMatcher = request.GetRequestMessageMatcher<RequestMessageGraphQLMatcher>();
         var requestMessageMultiPartMatcher = request.GetRequestMessageMatcher<RequestMessageMultiPartMatcher>();
+        var requestMessageProtoBufMatcher = request.GetRequestMessageMatcher<RequestMessageProtoBufMatcher>();
 
         var sb = new StringBuilder();
 
@@ -108,6 +109,11 @@ internal class MappingConverter
             sb.AppendLine($"        .WithCookie(\"{cookieMatcher.Name}\", {ToValueArguments(GetStringArray(cookieMatcher.Matchers!))}, true)");
         }
 
+        if (requestMessageHttpVersionMatcher?.HttpVersion != null)
+        {
+            sb.AppendLine($"        .WithHttpVersion({requestMessageHttpVersionMatcher.HttpVersion})");
+        }
+
 #if GRAPHQL
         if (requestMessageGraphQLMatcher is { Matchers: { } })
         {
@@ -128,6 +134,13 @@ internal class MappingConverter
         }
 #endif
 
+#if PROTOBUF
+        if (requestMessageProtoBufMatcher is { Matcher: { } })
+        {
+            sb.AppendLine("        // .WithBodyAsProtoBuf() is not yet supported");
+        }
+#endif
+
         if (requestMessageBodyMatcher is { Matchers: { } })
         {
             if (requestMessageBodyMatcher.Matchers.OfType<WildcardMatcher>().FirstOrDefault() is { } wildcardMatcher && wildcardMatcher.GetPatterns().Any())
@@ -182,6 +195,14 @@ internal class MappingConverter
             }
         }
 
+        if (response.ResponseMessage.TrailingHeaders is { })
+        {
+            foreach (var header in response.ResponseMessage.TrailingHeaders)
+            {
+                sb.AppendLine($"        .WithTrailingHeader(\"{header.Key}\", {ToValueArguments(header.Value.ToArray())})");
+            }
+        }
+
         if (response.ResponseMessage.BodyData is { } bodyData)
         {
             switch (response.ResponseMessage.BodyData.DetectedBodyType)
@@ -190,6 +211,7 @@ internal class MappingConverter
                 case BodyType.FormUrlEncoded:
                     sb.AppendLine($"        .WithBody({ToCSharpStringLiteral(bodyData.BodyAsString)})");
                     break;
+
                 case BodyType.Json:
                     if (bodyData.BodyAsJson is string bodyStringValue)
                     {
@@ -239,6 +261,8 @@ internal class MappingConverter
         var bodyMatcher = request.GetRequestMessageMatcher<RequestMessageBodyMatcher>();
         var graphQLMatcher = request.GetRequestMessageMatcher<RequestMessageGraphQLMatcher>();
         var multiPartMatcher = request.GetRequestMessageMatcher<RequestMessageMultiPartMatcher>();
+        var protoBufMatcher = request.GetRequestMessageMatcher<RequestMessageProtoBufMatcher>();
+        var httpVersionMatcher = request.GetRequestMessageMatcher<RequestMessageHttpVersionMatcher>();
 
         var mappingModel = new MappingModel
         {
@@ -253,6 +277,7 @@ internal class MappingConverter
             WhenStateIs = mapping.ExecutionConditionState,
             SetStateTo = mapping.NextState,
             Data = mapping.Data,
+            ProtoDefinition = mapping.ProtoDefinition?.Value,
             Probability = mapping.Probability,
             Request = new RequestModel
             {
@@ -290,6 +315,11 @@ internal class MappingConverter
             mappingModel.Request.MethodsMatchOperator = methodMatcher.Methods.Length > 1 ? methodMatcher.MatchOperator.ToString() : null;
         }
 
+        if (httpVersionMatcher?.HttpVersion != null)
+        {
+            mappingModel.Request.HttpVersion = httpVersionMatcher.HttpVersion;
+        }
+
         if (clientIPMatcher is { Matchers: { } })
         {
             var clientIPMatchers = _mapper.Map(clientIPMatcher.Matchers);
@@ -329,7 +359,7 @@ internal class MappingConverter
             mappingModel.Response.Delay = (int?)(response.Delay == Timeout.InfiniteTimeSpan ? TimeSpan.MaxValue.TotalMilliseconds : response.Delay?.TotalMilliseconds);
         }
 
-        var nonNullableWebHooks = mapping.Webhooks?.Where(wh => wh != null).ToArray() ?? EmptyArray<IWebhook>.Value;
+        var nonNullableWebHooks = mapping.Webhooks?.ToArray() ?? EmptyArray<IWebhook>.Value;
         if (nonNullableWebHooks.Length == 1)
         {
             mappingModel.Webhook = WebhookMapper.Map(nonNullableWebHooks[0]);
@@ -339,20 +369,40 @@ internal class MappingConverter
             mappingModel.Webhooks = mapping.Webhooks.Select(WebhookMapper.Map).ToArray();
         }
 
-        var bodyMatchers = multiPartMatcher?.Matchers ?? graphQLMatcher?.Matchers ?? bodyMatcher?.Matchers;
-        var matchOperator = multiPartMatcher?.MatchOperator ?? graphQLMatcher?.MatchOperator ?? bodyMatcher?.MatchOperator;
+        var bodyMatchers =
+            protoBufMatcher?.Matcher != null ? new[] { protoBufMatcher.Matcher } : null ??
+            multiPartMatcher?.Matchers ??
+            graphQLMatcher?.Matchers ??
+            bodyMatcher?.Matchers;
 
-        if (bodyMatchers != null && matchOperator != null)
+        var matchOperator =
+            multiPartMatcher?.MatchOperator ??
+            graphQLMatcher?.MatchOperator ??
+            bodyMatcher?.MatchOperator ??
+            MatchOperator.Or;
+
+        if (bodyMatchers != null)
         {
+            void AfterMap(MatcherModel matcherModel)
+            {
+#if PROTOBUF
+                // In case the ProtoDefinition is defined at the Mapping level, clear the Pattern at the Matcher level
+                if (bodyMatchers?.OfType<ProtoBufMatcher>().Any() == true && mappingModel.ProtoDefinition != null)
+                {
+                    matcherModel.Pattern = null;
+                }
+#endif
+            }
+
             mappingModel.Request.Body = new BodyModel();
 
             if (bodyMatchers.Length == 1)
             {
-                mappingModel.Request.Body.Matcher = _mapper.Map(bodyMatchers[0]);
+                mappingModel.Request.Body.Matcher = _mapper.Map(bodyMatchers[0], AfterMap);
             }
             else if (bodyMatchers.Length > 1)
             {
-                mappingModel.Request.Body.Matchers = _mapper.Map(bodyMatchers);
+                mappingModel.Request.Body.Matchers = _mapper.Map(bodyMatchers, AfterMap);
                 mappingModel.Request.Body.MatchOperator = matchOperator.ToString();
             }
         }
@@ -390,6 +440,11 @@ internal class MappingConverter
                 mappingModel.Response.Headers = MapHeaders(response.ResponseMessage.Headers);
             }
 
+            if (response.ResponseMessage.TrailingHeaders is { Count: > 0 })
+            {
+                mappingModel.Response.TrailingHeaders = MapHeaders(response.ResponseMessage.TrailingHeaders);
+            }
+
             if (response.UseTransformer)
             {
                 mappingModel.Response.UseTransformer = response.UseTransformer;
@@ -402,43 +457,7 @@ internal class MappingConverter
                 mappingModel.Response.UseTransformerForBodyAsFile = response.UseTransformerForBodyAsFile;
             }
 
-            if (response.ResponseMessage.BodyData != null)
-            {
-                switch (response.ResponseMessage.BodyData?.DetectedBodyType)
-                {
-                    case BodyType.String:
-                    case BodyType.FormUrlEncoded:
-                        mappingModel.Response.Body = response.ResponseMessage.BodyData.BodyAsString;
-                        break;
-
-                    case BodyType.Json:
-                        mappingModel.Response.BodyAsJson = response.ResponseMessage.BodyData.BodyAsJson;
-                        if (response.ResponseMessage.BodyData.BodyAsJsonIndented == true)
-                        {
-                            mappingModel.Response.BodyAsJsonIndented = response.ResponseMessage.BodyData.BodyAsJsonIndented;
-                        }
-                        break;
-
-                    case BodyType.Bytes:
-                        mappingModel.Response.BodyAsBytes = response.ResponseMessage.BodyData.BodyAsBytes;
-                        break;
-
-                    case BodyType.File:
-                        mappingModel.Response.BodyAsFile = response.ResponseMessage.BodyData.BodyAsFile;
-                        mappingModel.Response.BodyAsFileIsCached = response.ResponseMessage.BodyData.BodyAsFileIsCached;
-                        break;
-                }
-
-                if (response.ResponseMessage.BodyData?.Encoding != null && response.ResponseMessage.BodyData.Encoding.WebName != "utf-8")
-                {
-                    mappingModel.Response.BodyEncoding = new EncodingModel
-                    {
-                        EncodingName = response.ResponseMessage.BodyData.Encoding.EncodingName,
-                        CodePage = response.ResponseMessage.BodyData.Encoding.CodePage,
-                        WebName = response.ResponseMessage.BodyData.Encoding.WebName
-                    };
-                }
-            }
+            MapResponse(response, mappingModel);
 
             if (response.ResponseMessage.FaultType != FaultType.NONE)
             {
@@ -453,6 +472,61 @@ internal class MappingConverter
         return mappingModel;
     }
 
+    private static void MapResponse(Response response, MappingModel mappingModel)
+    {
+        if (response.ResponseMessage.BodyData == null)
+        {
+            return;
+        }
+
+        switch (response.ResponseMessage.BodyData?.DetectedBodyType)
+        {
+            case BodyType.String:
+            case BodyType.FormUrlEncoded:
+                mappingModel.Response.Body = response.ResponseMessage.BodyData.BodyAsString;
+                break;
+
+            case BodyType.Json:
+                mappingModel.Response.BodyAsJson = response.ResponseMessage.BodyData.BodyAsJson;
+                if (response.ResponseMessage.BodyData.BodyAsJsonIndented == true)
+                {
+                    mappingModel.Response.BodyAsJsonIndented = response.ResponseMessage.BodyData.BodyAsJsonIndented;
+                }
+                break;
+
+            case BodyType.ProtoBuf:
+                // If the ProtoDefinition is not defined at the MappingModel, get the ProtoDefinition from the ResponseMessage.
+                if (mappingModel.ProtoDefinition == null)
+                {
+                    mappingModel.Response.ProtoDefinition = response.ResponseMessage.BodyData.ProtoDefinition?.Invoke().Value;
+                }
+
+                mappingModel.Response.ProtoBufMessageType = response.ResponseMessage.BodyData.ProtoBufMessageType;
+                mappingModel.Response.BodyAsBytes = null;
+                mappingModel.Response.BodyAsJson = response.ResponseMessage.BodyData.BodyAsJson;
+                break;
+
+            case BodyType.Bytes:
+                mappingModel.Response.BodyAsBytes = response.ResponseMessage.BodyData.BodyAsBytes;
+                break;
+
+            case BodyType.File:
+                mappingModel.Response.BodyAsFile = response.ResponseMessage.BodyData.BodyAsFile;
+                mappingModel.Response.BodyAsFileIsCached = response.ResponseMessage.BodyData.BodyAsFileIsCached;
+                break;
+        }
+
+        if (response.ResponseMessage.BodyData?.Encoding != null && response.ResponseMessage.BodyData.Encoding.WebName != "utf-8")
+        {
+            mappingModel.Response.BodyEncoding = new EncodingModel
+            {
+                EncodingName = response.ResponseMessage.BodyData.Encoding.EncodingName,
+                CodePage = response.ResponseMessage.BodyData.Encoding.CodePage,
+                WebName = response.ResponseMessage.BodyData.Encoding.WebName
+            };
+        }
+    }
+
     private static string GetString(IStringMatcher stringMatcher)
     {
         return stringMatcher.GetPatterns().Select(p => ToCSharpStringLiteral(p.GetPattern())).First();

src/WireMock.Net/Serialization/MatcherMapper.cs

@@ -25,29 +25,25 @@ internal class MatcherMapper
 
     public IMatcher[]? Map(IEnumerable<MatcherModel>? matchers)
     {
-        if (matchers == null)
-        {
-            return null;
-        }
-        return matchers.Select(Map).Where(m => m != null).ToArray()!;
+        return matchers?.Select(Map).OfType<IMatcher>().ToArray();
     }
 
-    public IMatcher? Map(MatcherModel? matcher)
+    public IMatcher? Map(MatcherModel? matcherModel)
     {
-        if (matcher == null)
+        if (matcherModel == null)
         {
             return null;
         }
 
-        string[] parts = matcher.Name.Split('.');
+        string[] parts = matcherModel.Name.Split('.');
         string matcherName = parts[0];
         string? matcherType = parts.Length > 1 ? parts[1] : null;
-        var stringPatterns = ParseStringPatterns(matcher);
-        var matchBehaviour = matcher.RejectOnMatch == true ? MatchBehaviour.RejectOnMatch : MatchBehaviour.AcceptOnMatch;
-        var matchOperator = StringUtils.ParseMatchOperator(matcher.MatchOperator);
-        bool ignoreCase = matcher.IgnoreCase == true;
+        var stringPatterns = ParseStringPatterns(matcherModel);
+        var matchBehaviour = matcherModel.RejectOnMatch == true ? MatchBehaviour.RejectOnMatch : MatchBehaviour.AcceptOnMatch;
+        var matchOperator = StringUtils.ParseMatchOperator(matcherModel.MatchOperator);
+        bool ignoreCase = matcherModel.IgnoreCase == true;
         bool useRegexExtended = _settings.UseRegexExtended == true;
-        bool useRegex = matcher.Regex == true;
+        bool useRegex = matcherModel.Regex == true;
 
         switch (matcherName)
         {
@@ -72,26 +68,31 @@ internal class MatcherMapper
                 return CreateExactObjectMatcher(matchBehaviour, stringPatterns[0]);
 #if GRAPHQL
             case nameof(GraphQLMatcher):
-                return new GraphQLMatcher(stringPatterns[0].GetPattern(), matcher.CustomScalars, matchBehaviour, matchOperator);
+                return new GraphQLMatcher(stringPatterns[0].GetPattern(), matcherModel.CustomScalars, matchBehaviour, matchOperator);
 #endif
 
 #if MIMEKIT
             case nameof(MimePartMatcher):
-                return CreateMimePartMatcher(matchBehaviour, matcher);
+                return CreateMimePartMatcher(matchBehaviour, matcherModel);
+#endif
+
+#if PROTOBUF
+            case nameof(ProtoBufMatcher):
+                return CreateProtoBufMatcher(matchBehaviour, stringPatterns[0].GetPattern(), matcherModel);
 #endif
             case nameof(RegexMatcher):
                 return new RegexMatcher(matchBehaviour, stringPatterns, ignoreCase, useRegexExtended, matchOperator);
 
             case nameof(JsonMatcher):
-                var valueForJsonMatcher = matcher.Pattern ?? matcher.Patterns;
+                var valueForJsonMatcher = matcherModel.Pattern ?? matcherModel.Patterns;
                 return new JsonMatcher(matchBehaviour, valueForJsonMatcher!, ignoreCase);
 
             case nameof(JsonPartialMatcher):
-                var valueForJsonPartialMatcher = matcher.Pattern ?? matcher.Patterns;
+                var valueForJsonPartialMatcher = matcherModel.Pattern ?? matcherModel.Patterns;
                 return new JsonPartialMatcher(matchBehaviour, valueForJsonPartialMatcher!, ignoreCase, useRegex);
 
             case nameof(JsonPartialWildcardMatcher):
-                var valueForJsonPartialWildcardMatcher = matcher.Pattern ?? matcher.Patterns;
+                var valueForJsonPartialWildcardMatcher = matcherModel.Pattern ?? matcherModel.Patterns;
                 return new JsonPartialWildcardMatcher(matchBehaviour, valueForJsonPartialWildcardMatcher!, ignoreCase, useRegex);
 
             case nameof(JsonPathMatcher):
@@ -101,7 +102,7 @@ internal class MatcherMapper
                 return new JmesPathMatcher(matchBehaviour, matchOperator, stringPatterns);
 
             case nameof(XPathMatcher):
-                return new XPathMatcher(matchBehaviour, matchOperator, matcher.XmlNamespaceMap, stringPatterns);
+                return new XPathMatcher(matchBehaviour, matchOperator, matcherModel.XmlNamespaceMap, stringPatterns);
 
             case nameof(WildcardMatcher):
                 return new WildcardMatcher(matchBehaviour, stringPatterns, ignoreCase, matchOperator);
@@ -121,19 +122,19 @@ internal class MatcherMapper
             default:
                 if (_settings.CustomMatcherMappings != null && _settings.CustomMatcherMappings.ContainsKey(matcherName))
                 {
-                    return _settings.CustomMatcherMappings[matcherName](matcher);
+                    return _settings.CustomMatcherMappings[matcherName](matcherModel);
                 }
 
                 throw new NotSupportedException($"Matcher '{matcherName}' is not supported.");
         }
     }
 
-    public MatcherModel[]? Map(IEnumerable<IMatcher>? matchers)
+    public MatcherModel[]? Map(IEnumerable<IMatcher>? matchers, Action<MatcherModel>? afterMap = null)
     {
-        return matchers?.Where(m => m != null).Select(Map).ToArray();
+        return matchers?.Select(m => Map(m, afterMap)).OfType<MatcherModel>().ToArray();
     }
 
-    public MatcherModel? Map(IMatcher? matcher)
+    public MatcherModel? Map(IMatcher? matcher, Action<MatcherModel>? afterMap = null)
     {
         if (matcher == null)
         {
@@ -194,14 +195,9 @@ internal class MatcherMapper
                 }
                 break;
 
-            // If the matcher is a IValueMatcher, get the value (can be string or object).
-            case IValueMatcher valueMatcher:
-                model.Pattern = valueMatcher.Value;
-                break;
-
-            // If the matcher is a ExactObjectMatcher, get the ValueAsObject or ValueAsBytes.
-            case ExactObjectMatcher exactObjectMatcher:
-                model.Pattern = exactObjectMatcher.ValueAsObject ?? exactObjectMatcher.ValueAsBytes;
+            // If the matcher is a IObjectMatcher, get the value (can be string or object or byte[]).
+            case IObjectMatcher objectMatcher:
+                model.Pattern = objectMatcher.Value;
                 break;
 
 #if MIMEKIT
@@ -212,8 +208,18 @@ internal class MatcherMapper
                 model.ContentTypeMatcher = Map(mimePartMatcher.ContentTypeMatcher);
                 break;
 #endif
+
+#if PROTOBUF
+            case ProtoBufMatcher protoBufMatcher:
+                model.Pattern = protoBufMatcher.ProtoDefinition().Value;
+                model.ProtoBufMessageType = protoBufMatcher.MessageType;
+                model.ContentMatcher = Map(protoBufMatcher.Matcher);
+                break;
+#endif
         }
 
+        afterMap?.Invoke(model);
+
         return model;
     }
 
@@ -260,7 +266,7 @@ internal class MatcherMapper
     }
 
 #if MIMEKIT
-    private MimePartMatcher CreateMimePartMatcher(MatchBehaviour matchBehaviour, MatcherModel? matcher)
+    private MimePartMatcher CreateMimePartMatcher(MatchBehaviour matchBehaviour, MatcherModel matcher)
     {
         var contentTypeMatcher = Map(matcher?.ContentTypeMatcher) as IStringMatcher;
         var contentDispositionMatcher = Map(matcher?.ContentDispositionMatcher) as IStringMatcher;
@@ -270,4 +276,28 @@ internal class MatcherMapper
         return new MimePartMatcher(matchBehaviour, contentTypeMatcher, contentDispositionMatcher, contentTransferEncodingMatcher, contentMatcher);
     }
 #endif
+
+#if PROTOBUF
+    private ProtoBufMatcher CreateProtoBufMatcher(MatchBehaviour? matchBehaviour, string protoDefinitionOrId, MatcherModel matcher)
+    {
+        var objectMatcher = Map(matcher.ContentMatcher) as IObjectMatcher;
+
+        IdOrText protoDefinition;
+        if (_settings.ProtoDefinitions?.TryGetValue(protoDefinitionOrId, out var protoDefinitionFromSettings) == true)
+        {
+            protoDefinition = new(protoDefinitionOrId, protoDefinitionFromSettings);
+        }
+        else
+        {
+            protoDefinition = new(null, protoDefinitionOrId);
+        }
+
+        return new ProtoBufMatcher(
+            () => protoDefinition,
+            matcher!.ProtoBufMessageType!,
+            matchBehaviour ?? MatchBehaviour.AcceptOnMatch,
+            objectMatcher
+        );
+    }
+#endif
 }

src/WireMock.Net/Serialization/ProxyMappingConverter.cs

@@ -41,6 +41,7 @@ internal class ProxyMappingConverter
         var paramMatchers = request?.GetRequestMessageMatchers<RequestMessageParamMatcher>();
         var methodMatcher = request?.GetRequestMessageMatcher<RequestMessageMethodMatcher>();
         var bodyMatcher = request?.GetRequestMessageMatcher<RequestMessageBodyMatcher>();
+        var httpVersionMatcher = request?.GetRequestMessageMatcher<RequestMessageHttpVersionMatcher>();
 
         var newRequest = Request.Create();
 
@@ -70,6 +71,16 @@ internal class ProxyMappingConverter
             newRequest.UsingMethod(requestMessage.Method);
         }
 
+        // HttpVersion
+        if (useDefinedRequestMatchers && httpVersionMatcher?.HttpVersion is not null)
+        {
+            newRequest.WithHttpVersion(httpVersionMatcher.HttpVersion);
+        }
+        else
+        {
+            newRequest.WithHttpVersion(requestMessage.HttpVersion);
+        }
+
         // QueryParams
         if (useDefinedRequestMatchers && paramMatchers is not null)
         {
@@ -188,8 +199,7 @@ internal class ProxyMappingConverter
             webhooks: null,
             useWebhooksFireAndForget: null,
             timeSettings: null,
-            data: mapping?.Data,
-            probability: null
+            data: mapping?.Data
         );
     }
 }