Create GraphQL project (#1334)

* Create new project for GraphQL

* ...

* .

* ok?

* Update src/WireMock.Net.Shared/Extensions/AnyOfExtensions.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* --

* ...

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

src/WireMock.Net.GraphQL/Matchers/GraphQLMatcher.cs

@@ -0,0 +1,211 @@
+// Copyright © WireMock.Net
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using AnyOfTypes;
+using GraphQL;
+using GraphQL.Types;
+using GraphQLParser;
+using GraphQLParser.AST;
+using Newtonsoft.Json;
+using Stef.Validation;
+using WireMock.Exceptions;
+using WireMock.Extensions;
+using WireMock.GraphQL.Models;
+using WireMock.Models;
+using WireMock.Models.GraphQL;
+using WireMock.Utils;
+
+namespace WireMock.Matchers;
+
+/// <summary>
+/// GrapQLMatcher Schema Matcher
+/// </summary>
+public class GraphQLMatcher : IGraphQLMatcher
+{
+    private sealed class GraphQLRequest
+    {
+        // ReSharper disable once UnusedAutoPropertyAccessor.Local
+        public string? Query { get; set; }
+
+        // ReSharper disable once UnusedAutoPropertyAccessor.Local
+        public Dictionary<string, object?>? Variables { get; set; }
+    }
+
+    private readonly AnyOf<string, StringPattern>[] _patterns;
+
+    private readonly ISchema _schema;
+
+    /// <inheritdoc />
+    public MatchBehaviour MatchBehaviour { get; }
+
+    /// <summary>
+    /// An optional dictionary defining the custom Scalar and the type.
+    /// </summary>
+    public IDictionary<string, Type>? CustomScalars { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="GraphQLMatcher"/> class.
+    /// </summary>
+    /// <param name="schema">The schema.</param>
+    /// <param name="matchBehaviour">The match behaviour. (default = "AcceptOnMatch")</param>
+    /// <param name="matchOperator">The <see cref="Matchers.MatchOperator"/> to use. (default = "Or")</param>
+    public GraphQLMatcher(
+        AnyOf<string, StringPattern, ISchemaData> schema,
+        MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch,
+        MatchOperator matchOperator = MatchOperator.Or
+    ) : this(schema, null, matchBehaviour, matchOperator)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="GraphQLMatcher"/> class.
+    /// </summary>
+    /// <param name="schema">The schema.</param>
+    /// <param name="customScalars">A dictionary defining the custom scalars used in this schema. (optional)</param>
+    /// <param name="matchBehaviour">The match behaviour. (default = "AcceptOnMatch")</param>
+    /// <param name="matchOperator">The <see cref="Matchers.MatchOperator"/> to use. (default = "Or")</param>
+    public GraphQLMatcher(
+        AnyOf<string, StringPattern, ISchemaData> schema,
+        IDictionary<string, Type>? customScalars,
+        MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch,
+        MatchOperator matchOperator = MatchOperator.Or
+    )
+    {
+        Guard.NotNull(schema);
+        CustomScalars = customScalars;
+        MatchBehaviour = matchBehaviour;
+        MatchOperator = matchOperator;
+
+        var patterns = new List<AnyOf<string, StringPattern>>();
+        switch (schema.CurrentType)
+        {
+            case AnyOfType.First:
+                patterns.Add(schema.First);
+                _schema = BuildSchema(schema);
+                break;
+
+            case AnyOfType.Second:
+                patterns.Add(schema.Second);
+                _schema = BuildSchema(schema.Second.Pattern);
+                break;
+
+            case AnyOfType.Third:
+                _schema = ((SchemaDataWrapper)schema.Third).Schema;
+                break;
+
+            default:
+                throw new NotSupportedException();
+        }
+        _patterns = patterns.ToArray();
+    }
+
+    /// <inheritdoc />
+    public MatchResult IsMatch(string? input)
+    {
+        var score = MatchScores.Mismatch;
+        Exception? exception = null;
+
+        if (input != null && TryGetGraphQLRequest(input, out var graphQLRequest))
+        {
+            try
+            {
+                var executionResult = new DocumentExecuter().ExecuteAsync(eo =>
+                {
+                    eo.ThrowOnUnhandledException = true;
+
+                    eo.Schema = _schema;
+                    eo.Query = graphQLRequest.Query;
+
+                    if (graphQLRequest.Variables != null)
+                    {
+                        eo.Variables = new Inputs(graphQLRequest.Variables);
+                    }
+                }).GetAwaiter().GetResult();
+
+                if (executionResult.Errors == null || executionResult.Errors.Count == 0)
+                {
+                    score = MatchScores.Perfect;
+                }
+                else
+                {
+                    exception = executionResult.Errors.OfType<Exception>().ToArray().ToException();
+                }
+            }
+            catch (Exception ex)
+            {
+                exception = ex;
+            }
+        }
+
+        return new MatchResult(MatchBehaviourHelper.Convert(MatchBehaviour, score), exception);
+    }
+
+    /// <inheritdoc />
+    public AnyOf<string, StringPattern>[] GetPatterns()
+    {
+        return _patterns;
+    }
+
+    /// <inheritdoc />
+    public MatchOperator MatchOperator { get; }
+
+    /// <inheritdoc />
+    public string Name => nameof(GraphQLMatcher);
+
+    /// <inheritdoc />
+    public string GetCSharpCodeArguments()
+    {
+        return "NotImplemented";
+    }
+
+    private static bool TryGetGraphQLRequest(string input, [NotNullWhen(true)] out GraphQLRequest? graphQLRequest)
+    {
+        try
+        {
+            graphQLRequest = JsonConvert.DeserializeObject<GraphQLRequest>(input);
+            return graphQLRequest != null;
+        }
+        catch
+        {
+            graphQLRequest = default;
+            return false;
+        }
+    }
+
+    /// <param name="typeDefinitions">A textual description of the schema in SDL (Schema Definition Language) format.</param>
+    private ISchema BuildSchema(string typeDefinitions)
+    {
+        var schema = Schema.For(typeDefinitions);
+
+        // #984
+        var graphTypes = schema.BuiltInTypeMappings.Select(tm => tm.graphType).ToArray();
+        schema.RegisterTypes(graphTypes);
+
+        var doc = Parser.Parse(typeDefinitions);
+        var scalarTypeDefinitions = doc.Definitions
+            .Where(d => d.Kind == ASTNodeKind.ScalarTypeDefinition)
+            .OfType<GraphQLTypeDefinition>();
+
+        foreach (var scalarTypeDefinitionName in scalarTypeDefinitions.Select(s => s.Name.StringValue))
+        {
+            var customScalarGraphTypeName = $"{scalarTypeDefinitionName}GraphType";
+            if (graphTypes.All(t => t.Name != customScalarGraphTypeName)) // Only process when not built-in.
+            {
+                // Check if this custom Scalar is defined in the dictionary
+                if (CustomScalars == null || !CustomScalars.TryGetValue(scalarTypeDefinitionName, out var clrType))
+                {
+                    throw new WireMockException($"The GraphQL Scalar type '{scalarTypeDefinitionName}' is not defined in the CustomScalars dictionary.");
+                }
+
+                // Create a custom Scalar GraphType (extending the WireMockCustomScalarGraphType<{clrType}> class)
+                var customScalarGraphType = ReflectionUtils.CreateGenericType(customScalarGraphTypeName, typeof(WireMockCustomScalarGraphType<>), clrType);
+                schema.RegisterType(customScalarGraphType);
+            }
+        }
+
+        return schema;
+    }
+}

src/WireMock.Net.GraphQL/Models/SchemaDataWrapper.cs

@@ -0,0 +1,18 @@
+// Copyright © WireMock.Net
+
+using GraphQL.Types;
+using WireMock.Models.GraphQL;
+
+namespace WireMock.Models;
+
+/// <summary>
+/// Represents a wrapper for schema data, providing access to the associated schema.
+/// </summary>
+/// <param name="schema"></param>
+public class SchemaDataWrapper(ISchema schema) : ISchemaData
+{
+    /// <summary>
+    /// Gets the schema associated with the current instance.
+    /// </summary>
+    public ISchema Schema { get; } = schema;
+}

src/WireMock.Net.GraphQL/Models/WireMockCustomScalarGraphType.cs

@@ -0,0 +1,31 @@
+// Copyright © WireMock.Net
+
+using System;
+using GraphQL.Types;
+
+// ReSharper disable once CheckNamespace
+namespace WireMock.GraphQL.Models;
+
+/// <inheritdoc />
+public abstract class WireMockCustomScalarGraphType<T> : ScalarGraphType
+{
+    /// <inheritdoc />
+    public override object? ParseValue(object? value)
+    {
+        switch (value)
+        {
+            case null:
+                return null;
+
+            case T:
+                return value;
+        }
+
+        if (value is string && typeof(T) != typeof(string))
+        {
+            throw new InvalidCastException($"Unable to convert value '{value}' of type '{typeof(string)}' to type '{typeof(T)}'.");
+        }
+
+        return (T)Convert.ChangeType(value, typeof(T));
+    }
+}

src/WireMock.Net.GraphQL/Properties/AssemblyInfo.cs

@@ -0,0 +1,8 @@
+// Copyright © WireMock.Net
+
+using System.Runtime.CompilerServices;
+
+// [assembly: InternalsVisibleTo("WireMock.Net.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e138ec44d93acac565953052636eb8d5e7e9f27ddb030590055cd1a0ab2069a5623f1f77ca907d78e0b37066ca0f6d63da7eecc3fcb65b76aa8ebeccf7ebe1d11264b8404cd9b1cbbf2c83f566e033b3e54129f6ef28daffff776ba7aebbc53c0d635ebad8f45f78eb3f7e0459023c218f003416e080f96a1a3c5ffeb56bee9e")]
+
+// Needed for Moq in the UnitTest project
+// [assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]

src/WireMock.Net.GraphQL/RequestBuilders/IRequestBuilderExtensions.cs

@@ -0,0 +1,94 @@
+// Copyright © WireMock.Net
+
+using System;
+using System.Collections.Generic;
+using GraphQL.Types;
+using Stef.Validation;
+using WireMock.Matchers;
+using WireMock.Matchers.Request;
+using WireMock.Models;
+using WireMock.Models.GraphQL;
+
+namespace WireMock.RequestBuilders;
+
+/// <summary>
+/// IRequestBuilderExtensions extensions for GraphQL.
+/// </summary>
+// ReSharper disable once InconsistentNaming
+public static class IRequestBuilderExtensions
+{
+    /// <summary>
+    /// WithBodyAsGraphQL: The GraphQL body as a string.
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="schema">The GraphQL schema.</param>
+    /// <param name="matchBehaviour">The match behaviour. (Default is <c>MatchBehaviour.AcceptOnMatch</c>).</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithGraphQLSchema(this IRequestBuilder requestBuilder, string schema, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageGraphQLMatcher(matchBehaviour, schema));
+    }
+
+    /// <summary>
+    /// WithBodyAsGraphQL: The GraphQL schema as a string.
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="schema">The GraphQL schema.</param>
+    /// <param name="customScalars">A dictionary defining the custom scalars used in this schema. (optional)</param>
+    /// <param name="matchBehaviour">The match behaviour. (Default is <c>MatchBehaviour.AcceptOnMatch</c>).</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithGraphQLSchema(this IRequestBuilder requestBuilder, string schema, IDictionary<string, Type>? customScalars, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageGraphQLMatcher(matchBehaviour, schema, customScalars));
+    }
+
+    /// <summary>
+    /// WithBodyAsGraphQL: The GraphQL schema as a <see cref="ISchema"/>.
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="schema">The GraphQL schema.</param>
+    /// <param name="matchBehaviour">The match behaviour. (Default is <c>MatchBehaviour.AcceptOnMatch</c>).</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithGraphQLSchema(this IRequestBuilder requestBuilder, ISchema schema, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageGraphQLMatcher(matchBehaviour, new SchemaDataWrapper(schema)));
+    }
+
+    /// <summary>
+    /// WithBodyAsGraphQL: The GraphQL schema as a <see cref="ISchema"/>.
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="schema">The GraphQL schema.</param>
+    /// <param name="customScalars">A dictionary defining the custom scalars used in this schema. (optional)</param>
+    /// <param name="matchBehaviour">The match behaviour. (Default is <c>MatchBehaviour.AcceptOnMatch</c>).</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithGraphQLSchema(this IRequestBuilder requestBuilder, ISchema schema, IDictionary<string, Type>? customScalars, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageGraphQLMatcher(matchBehaviour, new SchemaDataWrapper(schema), customScalars));
+    }
+
+    /// <summary>
+    /// WithBodyAsGraphQL: The GraphQL schema as a <see cref="ISchemaData"/>.
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="schema">The GraphQL schema.</param>
+    /// <param name="matchBehaviour">The match behaviour. (Default is <c>MatchBehaviour.AcceptOnMatch</c>).</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithGraphQLSchema(this IRequestBuilder requestBuilder, ISchemaData schema, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageGraphQLMatcher(matchBehaviour, schema));
+    }
+
+    /// <summary>
+    /// WithBodyAsGraphQL: The GraphQL schema as a <see cref="ISchemaData"/>.
+    /// </summary>
+    /// <param name="requestBuilder">The <see cref="IRequestBuilder"/>.</param>
+    /// <param name="schema">The GraphQL schema.</param>
+    /// <param name="customScalars">A dictionary defining the custom scalars used in this schema. (optional)</param>
+    /// <param name="matchBehaviour">The match behaviour. (Default is <c>MatchBehaviour.AcceptOnMatch</c>).</param>
+    /// <returns>The <see cref="IRequestBuilder"/>.</returns>
+    public static IRequestBuilder WithGraphQLSchema(this IRequestBuilder requestBuilder, ISchemaData schema, IDictionary<string, Type>? customScalars, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch)
+    {
+        return Guard.NotNull(requestBuilder).Add(new RequestMessageGraphQLMatcher(matchBehaviour, schema, customScalars));
+    }
+}

