💫 Toolkit to help you get started with SDD or any other process!
feat(workflows): opt-in output_format: json exposes parsed shell stdout as output.data (#2963)
Huy Do071f784dfa4b
diff --git a/src/specify_cli/workflows/steps/shell/__init__.py b/src/specify_cli/workflows/steps/shell/__init__.pyindex 73ac99530..8c62e4cfa 100644--- a/src/specify_cli/workflows/steps/shell/__init__.py+++ b/src/specify_cli/workflows/steps/shell/__init__.py@@ -2,6 +2,7 @@from __future__ import annotations+import jsonimport subprocessfrom typing import Any@@ -49,6 +50,23 @@ class ShellStep(StepBase):error=f"Shell command exited with code {proc.returncode}.",output=output,)+ if config.get("output_format") == "json":+ # Opt-in structured output: expose the parsed stdout under+ # ``output.data`` so later steps can consume typed values+ # (e.g. a fan-out's ``items:``). A parse failure fails the+ # step — declaring ``output_format: json`` is a contract.+ try:+ output["data"] = json.loads(proc.stdout)+ except json.JSONDecodeError as exc:+ return StepResult(+ status=StepStatus.FAILED,+ error=(+ f"Shell step {config.get('id', '?')!r} declared "+ f"output_format: json but stdout is not valid "+ f"JSON: {exc}"+ ),+ output=output,+ )return StepResult(status=StepStatus.COMPLETED,output=output,@@ -72,4 +90,10 @@ class ShellStep(StepBase):errors.append(f"Shell step {config.get('id', '?')!r} is missing 'run' field.")+ output_format = config.get("output_format")+ if output_format is not None and output_format != "json":+ errors.append(+ f"Shell step {config.get('id', '?')!r}: 'output_format' must "+ f"be 'json' when present, got {output_format!r}."+ )return errorsdiff --git a/tests/test_workflows.py b/tests/test_workflows.pyindex 00a6bb8c4..6e1eaabf0 100644--- a/tests/test_workflows.py+++ b/tests/test_workflows.py@@ -912,6 +912,17 @@ class TestPromptStep:class TestShellStep:"""Test the shell step type."""+ @staticmethod+ def _python_run(tmp_path, body):+ """A portable shell ``run`` that executes ``body`` with the current+ interpreter, avoiding non-portable shell quoting (e.g. Windows+ ``cmd.exe`` keeping single quotes) in the output_format tests."""+ import sys++ script = tmp_path / "emit.py"+ script.write_text(body, encoding="utf-8")+ return f'"{sys.executable}" "{script}"'+def test_execute_echo(self):from specify_cli.workflows.steps.shell import ShellStepfrom specify_cli.workflows.base import StepContext, StepStatus@@ -944,6 +955,62 @@ class TestShellStep:assert any("missing 'run'" in e for e in errors)+ def test_output_format_json_exposes_data(self, tmp_path):+ from specify_cli.workflows.steps.shell import ShellStep+ from specify_cli.workflows.base import StepContext, StepStatus++ step = ShellStep()+ ctx = StepContext(project_root=str(tmp_path))+ config = {+ "id": "emit",+ "run": self._python_run(+ tmp_path, 'import json; print(json.dumps({"items": [1, 2]}))\n'+ ),+ "output_format": "json",+ }+ result = step.execute(config, ctx)+ assert result.status == StepStatus.COMPLETED+ assert result.output["data"] == {"items": [1, 2]}+ assert result.output["exit_code"] == 0 # raw keys still present++ def test_output_format_json_invalid_stdout_fails(self, tmp_path):+ from specify_cli.workflows.steps.shell import ShellStep+ from specify_cli.workflows.base import StepContext, StepStatus++ step = ShellStep()+ ctx = StepContext(project_root=str(tmp_path))+ config = {+ "id": "emit",+ "run": self._python_run(tmp_path, "print('not-json')\n"),+ "output_format": "json",+ }+ result = step.execute(config, ctx)+ assert result.status == StepStatus.FAILED+ assert "output_format: json" in (result.error or "")++ def test_no_output_format_keeps_raw_output_only(self, tmp_path):+ from specify_cli.workflows.steps.shell import ShellStep+ from specify_cli.workflows.base import StepContext, StepStatus++ step = ShellStep()+ ctx = StepContext(project_root=str(tmp_path))+ config = {+ "id": "emit",+ "run": self._python_run(+ tmp_path, 'import json; print(json.dumps({"items": []}))\n'+ ),+ }+ result = step.execute(config, ctx)+ assert result.status == StepStatus.COMPLETED+ assert "data" not in result.output++ def test_validate_rejects_unknown_output_format(self):+ from specify_cli.workflows.steps.shell import ShellStep++ step = ShellStep()+ errors = step.validate({"id": "emit", "run": "exit 0", "output_format": "yaml"})+ assert any("'output_format' must be 'json'" in e for e in errors)+class _StubStdin:"""Stdin stub exposing only a fixed ``isatty`` result.