Fix CompareTo in RequestMatchResult

#344

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

@@ -0,0 +1,11 @@
+using System;
+
+namespace WireMock.Matchers.Request
+{
+    public class MatchDetail
+    {
+        public Type MatcherType { get; set; }
+
+        public double Score { get; set; }
+    }
+}

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

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace WireMock.Matchers.Request
 {
@@ -14,15 +15,15 @@ public class RequestMatchResult : IComparable
         /// <value>
         /// The match-score.
         /// </value>
-        public double TotalScore { get; private set; }
+        public double TotalScore => MatchDetails.Sum(md => md.Score);
 
         /// <summary>
         /// Gets or sets the total number of matches.
         /// </summary>
         /// <value>
         /// The total number of matches.
         /// </value>
-        public int TotalNumber { get; private set; }
+        public int TotalNumber => MatchDetails.Count;
 
         /// <summary>
         /// Gets or sets a value indicating whether this instance is perfect match.
@@ -43,12 +44,7 @@ public class RequestMatchResult : IComparable
         /// <summary>
         /// Gets the match details.
         /// </summary>
-        public IList<KeyValuePair<Type, double>> MatchDetails { get; }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="RequestMatchResult"/> class.
-        /// </summary>
-        public RequestMatchResult() => MatchDetails = new List<KeyValuePair<Type, double>>();
+        public IList<MatchDetail> MatchDetails { get; } = new List<MatchDetail>();
 
         /// <summary>
         /// Adds the score.
@@ -58,9 +54,7 @@ public class RequestMatchResult : IComparable
         /// <returns>The score.</returns>
         public double AddScore(Type matcherType, double score)
         {
-            TotalScore += score;
-            TotalNumber++;
-            MatchDetails.Add(new KeyValuePair<Type, double>(matcherType, score));
+            MatchDetails.Add(new MatchDetail { MatcherType = matcherType, Score = score });
 
             return score;
         }
@@ -76,7 +70,10 @@ public int CompareTo(object obj)
         {
             var compareObj = (RequestMatchResult)obj;
 
-            return compareObj.AverageTotalScore.CompareTo(AverageTotalScore);
+            int averageTotalScoreResult = compareObj.AverageTotalScore.CompareTo(AverageTotalScore);
+
+            // In case the score is equal, prefer the one with the most matchers.
+            return averageTotalScoreResult == 0 ? compareObj.TotalNumber.CompareTo(TotalNumber) : averageTotalScoreResult;
         }
     }
 }

src/WireMock.Net/Owin/MappingMatcher.cs

@@ -49,8 +49,9 @@ public MappingMatcherResult FindBestMatch(RequestMessage request)
             }
 
             return mappings
-                .OrderBy(m => m.Mapping.Priority)
-                .FirstOrDefault(m => m.RequestMatchResult.IsPerfectMatch);
+                .Where(m => m.RequestMatchResult.IsPerfectMatch)
+                .OrderBy(m => m.Mapping.Priority).ThenBy(m => m.RequestMatchResult)
+                .FirstOrDefault();
         }
     }
 }

src/WireMock.Net/Serialization/LogEntryMapper.cs

@@ -108,14 +108,14 @@ public static LogEntryModel Map(LogEntry logEntry)
                 Response = logResponseModel,
                 RequestMatchResult = logEntry.RequestMatchResult != null ? new LogRequestMatchModel
                 {
+                    IsPerfectMatch = logEntry.RequestMatchResult.IsPerfectMatch,
                     TotalScore = logEntry.RequestMatchResult.TotalScore,
                     TotalNumber = logEntry.RequestMatchResult.TotalNumber,
-                    IsPerfectMatch = logEntry.RequestMatchResult.IsPerfectMatch,
                     AverageTotalScore = logEntry.RequestMatchResult.AverageTotalScore,
-                    MatchDetails = logEntry.RequestMatchResult.MatchDetails.Select(x => new
+                    MatchDetails = logEntry.RequestMatchResult.MatchDetails.Select(md => new
                     {
-                        Name = x.Key.Name.Replace("RequestMessage", string.Empty),
-                        Score = x.Value
+                        Name = md.MatcherType.Name.Replace("RequestMessage", string.Empty),
+                        Score = md.Score
                     } as object).ToList()
                 } : null
             };

test/WireMock.Net.Tests/Matchers/RequestMatchResultTests.cs

