Merge pull request #176 from Microsoft/dm/validatedextensions

Validation for custom extensions

Author: darrelmiller

.vscode/tasks.json

@@ -0,0 +1,27 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "type": "shell",
+            "command": "msbuild",
+            "args": [
+                "/property:GenerateFullPaths=true",
+                "/t:build"
+            ],
+            "group": "build",
+            "presentation": {
+                "reveal": "silent"
+            },
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "workbench",
+            "type": "shell",
+            "command": "src/Microsoft.OpenApi.WorkBench/bin/Debug/Microsoft.OpenApi.WorkBench.exe",
+            "problemMatcher": []
+        }
+    ]
+}

src/Microsoft.OpenApi.Readers/OpenApiReaderSettings.cs

@@ -0,0 +1,29 @@
+using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Interfaces;
+using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Validations;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.OpenApi.Readers
+{
+    /// <summary>
+    /// Configuration settings to control how OpenAPI documents are parsed
+    /// </summary>
+    public class OpenApiReaderSettings
+    {
+        /// <summary>
+        /// Dictionary of parsers for converting extensions into strongly typed classes
+        /// </summary>
+        public Dictionary<string, Func<IOpenApiAny , IOpenApiExtension>> ExtensionParsers { get; set; } = new Dictionary<string, Func<IOpenApiAny, IOpenApiExtension>>();
+
+        /// <summary>
+        /// Rules to use for validating OpenAPI specification.  If none are provided a default set of rules are applied.
+        /// </summary>
+        public ValidationRuleSet RuleSet { get; set; }
+
+    }
+}

src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

@@ -3,8 +3,11 @@
 
 using System.IO;
 using System.Linq;
+using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.Interface;
+using Microsoft.OpenApi.Services;
+using Microsoft.OpenApi.Validations;
 using SharpYaml;
 using SharpYaml.Serialization;
 
@@ -15,7 +18,17 @@ namespace Microsoft.OpenApi.Readers
     /// </summary>
     public class OpenApiStreamReader : IOpenApiReader<Stream, OpenApiDiagnostic>
     {
+        private OpenApiReaderSettings _settings;
 
+        /// <summary>
+        /// Create stream reader with custom settings if desired.
+        /// </summary>
+        /// <param name="settings"></param>
+        public OpenApiStreamReader(OpenApiReaderSettings settings = null)
+        {
+            _settings = settings ?? new OpenApiReaderSettings();
+
+        }
         /// <summary>
         /// Reads the stream input and parses it into an Open API document.
         /// </summary>
@@ -28,6 +41,7 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
             YamlDocument yamlDocument;
             diagnostic = new OpenApiDiagnostic();
 
+            // Parse the YAML/JSON
             try
             {
                 yamlDocument = LoadYamlDocument(input);
@@ -38,8 +52,22 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
                 return new OpenApiDocument();
             }
 
-            context = new ParsingContext();
-            return context.Parse(yamlDocument, diagnostic);
+            context = new ParsingContext
+            {
+                ExtensionParsers = _settings.ExtensionParsers
+            };
+
+            // Parse the OpenAPI Document
+            var document = context.Parse(yamlDocument, diagnostic);
+
+            // Validate the document
+            var errors = document.Validate(_settings.RuleSet);
+            foreach (var item in errors)
+            {
+                diagnostic.Errors.Add(new OpenApiError(item.ErrorPath, item.ErrorMessage));
+            } 
+
+            return document;
         }
 
         /// <summary>

src/Microsoft.OpenApi.Readers/OpenApiStringReader.cs

@@ -12,6 +12,17 @@ namespace Microsoft.OpenApi.Readers
     /// </summary>
     public class OpenApiStringReader : IOpenApiReader<string, OpenApiDiagnostic>
     {
+        private readonly OpenApiReaderSettings _settings;
+
+        /// <summary>
+        /// Constructor tha allows reader to use non-default settings
+        /// </summary>
+        /// <param name="settings"></param>
+        public OpenApiStringReader(OpenApiReaderSettings settings = null)
+        {
+            _settings = settings ?? new OpenApiReaderSettings(); 
+        }
+
         /// <summary>
         /// Reads the string input and parses it into an Open API document.
         /// </summary>
@@ -24,7 +35,7 @@ public OpenApiDocument Read(string input, out OpenApiDiagnostic diagnostic)
                 writer.Flush();
                 memoryStream.Position = 0;
 
-                return new OpenApiStreamReader().Read(memoryStream, out diagnostic);
+                return new OpenApiStreamReader(_settings).Read(memoryStream, out diagnostic);
             }
         }
     }

