initial classpath-based schema client implementation

Author: erosb

core/pom.xml

@@ -128,6 +128,18 @@
                         <breakBuildOnSourceIncompatibleModifications>
                             true
                         </breakBuildOnSourceIncompatibleModifications>
+                        <overrideCompatibilityChangeParameters>
+                            <overrideCompatibilityChangeParameter>
+                                <compatibilityChange>METHOD_NEW_DEFAULT</compatibilityChange>
+                                <binaryCompatible>true</binaryCompatible>
+                                <sourceCompatible>true</sourceCompatible>
+                            </overrideCompatibilityChangeParameter>
+                            <overrideCompatibilityChangeParameter>
+                                <compatibilityChange>METHOD_ABSTRACT_NOW_DEFAULT</compatibilityChange>
+                                <binaryCompatible>true</binaryCompatible>
+                                <sourceCompatible>true</sourceCompatible>
+                            </overrideCompatibilityChangeParameter>
+                        </overrideCompatibilityChangeParameters>
                     </parameter>
                 </configuration>
                 <executions>

core/src/main/java/org/everit/json/schema/loader/ClassPathAwareSchemaClient.java

@@ -0,0 +1,37 @@
+package org.everit.json.schema.loader;
+
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
+import static java.util.Objects.requireNonNull;
+
+import java.io.InputStream;
+import java.util.List;
+import java.util.Optional;
+
+class ClassPathAwareSchemaClient implements SchemaClient {
+
+    private static final List<String> HANDLED_PREFIXES = unmodifiableList(asList("classpath://", "classpath:/", "classpath:"));
+
+    private final SchemaClient fallbackClient;
+
+    ClassPathAwareSchemaClient(SchemaClient fallbackClient) {
+        this.fallbackClient = requireNonNull(fallbackClient, "fallbackClient cannot be null");
+    }
+
+    @Override public InputStream get(String url) {
+        return handleProtocol(url)
+                .map(this::loadFromClasspath)
+                .orElseGet(() -> fallbackClient.get(url));
+    }
+
+    private InputStream loadFromClasspath(String str) {
+        return getClass().getResourceAsStream(str);
+    }
+
+    private Optional<String> handleProtocol(String url) {
+        return HANDLED_PREFIXES.stream().filter(url::startsWith)
+                .map(prefix -> "/" + url.substring(prefix.length()))
+                .findFirst();
+    }
+
+}

core/src/main/java/org/everit/json/schema/loader/SchemaClient.java

@@ -3,6 +3,8 @@
 import java.io.InputStream;
 import java.util.function.Function;
 
+import org.everit.json.schema.loader.internal.DefaultSchemaClient;
+
 /**
  * This interface is used by {@link SchemaLoader} to fetch the contents denoted by remote JSON
  * pointer.
@@ -13,6 +15,10 @@
 @FunctionalInterface
 public interface SchemaClient extends Function<String, InputStream> {
 
+    static SchemaClient classPathAwareClient() {
+        return new ClassPathAwareSchemaClient(new DefaultSchemaClient());
+    }
+
     @Override
     default InputStream apply(final String url) {
         return get(url);

core/src/test/java/org/everit/json/schema/loader/ClassPathAwareSchemaClientTest.java

@@ -0,0 +1,54 @@
+package org.everit.json.schema.loader;
+
+import static org.everit.json.schema.JSONMatcher.sameJsonAs;
+import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.io.InputStream;
+
+import org.everit.json.schema.ResourceLoader;
+import org.json.JSONObject;
+import org.json.JSONTokener;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import junitparams.JUnitParamsRunner;
+import junitparams.Parameters;
+
+@RunWith(JUnitParamsRunner.class)
+public class ClassPathAwareSchemaClientTest {
+
+    private static final JSONObject EXPECTED = ResourceLoader.DEFAULT.readObj("constobject.json");
+
+    private SchemaClient fallbackClient;
+
+    @Before
+    public void before() {
+        fallbackClient = mock(SchemaClient.class);
+    }
+
+    @Test
+    public void delegatesUnhandledProtocolsToFallback() {
+        InputStream expected = ResourceLoader.DEFAULT.getStream("arraytestcases.json");
+        when(fallbackClient.get("http://example.org")).thenReturn(expected);
+        ClassPathAwareSchemaClient subject = new ClassPathAwareSchemaClient(fallbackClient);
+        InputStream actual = subject.get("http://example.org");
+        assertSame(expected, actual);
+    }
+
+    @Test
+    @Parameters({
+            "classpath:/org/everit/jsonvalidator/constobject.json",
+            "classpath://org/everit/jsonvalidator/constobject.json",
+            "classpath:org/everit/jsonvalidator/constobject.json"
+    })
+    public void success(String url) {
+        ClassPathAwareSchemaClient subject = new ClassPathAwareSchemaClient(fallbackClient);
+        JSONObject actual = new JSONObject(new JSONTokener(subject.get(url)));
+        assertThat(actual, sameJsonAs(EXPECTED));
+    }
+
+}

core/src/test/java/org/everit/json/schema/loader/internal/ReferenceResolverTest.java

@@ -15,26 +15,25 @@
  */
 package org.everit.json.schema.loader.internal;
 
