Fix ProtoBuf mapping.json (#1236)

* Fix ProtoBuf Mappings

* [Fact(Skip = "#1233")]

* fix?

* PortUtils

Author: StefH

src/WireMock.Net.Abstractions/Server/IWireMockServer.cs

@@ -215,14 +215,16 @@ public interface IWireMockServer : IDisposable
     /// This can be used if you have 1 or more <see cref="MappingModel"/> defined and want to register these in WireMock.Net directly instead of using the fluent syntax.
     /// </summary>
     /// <param name="mappings">The MappingModels</param>
+    /// <returns><see cref="IWireMockServer"/></returns>
     IWireMockServer WithMapping(params MappingModel[] mappings);
 
     /// <summary>
     /// Register the mappings (via json string).
     /// 
-    /// This can be used if you the mappings as json string defined and want to register these in WireMock.Net directly instead of using the fluent syntax.
+    /// This can be used if you've the mappings as json string defined and want to register these in WireMock.Net directly instead of using the fluent syntax.
     /// </summary>
     /// <param name="mappings">The mapping(s) as json string.</param>
+    /// <returns><see cref="IWireMockServer"/></returns>
     IWireMockServer WithMapping(string mappings);
 
     /// <summary>
@@ -238,5 +240,5 @@ public interface IWireMockServer : IDisposable
     /// </summary>
     /// <param name="converterType">The <see cref="MappingConverterType"/></param>
     /// <returns>C# code</returns>
-    public string MappingsToCSharpCode(MappingConverterType converterType);
+    string MappingsToCSharpCode(MappingConverterType converterType);
 }

src/WireMock.Net.RestClient/IWireMockAdminApi.cs

@@ -130,14 +130,23 @@ public interface IWireMockAdminApi
     Task<StatusModel> ReloadStaticMappingsAsync(CancellationToken cancellationToken = default);
 
     /// <summary>
-    /// Get a mapping based on the guid
+    /// Get a mapping based on the guid.
     /// </summary>
     /// <param name="guid">The Guid</param>
     /// <returns>MappingModel</returns>
     /// <param name="cancellationToken">The optional cancellationToken.</param>
     [Get("mappings/{guid}")]
     Task<MappingModel> GetMappingAsync([Path] Guid guid, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// Get a mapping based on the guid.
+    /// </summary>
+    /// <param name="guid">The Guid</param>
+    /// <returns>MappingModel</returns>
+    /// <param name="cancellationToken">The optional cancellationToken.</param>
+    [Get("mappings/{guid}")]
+    Task<MappingModel> GetMappingAsync([Path] string guid, CancellationToken cancellationToken = default);
+
     /// <summary>
     /// Get the C# code from a mapping based on the guid
     /// </summary>

src/WireMock.Net/Matchers/Helpers/BodyDataMatchScoreCalculator.cs

@@ -66,6 +66,12 @@ public static MatchResult CalculateMatchScore(IBodyData? requestMessage, IMatche
             return stringMatcher.IsMatch(requestMessage.BodyAsString);
         }
 
+        // In case the matcher is a IProtoBufMatcher, use the BodyAsBytes to match on.
+        if (matcher is IProtoBufMatcher protoBufMatcher)
+        {
+            return protoBufMatcher.IsMatchAsync(requestMessage.BodyAsBytes).GetAwaiter().GetResult();
+        }
+
         return default;
     }
 }

src/WireMock.Net/Matchers/ProtoBufMatcher.cs

@@ -2,7 +2,6 @@
 
 #if PROTOBUF
 using System;
-using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using ProtoBufJsonConverter;
@@ -28,7 +27,7 @@ public class ProtoBufMatcher : IProtoBufMatcher
     /// <summary>
     /// The Func to define the proto definition as id or texts.
     /// </summary>
-    public Func<IdOrTexts> ProtoDefinition { get; }
+    public Func<IdOrTexts> ProtoDefinition { get; internal set; }
 
     /// <summary>
     /// The full type of the protobuf (request/response) message object. Format is "{package-name}.{type-name}".

src/WireMock.Net/RequestBuilders/IBodyRequestBuilder.cs

@@ -2,7 +2,6 @@
 
 using System;
 using System.Collections.Generic;
-using JsonConverter.Abstractions;
 using WireMock.Matchers;
 using WireMock.Util;
 

src/WireMock.Net/RequestBuilders/Request.cs

@@ -5,8 +5,10 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using Stef.Validation;
+using WireMock.Matchers;
 using WireMock.Matchers.Request;
 
 namespace WireMock.RequestBuilders;
@@ -71,6 +73,19 @@ public IList<T> GetRequestMessageMatchers<T>() where T : IRequestMatcher
         return _requestMatchers.OfType<T>().FirstOrDefault(func);
     }
 
