Use rules to validate required properties instead of reader

Author: darrelmiller

src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

@@ -5,6 +5,8 @@
 using System.Linq;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.Interface;
+using Microsoft.OpenApi.Services;
+using Microsoft.OpenApi.Validations;
 using SharpYaml;
 using SharpYaml.Serialization;
 
@@ -28,6 +30,7 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
             YamlDocument yamlDocument;
             diagnostic = new OpenApiDiagnostic();
 
+            // Parse the YAML/JSON
             try
             {
                 yamlDocument = LoadYamlDocument(input);
@@ -38,8 +41,20 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
                 return new OpenApiDocument();
             }
 
+            // Parse the OpenAPI Document
             context = new ParsingContext();
-            return context.Parse(yamlDocument, diagnostic);
+            var document = context.Parse(yamlDocument, diagnostic);
+
+            // Validate the document
+            var openApiValidator = new OpenApiValidator();
+            var walker = new OpenApiWalker(openApiValidator);
+            walker.Walk(document);
+            foreach (var item in openApiValidator.Errors)
+            {
+                diagnostic.Errors.Add(new OpenApiError(item.ErrorPath, item.ErrorMessage));
+            } 
+
+            return document;
         }
 
         /// <summary>

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

@@ -46,7 +46,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
 
             ParseMap(openApiNode, openApidoc, _openApiFixedFields, _openApiPatternFields, required);
 
-            ReportMissing(openApiNode, required);
+            //ReportMissing(openApiNode, required);
 
             return openApidoc;
         }

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

@@ -33,7 +33,7 @@ private static void ParseMap<T>(
                 requiredFields?.Remove(propertyNode.Name);
             }
 
-            ReportMissing(mapNode, requiredFields);
+            //ReportMissing(mapNode, requiredFields);
         }
 
         private static RuntimeExpression LoadRuntimeExpression(ParseNode node)

src/Microsoft.OpenApi/Extensions/OpenApiElementExtensions.cs

@@ -20,7 +20,7 @@ public static class OpenApiElementExtensions
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="element"></param>
-        /// <returns></returns>
+        /// <returns>An IEnumerable of errors.  This function will never return null.</returns>
         public static IEnumerable<ValidationError> Validate(this IOpenApiElement element)         {
             var validator = new OpenApiValidator();
             var walker = new OpenApiWalker(validator);

src/Microsoft.OpenApi/Validations/OpenApiValidator.cs

@@ -29,6 +29,16 @@ public OpenApiValidator(ValidationRuleSet ruleSet = null)
             _context = new ValidationContext(_ruleSet);
         }
 
+        /// <summary>
+        /// Create a vistor that will validate an OpenAPIDocument using an existing ValidationContext
+        /// </summary>
+        /// <param name="context">Existing validation context</param>
+        public OpenApiValidator(ValidationContext context)
+        {
+            _ruleSet = context.RuleSet;
+            _context = new ValidationContext(_ruleSet);
+        }
+
         /// <summary>
         /// Execute validation rules against an <see cref="OpenApiDocument"/>
         /// </summary>

src/Microsoft.OpenApi/Validations/Rules/OpenApiInfoRules.cs

@@ -20,12 +20,14 @@ internal static class OpenApiInfoRules
             new ValidationRule<OpenApiInfo>(
                 (context, item) =>
                 {
+                    context.Push("info");
+
                     // title
                     context.Push("title");
                     if (String.IsNullOrEmpty(item.Title))
                     {
                         ValidationError error = new ValidationError(ErrorReason.Required, context.PathString,
-                            String.Format(SRResource.Validation_FieldIsRequired, "url", "info"));
+                            String.Format(SRResource.Validation_FieldIsRequired, "title", "info"));
                         context.AddError(error);
                     }
                     context.Pop();
@@ -39,6 +41,8 @@ internal static class OpenApiInfoRules
                         context.AddError(error);
                     }
                     context.Pop();
+
+                    context.Pop();
                 });
 
         // add more rule.

src/Microsoft.OpenApi/Validations/ValidationContext.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using Microsoft.OpenApi.Validations.Rules;
 
 namespace Microsoft.OpenApi.Validations
@@ -70,7 +71,7 @@ internal string PathString
         {
             get
             {
-                return "#/" + String.Join("/", _path);
+                return "#/" + String.Join("/", _path.Reverse());
             }
         }
         #endregion

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs

@@ -105,7 +105,7 @@ public void ParseBrokenMinimalDocumentShouldYieldExpectedDiagnostic()
                     {
                         Errors =
                         {
-                            new OpenApiError("#/info", "title is a required property")
+                            new OpenApiError("#/info/title", "The field 'title' in 'info' object is REQUIRED.")
                         }
                     });
             }

test/Microsoft.OpenApi.Tests/Validations/OpenApiInfoValidationTests.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Properties;
 using Microsoft.OpenApi.Services;
@@ -17,19 +18,14 @@ public class OpenApiInfoValidationTests
         public void ValidateFieldIsRequiredInInfo()
         {
             // Arrange
-            string urlError = String.Format(SRResource.Validation_FieldIsRequired, "url", "info");
+            string urlError = String.Format(SRResource.Validation_FieldIsRequired, "title", "info");
             string versionError = String.Format(SRResource.Validation_FieldIsRequired, "version", "info");
-            IEnumerable<ValidationError> errors;
             OpenApiInfo info = new OpenApiInfo();
 
             // Act
-            var validator = new OpenApiValidator();
-            var walker = new OpenApiWalker(validator);
-            walker.Walk(info);
-
+            var errors = info.Validate();
 
             // Assert
-            errors = validator.Errors;
             bool result = !errors.Any();
 
             // Assert