Removed Error Reason

darrelmiller · darrelmiller · commit 2d9809891aa5 · 2018-04-04T11:06:17.000-04:00
diff --git a/src/Microsoft.OpenApi/Validations/OpenApiValidatorError.cs b/src/Microsoft.OpenApi/Validations/OpenApiValidatorError.cs
@@ -10,43 +10,11 @@
 
 namespace Microsoft.OpenApi.Validations
 {
-    /// <summary>
-    /// Error reason.
-    /// </summary>
-    public enum ErrorReason
-    {
-        /// <summary>
-        /// Field is required.
-        /// </summary>
-        Required,
-
-        /// <summary>
-        /// Format error.
-        /// </summary>
-        Format,
-
-        /// <summary>
-        /// Duplicate Key error.
-        /// </summary>
-        DuplicateKey
-
-    }
-
     /// <summary>
     /// Errors detected when validating a OpenAPI Element
     /// </summary>
     public class OpenApiValidatorError : OpenApiError
     {
-        /// <summary>
-        /// Initializes the <see cref="OpenApiError"/> class.
-        /// </summary>
-        public OpenApiValidatorError(ErrorReason reason, string pointer, string message) : base(pointer, message)
-        {
-            Pointer = pointer;
-            Message = message;
-            ReasonClass = reason;
-        }
-
         /// <summary>
         /// Initializes the <see cref="OpenApiError"/> class.
         /// </summary>
@@ -57,15 +25,9 @@ public OpenApiValidatorError(string ruleName, string pointer, string message) :
             RuleName = ruleName;
         }
 
-        /// <summary>
-        /// Classified Reason for the error.
-        /// </summary>
-        public ErrorReason ReasonClass { get; set; }
-
         /// <summary>
         /// Name of rule that detected the error.
         /// </summary>
         public string RuleName { get; set; }
-
     }
 }
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs
@@ -57,7 +57,7 @@ private static void ValidateKeys(IValidationContext context, IEnumerable<string>
             {
                 if (!KeyRegex.IsMatch(key))
                 {
-                    context.CreateError(nameof(KeyMustBeRegularExpression), ErrorReason.Format, 
+                    context.CreateError(nameof(KeyMustBeRegularExpression), 
                         string.Format(SRResource.Validation_ComponentsKeyMustMatchRegularExpr, key, component, KeyRegex.ToString()));
                 }
             }
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiContactRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiContactRules.cs
@@ -26,7 +26,7 @@ public static class OpenApiContactRules
                     {
                         if (!item.Email.IsEmailAddress())
                         {
-                            context.CreateError(nameof(EmailMustBeEmailFormat), ErrorReason.Format, 
+                            context.CreateError(nameof(EmailMustBeEmailFormat), 
                                 String.Format(SRResource.Validation_StringMustBeEmailAddress, item.Email));
                         }
                     }
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiDocumentRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiDocumentRules.cs
@@ -24,7 +24,7 @@ public static class OpenApiDocumentRules
                     context.Enter("info");
                     if (item.Info == null)
                     {
-                        context.CreateError(nameof(OpenApiDocumentFieldIsMissing),ErrorReason.Required, 
+                        context.CreateError(nameof(OpenApiDocumentFieldIsMissing),
                             String.Format(SRResource.Validation_FieldIsRequired, "info", "document"));
                     }
                     context.Exit();
@@ -33,7 +33,7 @@ public static class OpenApiDocumentRules
                     context.Enter("paths");
                     if (item.Paths == null)
                     {
-                        context.CreateError(nameof(OpenApiDocumentFieldIsMissing), ErrorReason.Required, 
+                        context.CreateError(nameof(OpenApiDocumentFieldIsMissing), 
                             String.Format(SRResource.Validation_FieldIsRequired, "paths", "document"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiExtensionRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiExtensionRules.cs
@@ -26,7 +26,7 @@ public static class OpenApiExtensibleRules
                     {
                         if (!extensible.Key.StartsWith("x-"))
                         {
-                            context.CreateError(nameof(ExtensionNameMustStartWithXDash),ErrorReason.Format, 
+                            context.CreateError(nameof(ExtensionNameMustStartWithXDash),
                                 String.Format(SRResource.Validation_ExtensionNameMustBeginWithXDash, extensible.Key, context.PathString));
                         }
                     }
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiExternalDocsRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiExternalDocsRules.cs
@@ -24,7 +24,7 @@ public static class OpenApiExternalDocsRules
                     context.Enter("url");
                     if (item.Url == null)
                     {
-                        context.CreateError(nameof(UrlIsRequired),ErrorReason.Required, 
+                        context.CreateError(nameof(UrlIsRequired),
                             String.Format(SRResource.Validation_FieldIsRequired, "url", "External Documentation"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiInfoRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiInfoRules.cs
@@ -25,7 +25,7 @@ public static class OpenApiInfoRules
                     context.Enter("title");
                     if (item.Title == null)
                     {
-                        context.CreateError(nameof(InfoRequiredFields),ErrorReason.Required, 
+                        context.CreateError(nameof(InfoRequiredFields),
                             String.Format(SRResource.Validation_FieldIsRequired, "title", "info"));
                     }
                     context.Exit();
@@ -34,7 +34,7 @@ public static class OpenApiInfoRules
                     context.Enter("version");
                     if (item.Version == null)
                     {
-                        context.CreateError(nameof(InfoRequiredFields), ErrorReason.Required, 
+                        context.CreateError(nameof(InfoRequiredFields), 
                             String.Format(SRResource.Validation_FieldIsRequired, "version", "info"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiLicenseRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiLicenseRules.cs
@@ -23,7 +23,7 @@ public static class OpenApiLicenseRules
                     context.Enter("name");
                     if (license.Name == null)
                     {
-                        context.CreateError(nameof(LicenseRequiredFields),ErrorReason.Required,
+                        context.CreateError(nameof(LicenseRequiredFields),
                             String.Format(SRResource.Validation_FieldIsRequired, "name", "license"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiOAuthFlowRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiOAuthFlowRules.cs
@@ -24,7 +24,7 @@ public static class OpenApiOAuthFlowRules
                     context.Enter("authorizationUrl");
                     if (flow.AuthorizationUrl == null)
                     {
-                        context.CreateError(nameof(OAuthFlowRequiredFields),ErrorReason.Required,
+                        context.CreateError(nameof(OAuthFlowRequiredFields),
                             String.Format(SRResource.Validation_FieldIsRequired, "authorizationUrl", "OAuth Flow"));
                     }
                     context.Exit();
@@ -33,7 +33,7 @@ public static class OpenApiOAuthFlowRules
                     context.Enter("tokenUrl");
                     if (flow.TokenUrl == null)
                     {
-                        context.CreateError(nameof(OAuthFlowRequiredFields), ErrorReason.Required,
+                        context.CreateError(nameof(OAuthFlowRequiredFields), 
                             String.Format(SRResource.Validation_FieldIsRequired, "tokenUrl", "OAuth Flow"));
                     }
                     context.Exit();
@@ -42,7 +42,7 @@ public static class OpenApiOAuthFlowRules
                     context.Enter("scopes");
                     if (flow.Scopes == null)
                     {
-                        context.CreateError(nameof(OAuthFlowRequiredFields), ErrorReason.Required,
+                        context.CreateError(nameof(OAuthFlowRequiredFields), 
                             String.Format(SRResource.Validation_FieldIsRequired, "scopes", "OAuth Flow"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiPathsRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiPathsRules.cs
@@ -26,7 +26,7 @@ public static class OpenApiPathsRules
 
                          if (pathName == null || !pathName.StartsWith("/"))
                         {
-                            context.CreateError(nameof(PathNameMustBeginWithSlash),ErrorReason.Format,
+                            context.CreateError(nameof(PathNameMustBeginWithSlash),
                                 string.Format(SRResource.Validation_PathItemMustBeginWithSlash, pathName));
                         }
 
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiResponseRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiResponseRules.cs
@@ -24,7 +24,7 @@ public static class OpenApiResponseRules
                     context.Enter("description");
                     if (response.Description == null)
                     {
-                        context.CreateError(nameof(ResponseRequiredFields),ErrorReason.Required,
+                        context.CreateError(nameof(ResponseRequiredFields),
                             String.Format(SRResource.Validation_FieldIsRequired, "description", "response"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiResponsesRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiResponsesRules.cs
@@ -22,7 +22,7 @@ public static class OpenApiResponsesRules
                 {
                     if (!responses.Keys.Any())
                     {
-                        context.CreateError(nameof(ResponsesMustContainAtLeastOneResponse),ErrorReason.Required,
+                        context.CreateError(nameof(ResponsesMustContainAtLeastOneResponse),
                                 "Responses must contain at least one response");
                     }
                 });
@@ -40,7 +40,7 @@ public static class OpenApiResponsesRules
 
                         if (key != "default" && !Regex.IsMatch(key, "^[1-5]([0-9][0-9]|XX)$"))
                         {
-                            context.CreateError(nameof(ResponsesMustBeIdentifiedByDefaultOrStatusCode), ErrorReason.Format, 
+                            context.CreateError(nameof(ResponsesMustBeIdentifiedByDefaultOrStatusCode), 
                                     
                                     "Responses key must be 'default', an HTTP status code, " +
                                     "or one of the following strings representing a range of HTTP status codes: " +
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiServerRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiServerRules.cs
@@ -23,7 +23,7 @@ public static class OpenApiServerRules
                     context.Enter("url");
                     if (server.Url == null)
                     {
-                        context.CreateError(nameof(ServerRequiredFields),ErrorReason.Required,
+                        context.CreateError(nameof(ServerRequiredFields),
                             String.Format(SRResource.Validation_FieldIsRequired, "url", "server"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/Rules/OpenApiTagRules.cs b/src/Microsoft.OpenApi/Validations/Rules/OpenApiTagRules.cs
@@ -23,7 +23,7 @@ public static class OpenApiTagRules
                     context.Enter("name");
                     if (tag.Name == null)
                     {
-                        context.CreateError(nameof(TagRequiredFields),ErrorReason.Required,
+                        context.CreateError(nameof(TagRequiredFields),
                             String.Format(SRResource.Validation_FieldIsRequired, "name", "tag"));
                     }
                     context.Exit();
diff --git a/src/Microsoft.OpenApi/Validations/ValidationExtensions.cs b/src/Microsoft.OpenApi/Validations/ValidationExtensions.cs
@@ -18,10 +18,9 @@ public static class ValidationContextExtensions
         /// <summary>
         /// Helper method to simplify validation rules
         /// </summary>
-        public static void CreateError(this IValidationContext context, string ruleName, ErrorReason reason, string message)
+        public static void CreateError(this IValidationContext context, string ruleName, string message)
         {
-            OpenApiValidatorError error = new OpenApiValidatorError(reason, context.PathString, message);
-            error.RuleName = ruleName;
+            OpenApiValidatorError error = new OpenApiValidatorError(ruleName, context.PathString, message);
             context.AddError(error);
         }
     }
diff --git a/test/Microsoft.OpenApi.Tests/Services/OpenApiValidatorTests.cs b/test/Microsoft.OpenApi.Tests/Services/OpenApiValidatorTests.cs
@@ -9,6 +9,7 @@
 using Microsoft.OpenApi.Properties;
 using Microsoft.OpenApi.Services;
 using Microsoft.OpenApi.Validations;
+using Microsoft.OpenApi.Validations.Rules;
 using Microsoft.OpenApi.Writers;
 using Xunit;
 using Xunit.Abstractions;
@@ -57,11 +58,8 @@ public void ResponseMustHaveADescription()
             validator.Errors.ShouldBeEquivalentTo(
                     new List<OpenApiError>
                     {
-                        new OpenApiValidatorError(ErrorReason.Required, "#/paths/~1test/get/responses/200/description",
+                        new OpenApiValidatorError(nameof(OpenApiResponseRules.ResponseRequiredFields),"#/paths/~1test/get/responses/200/description",
                             String.Format(SRResource.Validation_FieldIsRequired, "description", "response"))
-                        {
-                            RuleName = "ResponseRequiredFields"
-                        }
         });
         }
 
@@ -92,11 +90,8 @@ public void ServersShouldBeReferencedByIndex()
             validator.Errors.ShouldBeEquivalentTo(
                     new List<OpenApiError>
                     {
-                        new OpenApiValidatorError(ErrorReason.Required, "#/servers/1/url",
+                        new OpenApiValidatorError(nameof(OpenApiServerRules.ServerRequiredFields), "#/servers/1/url",
                             String.Format(SRResource.Validation_FieldIsRequired, "url", "server"))
-                        {
-                            RuleName = "ServerRequiredFields"
-                        }
         });
         }
 
@@ -112,7 +107,7 @@ public void ValidateCustomExtension()
                  {
                      if (item.Bar == "hey")
                      {
-                         context.AddError(new OpenApiValidatorError(ErrorReason.Format, context.PathString, "Don't say hey"));
+                         context.AddError(new OpenApiValidatorError("FooExtensionRule", context.PathString, "Don't say hey"));
                      }
                  }));
 
@@ -138,7 +133,7 @@ public void ValidateCustomExtension()
             validator.Errors.ShouldBeEquivalentTo(
                    new List<OpenApiError>
                    {
-                       new OpenApiValidatorError(ErrorReason.Format, "#/info/x-foo", "Don't say hey")
+                       new OpenApiValidatorError("FooExtensionRule", "#/info/x-foo", "Don't say hey")
                    });
         }
 
diff --git a/test/Microsoft.OpenApi.Tests/Validations/OpenApiResponseValidationTests.cs b/test/Microsoft.OpenApi.Tests/Validations/OpenApiResponseValidationTests.cs
@@ -33,7 +33,6 @@ public void ValidateDescriptionIsRequiredInResponse()
             Assert.NotNull(errors);
             OpenApiValidatorError error = Assert.Single(errors) as OpenApiValidatorError;
             Assert.Equal(String.Format(SRResource.Validation_FieldIsRequired, "description", "response"), error.Message);
-            Assert.Equal(ErrorReason.Required, error.ReasonClass);
             Assert.Equal("#/description", error.Pointer);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ private static void ValidateKeys(IValidationContext context, IEnumerable<string>`
`57`	`57`	`{`
`58`	`58`	`if (!KeyRegex.IsMatch(key))`
`59`	`59`	`{`
`60`		`- context.CreateError(nameof(KeyMustBeRegularExpression), ErrorReason.Format,`
	`60`	`+ context.CreateError(nameof(KeyMustBeRegularExpression),`
`61`	`61`	`string.Format(SRResource.Validation_ComponentsKeyMustMatchRegularExpr, key, component, KeyRegex.ToString()));`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public static class OpenApiContactRules`
`26`	`26`	`{`
`27`	`27`	`if (!item.Email.IsEmailAddress())`
`28`	`28`	`{`
`29`		`- context.CreateError(nameof(EmailMustBeEmailFormat), ErrorReason.Format,`
	`29`	`+ context.CreateError(nameof(EmailMustBeEmailFormat),`
`30`	`30`	`String.Format(SRResource.Validation_StringMustBeEmailAddress, item.Email));`
`31`	`31`	`}`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public static class OpenApiDocumentRules`
`24`	`24`	`context.Enter("info");`
`25`	`25`	`if (item.Info == null)`
`26`	`26`	`{`
`27`		`- context.CreateError(nameof(OpenApiDocumentFieldIsMissing),ErrorReason.Required,`
	`27`	`+ context.CreateError(nameof(OpenApiDocumentFieldIsMissing),`
`28`	`28`	`String.Format(SRResource.Validation_FieldIsRequired, "info", "document"));`
`29`	`29`	`}`
`30`	`30`	`context.Exit();`
`@@ -33,7 +33,7 @@ public static class OpenApiDocumentRules`
`33`	`33`	`context.Enter("paths");`
`34`	`34`	`if (item.Paths == null)`
`35`	`35`	`{`
`36`		`- context.CreateError(nameof(OpenApiDocumentFieldIsMissing), ErrorReason.Required,`
	`36`	`+ context.CreateError(nameof(OpenApiDocumentFieldIsMissing),`
`37`	`37`	`String.Format(SRResource.Validation_FieldIsRequired, "paths", "document"));`
`38`	`38`	`}`
`39`	`39`	`context.Exit();`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public static class OpenApiInfoRules`
`25`	`25`	`context.Enter("title");`
`26`	`26`	`if (item.Title == null)`
`27`	`27`	`{`
`28`		`- context.CreateError(nameof(InfoRequiredFields),ErrorReason.Required,`
	`28`	`+ context.CreateError(nameof(InfoRequiredFields),`
`29`	`29`	`String.Format(SRResource.Validation_FieldIsRequired, "title", "info"));`
`30`	`30`	`}`
`31`	`31`	`context.Exit();`
`@@ -34,7 +34,7 @@ public static class OpenApiInfoRules`
`34`	`34`	`context.Enter("version");`
`35`	`35`	`if (item.Version == null)`
`36`	`36`	`{`
`37`		`- context.CreateError(nameof(InfoRequiredFields), ErrorReason.Required,`
	`37`	`+ context.CreateError(nameof(InfoRequiredFields),`
`38`	`38`	`String.Format(SRResource.Validation_FieldIsRequired, "version", "info"));`
`39`	`39`	`}`
`40`	`40`	`context.Exit();`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public static class OpenApiLicenseRules`
`23`	`23`	`context.Enter("name");`
`24`	`24`	`if (license.Name == null)`
`25`	`25`	`{`
`26`		`- context.CreateError(nameof(LicenseRequiredFields),ErrorReason.Required,`
	`26`	`+ context.CreateError(nameof(LicenseRequiredFields),`
`27`	`27`	`String.Format(SRResource.Validation_FieldIsRequired, "name", "license"));`
`28`	`28`	`}`
`29`	`29`	`context.Exit();`