Fix CompareTo in RequestMatchResult (#345)

* Fix CompareTo in RequestMatchResult
#344

* fix test
This commit is contained in:
Stef Heyenrath
2019-09-17 14:50:43 +02:00
committed by GitHub
parent 2f406029c9
commit 5b8b588983
6 changed files with 117 additions and 24 deletions

View File

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

View File

@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
namespace WireMock.Matchers.Request
{
@@ -14,7 +15,7 @@ namespace WireMock.Matchers.Request
/// <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.
@@ -22,7 +23,7 @@ namespace WireMock.Matchers.Request
/// <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 @@ namespace WireMock.Matchers.Request
/// <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 @@ namespace WireMock.Matchers.Request
/// <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 @@ namespace WireMock.Matchers.Request
{
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;
}
}
}

View File

@@ -49,8 +49,9 @@ namespace WireMock.Owin
}
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();
}
}
}

View File

@@ -108,14 +108,14 @@ namespace WireMock.Serialization
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
};

View File

@@ -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);
}
}
}

View File

@@ -70,7 +70,10 @@ namespace WireMock.Net.Tests.Owin
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 @@ namespace WireMock.Net.Tests.Owin
{
// 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 @@ namespace WireMock.Net.Tests.Owin
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(1.0);
}
private ConcurrentDictionary<Guid, IMapping> InitMappings(params (Guid guid, double[] scores)[] matches)
{
var mappings = new ConcurrentDictionary<Guid, IMapping>();
@@ -110,9 +136,13 @@ namespace WireMock.Net.Tests.Owin
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);
}