Merge pull request #263 from rzukowski/255_issue_id_ref

255 issue id ref

Author: stevehu

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

@@ -325,7 +325,11 @@ public String readId(JsonNode schemaNode) {
     public String getUri() {
         return uri;
     }
-    
+
+    public String getIdKeyword() {
+        return idKeyword;
+    }
+
     public JsonValidator newValidator(ValidationContext validationContext, String schemaPath, String keyword /* keyword */, JsonNode schemaNode,
             JsonSchema parentSchema) {
 

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

@@ -38,6 +38,7 @@
 public class JsonSchema extends BaseJsonValidator {
     private static final Pattern intPattern = Pattern.compile("^[0-9]+$");
     protected final Map<String, JsonValidator> validators;
+    private final String idKeyword;
     private final ValidationContext validationContext;
 
     /**
@@ -72,6 +73,7 @@ private JsonSchema(ValidationContext validationContext,  String schemaPath, URI
             validationContext.getConfig() != null && validationContext.getConfig().isFailFast());
         this.validationContext = validationContext;
         this.config = validationContext.getConfig();
+        this.idKeyword = validationContext.getMetaSchema().getIdKeyword();
         this.currentUri = this.combineCurrentUriWithIds(currentUri, schemaNode);
         this.validators = Collections.unmodifiableMap(this.read(schemaNode));
     }
@@ -119,16 +121,19 @@ public JsonNode getRefSchemaNode(String ref) {
                     node = node.get(key);
                 }
                 if (node == null){
-                    JsonSchema subSchema = schema.fetchSubSchemaNode(validationContext);
-                    if (subSchema != null) {
-                        node = subSchema.getRefSchemaNode(ref);
-                    }
+                    node = handleNullNode(ref, schema);
                 }
                 if (node == null){
                     break;
                 }
             }
         }
+        else if (ref.startsWith("#") && ref.length() > 1) {
+            node = getNodeById(ref, node);
+            if(node == null) {
+                node = handleNullNode(ref, schema);
+            }
+        }
         return node;
     }
 
@@ -140,6 +145,37 @@ public JsonSchema findAncestor() {
         return ancestor;
     }
 
+    private JsonNode handleNullNode(String ref, JsonSchema schema) {
+        JsonSchema subSchema = schema.fetchSubSchemaNode(validationContext);
+        if (subSchema != null) {
+            return subSchema.getRefSchemaNode(ref);
+        }
+        return null;
+    }
+
+    private JsonNode getNodeById(String ref, JsonNode node) {
+        if (nodeContainsRef(ref, node)) {
+            return node;
+        } else {
+            Iterator<JsonNode> children = node.elements();
+            while (children.hasNext()) {
+                JsonNode refNode = getNodeById(ref, children.next());
+                if (refNode != null) {
+                    return refNode;
+                }
+            }
+        }
+        return null;
+    }
+
+    private boolean nodeContainsRef(String ref, JsonNode node) {
+        JsonNode id = node.get(idKeyword);
+        if (id != null) {
+            return ref.equals(id.asText());
+        }
+        return false;
+    }
+
     private Map<String, JsonValidator> read(JsonNode schemaNode) {
         Map<String, JsonValidator> validators = new HashMap<String, JsonValidator>();
         if(schemaNode.isBoolean()) {

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

@@ -78,4 +78,7 @@ public JsonSchemaRef getReferenceParsingInProgress(String refValue) {
         return refParsingInProgress.get(refValue);
     }
 
+    protected JsonMetaSchema getMetaSchema() {
+        return metaSchema;
+    }
 }

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

@@ -279,6 +279,11 @@ public void testRefRemoteValidator() throws Exception {
         runTestFile("draft4/refRemote.json");
     }
 
+    @Test
+    public void testRefIdReference() throws Exception {
+        runTestFile("draft4/idRef.json");
+    }
+
     @Test
     public void testRelativeRefRemoteValidator() throws Exception {
         runTestFile("draft4/relativeRefRemote.json");
@@ -289,7 +294,6 @@ public void testRequiredValidator() throws Exception {
         runTestFile("draft4/required.json");
     }
 
-
     @Test
     public void testTypeValidator() throws Exception {
         runTestFile("draft4/type.json");

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

@@ -291,6 +291,11 @@ public void testRefRemoteValidator() throws Exception {
         runTestFile("draft6/refRemote.json");
     }
 
+    @Test
+    public void testRefIdReference() throws Exception {
+        runTestFile("draft6/idRef.json");
+    }
+
     @Test
     @Ignore
     public void testRefRemoteValidator_Ignored() throws Exception {

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

@@ -392,6 +392,11 @@ public void testRefRemoteValidator() throws Exception {
         runTestFile("draft7/refRemote.json");
     }
 
+    @Test
+    public void testRefIdReference() throws Exception {
+        runTestFile("draft7/idRef.json");
+    }
+
     @Test
     @Ignore
     public void testRefRemoteValidator_Ignored() throws Exception {

src/test/resources/draft4/idRef.json

@@ -0,0 +1,54 @@
+[
+  {
+    "description": "refer to subschema by a unique name ($id)",
+    "schema": {
+      "type": "object",
+      "properties": {
+        "cars": {
+          "type": "array",
+          "items": {
+            "$ref": "#car"
+          }
+        }
+      },
+      "definitions": {
+        "car": {
+          "id": "#car",
+          "type": "object",
+          "properties": {
+            "model": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "model"
+          ]
+        }
+      }
+    },
+    "tests": [
+      {
+        "description": "invalid when element referenced by id is invalid",
+        "data": {
+          "cars": [
+            {
+
+            }
+          ]
+        },
+        "valid": false
+      },
+      {
+        "description": "valid when element referenced by id is valid",
+        "data": {
+          "cars": [
+            {
+              "model": "BMW"
+            }
+          ]
+        },
+        "valid": true
+      }
+    ]
+  }
+]

src/test/resources/draft6/idRef.json

@@ -0,0 +1,54 @@
+[
+  {
+    "description": "refer to subschema by a unique name ($id)",
+    "schema": {
+      "type": "object",
+      "properties": {
+        "cars": {
+          "type": "array",
+          "items": {
+            "$ref": "#car"
+          }
+        }
+      },
+      "definitions": {
+        "car": {
+          "$id": "#car",
+          "type": "object",
+          "properties": {
+            "model": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "model"
+          ]
+        }
+      }
+    },
+    "tests": [
+      {
+        "description": "invalid when element referenced by id is invalid",
+        "data": {
+          "cars": [
+            {
+
+            }
+          ]
+        },
+        "valid": false
+      },
+      {
+        "description": "valid when element referenced by id is valid",
+        "data": {
+          "cars": [
+            {
+              "model": "BMW"
+            }
+          ]
+        },
+        "valid": true
+      }
+    ]
+  }
+]

src/test/resources/draft7/idRef.json

@@ -0,0 +1,54 @@
+[
+  {
+    "description": "refer to subschema by a unique name ($id)",
+    "schema": {
+      "type": "object",
+      "properties": {
+        "cars": {
+          "type": "array",
+          "items": {
+            "$ref": "#car"
+          }
+        }
+      },
+      "definitions": {
+        "car": {
+          "$id": "#car",
+          "type": "object",
+          "properties": {
+            "model": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "model"
+          ]
+        }
+      }
+    },
+    "tests": [
+      {
+        "description": "invalid when element referenced by id is invalid",
+        "data": {
+          "cars": [
+            {
+
+            }
+          ]
+        },
+        "valid": false
+      },
+      {
+        "description": "valid when element referenced by id is valid",
+        "data": {
+          "cars": [
+            {
+              "model": "BMW"
+            }
+          ]
+        },
+        "valid": true
+      }
+    ]
+  }
+]