@@ -0,0 +1,54 @@
+using System.Linq;
+using FluentAssertions;
+using WireMock.Matchers;
+using WireMock.Matchers.Request;
+using Xunit;
+
+namespace WireMock.Net.Tests.Matchers
+{
+    public class RequestMatchResultTests
+    {
+        [Fact]
+        public void CompareTo_WithDifferentAverageScore_ReturnsBestMatch()
+        {
+            // Arrange
+            var result1 = new RequestMatchResult();
+            result1.AddScore(typeof(WildcardMatcher), 1);
+            result1.AddScore(typeof(WildcardMatcher), 0.9);
+
+            var result2 = new RequestMatchResult();
+            result2.AddScore(typeof(LinqMatcher), 1);
+            result2.AddScore(typeof(LinqMatcher), 1);
+
+            var results = new[] { result1, result2 };
+
+            // Act
+            var best = results.OrderBy(x => x).First();
+
+            // Assert
+            best.Should().Be(result2);
+        }
+
+        [Fact]
+        public void CompareTo_WithSameAverageScoreButMoreMatchers_ReturnsMatchWithMoreMatchers()
+        {
+            // Arrange
+            var result1 = new RequestMatchResult();
+            result1.AddScore(typeof(WildcardMatcher), 1);
+            result1.AddScore(typeof(WildcardMatcher), 1);
+
+            var result2 = new RequestMatchResult();
+            result2.AddScore(typeof(LinqMatcher), 1);
+            result2.AddScore(typeof(LinqMatcher), 1);
+            result2.AddScore(typeof(LinqMatcher), 1);
+
+            var results = new[] { result1, result2 };
+
+            // Act
+            var best = results.OrderBy(x => x).First();
+
+            // Assert
+            best.Should().Be(result2);
+        }
+    }
+}

test/WireMock.Net.Tests/Owin/MappingMatcherTests.cs

@@ -70,7 +70,10 @@ public void MappingMatcher_FindBestMatch_WhenMappingThrowsException_ShouldReturn
         public void MappingMatcher_FindBestMatch_WhenAllowPartialMappingIsFalse_ShouldReturnExactMatch()
         {
             // Assign
-            var mappings = InitMappings(new[] { (Guid.Parse("00000000-0000-0000-0000-000000000001"), 0.1), (Guid.Parse("00000000-0000-0000-0000-000000000002"), 1.0) });
+            var mappings = InitMappings(
+                (Guid.Parse("00000000-0000-0000-0000-000000000001"), new[] { 0.1 }),
+                (Guid.Parse("00000000-0000-0000-0000-000000000002"), new[] { 1.0 })
+            );
             _optionsMock.Setup(o => o.Mappings).Returns(mappings);
 
             var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1");
@@ -88,7 +91,10 @@ public void MappingMatcher_FindBestMatch_WhenAllowPartialMappingIsTrue_ShouldRet
         {
             // Assign
             _optionsMock.SetupGet(o => o.AllowPartialMapping).Returns(true);
-            var mappings = InitMappings(new[] { (Guid.Parse("00000000-0000-0000-0000-000000000001"), 0.1), (Guid.Parse("00000000-0000-0000-0000-000000000002"), 0.9) });
+            var mappings = InitMappings(
+                (Guid.Parse("00000000-0000-0000-0000-000000000001"), new[] { 0.1 }),
+                (Guid.Parse("00000000-0000-0000-0000-000000000002"), new[] { 0.9 })
+            );
             _optionsMock.Setup(o => o.Mappings).Returns(mappings);
 
             var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1");
@@ -101,7 +107,27 @@ public void MappingMatcher_FindBestMatch_WhenAllowPartialMappingIsTrue_ShouldRet
             Check.That(result.RequestMatchResult.AverageTotalScore).IsEqualTo(0.9);
         }
 
-        private ConcurrentDictionary<Guid, IMapping> InitMappings(params (Guid guid, double match)[] matches)
+        [Fact]
+        public void MappingMatcher_FindBestMatch_WhenAllowPartialMappingIsFalse_And_WithSameAverageScoreButMoreMatchers_ReturnsMatchWithMoreMatchers()
+        {
+            // Assign
+            var mappings = InitMappings(
+                (Guid.Parse("00000000-0000-0000-0000-000000000001"), new[] { 1.0 }),
+                (Guid.Parse("00000000-0000-0000-0000-000000000002"), new[] { 1.0, 1.0 })
+            );
+            _optionsMock.Setup(o => o.Mappings).Returns(mappings);
+
+            var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1");
+
+            // Act
+            var result = _sut.FindBestMatch(request);
+
+            // Assert and Verify
+            Check.That(result.Mapping.Guid).IsEqualTo(Guid.Parse("00000000-0000-0000-0000-000000000002"));
+            Check.That(result.RequestMatchResult.AverageTotalScore).IsEqualTo(0.9);
+        }
+
+        private ConcurrentDictionary<Guid, IMapping> InitMappings(params (Guid guid, double[] scores)[] matches)
         {
             var mappings = new ConcurrentDictionary<Guid, IMapping>();
 
@@ -110,9 +136,13 @@ private ConcurrentDictionary<Guid, IMapping> InitMappings(params (Guid guid, dou
                 var mappingMock = new Mock<IMapping>();
                 mappingMock.SetupGet(m => m.Guid).Returns(match.guid);
 
-                var partialMatchResult = new RequestMatchResult();
-                partialMatchResult.AddScore(typeof(object), match.match);
-                mappingMock.Setup(m => m.GetRequestMatchResult(It.IsAny<RequestMessage>(), It.IsAny<string>())).Returns(partialMatchResult);
+                var requestMatchResult = new RequestMatchResult();
+                foreach (var score in match.scores)
+                {
+                    requestMatchResult.AddScore(typeof(object), score);
+                }
+
+                mappingMock.Setup(m => m.GetRequestMatchResult(It.IsAny<RequestMessage>(), It.IsAny<string>())).Returns(requestMatchResult);
 
                 mappings.TryAdd(match.guid, mappingMock.Object);
             }