Merge branch 'master' into bug/cyclic-dep

Author: stevehu

src/main/java/com/networknt/schema/JsonSchemaFactory.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.networknt.schema.uri.*;
+import com.networknt.schema.urn.URNFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -41,6 +42,7 @@ public static class Builder {
         private String defaultMetaSchemaURI;
         private final Map<String, URIFactory> uriFactoryMap = new HashMap<String, URIFactory>();
         private final Map<String, URIFetcher> uriFetcherMap = new HashMap<String, URIFetcher>();
+        private URNFactory urnFactory;
         private final Map<String, JsonMetaSchema> jsonMetaSchemas = new HashMap<String, JsonMetaSchema>();
         private final Map<String, String> uriMap = new HashMap<String, String>();
 
@@ -121,13 +123,19 @@ public Builder addUriMappings(final Map<String, String> map) {
             return this;
         }
 
+        public Builder addUrnFactory(URNFactory urnFactory) {
+            this.urnFactory = urnFactory;
+            return this;
+        }
+
         public JsonSchemaFactory build() {
             // create builtin keywords with (custom) formats.
             return new JsonSchemaFactory(
                     objectMapper == null ? new ObjectMapper() : objectMapper,
                     defaultMetaSchemaURI,
                     new URISchemeFactory(uriFactoryMap),
                     new URISchemeFetcher(uriFetcherMap),
+                    urnFactory,
                     jsonMetaSchemas,
                     uriMap
             );
@@ -138,15 +146,18 @@ public JsonSchemaFactory build() {
     private final String defaultMetaSchemaURI;
     private final URISchemeFactory uriFactory;
     private final URISchemeFetcher uriFetcher;
+    private final URNFactory urnFactory;
     private final Map<String, JsonMetaSchema> jsonMetaSchemas;
     private final Map<String, String> uriMap;
     private final ConcurrentMap<URI, JsonSchema> uriSchemaCache = new ConcurrentHashMap<URI, JsonSchema>();
 
+
     private JsonSchemaFactory(
             final ObjectMapper mapper,
             final String defaultMetaSchemaURI,
             final URISchemeFactory uriFactory,
             final URISchemeFetcher uriFetcher,
+            final URNFactory urnFactory,
             final Map<String, JsonMetaSchema> jsonMetaSchemas,
             final Map<String, String> uriMap) {
         if (mapper == null) {
@@ -174,6 +185,7 @@ private JsonSchemaFactory(
         this.defaultMetaSchemaURI = defaultMetaSchemaURI;
         this.uriFactory = uriFactory;
         this.uriFetcher = uriFetcher;
+        this.urnFactory = urnFactory;
         this.jsonMetaSchemas = jsonMetaSchemas;
         this.uriMap = uriMap;
     }
@@ -258,7 +270,7 @@ protected JsonSchema newJsonSchema(final URI schemaUri, final JsonNode schemaNod
 
     protected ValidationContext createValidationContext(final JsonNode schemaNode) {
         final JsonMetaSchema jsonMetaSchema = findMetaSchemaForSchema(schemaNode);
-        return new ValidationContext(this.uriFactory, jsonMetaSchema, this, null);
+        return new ValidationContext(this.uriFactory, this.urnFactory, jsonMetaSchema, this, null);
     }
 
     private JsonMetaSchema findMetaSchemaForSchema(final JsonNode schemaNode) {
@@ -330,7 +342,7 @@ public JsonSchema getSchema(final URI schemaUri, final SchemaValidatorsConfig co
 
                 JsonSchema jsonSchema;
                 if (idMatchesSourceUri(jsonMetaSchema, schemaNode, schemaUri)) {
-                    jsonSchema = new JsonSchema(new ValidationContext(this.uriFactory, jsonMetaSchema, this, config), mappedUri, schemaNode, true /*retrieved via id, resolving will not change anything*/);
+                    jsonSchema = new JsonSchema(new ValidationContext(this.uriFactory, this.urnFactory, jsonMetaSchema, this, config), mappedUri, schemaNode, true /*retrieved via id, resolving will not change anything*/);
                 } else {
                     final ValidationContext validationContext = createValidationContext(schemaNode);
                     validationContext.setConfig(config);

src/main/java/com/networknt/schema/RefValidator.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.networknt.schema.uri.URIFactory;
+import com.networknt.schema.urn.URNFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -60,7 +61,15 @@ static JsonSchemaRef getRefSchema(JsonSchema parentSchema, ValidationContext val
             // account the current uri of the parent schema.
             URI schemaUri = determineSchemaUri(validationContext.getURIFactory(), parentSchema, refUri);
             if (schemaUri == null) {
-                return null;
+                // the URNFactory is optional
+                if (validationContext.getURNFactory() == null) {
+                    return null;
+                }
+                // If the uri dose't determinate try to determinate with urn factory
+                schemaUri = determineSchemaUrn(validationContext.getURNFactory(), refUri);
+                if (schemaUri == null) {
+                    return null;
+                }
             }
 
             // This should retrieve schemas regardless of the protocol that is in the uri.
@@ -106,6 +115,16 @@ private static URI determineSchemaUri(final URIFactory uriFactory, final JsonSch
         return schemaUri;
     }
 
+    private static URI determineSchemaUrn(final URNFactory urnFactory, final String refUri) {
+        URI schemaUrn;
+        try {
+            schemaUrn = urnFactory.create(refUri);
+        } catch (IllegalArgumentException e) {
+            schemaUrn = null;
+        }
+        return schemaUrn;
+    }
+
     public Set<ValidationMessage> validate(JsonNode node, JsonNode rootNode, String at) {
         debug(logger, node, rootNode, at);
 

src/main/java/com/networknt/schema/ValidationContext.java

@@ -18,18 +18,20 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.networknt.schema.uri.URIFactory;
+import com.networknt.schema.urn.URNFactory;
 
 import java.util.HashMap;
 import java.util.Map;
 
 public class ValidationContext {
     private final URIFactory uriFactory;
+    private final URNFactory urnFactory;
     private final JsonMetaSchema metaSchema;
     private final JsonSchemaFactory jsonSchemaFactory;
     private SchemaValidatorsConfig config;
     private final Map<String, JsonSchemaRef> refParsingInProgress = new HashMap<String, JsonSchemaRef>();
 
-    public ValidationContext(URIFactory uriFactory, JsonMetaSchema metaSchema, JsonSchemaFactory jsonSchemaFactory, SchemaValidatorsConfig config) {
+    public ValidationContext(URIFactory uriFactory, URNFactory urnFactory, JsonMetaSchema metaSchema, JsonSchemaFactory jsonSchemaFactory, SchemaValidatorsConfig config) {
         if (uriFactory == null) {
             throw new IllegalArgumentException("URIFactory must not be null");
         }
@@ -40,6 +42,7 @@ public ValidationContext(URIFactory uriFactory, JsonMetaSchema metaSchema, JsonS
             throw new IllegalArgumentException("JsonSchemaFactory must not be null");
         }
         this.uriFactory = uriFactory;
+        this.urnFactory = urnFactory;
         this.metaSchema = metaSchema;
         this.jsonSchemaFactory = jsonSchemaFactory;
         this.config = config;
@@ -58,6 +61,10 @@ public URIFactory getURIFactory() {
         return this.uriFactory;
     }
 
+    public URNFactory getURNFactory() {
+        return this.urnFactory;
+    }
+
     public JsonSchemaFactory getJsonSchemaFactory() {
         return jsonSchemaFactory;
     }

src/main/java/com/networknt/schema/urn/URNFactory.java

@@ -0,0 +1,13 @@
+package com.networknt.schema.urn;
+
+import java.net.URI;
+
+public interface URNFactory
+{
+  /**
+   * @param urn Some urn string.
+   * @return The converted {@link URI}.
+   * @throws IllegalArgumentException if there was a problem creating the {@link URI} with the given data.
+   */
+  URI create(String urn);
+}

src/test/java/com/networknt/schema/UrnTest.java

@@ -0,0 +1,66 @@
+package com.networknt.schema;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.networknt.schema.uri.ClasspathURLFactory;
+import com.networknt.schema.uri.URLFactory;
+import com.networknt.schema.urn.URNFactory;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URL;
+
+import static org.junit.Assert.assertEquals;
+
+public class UrnTest
+{
+  private final ObjectMapper mapper = new ObjectMapper();
+  private final ClasspathURLFactory classpathURLFactory = new ClasspathURLFactory();
+  private final URLFactory urlFactory = new URLFactory();
+
+  /**
+   * Validate that a JSON URI Mapping file containing the URI Mapping schema is
+   * schema valid.
+   *
+   * @throws IOException if unable to parse the mapping file
+   */
+  @Test
+  public void testURNToURI() throws Exception {
+    URL urlTestData = ClasspathURLFactory.convert(
+        this.classpathURLFactory.create("resource:draft7/urn/test.json"));
+    
+    URNFactory urnFactory = new URNFactory()
+    {
+      @Override public URI create(String urn)
+      {
+        try {
+          URL absoluteURL = ClasspathURLFactory.convert(new ClasspathURLFactory().create(String.format("resource:draft7/urn/%s.schema.json", urn)));
+          return absoluteURL.toURI();
+        } catch (Exception ex) {
+          return null;
+        }
+      }
+    };
+
+    InputStream is = null;
+    try {
+      is = new URL("https://raw.githubusercontent.com/francesc79/json-schema-validator/feature/urn-management/src/test/resources/draft7/urn/urn.schema.json").openStream();
+      JsonMetaSchema draftV7 = JsonMetaSchema.getV7();
+      JsonSchemaFactory.Builder builder = JsonSchemaFactory.builder()
+          .defaultMetaSchemaURI(draftV7.getUri())
+          .addMetaSchema(draftV7)
+          .addUrnFactory(urnFactory);
+      JsonSchemaFactory instance = builder.build();
+      JsonSchema schema = instance.getSchema(is);
+      assertEquals(0, schema.validate(mapper.readTree(urlTestData)).size());
+    } catch( Exception e) {
+      e.printStackTrace();
+    }
+    finally {
+      if (is != null) {
+        is.close();
+      }
+    }
+  }
+}

src/test/resources/draft7/urn/account.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "account",
+  "type": "object",
+  "properties": {
+    "first-name": {
+      "type": "string"
+    },
+    "age": {
+      "type": "integer"
+    }
+  }
+}

src/test/resources/draft7/urn/test.json

@@ -0,0 +1,6 @@
+{
+  "account": {
+    "first-name": "Test",
+    "age": 18
+  }
+}

src/test/resources/draft7/urn/urn.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "schema-with-urn-ref",
+  "type": "object",
+  "properties": {
+    "account": {
+      "$ref": "account"
+    }
+  }
+}