new projectx

src/WireMock.Net.Matchers.SystemTextJsonPath/Matchers/SystemTextJsonPathMatcher.cs

@@ -0,0 +1,184 @@
+// Copyright © WireMock.Net
+
+using System.Text.Json;
+using System.Text.Json.Nodes;
+using AnyOfTypes;
+using Json.Path;
+using Stef.Validation;
+using WireMock.Extensions;
+using WireMock.Models;
+using WireMock.Util;
+
+namespace WireMock.Matchers;
+
+/// <summary>
+/// SystemTextJsonPathMatcher - behaves the same as JsonPathMatcher but uses System.Text.Json and Json.Path instead of Newtonsoft.Json.
+/// </summary>
+/// <seealso cref="ISystemTextJsonPathMatcher" />
+public class SystemTextJsonPathMatcher : ISystemTextJsonPathMatcher
+{
+    private readonly AnyOf<string, StringPattern>[] _patterns;
+
+    /// <inheritdoc />
+    public MatchBehaviour MatchBehaviour { get; }
+
+    /// <inheritdoc />
+    public object Value { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextJsonPathMatcher"/> class.
+    /// </summary>
+    /// <param name="patterns">The patterns.</param>
+    public SystemTextJsonPathMatcher(params string[] patterns)
+        : this(MatchBehaviour.AcceptOnMatch, MatchOperator.Or, patterns.ToAnyOfPatterns())
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextJsonPathMatcher"/> class.
+    /// </summary>
+    /// <param name="patterns">The patterns.</param>
+    public SystemTextJsonPathMatcher(params AnyOf<string, StringPattern>[] patterns)
+        : this(MatchBehaviour.AcceptOnMatch, MatchOperator.Or, patterns)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SystemTextJsonPathMatcher"/> class.
+    /// </summary>
+    /// <param name="matchBehaviour">The match behaviour.</param>
+    /// <param name="matchOperator">The <see cref="Matchers.MatchOperator"/> to use. (default = "Or")</param>
+    /// <param name="patterns">The patterns.</param>
+    public SystemTextJsonPathMatcher(
+        MatchBehaviour matchBehaviour,
+        MatchOperator matchOperator = MatchOperator.Or,
+        params AnyOf<string, StringPattern>[] patterns)
+    {
+        _patterns = Guard.NotNull(patterns);
+        MatchBehaviour = matchBehaviour;
+        MatchOperator = matchOperator;
+        Value = patterns;
+    }
+
+    /// <inheritdoc />
+    public MatchResult IsMatch(string? input)
+    {
+        var score = MatchScores.Mismatch;
+        Exception? exception = null;
+
+        if (!string.IsNullOrWhiteSpace(input))
+        {
+            try
+            {
+                var node = JsonNode.Parse(input!);
+                score = IsMatchInternal(node);
+            }
+            catch (Exception ex)
+            {
+                exception = ex;
+            }
+        }
+
+        return MatchResult.From(Name, MatchBehaviourHelper.Convert(MatchBehaviour, score), exception);
+    }
+
+    /// <inheritdoc />
+    public MatchResult IsMatch(object? input)
+    {
+        var score = MatchScores.Mismatch;
+        Exception? exception = null;
+
+        // When input is null or byte[], return Mismatch.
+        if (input != null && input is not byte[])
+        {
+            try
+            {
+                JsonNode? node = input switch
+                {
+                    JsonNode jsonNode => jsonNode,
+                    string str => JsonNode.Parse(str),
+                    _ => JsonNode.Parse(JsonSerializer.Serialize(input))
+                };
+
+                score = IsMatchInternal(node);
+            }
+            catch (Exception ex)
+            {
+                exception = ex;
+            }
+        }
+
+        return MatchResult.From(Name, MatchBehaviourHelper.Convert(MatchBehaviour, score), exception);
+    }
+
+    /// <inheritdoc />
+    public AnyOf<string, StringPattern>[] GetPatterns()
+    {
+        return _patterns;
+    }
+
+    /// <inheritdoc />
+    public MatchOperator MatchOperator { get; }
+
+    /// <inheritdoc />
+    public string Name => nameof(SystemTextJsonPathMatcher);
+
+    /// <inheritdoc />
+    public string GetCSharpCodeArguments()
+    {
+        return $"new {Name}" +
+               $"(" +
+               $"{MatchBehaviour.GetFullyQualifiedEnumValue()}, " +
+               $"{MatchOperator.GetFullyQualifiedEnumValue()}, " +
+               $"{MappingConverterUtils.ToCSharpCodeArguments(_patterns)}" +
+               $")";
+    }
+
+    private double IsMatchInternal(JsonNode? node)
+    {
+        // JsonPath.Net requires the node to be inside an object or array for filter expressions.
+        // Similar to JsonPathMatcher's ConvertJTokenToJArrayIfNeeded, wrap a plain object in an array
+        // when it's an object with a single non-array child property.
+        var evaluationNode = WrapIfNeeded(node);
+
+        var values = _patterns
+            .Select(pattern =>
+            {
+                var path = JsonPath.Parse(pattern.GetPattern());
+                var result = path.Evaluate(evaluationNode);
+                return result.Matches is { Count: > 0 };
+            })
+            .ToArray();
+
+        return MatchScores.ToScore(values, MatchOperator);
+    }
+
+    // Mirrors JsonPathMatcher.ConvertJTokenToJArrayIfNeeded:
+    // If the node is an object with exactly one property whose value is not already an array,
+    // wrap that value in an array so that filter expressions (e.g. [?(@.x == y)]) can match.
+    private static JsonNode? WrapIfNeeded(JsonNode? node)
+    {
+        if (node is not JsonObject obj)
+        {
+            return node;
+        }
+
+        var properties = obj.ToList();
+        if (properties.Count != 1)
+        {
+            return node;
+        }
+
+        var single = properties[0];
+        if (single.Value is JsonArray)
+        {
+            return node;
+        }
+
+        var clonedValue = JsonNode.Parse(single.Value?.ToJsonString() ?? "null");
+        return new JsonObject
+        {
+            [single.Key] = new JsonArray(clonedValue)
+        };
+    }
+}

src/WireMock.Net.Matchers.SystemTextJsonPath/Properties/AssemblyInfo.cs

@@ -0,0 +1,5 @@
+// Copyright © WireMock.Net
+
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("WireMock.Net.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]

src/WireMock.Net.Matchers.SystemTextJsonPath/WireMock.Net.Matchers.SystemTextJsonPath.csproj

@@ -0,0 +1,41 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <Description>A SystemTextJsonPathMatcher which can be used to match WireMock.Net Requests using JSONPath with System.Text.Json.</Description>
+        <AssemblyTitle>WireMock.Net.Matchers.SystemTextJsonPath</AssemblyTitle>
+        <Authors>Stef Heyenrath</Authors>
+        <TargetFrameworks>netstandard2.0;net8.0</TargetFrameworks>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <PackageTags>wiremock;matchers;matcher;jsonpath;systemtextjson</PackageTags>
+        <RootNamespace>WireMock</RootNamespace>
+        <PackageId>WireMock.Net.Matchers.SystemTextJsonPath</PackageId>
+        <ProjectGuid>{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}</ProjectGuid>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
+        <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
+        <SignAssembly>true</SignAssembly>
+        <AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
+        <!--<DelaySign>true</DelaySign>-->
+        <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    </PropertyGroup>
+
+    <PropertyGroup Condition="'$(Configuration)' == 'Debug - Sonar'">
+        <CodeAnalysisRuleSet>../WireMock.Net/WireMock.Net.ruleset</CodeAnalysisRuleSet>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\WireMock.Net.Shared\WireMock.Net.Shared.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="JsonPath.Net" Version="3.0.2" />
+    </ItemGroup>
+
+</Project>