Add possibility to use settings to generate MappingModel models with …

…wildcard path parameters. (#609) * Add optional settings for WithMappingFromOpenApi * . * . * cleanup
WireMock-Net · Apr 26, 2021 · d91b5d5 · d91b5d5
1 parent 43b96ce
commit d91b5d5
Show file tree

Hide file tree

Showing 11 changed files with 502 additions and 297 deletions.
diff --git a/WireMock.Net Solution.sln.DotSettings b/WireMock.Net Solution.sln.DotSettings
@@ -13,6 +13,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=funcs/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Heyenrath/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Jmes/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Raml/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=randomizer/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Stef/@EntryIndexedValue">True</s:Boolean>
 </wpf:ResourceDictionary>
diff --git a/examples/WireMock.Net.OpenApiParser.ConsoleApp/Run.cs b/examples/WireMock.Net.OpenApiParser.ConsoleApp/Run.cs
@@ -3,9 +3,11 @@
 using System.Linq;
 using WireMock.Admin.Mappings;
 using WireMock.Logging;
+using WireMock.Net.OpenApiParser.Extensions;
+using WireMock.Net.OpenApiParser.Settings;
+using WireMock.Net.OpenApiParser.Types;
 using WireMock.Server;
 using WireMock.Settings;
-using WireMock.Net.OpenApiParser.Extensions;
 
 namespace WireMock.Net.OpenApiParser.ConsoleApp
 {
@@ -23,13 +25,18 @@ public static void RunServer(string path)
                 ReadStaticMappings = false,
                 WatchStaticMappings = false,
                 WatchStaticMappingsInSubdirectories = false,
-                Logger = new WireMockConsoleLogger(),
+                Logger = new WireMockConsoleLogger()
             });
             Console.WriteLine("WireMockServer listening at {0}", string.Join(",", server.Urls));
 
             server.SetBasicAuthentication("a", "b");
 
-            server.WithMappingFromOpenApiFile(path, out var diag);
+            var settings = new WireMockOpenApiParserSettings
+            {
+                PathPatternToUse = ExampleValueType.Wildcard
+            };
+
+            server.WithMappingFromOpenApiFile(path, settings, out var diag);
 
             Console.WriteLine("Press any key to stop the server");
             System.Console.ReadKey();

diff --git a/src/WireMock.Net.OpenApiParser/Extensions/WireMockServerExtensions.cs b/src/WireMock.Net.OpenApiParser/Extensions/WireMockServerExtensions.cs
@@ -1,12 +1,19 @@
-using System;
-using System.IO;
+using System.IO;
 using System.Linq;
