Include WireMockOpenApiParser project (#916)

* Fix some nullability warnings for WireMockOpenApiParser * . * . * . * opt * FromText * ab * . * private const string AdminOpenApi = "/__admin/openapi"; * fix test * rnd * . * urldetails * 0 * , * . * tests * . * CompressionUtilsTests * ut * .
2026-03-30 05:41:46 +02:00 · 2023-04-08 21:25:17 +02:00
parent 3e24e3452b
commit a8775c3b77
35 changed files with 2284 additions and 295 deletions
--- a/src/WireMock.Net/IMapping.cs
+++ b/src/WireMock.Net/IMapping.cs
@@ -121,7 +121,7 @@ public interface IMapping
    /// <summary>
    /// Use Fire and Forget for the defined webhook(s). [Optional]
    /// </summary>
-    bool? UseWebhooksFireAndForget { get; set; }
+    bool? UseWebhooksFireAndForget { get; }

    /// <summary>
    /// Data Object which can be used when WithTransformer is used.
@@ -130,7 +130,7 @@ public interface IMapping
    /// lookup data "1"
    /// </example>
    /// </summary>
-    object? Data { get; set; }
+    object? Data { get; }

    /// <summary>
    /// ProvideResponseAsync
--- a/src/WireMock.Net/Mapping.cs
+++ b/src/WireMock.Net/Mapping.cs
@@ -67,13 +67,13 @@ public class Mapping : IMapping
    public IWebhook[]? Webhooks { get; }

    /// <inheritdoc />
-    public bool? UseWebhooksFireAndForget { get; set; }
+    public bool? UseWebhooksFireAndForget { get; }

    /// <inheritdoc />
    public ITimeSettings? TimeSettings { get; }

    /// <inheritdoc />
-    public object? Data { get; set; }
+    public object? Data { get; }

    /// <summary>
    /// Initializes a new instance of the <see cref="Mapping"/> class.
--- a/src/WireMock.Net/Models/UrlDetails.cs
+++ b/src/WireMock.Net/Models/UrlDetails.cs
@@ -1,51 +1,47 @@
-using System;
+using System;
 using Stef.Validation;

-namespace WireMock.Models
+namespace WireMock.Models;
+
+/// <summary>
+/// UrlDetails
+/// </summary>
+public class UrlDetails
 {
    /// <summary>
-    /// UrlDetails
+    /// Gets the url (relative).
    /// </summary>
-    public class UrlDetails
+    public Uri Url { get; }
+
+    /// <summary>
+    /// Gets the AbsoluteUrl.
+    /// </summary>
+    public Uri AbsoluteUrl { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UrlDetails"/> class.
+    /// </summary>
+    /// <param name="url">The URL.</param>
+    public UrlDetails(string url) : this(new Uri(url))
    {
-        /// <summary>
-        /// Gets the url (relative).
-        /// </summary>
-        public Uri Url { get; }
+    }

-        /// <summary>
-        /// Gets the AbsoluteUrl.
-        /// </summary>
-        public Uri AbsoluteUrl { get; }
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UrlDetails"/> class.
+    /// </summary>
+    /// <param name="url">The URL.</param>
+    public UrlDetails(Uri url) : this(url, url)
+    {
+    }

-        /// <summary>
-        /// Initializes a new instance of the <see cref="UrlDetails"/> class.
-        /// </summary>
-        /// <param name="url">The URL.</param>
-        public UrlDetails(string url) : this(new Uri(url))
-        {
-        }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="UrlDetails"/> class.
-        /// </summary>
-        /// <param name="url">The URL.</param>
-        public UrlDetails(Uri url) : this(url, url)
-        {
-        }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="UrlDetails"/> class.
-        /// </summary>
-        /// <param name="absoluteUrl">The absolute URL.</param>
-        /// <param name="url">The URL (relative).</param>
-        public UrlDetails(Uri absoluteUrl, Uri url)
-        {
-            Guard.NotNull(absoluteUrl, nameof(absoluteUrl));
-            Guard.NotNull(url, nameof(url));
-
-            AbsoluteUrl = absoluteUrl;
-            Url = url;
-        }
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UrlDetails"/> class.
+    /// </summary>
+    /// <param name="absoluteUrl">The absolute URL.</param>
+    /// <param name="url">The URL (relative).</param>
+    public UrlDetails(Uri absoluteUrl, Uri url)
+    {
+        AbsoluteUrl = Guard.NotNull(absoluteUrl);
+        Url = Guard.NotNull(url);
    }
 }
--- a/src/WireMock.Net/ResponseBuilders/IProxyResponseBuilder.cs
+++ b/src/WireMock.Net/ResponseBuilders/IProxyResponseBuilder.cs
@@ -27,7 +27,7 @@ public interface IProxyResponseBuilder : IStatusCodeResponseBuilder
    /// WithProxy using <see cref="X509Certificate2"/>.
    /// </summary>
    /// <param name="proxyUrl">The proxy url.</param>
-    /// <param name="certificate"">The X509Certificate2.</param>
+    /// <param name="certificate">The X509Certificate2.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithProxy(string proxyUrl, X509Certificate2 certificate);
 }
--- a/src/WireMock.Net/Serialization/SwaggerMapper.cs
+++ b/src/WireMock.Net/Serialization/SwaggerMapper.cs
@@ -54,10 +54,12 @@ internal static class SwaggerMapper
            {
                operation.Parameters.Add(openApiParameter);
            }
+
            foreach (var openApiParameter in MapRequestHeaders(mapping.Request.Headers))
            {
                operation.Parameters.Add(openApiParameter);
            }
+
            foreach (var openApiParameter in MapRequestCookies(mapping.Request.Cookies))
            {
                operation.Parameters.Add(openApiParameter);
@@ -94,7 +96,7 @@ internal static class SwaggerMapper
        return openApiDocument.ToJson(SchemaType.OpenApi3, Formatting.Indented);
    }

-    private static IEnumerable<OpenApiParameter> MapRequestQueryParameters(IList<ParamModel>? queryParameters)
+    private static IReadOnlyList<OpenApiParameter> MapRequestQueryParameters(IList<ParamModel>? queryParameters)
    {
        if (queryParameters == null)
        {
@@ -146,7 +148,7 @@ internal static class SwaggerMapper
            .ToList();
    }

-    private static IEnumerable<OpenApiParameter> MapRequestCookies(IList<CookieModel>? cookies)
+    private static IReadOnlyList<OpenApiParameter> MapRequestCookies(IList<CookieModel>? cookies)
    {
        if (cookies == null)
        {
--- a/src/WireMock.Net/Server/WireMockServer.Admin.cs
+++ b/src/WireMock.Net/Server/WireMockServer.Admin.cs
@@ -37,6 +37,8 @@ public partial class WireMockServer
    private const string AdminRequests = "/__admin/requests";
    private const string AdminSettings = "/__admin/settings";
    private const string AdminScenarios = "/__admin/scenarios";
+    private const string AdminOpenApi = "/__admin/openapi";
+
    private const string QueryParamReloadStaticMappings = "reloadStaticMappings";

    private static readonly Guid ProxyMappingGuid = new("e59914fd-782e-428e-91c1-4810ffb86567");
@@ -113,6 +115,10 @@ public partial class WireMockServer
        Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingGet()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(FileGet));
        Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingHead()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(FileHead));
        Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingDelete()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(FileDelete));
+
+        // __admin/openapi
+        Given(Request.Create().WithPath($"{AdminOpenApi}/convert").UsingPost()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(OpenApiConvertToMappings));
+        Given(Request.Create().WithPath($"{AdminOpenApi}/save").UsingPost()).AtPriority(WireMockConstants.AdminPriority).RespondWith(new DynamicResponseProvider(OpenApiSaveToMappings));
    }
    #endregion

