supporting validation for empty arrays

OneDrive · Feb 12, 2015 · 6e1c2c2 · 6e1c2c2
1 parent 04af441
commit 6e1c2c2
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 17 deletions.
diff --git a/OneDrive.ApiDocumentation.Validation/CodeBlockAnnotation.cs b/OneDrive.ApiDocumentation.Validation/CodeBlockAnnotation.cs
@@ -31,7 +31,10 @@ public class CodeBlockAnnotation
         /// Speicfy that the result is a collection of the resource type instead of a single instance.
         /// </summary>
         [JsonProperty("isCollection", DefaultValueHandling = DefaultValueHandling.Ignore)]
-        public bool IsCollection { get; set; }
+        public bool IsCollection { get; set; }
+
+        [JsonProperty("isEmpty", DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public bool IsEmpty { get; set; }
 
         [JsonProperty("truncated", DefaultValueHandling = DefaultValueHandling.Ignore)]
         public bool TruncatedResult { get; set; }

diff --git a/OneDrive.ApiDocumentation.Validation/Json/JsonSchema.cs b/OneDrive.ApiDocumentation.Validation/Json/JsonSchema.cs
@@ -94,11 +94,29 @@ public bool ValidateJson(string json, out ValidationError[] errors, Dictionary<s
                 }
                 else
                 {
-                    var collectionMembers = obj[collectionPropertyName];
-                    if (collectionMembers.Count() == 0)
-                    {
-                        detectedErrors.Add(new ValidationWarning(ValidationErrorCode.CollectionArrayEmpty, null, "Property contained an empty array that was not validated: {0}", collectionPropertyName));
-                    }
+                    var collectionMembers = obj[collectionPropertyName];
+                    if (!collectionMembers.Any())
+                    {
+                        if (!annotation.IsEmpty)
+                        {
+                            detectedErrors.Add(
+                                new ValidationWarning(
+                                    ValidationErrorCode.CollectionArrayEmpty,
+                                    null,
+                                    "Property contained an empty array that was not validated: {0}",
+                                    collectionPropertyName));
+                        }
+                    }
+                    else if (annotation.IsEmpty)
+                    {
+                        detectedErrors.Add(
+                            new ValidationWarning(
+                                ValidationErrorCode.CollectionArrayNotEmpty,
+                                null,
+                                "Property contained a non-empty array that was expected to be empty: {0}",
+                                collectionPropertyName));
+                    }
+
                     foreach (JContainer container in collectionMembers)
                     {
                         ValidateJContainer(container, annotation, otherSchemas, detectedErrors);
@@ -142,11 +160,14 @@ private void ValidateJContainer(JContainer obj, bool allowTruncation, Dictionary
             missingProperties.AddRange(from m in ExpectedProperties select m.Key);
 
             foreach (JToken token in obj)
-            {
-                JsonProperty inputProperty = ParseProperty(token, this);
-                missingProperties.Remove(inputProperty.Name);
-                // This detects bad types, extra properties, etc.
-                ValidateProperty(inputProperty, otherSchemas, detectedErrors, allowTruncation);
+            {
+                JsonProperty inputProperty = ParseProperty(token, this, detectedErrors);
+                if (inputProperty != null)
+                {
+                    missingProperties.Remove(inputProperty.Name);
+                    // This detects bad types, extra properties, etc.
+                    ValidateProperty(inputProperty, otherSchemas, detectedErrors, allowTruncation);
+                }
             }
 
             if (null != OptionalProperties)
@@ -256,7 +277,7 @@ private PropertyValidationOutcome ValidateProperty(JsonProperty inputProperty, D
                         inputProperty.Name, inputProperty.Type, schemaPropertyDef.Type));
                     return PropertyValidationOutcome.InvalidType;
                 }
-            }
+            }
             else
             {
                 detectedErrors.Add(new ValidationWarning(ValidationErrorCode.AdditionalPropertyDetected, null, "Extra property: property '{0}' [{1}] was not expected.", inputProperty.Name, inputProperty.Type));
@@ -477,9 +498,9 @@ private static JsonProperty ParseProperty(string name, JToken value, JsonSchema
             }
 
             return null;
-        }
-
-        private static JsonProperty ParseProperty(JToken token, JsonSchema containerSchema)
+        }
+
+        private static JsonProperty ParseProperty(JToken token, JsonSchema containerSchema, List<ValidationError> detectedErrors = null)
         {
             JsonProperty propertyInfo = null;
             if (token.Type == JTokenType.Property)
@@ -488,8 +509,19 @@ private static JsonProperty ParseProperty(JToken token, JsonSchema containerSche
                 propertyInfo = ParseProperty(tokenProperty.Name, tokenProperty.Value, containerSchema);
             }
             else
-            {
-                Console.WriteLine("Unhandled token type: " + token.Type);
+            {
+                if (detectedErrors != null)
+                {
+                    detectedErrors.Add(
+                        new ValidationWarning(
+                            ValidationErrorCode.JsonParserException,
+                            token.Path,
+                            "Unhandled token type: " + token.Type));
+                }
+                else
+                {
+                    Console.WriteLine("Unhandled token type: " + token.Type);
+                }
             }
             return propertyInfo;
         }

diff --git a/OneDrive.ApiDocumentation.Validation/ValidationError.cs b/OneDrive.ApiDocumentation.Validation/ValidationError.cs
@@ -14,6 +14,7 @@ public enum ValidationErrorCode
         JsonErrorObject,
         MissingCollectionProperty,
         CollectionArrayEmpty,
+        CollectionArrayNotEmpty,
         RequiredPropertiesMissing,
         AdditionalPropertyDetected,
         ExpectedTypeDifferent,