/
MatchingTest.java
493 lines (420 loc) · 15.3 KB
/
MatchingTest.java
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
package jsonmatch;
import com.fasterxml.jackson.databind.ObjectMapper;
import junit.framework.AssertionFailedError;
import org.buildobjects.doctest.runtime.junit4.DocufierRule;
import org.junit.Assert;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import static java.nio.charset.StandardCharsets.UTF_8;
import static jsonmatch.JsonMatch.*;
import static jsonmatch.util.Color.*;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
/**
* [DOC file=README.md]
*
* [![Build Status](https://travis-ci.com/softwaretechnik-berlin/jsonmatch.svg?branch=main)](https://travis-ci.com/softwaretechnik-berlin/jsonmatch)
* [![Maven Central](https://img.shields.io/maven-central/v/berlin.softwaretechnik/jsonmatch.svg?maxAge=3600)](https://mvnrepository.com/artifact/berlin.softwaretechnik/jsonmatch)
*
* `jsonmatch` is a library that helps with verifying JSON results
* in test cases. It provides a DSL to specify expectations,
* which is much nicer to use in Java than providing, e.g.
* JSON string literals. It also provides a visualisation of
* the test result that provides a view of the actual result,
* projected through the expectation that has been set up.
* Currently the visualisation uses ANSI coloured output.
*
* How to start with Maven:
*
* ~~~.xml
* <dependency>
* <groupId>berlin.softwaretechnik</groupId>
* <artifactId>jsonmatch</artifactId>
* <version>0.0.6</version>
* <scope>test</scope> <!-- If you only want to use jsonmatch in your tests. -->
* </dependency>
* ~~~
* **Note**: This file is generated from the [acceptance test](src/test/java/jsonmatch/MatchingTest.java). To make
* changes please edit the acceptance test.
*
*
*/
public class MatchingTest {
@Rule
public final DocufierRule doc = new DocufierRule();
/**
* This is how `jsonmatch` can be used in a test:
*/
@Test
@Ignore
public void useInAssertion() {
String result = "{\"a\":\"x\",\"b\":42,\"c\":\"X\",\"extra\":\"value\"}";
assertMatches(result, object()
.with("a", eq("x"))
.with("b", eq(42))
.with("c", eq("y"))
.with("d", eq("z"))
);
}
/**
* If run in the IDE, the test failure will look like this:
*
* ![](assertion-failure-intellij.png)
*
* The `assertMatches` method is actually not part of `jsonmatch` (yet).
* A possible implementation for JUnit4 could look like this:
*/
private void assertMatches(String json, Matcher matcher) {
Result result = matcher.match(json);
if (result.isMatch()) {
return;
}
throw new AssertionFailedError("\nJson didn't match expectation:\n" + result.visualize());
}
/**
* [NO-DOC]
*/
private void assertMatches(String json, MatcherBuilder matcherBuilder) {
assertMatches(json, matcherBuilder.build());
}
/**
* `jsonmatch` has a couple of static factory methods that serve as the
* main interface, that can be imported as follows:
*
* ~~~.java
* import jsonmatch.JsonMatch.*
* ~~~
*
* The main concepts in jsonmatch are `Matcher`s that can try to match
* `JsonNode`s or `String`s and `Result`s that know whether they
* represent a successful match and that can visualize the match (attempt).
*
* More Examples
* -------------
* Let's look at some more cases. We are using a special
* rendering of Java code, that allows us to have inline json literals
* and also we have an inline rendering of ANSI-coloured Strings. To take
* advantage of the full colouring make sure you look at this file
* in [github pages](https://softwaretechnik-berlin.github.io/jsonmatch/).
*
* Matching Simple Objects
* -----------------------
*
* The happy path case:
*/
@Test
public void simpleObjectMatch() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", eq("y"))
.with("z", eq(12))
.with("d", eq(false))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\", \"b\":\"y\", \"z\":12, \"d\": false}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[32m\"y\"\u001B[0m,\n" +
" \"z\": \u001B[32m12\u001B[0m,\n" +
" \"d\": \u001B[32mfalse\u001B[0m\n" +
"}\n", this::prettyAnsi), result.visualize());
assertTrue(result.isMatch());
}
/**
* By default the object matcher ignores extra fields.
* However it displays the extra information in gray:
*/
@Test
public void simpleObjectMatchIgnoreExtraData() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", eq("y"))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":\"y\", \"z\": 12}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[32m\"y\"\u001B[0m,\n" +
" \u001B[90m\"z\": \u001B[0m\u001B[90m12\u001B[0m\n" +
"}" +
"\n", this::prettyAnsi), result.visualize());
assertTrue(result.isMatch());
}
/**
* We can also choose to elide the values of ignored fields:
*/
@Test
public void simpleObjectMatchElideIgnoredFields() {
Matcher matcher = object()
.elideIgnoredFieldValues(true)
.with("a", eq("x"))
.with("b", eq("y"))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":\"y\", \"z\": 12}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[32m\"y\"\u001B[0m,\n" +
" \u001B[90m\"z\": \u001B[0m\u001B[90m…\u001B[0m\n" +
"}" +
"\n", this::prettyAnsi), result.visualize());
assertTrue(result.isMatch());
}
/**
* If the matcher is configured not to ignore extra fields
* it will fail as follows:
*/
@Test
public void simpleObjectMatchFailOnExtraData() {
Matcher matcher = object()
.ignoreExtraFields(false)
.with("a", eq("x"))
.with("b", eq("y"))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":\"y\", \"z\": 12}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[32m\"y\"\u001B[0m,\n" +
" \u001B[31m\"z\": \u001B[0m\u001B[31m12\u001B[0m unexpected field\n" +
"}\n", this::prettyAnsi), result.visualize());
assertFalse(result.isMatch());
}
/**
* Obviously field values need to match the expectation:
*/
@Test
public void simpleObjectMismatch() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", eq("o"))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":\"y\"}", this::prettyJson));
assertFalse(result.isMatch());
assertEquals(doc.tap(
"{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[31m\"y\"\u001B[0m expected \"o\"\n" +
"}\n", this::prettyAnsi),
result.visualize()
);
}
/**
* Missing fields will also fail to match:
*/
@Test
public void simpleObjectMissingField() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", eq("o"))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\"}", this::prettyJson));
assertEquals(doc.tap(
"{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \u001B[31m\"b\": \u001B[0mis missing\n" +
"}\n", this::prettyAnsi),
result.visualize()
);
assertFalse(result.isMatch());
}
/**
* Sometimes we want to give context on a particular expection:
*/
@Test
public void simpleObjectAnnotation() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", annotate(eq(42), "This is the answer, obviously."))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":42}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[32m42\u001B[0m ╶ This is the answer, obviously.\n" +
"}\n", this::prettyAnsi),
result.visualize()
);
assertTrue(result.isMatch());
}
/**
* Matching Arrays
* ---------------
* <p>
* We can also match elements of an array.
* Currently only an exact match is implemented, however
* more match modes, like all `ignoreExtraElements`,
* `ignoreOrder` can easily be added. Here a basic
* example:
*/
@Test
public void simpleArrayMatch() {
Matcher matcher = array()
.with(eq("Hello"))
.with(eq("World"))
.build();
Result result = matcher.match(doc.tap("[\"Hello\", \"World\"]", this::prettyJson));
assertTrue(result.isMatch());
assertEquals(doc.tap("[\n" +
" \u001B[32m\"Hello\"\u001B[0m,\n" +
" \u001B[32m\"World\"\u001B[0m\n" +
"]\n", this::prettyAnsi), result.visualize());
}
/**
* This is what a failed match on an array element looks like:
*/
@Test
public void simpleArrayMismatch() {
Matcher matcher = array()
.with(eq("Hello"))
.with(eq("World"))
.build();
Result result = matcher.match(doc.tap("[\"Hello\", \"Boat\"]", this::prettyJson));
assertFalse(result.isMatch());
assertEquals(doc.tap("[\n" +
" \u001B[32m\"Hello\"\u001B[0m,\n" +
" \u001B[31m\"Boat\"\u001B[0m expected \"World\"\n" +
"]\n", this::prettyAnsi), result.visualize());
}
/**
* Nested Objects
* --------------
* <p>
* We can also match on nested structures. Actually
* matchers support arbitrary nesting:
*/
@Test
public void nestedObjectMatch() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", object()
.with("c", eq("y"))
.with("d", eq("z"))
.build()
)
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":{\"c\": \"y\", \"d\": \"z\"}}", this::prettyJson));
assertTrue(result.isMatch());
assertEquals(doc.tap(
"{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": {\n" +
" \"c\": \u001B[32m\"y\"\u001B[0m,\n" +
" \"d\": \u001B[32m\"z\"\u001B[0m\n" +
" }\n" +
"}\n", this::prettyAnsi), result.visualize()
);
}
/**
* Annotations makes sense especially for bigger longer results.
* Here an example where a nested object is annotated.
*/
@Test
public void nestedObjectAnnotated() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", annotate(
object()
.with("c", eq("y"))
.with("d", eq("z"))
.build(),
"This is a nested structure."
))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":{\"c\": \"y\", \"d\": \"z\"}}", this::prettyJson));
assertTrue(result.isMatch());
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": { ╮\n" +
" \"c\": \u001B[32m\"y\"\u001B[0m, ├ This is a nested structure.\n" +
" \"d\": \u001B[32m\"z\"\u001B[0m │\n" +
" } ╯\n" +
"}\n", this::prettyAnsi), result.visualize()
);
}
/**
* This is what a mismatch on a nested object looks like:
*/
@Test
public void nestedObjectMismatch() {
Matcher matcher = object()
.with("a", eq("x"))
.with("b", object()
.with("c", eq("y"))
.with("d", eq("z"))
.build()
)
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":{\"c\": \"y\", \"d\": \"42\"}}", this::prettyJson));
assertFalse(result.isMatch());
assertEquals(doc.tap(
"{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": {\n" +
" \"c\": \u001B[32m\"y\"\u001B[0m,\n" +
" \"d\": \u001B[31m\"42\"\u001B[0m expected \"z\"\n" +
" }\n" +
"}\n", this::prettyAnsi),
result.visualize()
);
}
/**
* [NO-DOC]
*/
void assertEquals(String expected, String actual) {
System.out.println(actual);
Assert.assertEquals(expected, actual);
}
/**
* [NO-DOC]
*/
private String prettyJson(String t) {
try {
return new ObjectMapper()
.readTree(new ByteArrayInputStream(t.getBytes(UTF_8)))
.toPrettyString();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
/**
* [NO-DOC]
*/
private String prettyAnsi(String t) {
return
t
.replace(RED.getAnsi(), "<span style=\"color:red\">")
.replace(GREEN.getAnsi(), "<span style=\"color:green\">")
.replace(ANSI_RESET, "</span>")
.replace(GRAY.getAnsi(), "<span style=\"color:gray\">")
;
}
/** [NO-DOC] */
@Test
public void dealsWithNull(){
Matcher matcher = object()
.with("a", eq("x"))
.with("b", eq("y"))
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":null, \"z\": null}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[31mexpected <String>\u001B[0m but got <Null>,\n" +
" \u001B[90m\"z\": \u001B[0m\u001B[90mnull\u001B[0m\n" +
"}\n", this::prettyAnsi), result.visualize());
assertFalse(result.isMatch());
}
/** We can also match `null`: */
@Test
public void expectNull(){
Matcher matcher = object()
.with("a", eq("x"))
.with("b", isNull())
.build();
Result result = matcher.match(doc.tap("{\"a\":\"x\",\"b\":null, \"z\": null}", this::prettyJson));
assertEquals(doc.tap("{\n" +
" \"a\": \u001B[32m\"x\"\u001B[0m,\n" +
" \"b\": \u001B[32mnull\u001B[0m,\n" +
" \u001B[90m\"z\": \u001B[0m\u001B[90mnull\u001B[0m\n" +
"}\n", this::prettyAnsi), result.visualize());
assertTrue(result.isMatch());
}
}