-
Notifications
You must be signed in to change notification settings - Fork 8
test(cli): parse Click JSON output robustly in tests #731
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| """Helpers for asserting JSON output from Click CLI tests.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import json | ||
| from typing import Any | ||
|
|
||
|
|
||
| def parse_click_json_output(output: str) -> dict[str, Any]: | ||
| """Parse JSON from `CliRunner` output, tolerating prefixed stderr log lines. | ||
|
|
||
| Click's test runner can merge stderr into `result.output`, so scans that emit | ||
| findings may prepend log lines before the JSON payload even though a real | ||
| subprocess keeps stdout and stderr separate. | ||
| """ | ||
| try: | ||
| parsed = json.loads(output) | ||
| except json.JSONDecodeError: | ||
| decoder = json.JSONDecoder() | ||
| for index, char in enumerate(output): | ||
| if char != "{": | ||
| continue | ||
|
|
||
| try: | ||
| parsed, end = decoder.raw_decode(output, index) | ||
| except json.JSONDecodeError: | ||
| continue | ||
|
|
||
| if output[end:].strip(): | ||
| continue | ||
| break | ||
| else: | ||
| raise | ||
|
|
||
| if not isinstance(parsed, dict): | ||
| raise TypeError(f"Expected a JSON object, got {type(parsed).__name__}") | ||
| return parsed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| from __future__ import annotations | ||
|
|
||
| import json | ||
|
|
||
| import pytest | ||
|
|
||
| from tests.cli_output import parse_click_json_output | ||
|
|
||
|
|
||
| def test_parse_click_json_output_handles_prefixed_log_lines() -> None: | ||
| """Click tests may prefix stderr logs before the JSON body.""" | ||
| payload = {"files_scanned": 1, "issues": [{"rule_code": "S405"}]} | ||
| output = ( | ||
| "2026-03-20 16:16:35,821 - modelaudit.scanners - CRITICAL - " | ||
| "[S405] [CRITICAL] (evil.tar:../evil.txt): Archive entry ../evil.txt attempted path traversal\n" | ||
| f"{json.dumps(payload, indent=2)}\n" | ||
| ) | ||
|
|
||
| assert parse_click_json_output(output) == payload | ||
|
|
||
|
|
||
| def test_parse_click_json_output_rejects_non_object_json() -> None: | ||
| """CLI scan JSON should be an object payload, not a scalar or array.""" | ||
| with pytest.raises(TypeError, match="Expected a JSON object"): | ||
| parse_click_json_output("[]") |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.