@@ -737,7 +743,7 @@ public partial class WireMockServer
        return encodingModel != null ? Encoding.GetEncoding(encodingModel.CodePage) : null;
    }

-    private static ResponseMessage ToJson<T>(T result, bool keepNullValues = false)
+    private static ResponseMessage ToJson<T>(T result, bool keepNullValues = false, object? statusCode = null)
    {
        return new ResponseMessage
        {
@@ -746,7 +752,7 @@ public partial class WireMockServer
                DetectedBodyType = BodyType.String,
                BodyAsString = JsonConvert.SerializeObject(result, keepNullValues ? JsonSerializationConstants.JsonSerializerSettingsIncludeNullValues : JsonSerializationConstants.JsonSerializerSettingsDefault)
            },
-            StatusCode = (int)HttpStatusCode.OK,
+            StatusCode = statusCode ?? (int)HttpStatusCode.OK,
            Headers = new Dictionary<string, WireMockList<string>> { { HttpKnownHeaderNames.ContentType, new WireMockList<string>(WireMockConstants.ContentTypeJson) } }
        };
    }
--- a/src/WireMock.Net/Server/WireMockServer.ConvertMapping.cs
+++ b/src/WireMock.Net/Server/WireMockServer.ConvertMapping.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using Stef.Validation;
 using WireMock.Admin.Mappings;