src/Microsoft.OpenApi.Readers/ParsingContext.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.Exceptions;
@@ -24,6 +25,9 @@ public class ParsingContext
         private readonly Dictionary<string, IOpenApiReferenceable> _referenceStore = new Dictionary<string, IOpenApiReferenceable>();
         private readonly Dictionary<string, object> _tempStorage = new Dictionary<string, object>();
         private IOpenApiVersionService _versionService;
+
+        internal Dictionary<string, Func<IOpenApiAny, IOpenApiExtension>> ExtensionParsers { get; set; }  = new Dictionary<string, Func<IOpenApiAny, IOpenApiExtension>>();
+
         internal RootNode RootNode { get; set; }
         internal List<OpenApiTag> Tags { get; private set; } = new List<OpenApiTag>();
 
@@ -63,6 +67,7 @@ internal OpenApiDocument Parse(YamlDocument yamlDocument, OpenApiDiagnostic diag
             return doc;
         }
 
+
         /// <summary>
         /// Gets the version of the Open API document.
         /// </summary>

src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs

@@ -125,11 +125,8 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
 
             var openApiNode = rootNode.GetMap();
 
-            var required = new List<string> {"info", "swagger", "paths"};
+            ParseMap(openApiNode, openApidoc, _openApiFixedFields, _openApiPatternFields);
 
-            ParseMap(openApiNode, openApidoc, _openApiFixedFields, _openApiPatternFields, required);
-
-            ReportMissing(openApiNode, required);
 
             // Post Process OpenApi Object
             if (openApidoc.Servers == null)

src/Microsoft.OpenApi.Readers/V2/OpenApiInfoDeserializer.cs

@@ -65,11 +65,8 @@ public static OpenApiInfo LoadInfo(ParseNode node)
             var mapNode = node.CheckMapNode("Info");
 
             var info = new OpenApiInfo();
-            var required = new List<string> {"title", "version"};
 
-            ParseMap(mapNode, info, _infoFixedFields, _infoPatternFields, required);
-
-            ReportMissing(node, required);
+            ParseMap(mapNode, info, _infoFixedFields, _infoPatternFields);
 
             return info;
         }

src/Microsoft.OpenApi.Readers/V2/OpenApiV2Deserializer.cs

@@ -32,17 +32,6 @@ private static void ParseMap<T>(
             }
         }
 
-        private static void ReportMissing(ParseNode node, IList<string> required)
-        {
-            foreach (var error in required.Select(
-                    r => new OpenApiError(
-                        node.Context.GetLocation(),
-                        $"{r} is a required property"))
-                .ToList())
-            {
-                node.Diagnostic.Errors.Add(error);
-            }
-        }
 
         private static string LoadString(ParseNode node)
         {

src/Microsoft.OpenApi.Readers/V3/OpenApiDocumentDeserializer.cs

@@ -2,7 +2,9 @@
 // Licensed under the MIT license. 
 
 using System.Collections.Generic;
+using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Extensions;
+using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
 
@@ -42,13 +44,21 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
 
             var openApiNode = rootNode.GetMap();
 
-            var required = new List<string> {"info", "openapi", "paths"};
+            ParseMap(openApiNode, openApidoc, _openApiFixedFields, _openApiPatternFields);
 
-            ParseMap(openApiNode, openApidoc, _openApiFixedFields, _openApiPatternFields, required);
+            return openApidoc;
+        }
 
-            ReportMissing(openApiNode, required);
 
-            return openApidoc;
+        public static IOpenApiExtension LoadExtension(string name, ParseNode node)
+        {
+            if (node.Context.ExtensionParsers.TryGetValue(name, out var parser)) {
+                return parser(node.CreateAny());
+            }
+            else
+            {
+                return node.CreateAny();
+            }
         }
     }
 }

src/Microsoft.OpenApi.Readers/V3/OpenApiInfoDeserializer.cs

@@ -57,7 +57,7 @@ internal static partial class OpenApiV3Deserializer
 
         public static PatternFieldMap<OpenApiInfo> InfoPatternFields = new PatternFieldMap<OpenApiInfo>
         {
-            {s => s.StartsWith("x-"), (o, k, n) => o.AddExtension(k, n.CreateAny())}
+            {s => s.StartsWith("x-"), (o, k, n) => o.Extensions.Add(k,LoadExtension(k, n))}
         };
 
         public static OpenApiInfo LoadInfo(ParseNode node)
@@ -67,7 +67,7 @@ public static OpenApiInfo LoadInfo(ParseNode node)
             var info = new OpenApiInfo();
             var required = new List<string> {"title", "version"};
 
-            ParseMap(mapNode, info, InfoFixedFields, InfoPatternFields, required);
+            ParseMap(mapNode, info, InfoFixedFields, InfoPatternFields);
 
             return info;
         }