REFACTOR Breaking: Migrate CLI to use pyrit.models#1997
Merged
rlundeen2 merged 9 commits intoJun 30, 2026
Conversation
rlundeen2
force-pushed
the
rlundeen2/phase-16-pyrit-models-plan
branch
from
ed441d2 to
37b5cfb
Compare
…hase 16) Add pyrit/models/catalog package (target, scenario, initializer) as the canonical typed catalog models. Rewrite the CLI api_client and output to consume typed objects instead of dict[str, Any] payloads, and update backend mappers/routes/services plus tests to import the canonical types. Remove backend re-export shims so backend models hold only REST framing types. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
rlundeen2
force-pushed
the
rlundeen2/phase-16-pyrit-models-plan
branch
from
37b5cfb to
e72af5f
Compare
Contributor
|
The title and description both say |
rlundeen2
changed the title
Contributor
Author
Yep, meant to be models, sorry! |
…rit-models-plan # Conflicts: # pyrit/backend/mappers/target_mappers.py # pyrit/backend/routes/scenarios.py # pyrit/cli/_output.py # pyrit/cli/api_client.py # tests/unit/cli/test_output.py
Co-authored-by: hannahwestra25 <hannahwestra@microsoft.com>
…rit-models-plan # Conflicts: # pyrit/backend/routes/scenarios.py # pyrit/cli/_output.py # tests/unit/backend/test_scenario_run_service.py # tests/unit/cli/test_output.py
Mirrors the target.py fix: these catalog models ARE the FastAPI REST response models, so Field(..., description=...) belongs on them and surfaces in the OpenAPI schema. Removes the misleading docstring claim that descriptions live in the backend layer. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jsong468
reviewed
Jun 26, 2026
jsong468
reviewed
Jun 27, 2026
jsong468
reviewed
Jun 27, 2026
jsong468
reviewed
Jun 27, 2026
jsong468
reviewed
Jun 27, 2026
jsong468
reviewed
Jun 27, 2026
jsong468
reviewed
Jun 27, 2026
rlundeen2
changed the title
…s in CLI
Addresses PR review: when GET /scenarios/runs/{id}/results fails to fetch or
deserialize (e.g. a malformed server payload), the CLI now prints a serious
error and surfaces the exception (via _print_cli_exception, with a DEBUG
traceback) instead of silently falling back to the summary. Also replaces
string status literals with ScenarioRunState enum comparisons in pyrit_scan
and pyrit_shell (lazy-imported at point-of-use to keep the --help import
path free of pyrit.models per the CLI import guards).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
A COMPLETED run whose detailed results cannot be fetched or deserialized now returns exit code 1 (after loudly surfacing the error) instead of 0, so scripts and CI see a non-zero status. Updates the test harness to exercise the real results happy path and renames the failure-path test. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… defaults Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…rit-models-plan # Conflicts: # pyrit/cli/_cli_args.py # pyrit/cli/pyrit_scan.py
jsong468
reviewed
Jun 30, 2026
jsong468
approved these changes
Jun 30, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR migrates the CLI to use pyrit.models (now that it is a lot thinner) instead of dictionaries.
Also, this PR adds pyrit/models/catalog package (target, scenario, initializer) as the canonical typed catalog models - there were previously defined in the backend, but are needed by the API and are not presentation specific.
This is phase 16 of this pyrit.models plan: https://gist.github.com/rlundeen2/3e8daa8e12a11b4b6e52587b3c9b1dca