-import org.junit.Assert;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-import org.junit.runners.Parameterized.Parameters;
+import static java.util.Arrays.asList;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.fail;
 
 import java.net.URI;
 import java.net.URISyntaxException;
-import java.util.Arrays;
 import java.util.List;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.fail;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameters;
 
 @RunWith(Parameterized.class)
 public class ReferenceResolverTest {
 
     @Parameters(name = "{0}")
     public static List<Object[]> params() {
-        return Arrays.asList(
+        return asList(
                 parList("fragment id", "http://x.y.z/root.json#foo", "http://x.y.z/root.json", "#foo"),
                 parList("rel path", "http://example.org/foo", "http://example.org/bar", "foo"),
                 parList("file name change", "http://x.y.z/schema/child.json",
@@ -44,10 +43,18 @@ public static List<Object[]> params() {
                         "http://x.y.z/schema/", "child.json"),
                 parList("new root", "http://bserver.com", "http://aserver.com/",
                         "http://bserver.com"),
-                parList("null parent", "http://a.b.c", null, "http://a.b.c"));
+                parList("null parent", "http://a.b.c", null, "http://a.b.c"),
+                parList("classpath single-slash",
+                        "classpath:/hello/world.json/definitions/A",
+                        "classpath:/hello/world.json/", "definitions/A"
+                ),
+                parList("classpath double-slash",
+                        "classpath://hello/world.json#/definitions/A",
+                        "classpath://hello/world.json", "#/definitions/A"
+                ));
     }
 
-    private static Object[] parList(final String... params) {
+    private static Object[] parList(String... params) {
         return params;
     }
 
@@ -57,7 +64,7 @@ private static Object[] parList(final String... params) {
 
     private final String encounteredSegment;
 
-    public ReferenceResolverTest(final String testcaseName, final String expectedOutput,
+    public ReferenceResolverTest(String testcaseName, String expectedOutput,
             final String parentScope,
             final String encounteredSegment) {
         this.expectedOutput = expectedOutput;

tests/vanilla/src/main/java/org/everit/json/schema/IssueTest.java

@@ -22,6 +22,7 @@
 import java.util.stream.Collectors;
 
 import org.apache.commons.io.IOUtils;
+import org.everit.json.schema.loader.SchemaClient;
 import org.everit.json.schema.loader.SchemaLoader;
 import org.everit.json.schema.regexp.RE2JRegexpFactory;
 import org.json.JSONArray;
@@ -135,6 +136,11 @@ private void consumeValidatorConfig() {
                 loaderBuilder.draftV7Support();
             }
         });
+        configKeyHandlers.put("schemaClient", value -> {
+            if ("classPathAware".equals(value)) {
+                loaderBuilder.schemaClient(SchemaClient.classPathAwareClient());
+            }
+        });
         fileByName("validator-config.json").map(file -> streamAsJson(file)).ifPresent(configJson -> {
             configKeyHandlers.entrySet()
                     .stream()

tests/vanilla/src/main/resources/org/everit/json/schema/issues/issue245/definitions.json

@@ -0,0 +1,12 @@
+{
+  "definitions": {
+    "Str": {
+      "type": "string",
+      "maxLength": 3
+    },
+    "Num": {
+      "type": "integer",
+      "maximum": 3
+    }
+  }
+}

tests/vanilla/src/main/resources/org/everit/json/schema/issues/issue245/schema.json

@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "str": {
+      "$ref": "classpath://org/everit/json/schema/issues/issue245/definitions.json#/definitions/Str"
+    },
+    "num": {
+      "$ref": "classpath:/org/everit/json/schema/issues/issue245/definitions.json#/definitions/Num"
+    }
+  }
+}

tests/vanilla/src/main/resources/org/everit/json/schema/issues/issue245/subject-invalid.json

@@ -0,0 +1,4 @@
+{
+  "str": "aaaaa",
+  "num": 10
+}

tests/vanilla/src/main/resources/org/everit/json/schema/issues/issue245/validator-config.json

@@ -0,0 +1,3 @@
+{
+  "schemaClient": "classPathAware"
+}