Provide open api schema to dynamic examples generator so you can generate accurate data (#706)

* Provide open api schema to dynamic examples generator so you can generate accurate data using settings like max-length in case of a string

* Rename Schema Property and add a dynamic examples generator with properties from settings like max-length

* Remove blank lines

* Add virtual to all public method in WireMockOpenApiParserExampleValues and ireMockOpenApiParserDynamicExampleValues to extend and overrides examples values

examples/WireMock.Net.OpenApiParser.ConsoleApp/DynamicDataGeneration.cs

@@ -0,0 +1,26 @@
+using System;
+using Microsoft.OpenApi.Models;
+using RandomDataGenerator.FieldOptions;
+using RandomDataGenerator.Randomizers;
+using WireMock.Net.OpenApiParser.Settings;
+
+namespace WireMock.Net.OpenApiParser.ConsoleApp
+{
+    public class DynamicDataGeneration : WireMockOpenApiParserDynamicExampleValues
+    {
+        public override string String
+        {
+            get
+            {
+                //Since you have your Schema, you can get if max-lenght is set. You can generate accurate examples with this settings
+                var maxLength = this.Schema.MaxLength ?? 9;
+
+                return RandomizerFactory.GetRandomizer(new FieldOptionsTextRegex
+                {
+                    Pattern = $"[0-9A-Z]{{{maxLength}}}"
+                }).Generate() ?? "example-string";
+            }
+            set { }
+        }
+    }
+}

examples/WireMock.Net.OpenApiParser.ConsoleApp/OpenApiFiles/Swagger_Customer_V2.0.json

@@ -0,0 +1,73 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "customer",
+        "description": "It contains basic customer actions.",
+        "version": "v1"
+    },
+    "host": "localhost",
+    "basePath": "/v1/customer/",
+    "schemes": [
+        "https"
+    ],
+    "paths": {
+        "/": {
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "name": "Correlation-Id",
+                        "required": true,
+                        "in": "header",
+                        "type": "string",
+                        "maxLength": 3
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "",
+                        "x-amf-mediaType": "application/json",
+                        "schema": {
+                            "$ref": "#/definitions/ResponseCustmer"
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "ResponseCustmer": {
+
+            "type": "object",
+            "additionalProperties": true,
+            "required": [
+                "first-name",
+                "last-name",
+                "status",
+                "interest"
+            ],
+            "properties": {
+                "first-name": {
+                    "type": "string"
+                },
+                "last-name": {
+                    "type": "string"
+                },
+                "status": {
+                    "type": "string",
+                    "maxLength": 2
+                },
+                "interest": {
+                    "type": "string",
+                    "maxLength": 45
+                }
+            }
+        }
+    }
+}
+

examples/WireMock.Net.OpenApiParser.ConsoleApp/Program.cs

@@ -1,41 +1,59 @@
 using System;
 using System.IO;
-
+using Microsoft.OpenApi.Readers;
+using Newtonsoft.Json;
+
 namespace WireMock.Net.OpenApiParser.ConsoleApp
 {
     class Program
     {
         private const string Folder = "OpenApiFiles";
         static void Main(string[] args)
-        {
+        {
-            var serverOpenAPIExamples = Run.RunServer(Path.Combine(Folder, "openAPIExamples.yaml"), "https://localhost:9091/");
+            //RunOthersOpenApiParserExample();
-            var serverPetstore_V2_json = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V2.0.json"), "https://localhost:9092/");
+
-            var serverPetstore_V2_yaml = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V2.0.yaml"), "https://localhost:9093/");
+            RunMockServerWithDynamicExampleGeneration();
-            var serverPetstore_V300_yaml = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V3.0.0.yaml"), "https://localhost:9094/");
-            var serverPetstore_V302_json = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V3.0.2.json"), "https://localhost:9095/");
-
-            Console.WriteLine("Press any key to stop the servers");
-            Console.ReadKey();
-
-            serverOpenAPIExamples.Stop();
-            serverPetstore_V2_json.Stop();
-            serverPetstore_V2_yaml.Stop();
-            serverPetstore_V300_yaml.Stop();
-            serverPetstore_V302_json.Stop();
-
-            //IWireMockOpenApiParser parser = new WireMockOpenApiParser();
-
-            //var petStoreModels = parser.FromStream(File.OpenRead("petstore-openapi3.json"), out OpenApiDiagnostic diagnostic1);
-            //string petStoreJson = JsonConvert.SerializeObject(petStoreModels, Settings);
-            // File.WriteAllText("../../../wiremock-petstore-openapi3.json", petStoreJson);
-
-            //Run.RunServer(petStoreModels);
-
-            //var mappingModels2 = parser.FromStream(File.OpenRead("infura.yaml"), out OpenApiDiagnostic diagnostic2);
-            //Console.WriteLine(JsonConvert.SerializeObject(diagnostic2, Settings));
-
-            //string json2 = JsonConvert.SerializeObject(mappingModels2, Settings);
-            //Console.WriteLine(json2);
         }
+
+        private static void RunMockServerWithDynamicExampleGeneration() {
+            //Run your mocking framework specifieing youur Example Values generator class.
+            var serverCustomer_V2_json = Run.RunServer(Path.Combine(Folder, "Swagger_Customer_V2.0.json"), "http://localhost:8090/", true, new DynamicDataGeneration(), Types.ExampleValueType.Value, Types.ExampleValueType.Value);
+            Console.WriteLine("Press any key to stop the servers");
+
+            Console.ReadKey();
+            serverCustomer_V2_json.Stop();
+        }
+
+        private static void RunOthersOpenApiParserExample()
+        {
+            var serverOpenAPIExamples = Run.RunServer(Path.Combine(Folder, "openAPIExamples.yaml"), "https://localhost:9091/");
+            var serverPetstore_V2_json = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V2.0.json"), "https://localhost:9092/");
+            var serverPetstore_V2_yaml = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V2.0.yaml"), "https://localhost:9093/");
+            var serverPetstore_V300_yaml = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V3.0.0.yaml"), "https://localhost:9094/");
+            var serverPetstore_V302_json = Run.RunServer(Path.Combine(Folder, "Swagger_Petstore_V3.0.2.json"), "https://localhost:9095/");
+
+            Console.WriteLine("Press any key to stop the servers");
+            Console.ReadKey();
+
+            serverOpenAPIExamples.Stop();
+            serverPetstore_V2_json.Stop();
+            serverPetstore_V2_yaml.Stop();
+            serverPetstore_V300_yaml.Stop();
+            serverPetstore_V302_json.Stop();
+
+            //IWireMockOpenApiParser parser = new WireMockOpenApiParser();
+
+            //var petStoreModels = parser.FromStream(File.OpenRead("petstore-openapi3.json"), out OpenApiDiagnostic diagnostic1);
+            //string petStoreJson = JsonConvert.SerializeObject(petStoreModels, Settings);
+            // File.WriteAllText("../../../wiremock-petstore-openapi3.json", petStoreJson);
+
+            //Run.RunServer(petStoreModels);
+
+            //var mappingModels2 = parser.FromStream(File.OpenRead("infura.yaml"), out OpenApiDiagnostic diagnostic2);
+            //Console.WriteLine(JsonConvert.SerializeObject(diagnostic2, Settings));
+
+            //string json2 = JsonConvert.SerializeObject(mappingModels2, Settings);
+            //Console.WriteLine(json2);
+        }
     }
 }

examples/WireMock.Net.OpenApiParser.ConsoleApp/Run.cs

@@ -13,28 +13,30 @@ namespace WireMock.Net.OpenApiParser.ConsoleApp
 {
     public static class Run
     {
-        public static WireMockServer RunServer(string path, string url, bool dynamicExamples = true)
+        public static WireMockServer RunServer(string path, string url, bool dynamicExamples = true, IWireMockOpenApiParserExampleValues examplesValuesGenerator =  null, ExampleValueType pathPatternToUse = ExampleValueType.Wildcard, ExampleValueType headerPatternToUse = ExampleValueType.Wildcard)
         {
             var server = WireMockServer.Start(new WireMockServerSettings
             {
                 AllowCSharpCodeMatcher = true,
                 Urls = new[] { url },
                 StartAdminInterface = true,
-                ReadStaticMappings = false,
+                ReadStaticMappings = true,
                 WatchStaticMappings = false,
                 WatchStaticMappingsInSubdirectories = false,
                 Logger = new WireMockConsoleLogger(),
                 SaveUnmatchedRequests = true
             });
+
             Console.WriteLine("WireMockServer listening at {0}", string.Join(",", server.Urls));
 
-            server.SetBasicAuthentication("a", "b");
+            //server.SetBasicAuthentication("a", "b");
 
             var settings = new WireMockOpenApiParserSettings
             {
                 DynamicExamples = dynamicExamples,
-                PathPatternToUse = ExampleValueType.Wildcard,
+                ExampleValues = examplesValuesGenerator,
-                HeaderPatternToUse = ExampleValueType.Wildcard
+                PathPatternToUse = pathPatternToUse,
+                HeaderPatternToUse = headerPatternToUse,
             };
 
             server.WithMappingFromOpenApiFile(path, settings, out var diag);

examples/WireMock.Net.OpenApiParser.ConsoleApp/WireMock.Net.OpenApiParser.ConsoleApp.csproj

@@ -36,6 +36,9 @@
     <None Update="petstore.yml">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="OpenApiFiles\Swagger_Customer_V2.0.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
 </Project>

src/WireMock.Net.OpenApiParser/Settings/IWireMockOpenApiParserExampleValues.cs

@@ -1,5 +1,6 @@
 using System;
-
+using Microsoft.OpenApi.Models;
+
 namespace WireMock.Net.OpenApiParser.Settings
 {
     /// <summary>
@@ -48,5 +49,10 @@ namespace WireMock.Net.OpenApiParser.Settings
         /// An example value for a String.
         /// </summary>
         string String { get; set; }
+
+        /// <summary>
+        /// OpenApi Schema to generate dynamic examples more accurate
+        /// </summary>
+        OpenApiSchema Schema { get; set; }
     }
 }

src/WireMock.Net.OpenApiParser/Settings/WireMockOpenApiParserDynamicExampleValues.cs

@@ -1,4 +1,5 @@
 using System;
+using Microsoft.OpenApi.Models;
 using RandomDataGenerator.FieldOptions;
 using RandomDataGenerator.Randomizers;
 
@@ -10,22 +11,24 @@ namespace WireMock.Net.OpenApiParser.Settings
     public class WireMockOpenApiParserDynamicExampleValues : IWireMockOpenApiParserExampleValues
     {
         /// <inheritdoc />
-        public bool Boolean { get { return RandomizerFactory.GetRandomizer(new FieldOptionsBoolean()).Generate() ?? true; } set { } }
+        public virtual bool Boolean { get { return RandomizerFactory.GetRandomizer(new FieldOptionsBoolean()).Generate() ?? true; } set { } }
         /// <inheritdoc />
-        public int Integer { get { return RandomizerFactory.GetRandomizer(new FieldOptionsInteger()).Generate() ?? 42; } set { } }
+        public virtual int Integer { get { return RandomizerFactory.GetRandomizer(new FieldOptionsInteger()).Generate() ?? 42; } set { } }
         /// <inheritdoc />
-        public float Float { get { return RandomizerFactory.GetRandomizer(new FieldOptionsFloat()).Generate() ?? 4.2f; } set { } }
+        public virtual float Float { get { return RandomizerFactory.GetRandomizer(new FieldOptionsFloat()).Generate() ?? 4.2f; } set { } }
         /// <inheritdoc />
-        public double Double { get { return RandomizerFactory.GetRandomizer(new FieldOptionsDouble()).Generate() ?? 4.2d; } set { } }
+        public virtual double Double { get { return RandomizerFactory.GetRandomizer(new FieldOptionsDouble()).Generate() ?? 4.2d; } set { } }
         /// <inheritdoc />
-        public Func<DateTime> Date { get { return () => RandomizerFactory.GetRandomizer(new FieldOptionsDateTime()).Generate() ?? System.DateTime.UtcNow.Date; } set { } }
+        public virtual Func<DateTime> Date { get { return () => RandomizerFactory.GetRandomizer(new FieldOptionsDateTime()).Generate() ?? System.DateTime.UtcNow.Date; } set { } }
         /// <inheritdoc />
-        public Func<DateTime> DateTime { get { return () => RandomizerFactory.GetRandomizer(new FieldOptionsDateTime()).Generate() ?? System.DateTime.UtcNow; } set { } }
+        public virtual Func<DateTime> DateTime { get { return () => RandomizerFactory.GetRandomizer(new FieldOptionsDateTime()).Generate() ?? System.DateTime.UtcNow; } set { } }
         /// <inheritdoc />
-        public byte[] Bytes { get { return RandomizerFactory.GetRandomizer(new FieldOptionsBytes()).Generate(); } set { } }
+        public virtual byte[] Bytes { get { return RandomizerFactory.GetRandomizer(new FieldOptionsBytes()).Generate(); } set { } }
         /// <inheritdoc />
-        public object Object { get; set; } = "example-object";
+        public virtual object Object { get; set; } = "example-object";
         /// <inheritdoc />
-        public string String { get { return RandomizerFactory.GetRandomizer(new FieldOptionsTextRegex { Pattern = @"^[0-9]{2}[A-Z]{5}[0-9]{2}" }).Generate() ?? "example-string"; } set { } }
+        public virtual string String { get { return RandomizerFactory.GetRandomizer(new FieldOptionsTextRegex { Pattern = @"^[0-9]{2}[A-Z]{5}[0-9]{2}" }).Generate() ?? "example-string"; } set { } }
+        /// <inheritdoc />
+        public virtual OpenApiSchema Schema { get; set; }
     }
 }

src/WireMock.Net.OpenApiParser/Settings/WireMockOpenApiParserExampleValues.cs

@@ -1,5 +1,6 @@
 using System;
-
+using Microsoft.OpenApi.Models;
+
 namespace WireMock.Net.OpenApiParser.Settings
 {
     /// <summary>
@@ -8,22 +9,24 @@ namespace WireMock.Net.OpenApiParser.Settings
     public class WireMockOpenApiParserExampleValues : IWireMockOpenApiParserExampleValues
     {
         /// <inheritdoc />
-        public bool Boolean { get; set; } = true;
+        public virtual bool Boolean { get; set; } = true;
         /// <inheritdoc />
-        public int Integer { get; set; } = 42;
+        public virtual int Integer { get; set; } = 42;
         /// <inheritdoc />
-        public float Float { get; set; } = 4.2f;
+        public virtual float Float { get; set; } = 4.2f;
         /// <inheritdoc />
-        public double Double { get; set; } = 4.2d;
+        public virtual double Double { get; set; } = 4.2d;
         /// <inheritdoc />
-        public Func<DateTime> Date { get; set; } = () => System.DateTime.UtcNow.Date;
+        public virtual Func<DateTime> Date { get; set; } = () => System.DateTime.UtcNow.Date;
         /// <inheritdoc />
-        public Func<DateTime> DateTime { get; set; } = () => System.DateTime.UtcNow;
+        public virtual Func<DateTime> DateTime { get; set; } = () => System.DateTime.UtcNow;
         /// <inheritdoc />
-        public byte[] Bytes { get; set; } = { 48, 49, 50 };
+        public virtual byte[] Bytes { get; set; } = { 48, 49, 50 };
         /// <inheritdoc />
-        public object Object { get; set; } = "example-object";
+        public virtual object Object { get; set; } = "example-object";
         /// <inheritdoc />
-        public string String { get; set; } = "example-string";
+        public virtual string String { get; set; } = "example-string";
+        /// <inheritdoc />
+        public virtual OpenApiSchema Schema { get; set; } = new OpenApiSchema();
     }
 }

src/WireMock.Net.OpenApiParser/Utils/ExampleValueGenerator.cs

@@ -36,6 +36,8 @@ namespace WireMock.Net.OpenApiParser.Utils
             var schemaExample = schema?.Example;
             var schemaEnum = GetRandomEnumValue(schema?.Enum);
 
+            _settings.ExampleValues.Schema = schema;
+
             switch (schema?.GetSchemaType())
             {
                 case SchemaType.Boolean: