File: test_cli.py

package info (click to toggle)
python-jsonpath 2.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,028 kB
  • sloc: python: 9,473; makefile: 6
file content (597 lines) | stat: -rw-r--r-- 16,970 bytes parent folder | download
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
"""Test cases for the command line interface."""

import argparse
import json
import pathlib

import pytest

from jsonpath.__about__ import __version__
from jsonpath.cli import handle_patch_command
from jsonpath.cli import handle_path_command
from jsonpath.cli import handle_pointer_command
from jsonpath.cli import setup_parser
from jsonpath.exceptions import JSONPatchTestFailure
from jsonpath.exceptions import JSONPathIndexError
from jsonpath.exceptions import JSONPathSyntaxError
from jsonpath.exceptions import JSONPathTypeError
from jsonpath.exceptions import JSONPointerResolutionError
from jsonpath.patch import JSONPatch

SAMPLE_DATA = {
    "categories": [
        {
            "name": "footwear",
            "products": [
                {
                    "title": "Trainers",
                    "description": "Fashionable trainers.",
                    "price": 89.99,
                },
                {
                    "title": "Barefoot Trainers",
                    "description": "Running trainers.",
                    "price": 130.00,
                },
            ],
        },
        {
            "name": "headwear",
            "products": [
                {
                    "title": "Cap",
                    "description": "Baseball cap",
                    "price": 15.00,
                },
                {
                    "title": "Beanie",
                    "description": "Winter running hat.",
                    "price": 9.00,
                },
            ],
        },
    ],
    "price_cap": 10,
}


@pytest.fixture()
def parser() -> argparse.ArgumentParser:
    return setup_parser()


@pytest.fixture()
def invalid_target(tmp_path: pathlib.Path) -> str:
    target_path = tmp_path / "source.json"
    with open(target_path, "w") as fd:
        fd.write(r"}}invalid")
    return str(target_path)


@pytest.fixture()
def outfile(tmp_path: pathlib.Path) -> str:
    output_path = tmp_path / "result.json"
    return str(output_path)


@pytest.fixture()
def sample_target(tmp_path: pathlib.Path) -> str:
    target_path = tmp_path / "source.json"
    with open(target_path, "w") as fd:
        json.dump(SAMPLE_DATA, fd)
    return str(target_path)


def test_no_sub_command(
    parser: argparse.ArgumentParser, capsys: pytest.CaptureFixture[str]
) -> None:
    """Test that the CLI exits without a sub command."""
    with pytest.raises(SystemExit) as err:
        parser.parse_args([])

    captured = capsys.readouterr()
    assert err.value.code == 2  # noqa: PLR2004
    assert (
        captured.err.strip()
        == parser.format_usage()
        + "json: error: the following arguments are required: COMMAND"
    )


def test_help(
    parser: argparse.ArgumentParser, capsys: pytest.CaptureFixture[str]
) -> None:
    """Test that the CLI can display a help message without a command."""
    with pytest.raises(SystemExit) as err:
        parser.parse_args(["-h"])

    captured = capsys.readouterr()
    assert err.value.code == 0
    assert captured.out == parser.format_help()


def test_version(
    parser: argparse.ArgumentParser, capsys: pytest.CaptureFixture[str]
) -> None:
    """Test that the CLI can display a version number without a command."""
    with pytest.raises(SystemExit) as err:
        parser.parse_args(["--version"])

    captured = capsys.readouterr()
    assert err.value.code == 0
    assert captured.out.strip() == f"python-jsonpath, version {__version__}"