@@ -14,7 +15,7 @@ namespace WireMock.Server;

 public partial class WireMockServer
 {
-    private void ConvertMappingsAndRegisterAsRespondProvider(MappingModel[] mappingModels, string? path = null)
+    private void ConvertMappingsAndRegisterAsRespondProvider(IReadOnlyList<MappingModel> mappingModels, string? path = null)
    {
        var duplicateGuids = mappingModels
            .Where(m => m.Guid != null)
@@ -46,7 +47,7 @@ public partial class WireMockServer
        }

        var respondProvider = Given(requestBuilder, mappingModel.SaveToFile == true);
-        
+
        if (guid != null)
        {
            respondProvider = respondProvider.WithGuid(guid.Value);
@@ -107,7 +108,10 @@ public partial class WireMockServer
            respondProvider = respondProvider.WithWebhook(webhooks);
        }

-        respondProvider.WithWebhookFireAndForget(mappingModel.UseWebhooksFireAndForget ?? false);
+        if (mappingModel.UseWebhooksFireAndForget == true)
+        {
+            respondProvider.WithWebhookFireAndForget(mappingModel.UseWebhooksFireAndForget.Value);
+        }

        var responseBuilder = InitResponseBuilder(mappingModel.Response);
        respondProvider.RespondWith(responseBuilder);
@@ -205,11 +209,11 @@ public partial class WireMockServer
        {
            foreach (var cookieModel in requestModel.Cookies.Where(c => c.Matchers != null))
            {
-               requestBuilder = requestBuilder.WithCookie(
-                    cookieModel.Name,
-                    cookieModel.IgnoreCase == true,
-                    cookieModel.RejectOnMatch == true ? MatchBehaviour.RejectOnMatch : MatchBehaviour.AcceptOnMatch,
-                    cookieModel.Matchers!.Select(_matcherMapper.Map).OfType<IStringMatcher>().ToArray());
+                requestBuilder = requestBuilder.WithCookie(
+                     cookieModel.Name,
+                     cookieModel.IgnoreCase == true,
+                     cookieModel.RejectOnMatch == true ? MatchBehaviour.RejectOnMatch : MatchBehaviour.AcceptOnMatch,
+                     cookieModel.Matchers!.Select(_matcherMapper.Map).OfType<IStringMatcher>().ToArray());
            }
        }

--- a/src/WireMock.Net/Server/WireMockServer.OpenApiParser.cs
+++ b/src/WireMock.Net/Server/WireMockServer.OpenApiParser.cs
@@ -0,0 +1,54 @@
+#if OPENAPIPARSER
+using System;
+using System.Linq;
+using System.Net;
+using WireMock.Net.OpenApiParser;
+#endif
+
+namespace WireMock.Server;
+
+public partial class WireMockServer
+{
+    private IResponseMessage OpenApiConvertToMappings(IRequestMessage requestMessage)
+    {
+#if OPENAPIPARSER
+        try
+        {
+            var mappingModels = new WireMockOpenApiParser().FromText(requestMessage.Body, out var diagnostic);
+            return diagnostic.Errors.Any() ? ToJson(diagnostic, false, HttpStatusCode.BadRequest) : ToJson(mappingModels);
+        }
+        catch (Exception e)
+        {
+            _settings.Logger.Error("HttpStatusCode set to {0} {1}", HttpStatusCode.BadRequest, e);
+            return ResponseMessageBuilder.Create(e.Message, HttpStatusCode.BadRequest);
+        }
+#else
+        return ResponseMessageBuilder.Create("Not supported for .NETStandard 1.3 and .NET 4.5.2 or lower.", 400);
+#endif
+    }
+
+    private IResponseMessage OpenApiSaveToMappings(IRequestMessage requestMessage)
+    {
+#if OPENAPIPARSER
+        try
+        {
+            var mappingModels = new WireMockOpenApiParser().FromText(requestMessage.Body, out var diagnostic);
+            if (diagnostic.Errors.Any())
+            {
+                return ToJson(diagnostic, false, HttpStatusCode.BadRequest);
+            }
+
+            ConvertMappingsAndRegisterAsRespondProvider(mappingModels);
+
+            return ResponseMessageBuilder.Create("OpenApi document converted to Mappings", HttpStatusCode.Created);
+        }
+        catch (Exception e)
+        {
+            _settings.Logger.Error("HttpStatusCode set to {0} {1}", HttpStatusCode.BadRequest, e);
+            return ResponseMessageBuilder.Create(e.Message, HttpStatusCode.BadRequest);
+        }
+#else
+        return ResponseMessageBuilder.Create("Not supported for .NETStandard 1.3 and .NET 4.5.2 or lower.", 400);
+#endif
+    }
+}
--- a/src/WireMock.Net/Util/BytesEncodingUtils.cs
+++ b/src/WireMock.Net/Util/BytesEncodingUtils.cs
@@ -108,7 +108,7 @@ internal static class BytesEncodingUtils
            return true;
        }

