Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

test(workbench): share setup for managing saved findings (#1412)

mldangelo-oaidf69e0ded6e8
diff --git a/plugins/codex-security/tests/test_workbench_db.py b/plugins/codex-security/tests/test_workbench_db.py
index b5cb8769c..248090ec8 100644
--- a/plugins/codex-security/tests/test_workbench_db.py
+++ b/plugins/codex-security/tests/test_workbench_db.py
@@ -17,6 +17,7 @@ import pytest
from workbench_test_support import (
SCRIPT,
begin_deep_scan,
+ claim_remediation_resend,
create_saved_git_workspace,
create_saved_workspace,
create_workspace,
@@ -25,11 +26,15 @@ from workbench_test_support import (
get_scan,
initialize_git_repository,
mark_handoff_delivered,
+ mark_remediation_delivered,
+ request_remediation,
+ request_remediation_action,
resume_deep_scan,
run_workbench,
save_workspace,
scan_claim_command,
scan_command,
+ set_remediation,
set_triage,
stable_target_id,
start_delivered_scan,
@@ -986,18 +991,15 @@ def test_completed_finding_triage_and_remediation_persist(
source.write_bytes(f"vulnerable{line_ending}".encode())
scan_id, scan_dir = start_saved_scan(state_dir, target, tmp_path / "scans")
write_completed_contract(scan_dir, scan_id, target, relative_path=source.name)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
scan_dir = Path(str(completed["scanDir"]))
occurrence_id = str(completed["findings"][0]["occurrenceId"])
assert completed["findings"][0]["triage"] == {"status": "open"}
assert completed["findings"][0]["remediationState"] == {"state": "idle"}
- closed = run_workbench(
+ closed = set_triage(
state_dir,
- "set-finding-triage",
- "--occurrence-id",
occurrence_id,
- "--status",
"closed",
"--close-reason",
"already_fixed",
@@ -1010,12 +1012,9 @@ def test_completed_finding_triage_and_remediation_persist(
"status": "closed",
"updatedAt": None,
}
- run_workbench(
+ set_triage(
state_dir,
- "set-finding-triage",
- "--occurrence-id",
occurrence_id,
- "--status",
"closed",
"--close-reason",
"already_fixed",
@@ -1025,26 +1024,11 @@ def test_completed_finding_triage_and_remediation_persist(
request_id = str(uuid.uuid4())
generation_token = str(uuid.uuid4())
- closed_request = run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- check=False,
+ closed_request = request_remediation(
+ state_dir, occurrence_id, request_id, generation_token, check=False
)
assert "Reopen this finding" in str(closed_request["stderr"])
- run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "open",
- )
+ set_triage(state_dir, occurrence_id, "open")
with sqlite3.connect(state_dir / "workbench.sqlite3") as connection:
assert connection.execute(
"""
@@ -1058,29 +1042,12 @@ def test_completed_finding_triage_and_remediation_persist(
("closed", "already_fixed", "Patched before this scan completed."),
("open", None, None),
]
- requested = run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- )["scan"]
+ requested = request_remediation(state_dir, occurrence_id, request_id, generation_token)["scan"]
assert requested["findings"][0]["remediationState"]["state"] == "requested"
assert requested["findings"][0]["remediationState"]["pendingAction"] == "generate"
assert requested["findings"][0]["remediationState"]["actionClaimToken"] == generation_token
- pending_close = run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "closed",
- "--close-reason",
- "already_fixed",
- check=False,
+ pending_close = set_triage(
+ state_dir, occurrence_id, "closed", "--close-reason", "already_fixed", check=False
)
assert "pending remediation operation" in str(pending_close["stderr"])
patch_path = scan_dir / "remediation.patch"
@@ -1093,18 +1060,12 @@ def test_completed_finding_triage_and_remediation_persist(
"+fixed\n",
newline="\n",
)
- generated = run_workbench(
+ generated = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -1127,64 +1088,22 @@ def test_completed_finding_triage_and_remediation_persist(
"Contained archive extraction under the selected output directory."
)
apply_token = str(uuid.uuid4())
- apply_requested = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- apply_token,
+ apply_requested = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", apply_token
)["scan"]
assert apply_requested["findings"][0]["remediationState"]["pendingAction"] == "apply"
assert apply_requested["findings"][0]["remediationState"]["actionClaimToken"] == apply_token
assert apply_requested["findings"][0]["remediationState"]["version"] == 3
- apply_retried = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- apply_token,
+ apply_retried = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", apply_token
)["scan"]
assert apply_retried["findings"][0]["remediationState"]["version"] == 3
- wrong_apply = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- generation_token,
- check=False,
+ wrong_apply = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", generation_token, check=False
)
assert "operation is already pending" in str(wrong_apply["stderr"])
- live_resend = run_workbench(
- state_dir,
- "claim-finding-remediation-resend",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ live_resend = claim_remediation_resend(
+ state_dir, occurrence_id, request_id, str(uuid.uuid4()), check=False
)
assert "still owned by another panel" in str(live_resend["stderr"])
with sqlite3.connect(state_dir / "workbench.sqlite3") as connection:
@@ -1197,16 +1116,9 @@ def test_completed_finding_triage_and_remediation_persist(
("2000-01-01T00:00:00Z", request_id),
)
resend_token = str(uuid.uuid4())
- stale_resend = run_workbench(
- state_dir,
- "claim-finding-remediation-resend",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- resend_token,
- )["scan"]
+ stale_resend = claim_remediation_resend(state_dir, occurrence_id, request_id, resend_token)[
+ "scan"
+ ]
assert stale_resend["findings"][0]["remediationState"]["actionClaimToken"] == resend_token
wrong_release = run_workbench(
state_dir,
@@ -1230,18 +1142,12 @@ def test_completed_finding_triage_and_remediation_persist(
resend_token,
)["scan"]
assert released["findings"][0]["remediationState"]["actionClaimToken"] is None
- unowned_apply = run_workbench(
+ unowned_apply = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
resend_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
"unversioned",
@@ -1249,27 +1155,11 @@ def test_completed_finding_triage_and_remediation_persist(
)
assert "does not have an owned pending host request" in str(unowned_apply["stderr"])
retry_token = str(uuid.uuid4())
- reclaimed = run_workbench(
- state_dir,
- "claim-finding-remediation-resend",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- retry_token,
- )["scan"]
+ reclaimed = claim_remediation_resend(state_dir, occurrence_id, request_id, retry_token)["scan"]
assert reclaimed["findings"][0]["remediationState"]["actionClaimToken"] == retry_token
- delivered = run_workbench(
- state_dir,
- "mark-finding-remediation-delivered",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- retry_token,
- )["scan"]
+ delivered = mark_remediation_delivered(state_dir, occurrence_id, request_id, retry_token)[
+ "scan"
+ ]
assert delivered["findings"][0]["remediationState"]["actionDeliveredAt"]
with sqlite3.connect(state_dir / "workbench.sqlite3") as connection:
connection.execute(
@@ -1281,44 +1171,22 @@ def test_completed_finding_triage_and_remediation_persist(
("2000-01-01T00:00:00Z", "2000-01-01T00:00:00Z", request_id),
)
recovery_token = str(uuid.uuid4())
- recovered_delivery = run_workbench(
- state_dir,
- "claim-finding-remediation-resend",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- recovery_token,
+ recovered_delivery = claim_remediation_resend(
+ state_dir, occurrence_id, request_id, recovery_token
)["scan"]
assert (
recovered_delivery["findings"][0]["remediationState"]["actionClaimToken"] == recovery_token
)
assert recovered_delivery["findings"][0]["remediationState"]["actionDeliveredAt"] is None
- run_workbench(
- state_dir,
- "mark-finding-remediation-delivered",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- recovery_token,
- )
+ mark_remediation_delivered(state_dir, occurrence_id, request_id, recovery_token)
replacement_path = scan_dir / "replacement.patch"
replacement_path.write_text("diff --git a/src/other.py b/src/other.py\n")
- replaced_patch = run_workbench(
+ replaced_patch = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
recovery_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
"unversioned",
@@ -1329,18 +1197,12 @@ def test_completed_finding_triage_and_remediation_persist(
check=False,
)
assert "cannot replace its reviewed patch path" in str(replaced_patch["stderr"])
- unchanged_apply = run_workbench(
+ unchanged_apply = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
recovery_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
"unversioned",
@@ -1355,18 +1217,12 @@ def test_completed_finding_triage_and_remediation_persist(
applied_source = source.read_bytes()
unrelated = target / "unrelated.txt"
unrelated.write_text("not part of the reviewed patch\n")
- extra_changes = run_workbench(
+ extra_changes = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
recovery_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
"unversioned",
@@ -1374,51 +1230,28 @@ def test_completed_finding_triage_and_remediation_persist(
)
assert "changes outside the reviewed patch" in str(extra_changes["stderr"])
unrelated.unlink()
- applied = run_workbench(
+ applied = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
recovery_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
"unversioned",
)["scan"]
assert applied["findings"][0]["remediationState"]["state"] == "applied"
verify_token = str(uuid.uuid4())
- verify_requested = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "4",
- "--action",
- "verify",
- "--action-token",
- verify_token,
+ verify_requested = request_remediation_action(
+ state_dir, occurrence_id, request_id, "4", "verify", verify_token
)["scan"]
assert verify_requested["findings"][0]["remediationState"]["pendingAction"] == "verify"
- verifying = run_workbench(
+ verifying = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
verify_token,
- "--expected-version",
"5",
- "--state",
"verifying",
"--base-revision",
"unversioned",
@@ -1436,46 +1269,27 @@ def test_completed_finding_triage_and_remediation_persist(
("2000-01-01T00:00:00Z", request_id),
)
recovery_token = str(uuid.uuid4())
- recovered = run_workbench(
- state_dir,
- "claim-finding-remediation-resend",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- recovery_token,
- )["scan"]
+ recovered = claim_remediation_resend(state_dir, occurrence_id, request_id, recovery_token)[
+ "scan"
+ ]
assert recovered["findings"][0]["remediationState"]["actionClaimToken"] == recovery_token
- verifying_again = run_workbench(
+ verifying_again = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
recovery_token,
- "--expected-version",
"6",
- "--state",
"verifying",
"--base-revision",
"unversioned",
)["scan"]
assert verifying_again["findings"][0]["remediationState"]["pendingAction"] == "verify"
- verified = run_workbench(
+ verified = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
recovery_token,
- "--expected-version",
"7",
- "--state",
"verified",
"--base-revision",
"unversioned",
@@ -1485,38 +1299,14 @@ def test_completed_finding_triage_and_remediation_persist(
assert verified["findings"][0]["remediationState"]["state"] == "verified"
source.write_text("drifted after verification\n")
- stale_close = run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "closed",
- "--close-reason",
- "already_fixed",
- check=False,
+ stale_close = set_triage(
+ state_dir, occurrence_id, "closed", "--close-reason", "already_fixed", check=False
)
assert "Working-tree contents changed" in str(stale_close["stderr"])
source.write_bytes(applied_source)
- run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "closed",
- "--close-reason",
- "already_fixed",
- )
+ set_triage(state_dir, occurrence_id, "closed", "--close-reason", "already_fixed")
- reopened = run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "open",
- )["scan"]
+ reopened = set_triage(state_dir, occurrence_id, "open")["scan"]
assert reopened["findings"][0]["triage"]["status"] == "open"
assert reopened["findings"][0]["triage"]["closeReason"] is None
@@ -1562,7 +1352,7 @@ def test_completed_scan_disables_remediation_after_checkout_revision_changes(
target_kind="git_revision",
target_revision=revision,
)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
assert completed["remediationAvailable"] is True
with sqlite3.connect(state_dir / "workbench.sqlite3") as connection:
@@ -1570,14 +1360,14 @@ def test_completed_scan_disables_remediation_after_checkout_revision_changes(
"UPDATE scans SET target_device = target_device + 1 WHERE id = ?",
(scan_id,),
)
- remounted = run_workbench(state_dir, "get-scan", "--scan-id", scan_id)["scan"]
+ remounted = get_scan(state_dir, scan_id)["scan"]
assert remounted["remediationAvailable"] is True
assert remounted["findings"][0]["locations"][0]["absolutePath"] == str(target / "README.md")
(target / "README.md").write_text("new revision\n")
subprocess.run(["git", "add", "README.md"], cwd=target, check=True)
subprocess.run(["git", "commit", "-qm", "Advance checkout"], cwd=target, check=True)
- refreshed = run_workbench(state_dir, "get-scan", "--scan-id", scan_id)["scan"]
+ refreshed = get_scan(state_dir, scan_id)["scan"]
assert refreshed["remediationAvailable"] is False
assert "not at the revision that was scanned" in refreshed["remediationUnavailableReason"]
@@ -1592,7 +1382,7 @@ def assert_completed_scan_disables_remediation_after_checkout_path_is_replaced(
(target / "source.txt").write_text("vulnerable\n")
scan_id, scan_dir = start_saved_scan(state_dir, target, tmp_path / "scans")
write_completed_contract(scan_dir, scan_id, target, relative_path="source.txt")
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
occurrence_id = str(completed["findings"][0]["occurrenceId"])
with sqlite3.connect(state_dir / "workbench.sqlite3") as connection:
identity = connection.execute(
@@ -1611,20 +1401,12 @@ def assert_completed_scan_disables_remediation_after_checkout_path_is_replaced(
target.mkdir()
(target / "source.txt").write_text("vulnerable\n")
- refreshed = run_workbench(state_dir, "get-scan", "--scan-id", scan_id)["scan"]
+ refreshed = get_scan(state_dir, scan_id)["scan"]
assert refreshed["remediationAvailable"] is False
assert "checkout path was replaced" in refreshed["remediationUnavailableReason"]
assert "absolutePath" not in refreshed["findings"][0]["locations"][0]
- rejected = run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- str(uuid.uuid4()),
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ rejected = request_remediation(
+ state_dir, occurrence_id, str(uuid.uuid4()), str(uuid.uuid4()), check=False
)
assert "checkout path was replaced" in str(rejected["stderr"])
@@ -1648,91 +1430,40 @@ def test_completed_scan_disables_remediation_after_checkout_symlink_is_replaced(
def test_finding_management_rejects_invalid_state_transitions(tmp_path: Path) -> None:
state_dir, target, scan_id, scan_dir = empty_target_scan(tmp_path)
write_completed_contract(scan_dir, scan_id, target)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
scan_dir = Path(str(completed["scanDir"]))
occurrence_id = str(completed["findings"][0]["occurrenceId"])
- missing_reason = run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "closed",
- check=False,
- )
+ missing_reason = set_triage(state_dir, occurrence_id, "closed", check=False)
assert "Choose why this finding is being closed." in str(missing_reason["stderr"])
- missing_wont_fix_rationale = run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "closed",
- "--close-reason",
- "wont_fix",
- check=False,
+ missing_wont_fix_rationale = set_triage(
+ state_dir, occurrence_id, "closed", "--close-reason", "wont_fix", check=False
)
assert "Explain why this finding will not be fixed." in str(
missing_wont_fix_rationale["stderr"]
)
- invalid_transition = run_workbench(
- state_dir,
- "set-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- str(uuid.uuid4()),
- "--action-token",
- str(uuid.uuid4()),
- "--expected-version",
- "1",
- "--state",
- "verified",
- check=False,
+ invalid_transition = set_remediation(
+ state_dir, occurrence_id, str(uuid.uuid4()), str(uuid.uuid4()), "1", "verified", check=False
)
assert "remediation request not found" in str(invalid_transition["stderr"])
request_id = str(uuid.uuid4())
generation_token = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- )
- overlapping_request = run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- str(uuid.uuid4()),
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ request_remediation(state_dir, occurrence_id, request_id, generation_token)
+ overlapping_request = request_remediation(
+ state_dir, occurrence_id, str(uuid.uuid4()), str(uuid.uuid4()), check=False
)
assert "active remediation operation" in str(overlapping_request["stderr"])
patch_path = scan_dir / "remediation.patch"
patch_path.write_text("diff --git a/src/extract.py b/src/extract.py\n")
- digest_mismatch = run_workbench(
+ digest_mismatch = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -1745,77 +1476,35 @@ def test_finding_management_rejects_invalid_state_transitions(tmp_path: Path) ->
patch_path.write_bytes(
b"diff --git a/src/extract.py b/src/extract.py\n+" + b"x" * (2 * 1024 * 1024)
)
- run_workbench(
+ set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
"--patch-digest",
f"sha256:{hashlib.sha256(patch_path.read_bytes()).hexdigest()}",
)
- generated = run_workbench(state_dir, "get-scan", "--scan-id", scan_id)["scan"]
+ generated = get_scan(state_dir, scan_id)["scan"]
remediation = generated["findings"][0]["remediationState"]
assert remediation["patch"].endswith("... patch preview truncated ...")
assert remediation["patchStats"]["previewTruncated"] is True
- replayed_generation = run_workbench(
- state_dir,
- "set-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- "--expected-version",
- "2",
- "--state",
- "generated",
- check=False,
+ replayed_generation = set_remediation(
+ state_dir, occurrence_id, request_id, generation_token, "2", "generated", check=False
)
assert "does not have an owned pending host request" in str(replayed_generation["stderr"])
patch_path.write_text("tampered after review\n")
- refreshed = run_workbench(state_dir, "get-scan", "--scan-id", scan_id)["scan"]
+ refreshed = get_scan(state_dir, scan_id)["scan"]
assert refreshed["findings"][0]["remediationState"]["patch"] is None
- tampered_apply = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ tampered_apply = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", str(uuid.uuid4()), check=False
)
assert "Patch digest does not match" in str(tampered_apply["stderr"])
- stale_replay = run_workbench(
- state_dir,
- "set-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- "--expected-version",
- "1",
- "--state",
- "failed",
- check=False,
+ stale_replay = set_remediation(
+ state_dir, occurrence_id, request_id, generation_token, "1", "failed", check=False
)
assert "changed. Refresh it" in str(stale_replay["stderr"])
@@ -1840,26 +1529,8 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
nested_repository = target / "untracked-repository"
initialize_git_repository(nested_repository)
workspace_id = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "create-workspace",
- "--workspace-id",
- workspace_id,
- "--target-path",
- str(target),
- )
- run_workbench(
- state_dir,
- "save-workspace",
- "--workspace-id",
- workspace_id,
- "--target-path",
- str(target),
- "--scope",
- ".",
- "--mode",
- "standard",
- )
+ create_workspace(state_dir, workspace_id, "--target-path", str(target))
+ save_workspace(state_dir, workspace_id, str(target), ".", "standard")
started = start_delivered_scan(
state_dir,
"--workspace-id",
@@ -1878,21 +1549,12 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
target_revision=revision,
snapshot_digest=str(started["results"]["contract"]["target"]["requiredSnapshotDigest"]),
)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
scan_dir = Path(str(completed["scanDir"]))
occurrence_id = str(completed["findings"][0]["occurrenceId"])
request_id = str(uuid.uuid4())
generation_token = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- )
+ request_remediation(state_dir, occurrence_id, request_id, generation_token)
patch_path = scan_dir / "remediation.patch"
patch_path.write_text(
"diff --git a/README.md b/README.md\n"
@@ -1903,18 +1565,12 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
"+fixed\n"
)
(target / "README.md").write_text("changed while generating\n")
- stale_generation = run_workbench(
+ stale_generation = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -1924,18 +1580,12 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
)
assert "Working-tree contents changed" in str(stale_generation["stderr"])
(target / "README.md").write_text("fixture\n")
- run_workbench(
+ set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -1943,39 +1593,14 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
f"sha256:{hashlib.sha256(patch_path.read_bytes()).hexdigest()}",
)
(target / "README.md").write_text("changed after patch generation\n")
- stale_checkout = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ stale_checkout = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", str(uuid.uuid4()), check=False
)
assert stale_checkout["returncode"] != 0
assert "Working-tree contents changed" in str(stale_checkout["stderr"])
(target / "README.md").write_text("fixture\n")
apply_token = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- apply_token,
- )
+ request_remediation_action(state_dir, occurrence_id, request_id, "2", "apply", apply_token)
subprocess.run(
["git", "apply", "--directory=nested-target", str(patch_path)],
cwd=repository,
@@ -1992,18 +1617,12 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
ignored_entry.write_text("ignored runtime data\n")
unrelated = target / "unrelated.txt"
unrelated.write_text("not reviewed\n")
- extra_changes = run_workbench(
+ extra_changes = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
apply_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
revision,
@@ -2011,18 +1630,12 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
)
assert "changes outside the reviewed patch" in str(extra_changes["stderr"])
unrelated.unlink()
- applied = run_workbench(
+ applied = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
apply_token,
- "--expected-version",
"3",
- "--state",
"applied",
"--base-revision",
revision,
@@ -2033,63 +1646,33 @@ def test_finding_remediation_rejects_apply_after_checkout_changes(tmp_path: Path
def test_finding_remediation_rejects_delayed_update_after_superseding_patch(tmp_path: Path) -> None:
state_dir, target, scan_id, scan_dir = empty_target_scan(tmp_path)
write_completed_contract(scan_dir, scan_id, target)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
scan_dir = Path(str(completed["scanDir"]))
occurrence_id = str(completed["findings"][0]["occurrenceId"])
first_request_id = str(uuid.uuid4())
first_generation_token = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- first_request_id,
- "--action-token",
- first_generation_token,
- )
+ request_remediation(state_dir, occurrence_id, first_request_id, first_generation_token)
patch_path = scan_dir / "remediation.patch"
patch_path.write_text("diff --git a/src/extract.py b/src/extract.py\n")
- run_workbench(
+ set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
first_request_id,
- "--action-token",
first_generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
"--patch-digest",
f"sha256:{hashlib.sha256(patch_path.read_bytes()).hexdigest()}",
)
- run_workbench(
+ request_remediation(state_dir, occurrence_id, str(uuid.uuid4()), str(uuid.uuid4()))
+ delayed = set_remediation(
state_dir,
- "request-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
- str(uuid.uuid4()),
- "--action-token",
- str(uuid.uuid4()),
- )
- delayed = run_workbench(
- state_dir,
- "set-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
first_request_id,
- "--action-token",
first_generation_token,
- "--expected-version",
"2",
- "--state",
"applied",
"--base-revision",
"unversioned",
@@ -2111,36 +1694,21 @@ def test_finding_remediation_rejects_unversioned_directory_changes(tmp_path: Pat
source.write_text("original\n")
scan_id, scan_dir = start_saved_scan(state_dir, target, tmp_path / "scans")
write_completed_contract(scan_dir, scan_id, target, relative_path=source.name)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
scan_dir = Path(str(completed["scanDir"]))
occurrence_id = str(completed["findings"][0]["occurrenceId"])
request_id = str(uuid.uuid4())
generation_token = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- )
+ request_remediation(state_dir, occurrence_id, request_id, generation_token)
patch_path = scan_dir / "remediation.patch"
patch_path.write_text("diff --git a/source.txt b/source.txt\n")
source.write_text("changed while generating\n")
- stale_generation = run_workbench(
+ stale_generation = set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -2150,18 +1718,12 @@ def test_finding_remediation_rejects_unversioned_directory_changes(tmp_path: Pat
)
assert "Working-tree contents changed" in str(stale_generation["stderr"])
source.write_text("original\n")
- run_workbench(
+ set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -2169,20 +1731,8 @@ def test_finding_remediation_rejects_unversioned_directory_changes(tmp_path: Pat
f"sha256:{hashlib.sha256(patch_path.read_bytes()).hexdigest()}",
)
source.write_text("changed before apply\n")
- stale_apply = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ stale_apply = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", str(uuid.uuid4()), check=False
)
assert "Working-tree contents changed" in str(stale_apply["stderr"])
diff --git a/plugins/codex-security/tests/test_workbench_db_exports.py b/plugins/codex-security/tests/test_workbench_db_exports.py
index eda8075c7..d4a5b3845 100644
--- a/plugins/codex-security/tests/test_workbench_db_exports.py
+++ b/plugins/codex-security/tests/test_workbench_db_exports.py
@@ -21,7 +21,11 @@ from workbench_test_support import (
empty_target_scan,
initialize_git_repository,
mark_deep_coordinator_succeeded,
+ request_remediation,
+ request_remediation_action,
run_workbench,
+ scan_command,
+ set_remediation,
start_delivered_scan,
start_saved_scan,
start_workspace_scan,
@@ -1359,34 +1363,19 @@ def test_completion_rejects_replaced_scan_directory_ancestor(tmp_path: Path) ->
def test_remediation_apply_rejects_replaced_scan_directory_ancestor(tmp_path: Path) -> None:
state_dir, target, scan_id, scan_dir = empty_target_scan(tmp_path)
write_completed_contract(scan_dir, scan_id, target)
- completed = run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]
occurrence_id = str(completed["findings"][0]["occurrenceId"])
request_id = str(uuid.uuid4())
generation_token = str(uuid.uuid4())
- run_workbench(
- state_dir,
- "request-finding-remediation",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--action-token",
- generation_token,
- )
+ request_remediation(state_dir, occurrence_id, request_id, generation_token)
patch_path = scan_dir / "remediation.patch"
patch_path.write_text("diff --git a/src/extract.py b/src/extract.py\n")
- run_workbench(
+ set_remediation(
state_dir,
- "set-finding-remediation",
- "--occurrence-id",
occurrence_id,
- "--request-id",
request_id,
- "--action-token",
generation_token,
- "--expected-version",
"1",
- "--state",
"generated",
"--patch-path",
patch_path.name,
@@ -1399,20 +1388,8 @@ def test_remediation_apply_rejects_replaced_scan_directory_ancestor(tmp_path: Pa
replacement_parent = tmp_path / "replacement-parent"
shutil.copytree(moved_parent, replacement_parent)
stored_parent.symlink_to(replacement_parent, target_is_directory=True)
- failed = run_workbench(
- state_dir,
- "request-finding-remediation-action",
- "--occurrence-id",
- occurrence_id,
- "--request-id",
- request_id,
- "--expected-version",
- "2",
- "--action",
- "apply",
- "--action-token",
- str(uuid.uuid4()),
- check=False,
+ failed = request_remediation_action(
+ state_dir, occurrence_id, request_id, "2", "apply", str(uuid.uuid4()), check=False
)
assert "canonical non-symlink directory" in str(failed["stderr"])
diff --git a/plugins/codex-security/tests/test_workbench_feedback.py b/plugins/codex-security/tests/test_workbench_feedback.py
index 8639cca69..61924dd12 100644
--- a/plugins/codex-security/tests/test_workbench_feedback.py
+++ b/plugins/codex-security/tests/test_workbench_feedback.py
@@ -9,7 +9,10 @@ from typing import Any
import pytest
from workbench_test_support import (
create_saved_workspace,
+ get_scan,
run_workbench,
+ scan_command,
+ set_triage,
stable_target_id,
start_delivered_scan,
write_completed_contract,
@@ -58,7 +61,7 @@ def _complete_scan(
for anchor in anchors
]
findings_path.write_text(json.dumps(document))
- return run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ return scan_command(state_dir, "complete-scan", scan_id)["scan"]
def _close_finding(
@@ -82,7 +85,7 @@ def _close_finding(
def _feedback(state_dir: Path, scan_id: str) -> dict[str, Any]:
- return run_workbench(state_dir, "get-scan-feedback", "--scan-id", scan_id)
+ return scan_command(state_dir, "get-scan-feedback", scan_id)
@pytest.mark.parametrize("mode", ("standard", "deep"))
@@ -120,12 +123,9 @@ def test_false_positive_triage_requires_a_reason(tmp_path: Path, note: str | Non
completed = _complete_scan(state_dir, workspace_id, tmp_path / "scans", target)
occurrence_id = str(completed["findings"][0]["occurrenceId"])
- rejected = run_workbench(
+ rejected = set_triage(
state_dir,
- "set-finding-triage",
- "--occurrence-id",
occurrence_id,
- "--status",
"closed",
"--close-reason",
"false_positive",
@@ -135,7 +135,7 @@ def test_false_positive_triage_requires_a_reason(tmp_path: Path, note: str | Non
assert rejected["returncode"] != 0
assert "Explain why this finding is a false positive." in str(rejected["stderr"])
- scan = run_workbench(state_dir, "get-scan", "--scan-id", str(completed["scanId"]))["scan"]
+ scan = get_scan(state_dir, str(completed["scanId"]))["scan"]
assert scan["findings"][0]["triage"] == {"status": "open"}
@@ -257,14 +257,7 @@ def test_latest_decision_controls_false_positive_feedback(tmp_path: Path) -> Non
feedback["falsePositives"][0]["updatedAt"] == (closed["findings"][0]["triage"]["updatedAt"])
)
- run_workbench(
- state_dir,
- "set-finding-triage",
- "--occurrence-id",
- occurrence_id,
- "--status",
- "open",
- )
+ set_triage(state_dir, occurrence_id, "open")
assert _feedback(state_dir, scan_id)["falsePositives"] == []
_close_finding(state_dir, occurrence_id, "wont_fix", "Accepted risk.")
diff --git a/plugins/codex-security/tests/test_workbench_native_indexes.py b/plugins/codex-security/tests/test_workbench_native_indexes.py
index 43b51651e..617d864e9 100644
--- a/plugins/codex-security/tests/test_workbench_native_indexes.py
+++ b/plugins/codex-security/tests/test_workbench_native_indexes.py
@@ -8,8 +8,12 @@ import pytest
from workbench_test_support import (
create_saved_workspace,
run_workbench,
+ save_workspace,
+ scan_command,
+ set_triage,
stable_target_id,
start_delivered_scan,
+ update_progress,
write_completed_contract,
)
@@ -26,17 +30,8 @@ def complete_scan(
) -> dict[str, object]:
workspace = create_saved_workspace(state_dir, target)
if include_paths is not None:
- workspace = run_workbench(
- state_dir,
- "save-workspace",
- "--workspace-id",
- str(workspace["id"]),
- "--target-path",
- str(target),
- "--scope",
- include_paths[0],
- "--mode",
- "standard",
+ workspace = save_workspace(
+ state_dir, str(workspace["id"]), str(target), include_paths[0], "standard"
)
started = start_delivered_scan(state_dir, "--workspace-id", str(workspace["id"]))
scan_id = str(started["results"]["scanId"])
@@ -65,7 +60,7 @@ def complete_scan(
{"id": "unreviewed-path", "reason": "Review incomplete", "paths": ["src/extract.py"]}
]
coverage_path.write_text(json.dumps(coverage))
- return run_workbench(state_dir, "complete-scan", "--scan-id", scan_id)["scan"]
+ return scan_command(state_dir, "complete-scan", scan_id)["scan"]
@pytest.mark.parametrize(
@@ -147,12 +142,9 @@ def test_global_findings_keep_latest_occurrence_and_stable_target_identity(tmp_p
first_target_id = stable_target_id(first_target)
second_target_id = stable_target_id(second_target)
older_first = complete_scan(state_dir, first_target, identity_anchor="shared-finding")
- run_workbench(
+ set_triage(
state_dir,
- "set-finding-triage",
- "--occurrence-id",
str(older_first["findings"][0]["occurrenceId"]),
- "--status",
"closed",
"--close-reason",
"false_positive",
@@ -183,12 +175,9 @@ def test_global_findings_keep_latest_occurrence_and_stable_target_identity(tmp_p
""",
(latest_first_occurrence, "src/control.py", 10, 12, "root_control", 1),
)
- run_workbench(
+ set_triage(
state_dir,
- "set-finding-triage",
- "--occurrence-id",
distinct_first_occurrence,
- "--status",
"closed",
"--close-reason",
"false_positive",
@@ -246,12 +235,9 @@ def test_repository_index_reports_latest_scan_open_findings_and_missing_checkout
first_target_id = stable_target_id(first_target)
second_target_id = stable_target_id(second_target)
older_first = complete_scan(state_dir, first_target, identity_anchor="first-finding")
- run_workbench(
+ set_triage(
state_dir,
- "set-finding-triage",
- "--occurrence-id",
str(older_first["findings"][0]["occurrenceId"]),
- "--status",
"closed",
"--close-reason",
"false_positive",
@@ -269,14 +255,7 @@ def test_repository_index_reports_latest_scan_open_findings_and_missing_checkout
relative_path="docs/extract.py",
)
latest_second = complete_scan(state_dir, second_target, identity_anchor="second-finding")
- run_workbench(
- state_dir,
- "update-progress",
- "--scan-id",
- str(older_running["results"]["scanId"]),
- "--phase",
- "discovery",
- )
+ update_progress(state_dir, str(older_running["results"]["scanId"]), "--phase", "discovery")
second_target.rename(tmp_path / "moved-second-repo")
repositories = run_workbench(state_dir, "list-repositories")["repositories"]