src/WireMock.Net.GraphQL/Utils/ReflectionUtils.cs

@@ -0,0 +1,50 @@
+// Copyright © WireMock.Net
+
+using System;
+using System.Collections.Concurrent;
+using System.Linq;
+using System.Reflection;
+using System.Reflection.Emit;
+
+namespace WireMock.Utils;
+
+internal static class ReflectionUtils
+{
+    private const string DynamicModuleName = "WireMockDynamicModule";
+    private static readonly AssemblyName AssemblyName = new("WireMockDynamicAssembly");
+    private const TypeAttributes ClassAttributes =
+        TypeAttributes.Public |
+        TypeAttributes.Class |
+        TypeAttributes.AutoClass |
+        TypeAttributes.AnsiClass |
+        TypeAttributes.BeforeFieldInit |
+        TypeAttributes.AutoLayout;
+    private static readonly ConcurrentDictionary<string, Type> TypeCache = new();
+
+    public static Type CreateType(string typeName, Type? parentType = null)
+    {
+        return TypeCache.GetOrAdd(typeName, key =>
+        {
+            var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(AssemblyName, AssemblyBuilderAccess.Run);
+            var moduleBuilder = assemblyBuilder.DefineDynamicModule(DynamicModuleName);
+
+            var typeBuilder = moduleBuilder.DefineType(key, ClassAttributes, parentType);
+
+            // Create the type and cache it
+            return typeBuilder.CreateTypeInfo()!.AsType();
+        });
+    }
+
+    public static Type CreateGenericType(string typeName, Type genericTypeDefinition, params Type[] typeArguments)
+    {
+        var genericKey = $"{typeName}_{genericTypeDefinition.Name}_{string.Join(", ", typeArguments.Select(t => t.Name))}";
+
+        return TypeCache.GetOrAdd(genericKey, _ =>
+        {
+            var genericType = genericTypeDefinition.MakeGenericType(typeArguments);
+
+            // Create the type based on the genericType and cache it
+            return CreateType(typeName, genericType);
+        });
+    }
+}