def test_path_command_invalid_target(
    parser: argparse.ArgumentParser,
    invalid_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle invalid JSON with the _path_ command."""
    args = parser.parse_args(["path", "-q", "$.foo", "-f", invalid_target])

    with pytest.raises(SystemExit) as err:
        handle_path_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("target document json decode error:")


def test_path_command_invalid_target_debug(
    parser: argparse.ArgumentParser,
    invalid_target: str,
) -> None:
    """Test that we handle invalid JSON with the _path_ command."""
    args = parser.parse_args(["--debug", "path", "-q", "$.foo", "-f", invalid_target])
    with pytest.raises(json.JSONDecodeError):
        handle_path_command(args)


def test_json_path_syntax_error(
    parser: argparse.ArgumentParser,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle a JSONPath with a syntax error."""
    args = parser.parse_args(["path", "-q", "$.1", "-f", sample_target])

    with pytest.raises(SystemExit) as err:
        handle_path_command(args)

    assert err.value.code == 1
    captured = capsys.readouterr()
    assert captured.err.startswith("json path syntax error")


def test_json_path_syntax_error_debug(
    parser: argparse.ArgumentParser,
    sample_target: str,
) -> None:
    """Test that we handle a JSONPath with a syntax error."""
    args = parser.parse_args(["--debug", "path", "-q", "$.1", "-f", sample_target])
    with pytest.raises(JSONPathSyntaxError):
        handle_path_command(args)


def test_json_path_type_error(
    parser: argparse.ArgumentParser,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle a JSONPath with a type error."""
    args = parser.parse_args(
        ["path", "-q", "$.foo[?count(@.bar, 'baz')]", "-f", sample_target]
    )

    with pytest.raises(SystemExit) as err:
        handle_path_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("json path type error")


def test_json_path_type_error_debug(
    parser: argparse.ArgumentParser,
    sample_target: str,
) -> None:
    """Test that we handle a JSONPath with a type error."""
    args = parser.parse_args(
        ["--debug", "path", "-q", "$.foo[?count(@.bar, 'baz')]", "-f", sample_target]
    )

    with pytest.raises(JSONPathTypeError):
        handle_path_command(args)


def test_json_path_no_well_typed_checks(
    parser: argparse.ArgumentParser,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we can disable well-typedness checks."""
    # `count()` must be compared
    query = "$[?count(@..*)]"

    args = parser.parse_args(
        [
            "path",
            "-q",
            query,
            "-f",
            sample_target,
        ]
    )

    with pytest.raises(SystemExit) as err:
        handle_path_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("json path type error")

    args = parser.parse_args(
        [
            "path",
            "-q",
            query,
            "--no-type-checks",
            "-f",
            sample_target,
        ]
    )

    # does not raise
    handle_path_command(args)


def test_json_path_index_error(
    parser: argparse.ArgumentParser,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle a JSONPath with a syntax error."""
    args = parser.parse_args(["path", "-q", f"$.foo[{2**53}]", "-f", sample_target])

    with pytest.raises(SystemExit) as err:
        handle_path_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("json path index error")


def test_json_path_index_error_debug(
    parser: argparse.ArgumentParser,
    sample_target: str,
) -> None:
    """Test that we handle a JSONPath with a syntax error."""
    args = parser.parse_args(
        ["--debug", "path", "-q", f"$.foo[{2**53}]", "-f", sample_target]
    )

    with pytest.raises(JSONPathIndexError):
        handle_path_command(args)


def test_json_path(
    parser: argparse.ArgumentParser,
    sample_target: str,
    outfile: str,
) -> None:
    """Test a valid JSONPath."""
    args = parser.parse_args(
        ["path", "-q", "$..products.*", "-f", sample_target, "-o", outfile]
    )

    handle_path_command(args)
    args.output.flush()

    with open(outfile, "r") as fd:
        assert len(json.load(fd)) == 4  # noqa: PLR2004


def test_json_path_strict(
    parser: argparse.ArgumentParser,
    sample_target: str,
    outfile: str,
) -> None:
    """Test a valid JSONPath."""
    args = parser.parse_args(
        [
            "--debug",
            "path",
            "-q",
            "price_cap",  # No root identifier is an error in strict mode.
            "-f",
            sample_target,
            "-o",
            outfile,
            "--strict",
        ]
    )

    with pytest.raises(JSONPathSyntaxError):
        handle_path_command(args)

    args = parser.parse_args(
        [
            "path",
            "-q",
            "$.price_cap",  # With a root identifier is OK.
            "-f",
            sample_target,
            "-o",
            outfile,
            "--strict",
        ]
    )

    handle_path_command(args)
    args.output.flush()

    with open(outfile, "r") as fd:
        rv = json.load(fd)
        assert rv == [10]


def test_pointer_command_invalid_target(
    parser: argparse.ArgumentParser,
    invalid_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle invalid JSON with the _pointer_ command."""
    args = parser.parse_args(["pointer", "-p", "/foo/bar", "-f", invalid_target])

    with pytest.raises(SystemExit) as err:
        handle_pointer_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("target document json decode error:")


def test_pointer_command_invalid_target_debug(
    parser: argparse.ArgumentParser,
    invalid_target: str,
) -> None:
    """Test that we handle invalid JSON with the _pointer_ command."""
    args = parser.parse_args(
        ["--debug", "pointer", "-p", "/foo/bar", "-f", invalid_target]
    )
    with pytest.raises(json.JSONDecodeError):
        handle_pointer_command(args)


def test_pointer_command_resolution_error(
    parser: argparse.ArgumentParser,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle pointer resolution errors."""
    args = parser.parse_args(["pointer", "-p", "/foo/bar", "-f", sample_target])

    with pytest.raises(SystemExit) as err:
        handle_pointer_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("pointer key error: 'foo'")


def test_pointer_command_resolution_error_debug(
    parser: argparse.ArgumentParser, sample_target: str
) -> None:
    """Test that we handle pointer resolution errors."""
    args = parser.parse_args(
        ["--debug", "pointer", "-p", "/foo/bar", "-f", sample_target]
    )
    with pytest.raises(JSONPointerResolutionError):
        handle_pointer_command(args)


def test_json_pointer(
    parser: argparse.ArgumentParser, sample_target: str, outfile: str
) -> None:
    """Test a valid JSON Pointer."""
    args = parser.parse_args(
        ["pointer", "-p", "/categories/0/name", "-f", sample_target, "-o", outfile]
    )

    handle_pointer_command(args)
    args.output.flush()

    with open(outfile, "r") as fd:
        assert json.load(fd) == "footwear"


def test_json_pointer_empty_string(
    parser: argparse.ArgumentParser, sample_target: str, outfile: str
) -> None:
    """Test an empty JSON Pointer is valid."""
    args = parser.parse_args(["pointer", "-p", "", "-f", sample_target, "-o", outfile])

    handle_pointer_command(args)
    args.output.flush()

    with open(outfile, "r") as fd:
        assert json.load(fd) == SAMPLE_DATA


def test_read_pointer_from_file(
    parser: argparse.ArgumentParser,
    sample_target: str,
    outfile: str,
    tmp_path: pathlib.Path,
) -> None:
    """Test an empty JSON Pointer is valid."""
    pointer_file_path = tmp_path / "pointer.txt"
    with pointer_file_path.open("w") as fd:
        fd.write("/price_cap")

    args = parser.parse_args(
        ["pointer", "-r", str(pointer_file_path), "-f", sample_target, "-o", outfile]
    )

    handle_pointer_command(args)
    args.output.flush()

    with open(outfile, "r") as fd:
        assert json.load(fd) == SAMPLE_DATA["price_cap"]


def test_patch_command_invalid_patch(
    parser: argparse.ArgumentParser,
    sample_target: str,
    invalid_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle invalid patch JSON."""
    args = parser.parse_args(["patch", invalid_target, "-f", sample_target])

    with pytest.raises(SystemExit) as err:
        handle_patch_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("patch document json decode error:")


def test_patch_command_invalid_patch_debug(
    parser: argparse.ArgumentParser,
    sample_target: str,
    invalid_target: str,
) -> None:
    """Test that we handle invalid patch JSON."""
    args = parser.parse_args(["--debug", "patch", invalid_target, "-f", sample_target])
    with pytest.raises(json.JSONDecodeError):
        handle_patch_command(args)


def test_patch_not_an_array(
    parser: argparse.ArgumentParser,
    tmp_path: pathlib.Path,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle a patch that is not an array."""
    mock_patch_path = tmp_path / "patch.json"
    with mock_patch_path.open("w") as fd:
        json.dump({"foo": "bar"}, fd)

    args = parser.parse_args(["patch", str(mock_patch_path), "-f", sample_target])

    with pytest.raises(SystemExit) as err:
        handle_patch_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err == (
        "error: patch file does not look like an array of patch operations"
    )


def test_patch_command_invalid_target(
    parser: argparse.ArgumentParser,
    tmp_path: pathlib.Path,
    invalid_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle invalid JSON with the _patch_ command."""
    mock_patch_path = tmp_path / "patch.json"
    with mock_patch_path.open("w") as fd:
        json.dump([], fd)

    args = parser.parse_args(["patch", str(mock_patch_path), "-f", invalid_target])

    with pytest.raises(SystemExit) as err:
        handle_patch_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("target document json decode error:")


def test_patch_command_invalid_target_debug(
    parser: argparse.ArgumentParser,
    tmp_path: pathlib.Path,
    invalid_target: str,
) -> None:
    """Test that we handle invalid JSON with the _patch_ command."""
    mock_patch_path = tmp_path / "patch.json"
    with mock_patch_path.open("w") as fd:
        json.dump([], fd)

    args = parser.parse_args(
        ["--debug", "patch", str(mock_patch_path), "-f", invalid_target]
    )

    with pytest.raises(json.JSONDecodeError):
        handle_patch_command(args)


def test_patch_error(
    parser: argparse.ArgumentParser,
    tmp_path: pathlib.Path,
    sample_target: str,
    capsys: pytest.CaptureFixture[str],
) -> None:
    """Test that we handle patch errors."""
    mock_patch_path = tmp_path / "patch.json"
    patch = JSONPatch().test("/categories/0/name", "foo")
    with mock_patch_path.open("w") as fd:
        json.dump(patch.asdicts(), fd)

    args = parser.parse_args(["patch", str(mock_patch_path), "-f", sample_target])

    with pytest.raises(SystemExit) as err:
        handle_patch_command(args)

    captured = capsys.readouterr()
    assert err.value.code == 1
    assert captured.err.startswith("test failed")


def test_patch_error_debug(
    parser: argparse.ArgumentParser,
    tmp_path: pathlib.Path,
    sample_target: str,
) -> None:
    """Test that we handle patch errors."""
    mock_patch_path = tmp_path / "patch.json"
    patch = JSONPatch().test("/categories/0/name", "foo")
    with mock_patch_path.open("w") as fd:
        json.dump(patch.asdicts(), fd)

    args = parser.parse_args(
        ["--debug", "patch", str(mock_patch_path), "-f", sample_target]
    )

    with pytest.raises(JSONPatchTestFailure):
        handle_patch_command(args)


def test_json_patch(
    parser: argparse.ArgumentParser,
    tmp_path: pathlib.Path,
    sample_target: str,
    outfile: str,
) -> None:
    """Test a valid JSON patch."""
    mock_patch_path = tmp_path / "patch.json"
    patch = JSONPatch().replace("/categories/0/name", "foo")
    with mock_patch_path.open("w") as fd:
        json.dump(patch.asdicts(), fd)

    args = parser.parse_args(
        ["patch", str(mock_patch_path), "-f", sample_target, "-o", outfile]
    )

    handle_patch_command(args)
    args.output.flush()

    with open(outfile, "r") as fd:
        patched = json.load(fd)

    assert patched["categories"][0]["name"] == "foo"