+using System.Runtime.InteropServices.ComTypes;
+using JetBrains.Annotations;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers;
+using SharpYaml.Model;
+using Stef.Validation;
+using WireMock.Net.OpenApiParser.Settings;
 using WireMock.Server;
 
 namespace WireMock.Net.OpenApiParser.Extensions
 {
+    /// <summary>
+    /// Some extension methods for <see cref="IWireMockServer"/>.
+    /// </summary>
     public static class WireMockServerExtensions
     {
         /// <summary>
@@ -15,18 +22,26 @@ public static class WireMockServerExtensions
         /// <param name="server">The WireMockServer instance</param>
         /// <param name="path">Path containing OpenAPI file to parse and use the mappings.</param>
         /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
+        [PublicAPI]
         public static IWireMockServer WithMappingFromOpenApiFile(this IWireMockServer server, string path, out OpenApiDiagnostic diagnostic)
         {
-            if (server == null)
-            {
-                throw new ArgumentNullException(nameof(server));
-            }
-            if (string.IsNullOrEmpty(path))
-            {
-                throw new ArgumentNullException(nameof(path));
-            }
+            return WithMappingFromOpenApiFile(server, path, null, out diagnostic);
+        }
+
+        /// <summary>
+        /// Register the mappings via an OpenAPI (swagger) V2 or V3 file.
+        /// </summary>
+        /// <param name="server">The WireMockServer instance</param>
+        /// <param name="path">Path containing OpenAPI file to parse and use the mappings.</param>
+        /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
+        /// <param name="settings">Additional settings</param>
+        [PublicAPI]
+        public static IWireMockServer WithMappingFromOpenApiFile(this IWireMockServer server, string path, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic)
+        {
+            Guard.NotNull(server, nameof(server));
+            Guard.NotNullOrEmpty(path, nameof(path));
 
-            var mappings = new WireMockOpenApiParser().FromFile(path, out diagnostic);
+            var mappings = new WireMockOpenApiParser().FromFile(path, settings, out diagnostic);
 
             return server.WithMapping(mappings.ToArray());
         }
@@ -37,9 +52,27 @@ public static IWireMockServer WithMappingFromOpenApiFile(this IWireMockServer se
         /// <param name="server">The WireMockServer instance</param>
         /// <param name="stream">Stream containing OpenAPI description to parse and use the mappings.</param>
         /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
+        [PublicAPI]
         public static IWireMockServer WithMappingFromOpenApiStream(this IWireMockServer server, Stream stream, out OpenApiDiagnostic diagnostic)
         {
-            var mappings = new WireMockOpenApiParser().FromStream(stream, out diagnostic);
+            return WithMappingFromOpenApiStream(server, stream, null, out diagnostic);
+        }
+
+        /// <summary>
+        /// Register the mappings via an OpenAPI (swagger) V2 or V3 stream.
+        /// </summary>
+        /// <param name="server">The WireMockServer instance</param>
+        /// <param name="stream">Stream containing OpenAPI description to parse and use the mappings.</param>
+        /// <param name="settings">Additional settings</param>
+        /// <param name="diagnostic">Returns diagnostic object containing errors detected during parsing</param>
+        [PublicAPI]
+        public static IWireMockServer WithMappingFromOpenApiStream(this IWireMockServer server, Stream stream, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic)
+        {
+            Guard.NotNull(server, nameof(server));
+            Guard.NotNull(stream, nameof(stream));
+            Guard.NotNull(settings, nameof(settings));
+
+            var mappings = new WireMockOpenApiParser().FromStream(stream, settings, out diagnostic);
 
             return server.WithMapping(mappings.ToArray());
         }
@@ -49,9 +82,14 @@ public static IWireMockServer WithMappingFromOpenApiStream(this IWireMockServer
         /// </summary>
         /// <param name="server">The WireMockServer instance</param>
         /// <param name="document">The OpenAPI document to use as mappings.</param>
-        public static IWireMockServer WithMappingFromOpenApiDocument(this IWireMockServer server, OpenApiDocument document)
+        /// <param name="settings">Additional settings [optional]</param>
+        [PublicAPI]
+        public static IWireMockServer WithMappingFromOpenApiDocument(this IWireMockServer server, OpenApiDocument document, WireMockOpenApiParserSettings settings = null)
         {
-            var mappings = new WireMockOpenApiParser().FromDocument(document);
+            Guard.NotNull(server, nameof(server));
+            Guard.NotNull(document, nameof(document));
+
+            var mappings = new WireMockOpenApiParser().FromDocument(document, settings);
 
             return server.WithMapping(mappings.ToArray());
         }

diff --git a/src/WireMock.Net.OpenApiParser/IWireMockOpenApiParser.cs b/src/WireMock.Net.OpenApiParser/IWireMockOpenApiParser.cs
@@ -1,37 +1,57 @@
-using System.Collections.Generic;
-using System.IO;
-using Microsoft.OpenApi.Models;
-using Microsoft.OpenApi.Readers;
-using WireMock.Admin.Mappings;
-
-namespace WireMock.Net.OpenApiParser
-{
-    /// <summary>
-    /// Parse a OpenApi/Swagger/V2/V3 or Raml to WireMock MappingModels.
-    /// </summary>
-    public interface IWireMockOpenApiParser
-    {
+using System.Collections.Generic;
+using System.IO;
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers;
+using WireMock.Admin.Mappings;
+using WireMock.Net.OpenApiParser.Settings;
+
+namespace WireMock.Net.OpenApiParser
+{
+    /// <summary>
+    /// Parse a OpenApi/Swagger/V2/V3 or Raml to WireMock MappingModels.
+    /// </summary>
+    public interface IWireMockOpenApiParser
+    {
+        /// <summary>
+        /// Generate <see cref="IEnumerable{MappingModel}"/> from a file-path.
+        /// </summary>
+        /// <param name="path">The path to read the OpenApi/Swagger/V2/V3 or Raml file.</param>
+        /// <param name="diagnostic">OpenApiDiagnostic output</param>
+        /// <returns>MappingModel</returns>
+        IEnumerable<MappingModel> FromFile(string path, out OpenApiDiagnostic diagnostic);
+
+        /// <summary>
+        /// Generate <see cref="IEnumerable{MappingModel}"/> from a file-path.
+        /// </summary>
+        /// <param name="path">The path to read the OpenApi/Swagger/V2/V3 or Raml file.</param>
+        /// <param name="settings">Additional settings</param>
+        /// <param name="diagnostic">OpenApiDiagnostic output</param>
+        /// <returns>MappingModel</returns>
+        IEnumerable<MappingModel> FromFile(string path, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic);
+
         /// <summary>
         /// Generate <see cref="IEnumerable{MappingModel}"/> from an <seealso cref="OpenApiDocument"/>.
         /// </summary>
         /// <param name="document">The source OpenApiDocument</param>
-        /// <returns>MappingModel</returns>
-        IEnumerable<MappingModel> FromDocument(OpenApiDocument document);
-
+        /// <param name="settings">Additional settings [optional]</param>
+        /// <returns>MappingModel</returns>
+        IEnumerable<MappingModel> FromDocument(OpenApiDocument document, WireMockOpenApiParserSettings settings = null);
+
         /// <summary>
         /// Generate <see cref="IEnumerable{MappingModel}"/> from a <seealso cref="Stream"/>.
         /// </summary>
         /// <param name="stream">The source stream</param>
         /// <param name="diagnostic">OpenApiDiagnostic output</param>
-        /// <returns>MappingModel</returns>
-        IEnumerable<MappingModel> FromStream(Stream stream, out OpenApiDiagnostic diagnostic);
-
+        /// <returns>MappingModel</returns>
+        IEnumerable<MappingModel> FromStream(Stream stream, out OpenApiDiagnostic diagnostic);
+
         /// <summary>
-        /// Generate <see cref="IEnumerable{MappingModel}"/> from a file-path.
+        /// Generate <see cref="IEnumerable{MappingModel}"/> from a <seealso cref="Stream"/>.
         /// </summary>
-        /// <param name="path">The path to read the OpenApi/Swagger/V2/V3 or Raml file.</param>
+        /// <param name="stream">The source stream</param>
+        /// <param name="settings">Additional settings</param>
         /// <param name="diagnostic">OpenApiDiagnostic output</param>
-        /// <returns>MappingModel</returns>
-        IEnumerable<MappingModel> FromFile(string path, out OpenApiDiagnostic diagnostic);
-    }
+        /// <returns>MappingModel</returns>
+        IEnumerable<MappingModel> FromStream(Stream stream, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic);
+    }
 }