π« Toolkit to help you get started with SDD or any other process!
fix(workflows): route 'workflow status --json' errors to stderr (#3520)
Ali jawwadf75f5f836b35
diff --git a/src/specify_cli/workflows/_commands.py b/src/specify_cli/workflows/_commands.pyindex 9ab199c02..c01903322 100644--- a/src/specify_cli/workflows/_commands.py+++ b/src/specify_cli/workflows/_commands.py@@ -1262,14 +1262,18 @@ def workflow_status(engine = WorkflowEngine(project_root)if run_id:+ # Route errors to stderr under --json so the stdout JSON stream stays+ # parseable (mirrors `workflow run`/`workflow resume`); both handlers+ # fire before the json_output branch below.+ err = _error_console(json_output)try:from .engine import RunStatestate = RunState.load(run_id, project_root)except FileNotFoundError:- console.print(f"[red]Error:[/red] Run not found: {run_id}")+ err.print(f"[red]Error:[/red] Run not found: {run_id}")raise typer.Exit(1)except ValueError as exc:- console.print(f"[red]Error:[/red] {_escape_markup(str(exc))}")+ err.print(f"[red]Error:[/red] {_escape_markup(str(exc))}")raise typer.Exit(1)if json_output:diff --git a/tests/test_workflows.py b/tests/test_workflows.pyindex 7472585b4..4afc5455c 100644--- a/tests/test_workflows.py+++ b/tests/test_workflows.py@@ -13000,6 +13000,58 @@ steps:assert result.exit_code != 0assert "Run not found: nonexistent-run" in result.output+ def test_status_json_not_found_error_goes_to_stderr(+ self, project_dir, monkeypatch, capsys+ ):+ """Under --json, the not-found/invalid-run error must go to stderr so the+ stdout JSON stream stays parseable (empty on the error path) β mirroring+ `workflow run`/`workflow resume`. Before this fix both handlers used the+ stdout console, corrupting a consumer's json.loads(stdout)."""+ import typer+ from specify_cli.workflows import _commands++ (project_dir / ".specify" / "workflows").mkdir(parents=True, exist_ok=True)+ monkeypatch.setattr(+ _commands, "_require_specify_project", lambda: project_dir+ )+ with pytest.raises(typer.Exit) as exc:+ _commands.workflow_status("does-not-exist", json_output=True)+ assert exc.value.exit_code == 1+ captured = capsys.readouterr()+ assert "Run not found" in captured.err+ assert "Run not found" not in captured.out+ # stdout carries no partial/corrupt JSON on the error path.+ assert captured.out.strip() == ""++ def test_status_json_invalid_run_error_goes_to_stderr(+ self, project_dir, monkeypatch, capsys+ ):+ """The ValueError handler (a malformed/invalid run state) must ALSO route+ to stderr under --json, not just the FileNotFoundError one β otherwise a+ regression there would silently corrupt the JSON stream and this suite+ wouldn't catch it."""+ import typer+ from specify_cli.workflows import _commands+ from specify_cli.workflows.engine import RunState++ (project_dir / ".specify" / "workflows").mkdir(parents=True, exist_ok=True)+ monkeypatch.setattr(+ _commands, "_require_specify_project", lambda: project_dir+ )++ def _raise_value_error(*args, **kwargs):+ raise ValueError("corrupt run state: bad status")++ monkeypatch.setattr(RunState, "load", _raise_value_error)++ with pytest.raises(typer.Exit) as exc:+ _commands.workflow_status("some-run", json_output=True)+ assert exc.value.exit_code == 1+ captured = capsys.readouterr()+ assert "corrupt run state" in captured.err+ assert "corrupt run state" not in captured.out+ assert captured.out.strip() == ""+def test_status_no_run_id_list_path_unaffected(self, project_dir, monkeypatch):"""The no-run-id list-all-runs path must remain unaffected by thenew single-run ValueError boundary."""