-        if (ch >= 0xc2 && ch <= 0xdf)
+        if (ch is >= 0xc2 and <= 0xdf)
        {
            if (position >= length - 2)
            {
@@ -145,7 +145,7 @@ internal static class BytesEncodingUtils
            return true;
        }

-        if (ch >= 0xe1 && ch <= 0xef)
+        if (ch is >= 0xe1 and <= 0xef)
        {
            if (position >= length - 3)
            {
@@ -204,7 +204,7 @@ internal static class BytesEncodingUtils
            return true;
        }

-        if (ch >= 0xf1 && ch <= 0xf3)
+        if (ch is >= 0xf1 and <= 0xf3)
        {
            if (position >= length - 4)
            {
--- a/src/WireMock.Net/Util/RegexUtils.cs
+++ b/src/WireMock.Net/Util/RegexUtils.cs
@@ -25,7 +25,7 @@ internal static class RegexUtils
        return namedGroupsDictionary;
    }

-    public static (bool IsValid, bool Result) MatchRegex(string pattern, string input, bool useRegexExtended = true)
+    public static (bool IsValid, bool Result) MatchRegex(string? pattern, string input, bool useRegexExtended = true)
    {
        if (string.IsNullOrEmpty(pattern))
        {
--- a/src/WireMock.Net/WireMock.Net.csproj
+++ b/src/WireMock.Net/WireMock.Net.csproj
@@ -35,15 +35,19 @@
    </PropertyGroup>

    <PropertyGroup Condition="'$(TargetFramework)' == 'netstandard1.3' or '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1'">
-        <DefineConstants>NETSTANDARD;USE_ASPNETCORE</DefineConstants>
+        <DefineConstants>$(DefineConstants);NETSTANDARD;USE_ASPNETCORE</DefineConstants>
    </PropertyGroup>

    <PropertyGroup Condition="'$(TargetFramework)' == 'netcoreapp2.1' or '$(TargetFramework)' == 'netcoreapp2.2' or '$(TargetFramework)' == 'netcoreapp3.1' or '$(TargetFramework)' == 'net5.0' or '$(TargetFramework)' == 'net6.0'or '$(TargetFramework)' == 'net7.0' ">
-        <DefineConstants>USE_ASPNETCORE</DefineConstants>
+        <DefineConstants>$(DefineConstants);USE_ASPNETCORE</DefineConstants>
    </PropertyGroup>

    <PropertyGroup Condition="'$(TargetFramework)' == 'net461'">
-        <DefineConstants>USE_ASPNETCORE;NET46</DefineConstants>
+        <DefineConstants>$(DefineConstants);USE_ASPNETCORE;NET46</DefineConstants>
+    </PropertyGroup>
+
+    <PropertyGroup Condition="'$(TargetFramework)' != 'netstandard1.3' and '$(TargetFramework)' != 'net451' and '$(TargetFramework)' != 'net452'">
+        <DefineConstants>$(DefineConstants);OPENAPIPARSER</DefineConstants>
    </PropertyGroup>

    <ItemGroup>
@@ -189,4 +193,8 @@
        <ProjectReference Include="..\WireMock.Net.Abstractions\WireMock.Net.Abstractions.csproj" />
        <ProjectReference Include="..\WireMock.Org.Abstractions\WireMock.Org.Abstractions.csproj" />
    </ItemGroup>
+
+    <ItemGroup Condition="'$(TargetFramework)' != 'netstandard1.3' and '$(TargetFramework)' != 'net451' and '$(TargetFramework)' != 'net452'">
+        <ProjectReference Include="..\WireMock.Net.OpenApiParser\WireMock.Net.OpenApiParser.csproj" />
+    </ItemGroup>
 </Project>