1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
package com.networknt.schema;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.networknt.schema.walk.JsonSchemaWalkListener;
import com.networknt.schema.walk.WalkEvent;
import com.networknt.schema.walk.WalkFlow;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.TreeSet;
import static org.junit.jupiter.api.Assertions.assertEquals;
public class JsonWalkTest {
private JsonSchema jsonSchema;
private JsonSchema jsonSchema1;
private static final String SAMPLE_WALK_COLLECTOR_TYPE = "sampleWalkCollectorType";
private static final String CUSTOM_KEYWORD = "custom-keyword";
@BeforeEach
public void setup() {
setupSchema();
}
private void setupSchema() {
final JsonMetaSchema metaSchema = getJsonMetaSchema();
// Create Schema.
SchemaValidatorsConfig schemaValidatorsConfig = new SchemaValidatorsConfig();
schemaValidatorsConfig.addKeywordWalkListener(new AllKeywordListener());
schemaValidatorsConfig.addKeywordWalkListener(ValidatorTypeCode.REF.getValue(), new RefKeywordListener());
schemaValidatorsConfig.addKeywordWalkListener(ValidatorTypeCode.PROPERTIES.getValue(),
new PropertiesKeywordListener());
final JsonSchemaFactory schemaFactory = JsonSchemaFactory
.builder(JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909)).metaSchema(metaSchema)
.build();
this.jsonSchema = schemaFactory.getSchema(getSchema(), schemaValidatorsConfig);
// Create another Schema.
SchemaValidatorsConfig schemaValidatorsConfig1 = new SchemaValidatorsConfig();
schemaValidatorsConfig1.addKeywordWalkListener(ValidatorTypeCode.REF.getValue(), new RefKeywordListener());
schemaValidatorsConfig1.addKeywordWalkListener(ValidatorTypeCode.PROPERTIES.getValue(),
new PropertiesKeywordListener());
this.jsonSchema1 = schemaFactory.getSchema(getSchema(), schemaValidatorsConfig1);
}
private JsonMetaSchema getJsonMetaSchema() {
return JsonMetaSchema.builder(
"https://github.com/networknt/json-schema-validator/tests/schemas/example01", JsonMetaSchema.getV201909())
.keyword(new CustomKeyword()).build();
}
@Test
public void testWalk() throws IOException {
ObjectMapper objectMapper = new ObjectMapper();
ValidationResult result = jsonSchema.walk(
objectMapper.readTree(getClass().getClassLoader().getResourceAsStream("data/walk-data.json")), false);
JsonNode collectedNode = (JsonNode) result.getCollectorContext().get(SAMPLE_WALK_COLLECTOR_TYPE);
assertEquals(collectedNode, (objectMapper.readTree("{" +
" \"PROPERTY1\": \"sample1\","
+ " \"PROPERTY2\": \"sample2\","
+ " \"property3\": {"
+ " \"street_address\":\"test-address\","
+ " \"phone_number\": {"
+ " \"country-code\": \"091\","
+ " \"number\": \"123456789\""
+ " }"
+ " }"
+ "}")));
}
@Test
public void testWalkWithDifferentListeners() throws IOException {
ObjectMapper objectMapper = new ObjectMapper();
// This instance of schema contains all listeners.
ValidationResult result = jsonSchema.walk(
objectMapper.readTree(getClass().getClassLoader().getResourceAsStream("data/walk-data.json")), false);
JsonNode collectedNode = (JsonNode) result.getCollectorContext().get(SAMPLE_WALK_COLLECTOR_TYPE);
assertEquals(collectedNode, (objectMapper.readTree("{" +
" \"PROPERTY1\": \"sample1\","
+ " \"PROPERTY2\": \"sample2\","
+ " \"property3\": {"
+ " \"street_address\":\"test-address\","
+ " \"phone_number\": {"
+ " \"country-code\": \"091\","
+ " \"number\": \"123456789\""
+ " }"
+ " }"
+ "}")));
// This instance of schema contains one listener removed.
result = jsonSchema1.walk(objectMapper.readTree(getClass().getClassLoader().getResourceAsStream("data/walk-data.json")), false);
collectedNode = (JsonNode) result.getExecutionContext().getCollectorContext().get(SAMPLE_WALK_COLLECTOR_TYPE);
assertEquals(collectedNode, (objectMapper.readTree("{"
+ " \"property3\": {"
+ " \"street_address\":\"test-address\","
+ " \"phone_number\": {"
+ " \"country-code\": \"091\","
+ " \"number\": \"123456789\""
+ " }"
+ " }"
+ "}")));
}
private InputStream getSchema() {
return getClass().getClassLoader().getResourceAsStream("schema/walk-schema.json");
}
/**
* Our own custom keyword.
*/
private static class CustomKeyword implements Keyword {
@Override
public String getValue() {
return "custom-keyword";
}
@Override
public JsonValidator newValidator(SchemaLocation schemaLocation, JsonNodePath evaluationPath, JsonNode schemaNode,
JsonSchema parentSchema, ValidationContext validationContext) throws JsonSchemaException {
if (schemaNode != null && schemaNode.isArray()) {
return new CustomValidator(schemaLocation, evaluationPath, schemaNode);
}
return null;
}
/**
* We will be collecting information/data by adding the data in the form of
* collectors into collector context object while we are validating this node.
* This will be helpful in cases where we don't want to revisit the entire JSON
* document again just for gathering this kind of information.
*/
private static class CustomValidator extends AbstractJsonValidator {
public CustomValidator(SchemaLocation schemaLocation, JsonNodePath evaluationPath, JsonNode schemaNode) {
super(schemaLocation, evaluationPath, new CustomKeyword(), schemaNode);
}
@Override
public Set<ValidationMessage> validate(ExecutionContext executionContext, JsonNode node, JsonNode rootNode, JsonNodePath instanceLocation) {
return new TreeSet<ValidationMessage>();
}
@Override
public Set<ValidationMessage> walk(ExecutionContext executionContext, JsonNode node, JsonNode rootNode,
JsonNodePath instanceLocation, boolean shouldValidateSchema) {
return new LinkedHashSet<ValidationMessage>();
}
}
}
private static class AllKeywordListener implements JsonSchemaWalkListener {
@Override
public WalkFlow onWalkStart(WalkEvent keywordWalkEvent) {
ObjectMapper mapper = new ObjectMapper();
String keyWordName = keywordWalkEvent.getKeyword();
JsonNode schemaNode = keywordWalkEvent.getSchemaNode();
CollectorContext collectorContext = keywordWalkEvent.getExecutionContext().getCollectorContext();
if (collectorContext.get(SAMPLE_WALK_COLLECTOR_TYPE) == null) {
collectorContext.add(SAMPLE_WALK_COLLECTOR_TYPE, mapper.createObjectNode());
}
if (keyWordName.equals(CUSTOM_KEYWORD) && schemaNode.get(CUSTOM_KEYWORD).isArray()) {
ObjectNode objectNode = (ObjectNode) collectorContext.get(SAMPLE_WALK_COLLECTOR_TYPE);
objectNode.put(keywordWalkEvent.getSchemaNode().get("title").textValue().toUpperCase(),
keywordWalkEvent.getNode().textValue());
}
return WalkFlow.CONTINUE;
}
@Override
public void onWalkEnd(WalkEvent keywordWalkEvent, Set<ValidationMessage> validationMessages) {
}
}
private static class RefKeywordListener implements JsonSchemaWalkListener {
@Override
public WalkFlow onWalkStart(WalkEvent keywordWalkEvent) {
ObjectMapper mapper = new ObjectMapper();
CollectorContext collectorContext = keywordWalkEvent.getExecutionContext().getCollectorContext();
if (collectorContext.get(SAMPLE_WALK_COLLECTOR_TYPE) == null) {
collectorContext.add(SAMPLE_WALK_COLLECTOR_TYPE, mapper.createObjectNode());
}
ObjectNode objectNode = (ObjectNode) collectorContext.get(SAMPLE_WALK_COLLECTOR_TYPE);
objectNode.set(keywordWalkEvent.getSchemaNode().get("title").textValue().toLowerCase(),
keywordWalkEvent.getNode());
return WalkFlow.SKIP;
}
@Override
public void onWalkEnd(WalkEvent keywordWalkEvent, Set<ValidationMessage> validationMessages) {
}
}
private static class PropertiesKeywordListener implements JsonSchemaWalkListener {
@Override
public WalkFlow onWalkStart(WalkEvent keywordWalkEvent) {
JsonNode schemaNode = keywordWalkEvent.getSchemaNode();
if (schemaNode.get("title").textValue().equals("Property3")) {
return WalkFlow.SKIP;
}
return WalkFlow.CONTINUE;
}
@Override
public void onWalkEnd(WalkEvent keywordWalkEvent, Set<ValidationMessage> validationMessages) {
}
}
}
|
