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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
use crate::JsonTest;
use jsonpath_rust::JsonPath;
use serde_json::{Map, Value};
use std::str::FromStr;
/// Provides assertions for JSON values accessed via JSONPath expressions.
///
/// This struct is created by `JsonTest::assert_path()` and enables a fluent API
/// for testing JSON values. All assertion methods follow a builder pattern,
/// returning `&mut Self` for chaining.
///
/// # Examples
///
/// ```rust
/// use json_test::{JsonTest, PropertyAssertions};
/// use serde_json::json;
///
/// let data = json!({
/// "user": {
/// "name": "John",
/// "age": 30
/// }
/// });
///
/// let mut test = JsonTest::new(&data);
/// test.assert_path("$.user")
/// .exists()
/// .has_property("name")
/// .has_property_value("age", json!(30));
/// ```
#[derive(Debug)]
pub struct JsonPathAssertion<'a> {
pub(crate) path_str: String,
pub(crate) current_values: Vec<Value>,
pub(crate) test: Option<&'a mut JsonTest<'a>>,
}
impl<'a> JsonPathAssertion<'a> {
pub(crate) fn new_with_test(test: &'a mut JsonTest<'a>, json: &'a Value, path: &str) -> Self {
let parsed_path = JsonPath::<Value>::from_str(path)
.unwrap_or_else(|e| panic!("Invalid JSONPath expression: {}", e));
let result = parsed_path.find(json);
let current_values = match result {
Value::Array(values) => {
if !path.contains('[') && values.len() == 1 {
vec![values[0].clone()]
} else {
values
}
}
Value::Null => vec![],
other => vec![other],
};
Self {
path_str: path.to_string(),
current_values,
test: Some(test),
}
}
#[cfg(test)]
pub fn new_for_test(json: &'a Value, path: &str) -> Self {
let parsed_path = JsonPath::<Value>::from_str(path)
.unwrap_or_else(|e| panic!("Invalid JSONPath expression: {}", e));
let result = parsed_path.find(json);
let current_values = match result {
Value::Array(values) => {
if !path.contains('[') && values.len() == 1 {
vec![values[0].clone()]
} else {
values
}
}
Value::Null => vec![],
other => vec![other],
};
Self {
path_str: path.to_string(),
current_values,
test: None,
}
}
/// Asserts that the path exists and has at least one value.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"user": {"name": "John"}});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.user.name")
/// .exists();
/// ```
///
/// # Panics
///
/// Panics if the path does not exist in the JSON structure.
pub fn exists(&'a mut self) -> &'a mut Self {
if self.current_values.is_empty() {
panic!("Path {} does not exist", self.path_str);
}
self
}
/// Asserts that the path does not exist or has no values.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"user": {"name": "John"}});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.user.email")
/// .does_not_exist();
/// ```
///
/// # Panics
///
/// Panics if the path exists in the JSON structure.
pub fn does_not_exist(&'a mut self) -> &'a mut Self {
if !self.current_values.is_empty() {
panic!("Path {} exists but should not. Found values: {:?}",
self.path_str, self.current_values);
}
self
}
/// Asserts that the value at the current path equals the expected value.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"user": {"name": "John"}});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.user.name")
/// .equals(json!("John"));
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value doesn't match the expected value
pub fn equals(&'a mut self, expected: Value) -> &'a mut Self {
match self.current_values.get(0) {
Some(actual) if actual == &expected => self,
Some(actual) => panic!(
"Value mismatch at {}\nExpected: {}\nActual: {}",
self.path_str, expected, actual
),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the value at the current path is a string.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"message": "Hello"});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.message")
/// .is_string();
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a string
pub fn is_string(&'a mut self) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::String(_)) => self,
Some(v) => panic!("Expected string at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the string value contains the given substring.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"email": "test@example.com"});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.email")
/// .contains_string("@example");
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a string
/// - Panics if the string does not contain the substring
pub fn contains_string(&'a mut self, substring: &str) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::String(s)) if s.contains(substring) => self,
Some(Value::String(s)) => panic!(
"String at {} does not contain '{}'\nActual: {}",
self.path_str, substring, s
),
Some(v) => panic!("Expected string at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the string value starts with the given prefix.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"id": "user_123"});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.id")
/// .starts_with("user_");
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a string
/// - Panics if the string does not start with the prefix
pub fn starts_with(&'a mut self, prefix: &str) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::String(s)) if s.starts_with(prefix) => self,
Some(Value::String(s)) => panic!(
"String at {} does not start with '{}'\nActual: {}",
self.path_str, prefix, s
),
Some(v) => panic!("Expected string at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the string value ends with the given suffix.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"file": "document.pdf"});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.file")
/// .ends_with(".pdf");
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a string
/// - Panics if the string does not end with the suffix
pub fn ends_with(&'a mut self, suffix: &str) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::String(s)) if s.ends_with(suffix) => self,
Some(Value::String(s)) => panic!(
"String at {} does not end with '{}'\nActual: {}",
self.path_str, suffix, s
),
Some(v) => panic!("Expected string at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the string value matches the given regular expression pattern.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"email": "test@example.com"});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.email")
/// .matches_pattern(r"^[^@]+@[^@]+\.[^@]+$");
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a string
/// - Panics if the pattern is invalid
/// - Panics if the string does not match the pattern
pub fn matches_pattern(&'a mut self, pattern: &str) -> &'a mut Self {
let regex = regex::Regex::new(pattern)
.unwrap_or_else(|e| panic!("Invalid regex pattern: {}", e));
match self.current_values.get(0) {
Some(Value::String(s)) if regex.is_match(s) => self,
Some(Value::String(s)) => panic!(
"String at {} does not match pattern '{}'\nActual: {}",
self.path_str, pattern, s
),
Some(v) => panic!("Expected string at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the value at the current path is a number.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"count": 42});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.count")
/// .is_number();
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a number
pub fn is_number(&'a mut self) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Number(_)) => self,
Some(v) => panic!("Expected number at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the numeric value is greater than the given value.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"age": 21});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.age")
/// .is_greater_than(18);
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a number
/// - Panics if the value is not greater than the given value
pub fn is_greater_than(&'a mut self, value: i64) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Number(n)) if n.as_i64().map_or(false, |x| x > value) => self,
Some(Value::Number(n)) => panic!(
"Number at {} is not greater than {}\nActual: {}",
self.path_str, value, n
),
Some(v) => panic!("Expected number at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the numeric value is less than the given value.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"temperature": 36});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.temperature")
/// .is_less_than(40);
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a number
/// - Panics if the value is not less than the given value
pub fn is_less_than(&'a mut self, value: i64) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Number(n)) if n.as_i64().map_or(false, |x| x < value) => self,
Some(Value::Number(n)) => panic!(
"Number at {} is not less than {}\nActual: {}",
self.path_str, value, n
),
Some(v) => panic!("Expected number at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the numeric value is between the given minimum and maximum values (inclusive).
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"score": 85});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.score")
/// .is_between(0, 100);
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not a number
/// - Panics if the value is not between min and max (inclusive)
pub fn is_between(&'a mut self, min: i64, max: i64) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Number(n)) if n.as_i64().map_or(false, |x| x >= min && x <= max) => self,
Some(Value::Number(n)) => panic!(
"Number at {} is not between {} and {}\nActual: {}",
self.path_str, min, max, n
),
Some(v) => panic!("Expected number at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the value at the current path is an array.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"tags": ["rust", "testing"]});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.tags")
/// .is_array();
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not an array
pub fn is_array(&'a mut self) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Array(_)) => self,
Some(v) => panic!("Expected array at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the array has the expected length.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"tags": ["rust", "testing"]});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.tags")
/// .is_array()
/// .has_length(2);
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not an array
/// - Panics if the array length doesn't match the expected length
pub fn has_length(&'a mut self, expected: usize) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Array(arr)) if arr.len() == expected => self,
Some(Value::Array(arr)) => panic!(
"Array at {} has wrong length\nExpected: {}\nActual: {}",
self.path_str, expected, arr.len()
),
Some(v) => panic!("Expected array at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the array contains the expected value.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"roles": ["user", "admin"]});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.roles")
/// .is_array()
/// .contains(&json!("admin"));
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not an array
/// - Panics if the array does not contain the expected value
pub fn contains(&'a mut self, expected: &Value) -> &'a mut Self {
match self.current_values.get(0) {
Some(Value::Array(arr)) if arr.contains(expected) => self,
Some(Value::Array(arr)) => panic!(
"Array at {} does not contain expected value\nExpected: {}\nArray: {:?}",
self.path_str, expected, arr
),
Some(v) => panic!("Expected array at {}, got {:?}", self.path_str, v),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the value matches a custom predicate.
///
/// This method allows for complex value validation using custom logic.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"timestamp": "2024-01-01T12:00:00Z"});
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.timestamp")
/// .matches(|value| {
/// value.as_str()
/// .map(|s| s.contains("T") && s.ends_with("Z"))
/// .unwrap_or(false)
/// });
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value doesn't satisfy the predicate
pub fn matches<F>(&'a mut self, predicate: F) -> &'a mut Self
where
F: FnOnce(&Value) -> bool,
{
match self.current_values.get(0) {
Some(value) if predicate(value) => self,
Some(value) => panic!(
"Value at {} does not match predicate\nActual value: {}",
self.path_str, value
),
None => panic!("No value found at {}", self.path_str),
}
}
/// Asserts that the value is an object and returns it for further testing.
///
/// This method is primarily used internally by property assertions.
///
/// # Examples
///
/// ```rust
/// # use json_test::JsonTest;
/// # use serde_json::json;
/// # let data = json!({"user": {"name": "John", "age": 30}});
/// # let mut test = JsonTest::new(&data);
/// let obj = test.assert_path("$.user")
/// .assert_object();
/// assert!(obj.contains_key("name"));
/// ```
///
/// # Panics
///
/// - Panics if no value exists at the path
/// - Panics if the value is not an object
pub fn assert_object(&self) -> Map<String, Value> {
match &self.current_values[..] {
[Value::Object(obj)] => obj.clone(),
_ => panic!(
"Expected object at {}, got: {:?}",
self.path_str, self.current_values
),
}
}
/// Creates a new assertion for a different path while maintaining the test context.
///
/// This method enables chaining assertions across different paths.
///
/// # Examples
///
/// ```rust
/// # use json_test::{JsonTest, PropertyAssertions};
/// # use serde_json::json;
/// # let data = json!({
/// # "user": {"name": "John"},
/// # "settings": {"theme": "dark"}
/// # });
/// # let mut test = JsonTest::new(&data);
/// test.assert_path("$.user")
/// .has_property("name")
/// .assert_path("$.settings")
/// .has_property("theme");
/// ```
///
/// # Panics
///
/// - Panics if called on an assertion without test context
pub fn assert_path(&'a mut self, path: &str) -> JsonPathAssertion<'a> {
match &mut self.test {
Some(test) => test.assert_path(path),
None => panic!("Cannot chain assertions without JsonTest context"),
}
}
}