+    internal bool TryGetProtoBufMatcher([NotNullWhen(true)] out IProtoBufMatcher? protoBufMatcher)
+    {
+        protoBufMatcher = GetRequestMessageMatcher<RequestMessageProtoBufMatcher>()?.Matcher;
+        if (protoBufMatcher != null)
+        {
+            return true;
+        }
+
+        var bodyMatcher = GetRequestMessageMatcher<RequestMessageBodyMatcher>();
+        protoBufMatcher = bodyMatcher?.Matchers?.OfType<IProtoBufMatcher>().FirstOrDefault();
+        return protoBufMatcher != null;
+    }
+
     private IRequestBuilder Add<T>(T requestMatcher) where T : IRequestMatcher
     {
         foreach (var existing in _requestMatchers.OfType<T>().ToArray())

src/WireMock.Net/ResponseBuilders/Response.WithHeaders.cs

@@ -49,7 +49,7 @@ public IResponseBuilder WithHeaders(IDictionary<string, WireMockList<string>> he
     public IResponseBuilder WithTrailingHeader(string name, params string[] values)
     {
 #if !TRAILINGHEADERS
-        throw new System.NotSupportedException("The WithBodyAsProtoBuf method can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
+        throw new System.NotSupportedException("The WithTrailingHeader method can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
 #else
 
         Guard.NotNull(name);
@@ -63,7 +63,7 @@ public IResponseBuilder WithTrailingHeader(string name, params string[] values)
     public IResponseBuilder WithTrailingHeaders(IDictionary<string, string> headers)
     {
 #if !TRAILINGHEADERS
-        throw new System.NotSupportedException("The WithBodyAsProtoBuf method can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
+        throw new System.NotSupportedException("The WithTrailingHeaders method can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
 #else
 
         Guard.NotNull(headers);
@@ -77,7 +77,7 @@ public IResponseBuilder WithTrailingHeaders(IDictionary<string, string> headers)
     public IResponseBuilder WithTrailingHeaders(IDictionary<string, string[]> headers)
     {
 #if !TRAILINGHEADERS
-        throw new System.NotSupportedException("The WithBodyAsProtoBuf method can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
+        throw new System.NotSupportedException("The WithTrailingHeaders method can not be used for .NETStandard1.3 or .NET Framework 4.6.1 or lower.");
 #else
 
         Guard.NotNull(headers);

src/WireMock.Net/ResponseBuilders/Response.cs

@@ -8,7 +8,6 @@
 using System.Threading.Tasks;
 using JetBrains.Annotations;
 using Stef.Validation;
-using WireMock.Matchers.Request;
 using WireMock.Proxy;
 using WireMock.RequestBuilders;
 using WireMock.Settings;
@@ -264,16 +263,15 @@ string RemoveFirstOccurrence(string source, string find)
 
         if (UseTransformer)
         {
-            // Check if the body matcher is a RequestMessageProtoBufMatcher and try to decode the byte-array to a BodyAsJson.
-            if (mapping.RequestMatcher is Request requestMatcher && requestMessage is RequestMessage request)
+            // If the body matcher is a RequestMessageProtoBufMatcher or BodyMatcher with a ProtoBufMatcher then try to decode the byte-array to a BodyAsJson.
+            if (mapping.RequestMatcher is Request request && requestMessage is RequestMessage requestMessageImplementation)
             {
-                var protoBufMatcher = requestMatcher.GetRequestMessageMatcher<RequestMessageProtoBufMatcher>()?.Matcher;
-                if (protoBufMatcher != null)
+                if (request.TryGetProtoBufMatcher(out var protoBufMatcher))
                 {
-                    var decoded = await protoBufMatcher.DecodeAsync(request.BodyData?.BodyAsBytes).ConfigureAwait(false);
+                    var decoded = await protoBufMatcher.DecodeAsync(requestMessage.BodyData?.BodyAsBytes).ConfigureAwait(false);
                     if (decoded != null)
                     {
-                        request.BodyAsJson = JsonUtils.ConvertValueToJToken(decoded);
+                        requestMessageImplementation.BodyAsJson = JsonUtils.ConvertValueToJToken(decoded);
                     }
                 }
             }

src/WireMock.Net/Serialization/MappingConverter.cs

@@ -379,7 +379,7 @@ public MappingModel ToMappingModel(IMapping mapping)
         }
 
         var bodyMatchers =
-            protoBufMatcher?.Matcher != null ? new[] { protoBufMatcher.Matcher } : null ??
+            protoBufMatcher?.Matcher != null ? [protoBufMatcher.Matcher] : null ??
             multiPartMatcher?.Matchers ??
             graphQLMatcher?.Matchers ??
             bodyMatcher?.Matchers;

src/WireMock.Net/Serialization/MatcherMapper.cs

@@ -220,7 +220,7 @@ public MatcherMapper(WireMockServerSettings settings)
                     {
                         model.Pattern = texts[0];
                     }
-                    else
+                    else if (texts.Count > 1)
                     {
                         model.Patterns = texts.Cast<object>().ToArray();
                     }
@@ -296,27 +296,9 @@ private ProtoBufMatcher CreateProtoBufMatcher(MatchBehaviour? matchBehaviour, IR
     {
         var objectMatcher = Map(matcher.ContentMatcher) as IObjectMatcher;
 
-        IdOrTexts protoDefinitionAsIdOrTexts;
-        if (protoDefinitions.Count == 1)
-        {
-            var idOrText = protoDefinitions[0];
-            if (_settings.ProtoDefinitions?.TryGetValue(idOrText, out var protoDefinitionFromSettings) == true)
-            {
-                protoDefinitionAsIdOrTexts = new(idOrText, protoDefinitionFromSettings);
-            }
-            else
-            {
-                protoDefinitionAsIdOrTexts = new(null, protoDefinitions);
-            }
-        }
-        else
-        {
-            protoDefinitionAsIdOrTexts = new(null, protoDefinitions);
-        }
-
         return new ProtoBufMatcher(
-            () => protoDefinitionAsIdOrTexts,
-            matcher!.ProtoBufMessageType!,
+            () => ProtoDefinitionHelper.GetIdOrTexts(_settings, protoDefinitions.ToArray()),
+            matcher.ProtoBufMessageType!,
             matchBehaviour ?? MatchBehaviour.AcceptOnMatch,
             objectMatcher
         );

src/WireMock.Net/Server/IRespondWithAProvider.cs

@@ -123,14 +123,14 @@ public interface IRespondWithAProvider
     void ThenRespondWithStatusCode(HttpStatusCode code);
 
     /// <summary>
-    /// Sets the the scenario.
+    /// Sets the scenario.
     /// </summary>
     /// <param name="scenario">The scenario.</param>
     /// <returns>The <see cref="IRespondWithAProvider"/>.</returns>
     IRespondWithAProvider InScenario(string scenario);
 
     /// <summary>
-    /// Sets the the scenario with an integer value.
+    /// Sets the scenario with an integer value.
     /// </summary>
     /// <param name="scenario">The scenario.</param>
     /// <returns>The <see cref="IRespondWithAProvider"/>.</returns>
@@ -220,7 +220,7 @@ IRespondWithAProvider WithWebhook(
 
     /// <summary>
     /// Data Object which can be used when WithTransformer is used.
-    /// e.g. lookup an path in this object using
+    /// e.g. lookup a path in this object using
     /// <param name="data">The data dictionary object.</param>
     /// <example>
     /// lookup data "1"

src/WireMock.Net/Server/RespondWithAProvider.cs

@@ -17,7 +17,7 @@
 namespace WireMock.Server;
 
 /// <summary>
-/// The respond with a provider.
+/// The RespondWithAProvider.
 /// </summary>
 internal class RespondWithAProvider : IRespondWithAProvider
 {
@@ -37,7 +37,6 @@ internal class RespondWithAProvider : IRespondWithAProvider
     private int _timesInSameState = 1;
     private bool? _useWebhookFireAndForget;
     private double? _probability;
-    private IdOrTexts? _protoDefinition;
     private GraphQLSchemaDetails? _graphQLSchemaDetails;
 
     public Guid Guid { get; private set; }
@@ -48,6 +47,8 @@ internal class RespondWithAProvider : IRespondWithAProvider
 
     public object? Data { get; private set; }
 
+    public IdOrTexts? ProtoDefinition { get; private set; }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="RespondWithAProvider"/> class.
     /// </summary>
@@ -104,9 +105,9 @@ public void RespondWith(IResponseProvider provider)
             mapping.WithProbability(_probability.Value);
         }
 
-        if (_protoDefinition != null)
+        if (ProtoDefinition != null)
         {
-            mapping.WithProtoDefinition(_protoDefinition.Value);
+            mapping.WithProtoDefinition(ProtoDefinition.Value);
         }
 
         _registrationCallback(mapping, _saveToFile);
@@ -296,7 +297,7 @@ public IRespondWithAProvider WithWebhook(
         Guard.NotNull(url);
         Guard.NotNull(method);
 
-        Webhooks = new[] { InitWebhook(url, method, headers, useTransformer, transformerType) };
+        Webhooks = [InitWebhook(url, method, headers, useTransformer, transformerType)];
 
         if (body != null)
         {
@@ -323,7 +324,7 @@ public IRespondWithAProvider WithWebhook(
         Guard.NotNull(url);
         Guard.NotNull(method);
 
-        Webhooks = new[] { InitWebhook(url, method, headers, useTransformer, transformerType) };
+        Webhooks = [InitWebhook(url, method, headers, useTransformer, transformerType)];
 
         if (body != null)
         {
@@ -355,23 +356,7 @@ public IRespondWithAProvider WithProtoDefinition(params string[] protoDefinition
     {
         Guard.NotNull(protoDefinitionOrId);
 
-        if (protoDefinitionOrId.Length == 1)
-        {
-            var idOrText = protoDefinitionOrId[0];
-            if (_settings.ProtoDefinitions?.TryGetValue(idOrText, out var protoDefinitions) == true)
-            {
-                _protoDefinition = new(idOrText, protoDefinitions);
-            }
-            else
-            {
-                _protoDefinition = new(null, protoDefinitionOrId);
-            }
-        }
-        else
-        {
-            _protoDefinition = new(null, protoDefinitionOrId);
-        }
-        
+        ProtoDefinition = ProtoDefinitionHelper.GetIdOrTexts(_settings, protoDefinitionOrId);
 
         return this;
     }