src/WireMock.Net.GraphQL/WireMock.Net.GraphQL.csproj

@@ -0,0 +1,47 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <Description>GraphQL support for WireMock.Net</Description>
+        <AssemblyTitle>WireMock.Net.Matchers.GraphQL</AssemblyTitle>
+        <Authors>Stef Heyenrath</Authors>
+        <TargetFrameworks>netstandard2.0;netstandard2.1;netcoreapp3.1;net5.0;net6.0;net8.0</TargetFrameworks>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <PackageTags>wiremock;matchers;matcher;graphql</PackageTags>
+        <RootNamespace>WireMock</RootNamespace>
+        <ProjectGuid>{B6269AAC-170A-4346-8B9A-444DED3D9A45}</ProjectGuid>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
+        <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
+        <CodeAnalysisRuleSet>../WireMock.Net/WireMock.Net.ruleset</CodeAnalysisRuleSet>
+        <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)' == 'Release' ">
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="GraphQL.NewtonsoftJson" Version="8.2.1" />
+    </ItemGroup>
+
+    <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
+        <PackageReference Include="System.Reflection.Emit" Version="4.3.0" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\WireMock.Net.Shared\WireMock.Net.Shared.csproj" />
+    </ItemGroup>
+
+    <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
+        <PackageReference Include="Nullable" Version="1.3.1">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+</Project>