issue668: handle references to yaml sub-schemas (#670)

Author: danfelicetta-RL

pom.xml

@@ -78,6 +78,11 @@
             <artifactId>jackson-databind</artifactId>
             <version>${version.jackson}</version>
         </dependency>
+        <dependency>
+          <groupId>com.fasterxml.jackson.dataformat</groupId>
+          <artifactId>jackson-dataformat-yaml</artifactId>
+          <version>${version.jackson}</version>
+        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>

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

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 import com.networknt.schema.uri.*;
 import com.networknt.schema.urn.URNFactory;
 import org.slf4j.Logger;
@@ -41,6 +42,7 @@ public class JsonSchemaFactory {
 
     public static class Builder {
         private ObjectMapper objectMapper = new ObjectMapper();
+        private YAMLMapper yamlMapper = new YAMLMapper();
         private String defaultMetaSchemaURI;
         private final Map<String, URIFactory> uriFactoryMap = new HashMap<String, URIFactory>();
         private final Map<String, URIFetcher> uriFetcherMap = new HashMap<String, URIFetcher>();
@@ -77,6 +79,11 @@ public Builder objectMapper(final ObjectMapper objectMapper) {
             return this;
         }
 
+        public Builder yamlMapper(final YAMLMapper yamlMapper) {
+            this.yamlMapper = yamlMapper;
+            return this;
+        }
+
         public Builder defaultMetaSchemaURI(final String defaultMetaSchemaURI) {
             this.defaultMetaSchemaURI = defaultMetaSchemaURI;
             return this;
@@ -154,6 +161,7 @@ public JsonSchemaFactory build() {
             // create builtin keywords with (custom) formats.
             return new JsonSchemaFactory(
                     objectMapper == null ? new ObjectMapper() : objectMapper,
+                    yamlMapper == null ? new YAMLMapper(): yamlMapper,
                     defaultMetaSchemaURI,
                     new URISchemeFactory(uriFactoryMap),
                     new URISchemeFetcher(uriFetcherMap),
@@ -166,7 +174,8 @@ public JsonSchemaFactory build() {
         }
     }
 
-    private final ObjectMapper mapper;
+    private final ObjectMapper jsonMapper;
+    private final YAMLMapper yamlMapper;
     private final String defaultMetaSchemaURI;
     private final URISchemeFactory uriFactory;
     private final URISchemeFetcher uriFetcher;
@@ -179,7 +188,8 @@ public JsonSchemaFactory build() {
 
 
     private JsonSchemaFactory(
-            final ObjectMapper mapper,
+            final ObjectMapper jsonMapper,
+            final YAMLMapper yamlMapper,
             final String defaultMetaSchemaURI,
             final URISchemeFactory uriFactory,
             final URISchemeFetcher uriFetcher,
@@ -188,8 +198,10 @@ private JsonSchemaFactory(
             final Map<String, String> uriMap,
             final boolean forceHttps,
             final boolean removeEmptyFragmentSuffix) {
-        if (mapper == null) {
+        if (jsonMapper == null) {
             throw new IllegalArgumentException("ObjectMapper must not be null");
+        } else if (yamlMapper == null) {
+            throw new IllegalArgumentException("YAMLMapper must not be null");
         } else if (defaultMetaSchemaURI == null || defaultMetaSchemaURI.trim().isEmpty()) {
             throw new IllegalArgumentException("defaultMetaSchemaURI must not be null or empty");
         } else if (uriFactory == null) {
@@ -203,7 +215,8 @@ private JsonSchemaFactory(
         } else if (uriMap == null) {
             throw new IllegalArgumentException("URL Mappings must not be null");
         }
-        this.mapper = mapper;
+        this.jsonMapper = jsonMapper;
+        this.yamlMapper = yamlMapper;
         this.defaultMetaSchemaURI = defaultMetaSchemaURI;
         this.uriFactory = uriFactory;
         this.uriFetcher = uriFetcher;
@@ -274,7 +287,8 @@ public static Builder builder(final JsonSchemaFactory blueprint) {
         Builder builder = builder()
                 .addMetaSchemas(blueprint.jsonMetaSchemas.values())
                 .defaultMetaSchemaURI(blueprint.defaultMetaSchemaURI)
-                .objectMapper(blueprint.mapper)
+                .objectMapper(blueprint.jsonMapper)
+                .yamlMapper(blueprint.yamlMapper)
                 .addUriMappings(blueprint.uriMap);
 
         for (Map.Entry<String, URIFactory> entry : blueprint.uriFactory.getURIFactories().entrySet()) {
@@ -319,7 +333,7 @@ public URIFactory getUriFactory() {
 
     public JsonSchema getSchema(final String schema, final SchemaValidatorsConfig config) {
         try {
-            final JsonNode schemaNode = mapper.readTree(schema);
+            final JsonNode schemaNode = jsonMapper.readTree(schema);
             return newJsonSchema(null, schemaNode, config);
         } catch (IOException ioe) {
             logger.error("Failed to load json schema!", ioe);
@@ -333,7 +347,7 @@ public JsonSchema getSchema(final String schema) {
 
     public JsonSchema getSchema(final InputStream schemaStream, final SchemaValidatorsConfig config) {
         try {
-            final JsonNode schemaNode = mapper.readTree(schemaStream);
+            final JsonNode schemaNode = jsonMapper.readTree(schemaStream);
             return newJsonSchema(null, schemaNode, config);
         } catch (IOException ioe) {
             logger.error("Failed to load json schema!", ioe);
@@ -370,7 +384,14 @@ public JsonSchema getSchema(final URI schemaUri, final SchemaValidatorsConfig co
 
             try {
                 inputStream = this.uriFetcher.fetch(mappedUri);
-                final JsonNode schemaNode = mapper.readTree(inputStream);
+
+                final JsonNode schemaNode;
+                if (isYaml(mappedUri)) {
+                    schemaNode = yamlMapper.readTree(inputStream);
+                } else {
+                    schemaNode = jsonMapper.readTree(inputStream);
+                }
+
                 final JsonMetaSchema jsonMetaSchema = findMetaSchemaForSchema(schemaNode);
 
                 JsonSchema jsonSchema;
@@ -428,6 +449,19 @@ private boolean idMatchesSourceUri(final JsonMetaSchema metaSchema, final JsonNo
         return result;
     }
 
+    private boolean isYaml(final URI schemaUri) {
+        final String schemeSpecificPart = schemaUri.getSchemeSpecificPart();
+        final int idx = schemeSpecificPart.lastIndexOf('.');
+
+        if (idx == -1) {
+            // no extension; assume json
+            return false;
+        }
+
+        final String extension = schemeSpecificPart.substring(idx);
+        return (".yml".equals(extension) || ".yaml".equals(extension));
+    }
+
     static protected String normalizeMetaSchemaUri(String u, boolean forceHttps, boolean removeEmptyFragmentSuffix) {
         try {
             URI uri = new URI(u);

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

@@ -0,0 +1,35 @@
+package com.networknt.schema;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+
+import java.io.InputStream;
+
+class Issue668Test {
+    protected JsonSchema getJsonSchemaFromStreamContent(InputStream schemaContent) throws Exception {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7);
+        YAMLMapper mapper = new YAMLMapper();
+        JsonNode node = mapper.readTree(schemaContent);
+        return factory.getSchema(node);
+    }
+
+    protected JsonNode getJsonNodeFromStreamContent(InputStream content) throws Exception {
+        ObjectMapper mapper = new ObjectMapper();
+        return mapper.readTree(content);
+    }
+
+    @Test
+    void shouldHandleReferencesToYaml() throws Exception {
+        String schemaPath = "/schema/issue668.yml";
+        String dataPath = "/data/issue668.json";
+        InputStream schemaInputStream = getClass().getResourceAsStream(schemaPath);
+        JsonSchema schema = getJsonSchemaFromStreamContent(schemaInputStream);
+        InputStream dataInputStream = getClass().getResourceAsStream(dataPath);
+        JsonNode node = getJsonNodeFromStreamContent(dataInputStream);
+        MatcherAssert.assertThat(schema.validate(node), Matchers.empty());
+    }
+}

src/test/resources/data/issue668.json

@@ -0,0 +1,5 @@
+{
+  "sub1": {},
+  "sub2": {},
+  "sub3": {}
+}

src/test/resources/schema/issue668-sub1.yml

@@ -0,0 +1 @@
+type: object

src/test/resources/schema/issue668-sub2.yaml

@@ -0,0 +1 @@
+type: object

src/test/resources/schema/issue668-sub3

@@ -0,0 +1 @@
+{"type": "object"}

src/test/resources/schema/issue668.yml

@@ -0,0 +1,9 @@
+$id: resource:/schema/issue668
+type: object
+properties:
+  sub1:
+    $ref: issue668-sub1.yml
+  sub2:
+    $ref: issue668-sub2.yaml
+  sub3:
+    $ref: issue668-sub3