π« Toolkit to help you get started with SDD or any other process!
fix(workflows): report validation errors instead of crashing on non-string workflow.yml scalars (#3421)
Marsel Safin34514fb20a34
diff --git a/src/specify_cli/workflows/_commands.py b/src/specify_cli/workflows/_commands.pyindex b1eecd619..e1d29b47d 100644--- a/src/specify_cli/workflows/_commands.py+++ b/src/specify_cli/workflows/_commands.py@@ -601,7 +601,15 @@ def workflow_add(except (ValueError, yaml.YAMLError) as exc:console.print(f"[red]Error:[/red] Invalid workflow YAML: {exc}")raise typer.Exit(1)- if not definition.id or not definition.id.strip():+ # Non-string ids (e.g. unquoted ``id: 123`` or ``id: 0``) fall through+ # to validate_workflow below, which reports a typed error instead of+ # crashing on ``.strip()`` here. Only None/empty/whitespace-only ids+ # are rejected as missing.+ if (+ definition.id is None+ or definition.id == ""+ or (isinstance(definition.id, str) and not definition.id.strip())+ ):console.print("[red]Error:[/red] Workflow definition has an empty or missing 'id'")raise typer.Exit(1)diff --git a/src/specify_cli/workflows/engine.py b/src/specify_cli/workflows/engine.pyindex 68f2ca6f3..6025c30c5 100644--- a/src/specify_cli/workflows/engine.py+++ b/src/specify_cli/workflows/engine.py@@ -129,26 +129,49 @@ def validate_workflow(definition: WorkflowDefinition) -> list[str]:errors: list[str] = []# -- Schema version ---------------------------------------------------- if definition.schema_version not in ("1.0", "1"):+ # str() so an unquoted ``schema_version: 1.0`` (YAML float) is accepted β+ # rejecting it would print "Unsupported schema_version 1.0. Expected '1.0'."+ if str(definition.schema_version) != "1.0":errors.append(f"Unsupported schema_version {definition.schema_version!r}. "f"Expected '1.0'.")# -- Top-level fields -------------------------------------------------- if not definition.id:+ # YAML parses unquoted scalars like ``id: 123`` or ``version: 1.0`` as+ # int/float; check types before regex/string operations so authoring+ # mistakes surface as validation errors instead of tracebacks. Only+ # ``None``/empty-string count as missing so falsey non-strings+ # (``id: 0``, ``name: false``) still get the typed error.+ if definition.id is None or definition.id == "":errors.append("Workflow is missing 'workflow.id'.")+ elif not isinstance(definition.id, str):+ errors.append(+ f"'workflow.id' must be a string, got "+ f"{type(definition.id).__name__} ({definition.id!r})."+ )elif not _ID_PATTERN.match(definition.id):errors.append(f"Workflow ID {definition.id!r} must be lowercase alphanumeric "f"with hyphens.")- if not definition.name:+ if definition.name is None or definition.name == "":errors.append("Workflow is missing 'workflow.name'.")+ elif not isinstance(definition.name, str):+ errors.append(+ f"'workflow.name' must be a string, got "+ f"{type(definition.name).__name__} ({definition.name!r})."+ )- if not definition.version:+ if definition.version is None or definition.version == "":errors.append("Workflow is missing 'workflow.version'.")+ elif not isinstance(definition.version, str):+ errors.append(+ f"'workflow.version' must be a string, got "+ f"{type(definition.version).__name__} ({definition.version!r}) β "+ f'quote it in YAML (version: "1.0.0").'+ )elif not re.match(r"^\d+\.\d+\.\d+$", definition.version):errors.append(f"Workflow version {definition.version!r} is not valid "@@ -256,9 +279,15 @@ def _validate_steps(continuestep_id = step_config.get("id")- if not step_id:+ if step_id is None or step_id == "":errors.append("Step is missing 'id' field.")continue+ if not isinstance(step_id, str):+ errors.append(+ f"Step ID must be a string, got "+ f"{type(step_id).__name__} ({step_id!r})."+ )+ continueif ":" in step_id:errors.append(diff --git a/tests/test_workflows.py b/tests/test_workflows.pyindex 00e0bafed..d7cff20f6 100644--- a/tests/test_workflows.py+++ b/tests/test_workflows.py@@ -2794,6 +2794,101 @@ steps:errors = validate_workflow(definition)assert any("lowercase alphanumeric" in e for e in errors)+ def test_non_string_workflow_id_reports_error(self):+ from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow++ definition = WorkflowDefinition.from_string("""+workflow:+ id: 123+ name: "Test"+ version: "1.0.0"+steps:+ - id: step-one+ command: speckit.specify+""")+ errors = validate_workflow(definition)+ assert any("workflow.id" in e and "string" in e for e in errors)++ def test_non_string_name_reports_error(self):+ from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow++ definition = WorkflowDefinition.from_string("""+workflow:+ id: "test"+ name: 123+ version: "1.0.0"+steps:+ - id: step-one+ command: speckit.specify+""")+ errors = validate_workflow(definition)+ assert any("workflow.name" in e and "string" in e for e in errors)++ def test_unquoted_float_version_reports_error(self):+ from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow++ definition = WorkflowDefinition.from_string("""+workflow:+ id: "test"+ name: "Test"+ version: 1.0+steps:+ - id: step-one+ command: speckit.specify+""")+ errors = validate_workflow(definition)+ assert any("workflow.version" in e and "quote" in e for e in errors)++ def test_non_string_step_id_reports_error(self):+ from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow++ definition = WorkflowDefinition.from_string("""+workflow:+ id: "test"+ name: "Test"+ version: "1.0.0"+steps:+ - id: 123+ command: speckit.specify+""")+ errors = validate_workflow(definition)+ assert any("Step ID" in e and "string" in e for e in errors)++ def test_falsey_non_string_scalars_report_typed_errors(self):+ from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow++ definition = WorkflowDefinition.from_string("""+workflow:+ id: 0+ name: false+ version: 0.0+steps:+ - id: 0+ command: speckit.specify+""")+ errors = validate_workflow(definition)+ assert any("'workflow.id' must be a string" in e for e in errors)+ assert any("'workflow.name' must be a string" in e for e in errors)+ assert any("'workflow.version' must be a string" in e for e in errors)+ assert any("Step ID must be a string" in e for e in errors)+ assert not any("missing" in e for e in errors)++ def test_unquoted_schema_version_accepted(self):+ from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow++ definition = WorkflowDefinition.from_string("""+schema_version: 1.0+workflow:+ id: "test"+ name: "Test"+ version: "1.0.0"+steps:+ - id: step-one+ command: speckit.specify+""")+ errors = validate_workflow(definition)+ assert errors == []+def test_no_steps(self):from specify_cli.workflows.engine import WorkflowDefinition, validate_workflow@@ -7049,3 +7144,53 @@ steps:},)assert _gate_outcome(state) is None+++class TestWorkflowAddNonStringScalars:+ """`workflow add` reports clean errors for non-string YAML scalars (#3420)."""++ @pytest.mark.parametrize(+ ("field_yaml", "expected"),+ [+ ('id: 123\n name: "Probe"\n version: "1.0.0"', "workflow.id"),+ ('id: "probe"\n name: "Probe"\n version: 1.0', "workflow.version"),+ ],+ )+ def test_add_reports_validation_error_not_traceback(+ self, project_dir, monkeypatch, field_yaml, expected+ ):+ from typer.testing import CliRunner+ from specify_cli import app++ monkeypatch.chdir(project_dir)+ wf = project_dir / "workflow.yml"+ wf.write_text(+ "schema_version: \"1.0\"\n"+ f"workflow:\n {field_yaml}\n"+ "steps:\n - id: s1\n type: shell\n run: \"echo hi\"\n",+ encoding="utf-8",+ )+ runner = CliRunner()+ result = runner.invoke(app, ["workflow", "add", str(wf)])+ assert result.exit_code == 1+ assert result.exception is None or isinstance(result.exception, SystemExit)+ assert expected in result.output++ def test_add_non_string_step_id_reports_validation_error(+ self, project_dir, monkeypatch+ ):+ from typer.testing import CliRunner+ from specify_cli import app++ monkeypatch.chdir(project_dir)+ wf = project_dir / "workflow.yml"+ wf.write_text(+ "workflow:\n id: \"probe\"\n name: \"Probe\"\n version: \"1.0.0\"\n"+ "steps:\n - id: 123\n type: shell\n run: \"echo hi\"\n",+ encoding="utf-8",+ )+ runner = CliRunner()+ result = runner.invoke(app, ["workflow", "add", str(wf)])+ assert result.exit_code == 1+ assert result.exception is None or isinstance(result.exception, SystemExit)+ assert "Step ID" in result.output