initial implementation of Validator interface

erosb · erosb · commit 9222b16dd81f · 2018-01-07T18:44:39.000+01:00
* introducing the Validator interface which is a top-level public orchestrator of the validation process
 * adding Validator#ValidatorBuilder which is a configuration point for the validation process
 * implementing Validator#failFirst
diff --git a/core/src/main/java/org/everit/json/schema/Schema.java b/core/src/main/java/org/everit/json/schema/Schema.java
@@ -93,9 +93,7 @@ protected Schema(Builder<?> builder) {
      *         if the {@code subject} is invalid against this schema.
      */
     public void validate(Object subject) {
-        ValidatingVisitor visitor = new ValidatingVisitor(subject, this);
-        visitor.visit(this);
-        visitor.failIfErrorFound();
+        Validator.builder().build().performValidation(this, subject);
     }
 
     /**
diff --git a/core/src/main/java/org/everit/json/schema/ValidatingVisitor.java b/core/src/main/java/org/everit/json/schema/ValidatingVisitor.java
@@ -19,11 +19,16 @@ private static boolean isNull(Object obj) {
 
     private ValidationFailureReporter failureReporter;
 
-    ValidatingVisitor(Object subject, Schema schema) {
+    ValidatingVisitor(Schema schema, Object subject) {
         this.subject = subject;
         this.failureReporter = new CollectingFailureReporter(schema);
     }
 
+    ValidatingVisitor(Object subject, ValidationFailureReporter failureReporter) {
+        this.subject = subject;
+        this.failureReporter = failureReporter;
+    }
+
     @Override void visitNumberSchema(NumberSchema numberSchema) {
         numberSchema.accept(new NumberSchemaValidatingVisitor(subject, failureReporter));
     }
diff --git a/core/src/main/java/org/everit/json/schema/Validator.java b/core/src/main/java/org/everit/json/schema/Validator.java
@@ -0,0 +1,52 @@
+package org.everit.json.schema;
+
+import java.util.function.BiFunction;
+
+public interface Validator {
+
+    class ValidatorBuilder {
+
+        private boolean failEarly = false;
+
+        public ValidatorBuilder failEarly() {
+            this.failEarly = true;
+            return this;
+        }
+
+        public Validator build() {
+            return new DefaultValidator(failEarly);
+        }
+
+    }
+
+    static ValidatorBuilder builder() {
+        return new ValidatorBuilder();
+    }
+
+    void performValidation(Schema schema, Object input);
+}
+
+class DefaultValidator implements Validator {
+
+    private BiFunction<Schema, Object, ValidatingVisitor> visitorFactory;
+
+    private boolean failEarly;
+
+    public DefaultValidator(boolean failEarly) {
+        this.failEarly = failEarly;
+    }
+
+    @Override public void performValidation(Schema schema, Object input) {
+        ValidationFailureReporter failureReporter = createFailureReporter(schema);
+        ValidatingVisitor visitor = new ValidatingVisitor(input, failureReporter);
+        visitor.visit(schema);
+        visitor.failIfErrorFound();
+    }
+
+    private ValidationFailureReporter createFailureReporter(Schema schema) {
+        if (failEarly) {
+            return new EarlyFailingFailureReporter(schema);
+        }
+        return new CollectingFailureReporter(schema);
+    }
+}
diff --git a/core/src/test/java/org/everit/json/schema/ObjectSchemaTest.java b/core/src/test/java/org/everit/json/schema/ObjectSchemaTest.java
@@ -15,29 +15,37 @@
  */
 package org.everit.json.schema;
 
-import nl.jqno.equalsverifier.EqualsVerifier;
-import nl.jqno.equalsverifier.Warning;
-import org.everit.json.schema.loader.SchemaLoader;
-import org.json.JSONObject;
-import org.json.JSONPointer;
-import org.junit.Test;
-
-import java.util.List;
-import java.util.concurrent.Callable;
-
 import static java.util.Arrays.asList;
 import static org.everit.json.schema.TestSupport.buildWithLocation;
 import static org.everit.json.schema.TestSupport.loadAsV6;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
+import java.util.List;
+import java.util.concurrent.Callable;
+
+import org.everit.json.schema.loader.SchemaLoader;
+import org.json.JSONObject;
+import org.json.JSONPointer;
+import org.junit.Test;
+
+import nl.jqno.equalsverifier.EqualsVerifier;
+import nl.jqno.equalsverifier.Warning;
+
 public class ObjectSchemaTest {
 
-    private static final JSONObject OBJECTS  = ResourceLoader.DEFAULT.readObj("objecttestcases.json");
+    private static final JSONObject OBJECTS = ResourceLoader.DEFAULT.readObj("objecttestcases.json");
 
     private ResourceLoader loader = ResourceLoader.DEFAULT;
 
+    public static final Schema MULTIPLE_VIOLATIONS_SCHEMA = ObjectSchema.builder()
+            .addPropertySchema("numberProp", new NumberSchema())
+            .patternProperty("^string.*", new StringSchema())
+            .addPropertySchema("boolProp", BooleanSchema.INSTANCE)
+            .addRequiredProperty("boolProp")
+            .build();
+
     @Test
     public void additionalPropertiesOnEmptyObject() {
         ObjectSchema.builder()
@@ -133,14 +141,8 @@ public void multipleSchemaDepViolation() {
 
     @Test
     public void multipleViolations() {
-        Schema subject = ObjectSchema.builder()
-                .addPropertySchema("numberProp", new NumberSchema())
-                .patternProperty("^string.*", new StringSchema())
-                .addPropertySchema("boolProp", BooleanSchema.INSTANCE)
-                .addRequiredProperty("boolProp")
-                .build();
         try {
-            subject.validate(OBJECTS.get("multipleViolations"));
+            MULTIPLE_VIOLATIONS_SCHEMA.validate(OBJECTS.get("multipleViolations"));
             fail("did not throw exception for 3 schema violations");
         } catch (ValidationException e) {
             assertEquals(3, e.getCausingExceptions().size());
@@ -268,9 +270,9 @@ public void patternPropsOverrideAdditionalProps() {
     public void propertyDepViolation() {
         ObjectSchema subject = buildWithLocation(
                 ObjectSchema.builder()
-                .addPropertySchema("ifPresent", NullSchema.INSTANCE)
-                .addPropertySchema("mustBePresent", BooleanSchema.INSTANCE)
-                .propertyDependency("ifPresent", "mustBePresent")
+                        .addPropertySchema("ifPresent", NullSchema.INSTANCE)
+                        .addPropertySchema("mustBePresent", BooleanSchema.INSTANCE)
+                        .propertyDependency("ifPresent", "mustBePresent")
         );
         TestSupport.failureOf(subject)
                 .input(OBJECTS.get("propertyDepViolation"))
@@ -290,9 +292,9 @@ public void propertySchemaViolation() {
     public void requiredProperties() {
         ObjectSchema subject = buildWithLocation(
                 ObjectSchema.builder()
-                .addPropertySchema("boolProp", BooleanSchema.INSTANCE)
-                .addPropertySchema("nullProp", NullSchema.INSTANCE)
-                .addRequiredProperty("boolProp")
+                        .addPropertySchema("boolProp", BooleanSchema.INSTANCE)
+                        .addPropertySchema("nullProp", NullSchema.INSTANCE)
+                        .addRequiredProperty("boolProp")
         );
         TestSupport.failureOf(subject)
                 .expectedPointer("#")
diff --git a/core/src/test/java/org/everit/json/schema/ValidatorTest.java b/core/src/test/java/org/everit/json/schema/ValidatorTest.java
@@ -0,0 +1,37 @@
+package org.everit.json.schema;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import org.junit.Test;
+
+public class ValidatorTest {
+
+    @Test
+    public void testCollectAllMode() {
+        Validator actual = Validator.builder().build();
+        try {
+            actual.performValidation(ObjectSchemaTest.MULTIPLE_VIOLATIONS_SCHEMA,
+                    ResourceLoader.DEFAULT.readObj("objecttestcases.json").get("multipleViolations"));
+            fail("did not throw exception");
+        } catch (ValidationException e) {
+            assertEquals("#: 3 schema violations found", e.getMessage());
+            assertEquals(3, e.getCausingExceptions().size());
+        }
+    }
+
+    @Test
+    public void testFailEarlyMode() {
+        Validator actual = Validator.builder().failEarly().build();
+        try {
+            actual.performValidation(ObjectSchemaTest.MULTIPLE_VIOLATIONS_SCHEMA,
+                    ResourceLoader.DEFAULT.readObj("objecttestcases.json").get("multipleViolations"));
+            fail("did not throw exception");
+        } catch (ValidationException e) {
+            assertEquals("#: required key [boolProp] not found", e.getMessage());
+            assertTrue("no causing exceptions", e.getCausingExceptions().isEmpty());
+        }
+    }
+
+}
diff --git a/tests/src/test/java/org/everit/json/schema/TestCase.java b/tests/src/test/java/org/everit/json/schema/TestCase.java
@@ -65,6 +65,12 @@ private TestCase(JSONObject input, JSONObject schemaTest, String fileName) {
         inputData = input.get("data");
     }
 
+    private void testInEarlyFailureMode(Schema schema) {
+        //        validator = new ValidatorBuilder().failEarly().build();
+        //        validator = new ValidatorBuilder().failEarly().loadDefaultValues().build();
+        //        validator.performValidation(schema, inputData);
+    }
+
     public void runTest(SchemaLoader.SchemaLoaderBuilder loaderBuilder) {
         try {
             SchemaLoader loader = loaderBuilder.schemaJson(schemaJson).build();
