-
Notifications
You must be signed in to change notification settings - Fork 196
/
JSONAssert.java
408 lines (384 loc) · 15.9 KB
/
JSONAssert.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
package org.skyscreamer.jsonassert;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.skyscreamer.jsonassert.comparator.JSONComparator;
/**
* <p>A set of assertion methods useful for writing tests methods that return JSON.</p>
*
* <p>There are two modes, strict and non-strict. In most cases, you will probably want
* to set strict to <i>false</i>, since that will make the tests less brittle.</p>
*
* <p>Strict tests require all of the elements requested to be returned, and only those elements
* (ie, the tests are non-extensible). Arrays of elements must be returned in the same
* order as expected. For example, say I'm expecting:</p>
*
* <code>{id:123,things['a','b','c']}</code>
*
* <p>The following would match when doing non-strict checking, but would fail on strict checking:</p>
*
* <code>{id:123,things['c','b','a'],anotherfield:'blah'}</code>
*
* <p><i>This library uses org.json. It has fewer dependencies than other JSON libraries (like net.sf.json),
* making JSONassert more portable.</i></p>
*
* <p>There are two known issues when dealing with non-strict comparisons:</p>
* <ul>
* <li>Unless the order is strict, checking does not handle mixed types in the JSONArray
* (e.g. <code>[1,2,{a:"b"}]</code> or <code>[{pet:"cat"},{car:"Ford"}]</code>)</li>
* <li>Unless the order is strict, checking cannot handle arrays of arrays (e.g. <code>[[1,2],[3,4]]</code>)</li>
* </ul>
* <p>You do not have to worry about encountering a false positive or false negative in these two edge cases.
* <i>JSONassert</i> will identify the conditions and throw a descriptive {@link IllegalArgumentException}. These
* cases will be fixed in future versions.</p>
*
*/
public class JSONAssert {
private JSONAssert() {}
/**
* Asserts that the JSONObject provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actual JSONObject to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertEquals(String expectedStr, JSONObject actual, boolean strict)
throws JSONException {
assertEquals(expectedStr, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONObject provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @see #assertEquals(String JSONObject, boolean)
*
* @param expectedStr Expected JSON string
* @param actual JSONObject to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, JSONObject actual, boolean strict)
throws JSONException {
assertNotEquals(expectedStr, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONObject provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actual JSONObject to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertEquals(String expectedStr, JSONObject actual, JSONCompareMode compareMode)
throws JSONException {
Object expected = JSONParser.parseJSON(expectedStr);
if (expected instanceof JSONObject) {
assertEquals((JSONObject)expected, actual, compareMode);
}
else {
throw new AssertionError("Expecting a JSON array, but passing in a JSON object");
}
}
/**
* Asserts that the JSONObject provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @see #assertEquals(String, JSONObject, JSONCompareMode)
*
* @param expectedStr Expected JSON string
* @param actual JSONObject to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, JSONObject actual, JSONCompareMode compareMode)
throws JSONException {
Object expected = JSONParser.parseJSON(expectedStr);
if (expected instanceof JSONObject) {
assertNotEquals((JSONObject) expected, actual, compareMode);
}
else {
throw new AssertionError("Expecting a JSON array, but passing in a JSON object");
}
}
/**
* Asserts that the JSONArray provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actual JSONArray to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertEquals(String expectedStr, JSONArray actual, boolean strict)
throws JSONException {
assertEquals(expectedStr, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONArray provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actual JSONArray to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, JSONArray actual, boolean strict)
throws JSONException {
assertNotEquals(expectedStr, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONArray provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actual JSONArray to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertEquals(String expectedStr, JSONArray actual, JSONCompareMode compareMode)
throws JSONException {
Object expected = JSONParser.parseJSON(expectedStr);
if (expected instanceof JSONArray) {
assertEquals((JSONArray) expected, actual, compareMode);
}
else {
throw new AssertionError("Expecting a JSON object, but passing in a JSON array");
}
}
/**
* Asserts that the JSONArray provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actual JSONArray to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, JSONArray actual, JSONCompareMode compareMode)
throws JSONException {
Object expected = JSONParser.parseJSON(expectedStr);
if (expected instanceof JSONArray) {
assertNotEquals((JSONArray) expected, actual, compareMode);
}
else {
throw new AssertionError("Expecting a JSON object, but passing in a JSON array");
}
}
/**
* Asserts that the JSONArray provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actualStr String to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertEquals(String expectedStr, String actualStr, boolean strict)
throws JSONException {
assertEquals(expectedStr, actualStr, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONArray provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actualStr String to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, String actualStr, boolean strict)
throws JSONException {
assertNotEquals(expectedStr, actualStr, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONArray provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actualStr String to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertEquals(String expectedStr, String actualStr, JSONCompareMode compareMode)
throws JSONException {
if (expectedStr==actualStr) return;
if (expectedStr==null){
throw new AssertionError("Expected string is null.");
}else if (actualStr==null){
throw new AssertionError("Actual string is null.");
}
JSONCompareResult result = JSONCompare.compareJSON(expectedStr, actualStr, compareMode);
if (result.failed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the JSONArray provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actualStr String to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, String actualStr, JSONCompareMode compareMode)
throws JSONException {
JSONCompareResult result = JSONCompare.compareJSON(expectedStr, actualStr, compareMode);
if (result.passed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the json string provided matches the expected string. If it isn't it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actualStr String to compare
* @param comparator Comparator
* @throws JSONException
*/
public static void assertEquals(String expectedStr, String actualStr, JSONComparator comparator)
throws JSONException {
JSONCompareResult result = JSONCompare.compareJSON(expectedStr, actualStr, comparator);
if (result.failed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the json string provided does not match the expected string. If it is it throws an
* {@link AssertionError}.
*
* @param expectedStr Expected JSON string
* @param actualStr String to compare
* @param comparator Comparator
* @throws JSONException
*/
public static void assertNotEquals(String expectedStr, String actualStr, JSONComparator comparator)
throws JSONException {
JSONCompareResult result = JSONCompare.compareJSON(expectedStr, actualStr, comparator);
if (result.passed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the JSONObject provided matches the expected JSONObject. If it isn't it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONObject
* @param actual JSONObject to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertEquals(JSONObject expected, JSONObject actual, boolean strict)
throws JSONException {
assertEquals(expected, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONObject provided does not match the expected JSONObject. If it is it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONObject
* @param actual JSONObject to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertNotEquals(JSONObject expected, JSONObject actual, boolean strict)
throws JSONException {
assertNotEquals(expected, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONObject provided matches the expected JSONObject. If it isn't it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONObject
* @param actual JSONObject to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertEquals(JSONObject expected, JSONObject actual, JSONCompareMode compareMode)
throws JSONException
{
JSONCompareResult result = JSONCompare.compareJSON(expected, actual, compareMode);
if (result.failed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the JSONObject provided does not match the expected JSONObject. If it is it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONObject
* @param actual JSONObject to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertNotEquals(JSONObject expected, JSONObject actual, JSONCompareMode compareMode)
throws JSONException
{
JSONCompareResult result = JSONCompare.compareJSON(expected, actual, compareMode);
if (result.passed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the JSONArray provided matches the expected JSONArray. If it isn't it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONArray
* @param actual JSONArray to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertEquals(JSONArray expected, JSONArray actual, boolean strict)
throws JSONException {
assertEquals(expected, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONArray provided does not match the expected JSONArray. If it is it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONArray
* @param actual JSONArray to compare
* @param strict Enables strict checking
* @throws JSONException
*/
public static void assertNotEquals(JSONArray expected, JSONArray actual, boolean strict)
throws JSONException {
assertNotEquals(expected, actual, strict ? JSONCompareMode.STRICT : JSONCompareMode.LENIENT);
}
/**
* Asserts that the JSONArray provided matches the expected JSONArray. If it isn't it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONArray
* @param actual JSONArray to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertEquals(JSONArray expected, JSONArray actual, JSONCompareMode compareMode)
throws JSONException {
JSONCompareResult result = JSONCompare.compareJSON(expected, actual, compareMode);
if (result.failed()) {
throw new AssertionError(result.getMessage());
}
}
/**
* Asserts that the JSONArray provided does not match the expected JSONArray. If it is it throws an
* {@link AssertionError}.
*
* @param expected Expected JSONArray
* @param actual JSONArray to compare
* @param compareMode Specifies which comparison mode to use
* @throws JSONException
*/
public static void assertNotEquals(JSONArray expected, JSONArray actual, JSONCompareMode compareMode)
throws JSONException {
JSONCompareResult result = JSONCompare.compareJSON(expected, actual, compareMode);
if (result.passed()) {
throw new AssertionError(result.getMessage());
}
}
}