diff --git a/src/specify_cli/workflows/catalog/command_add.py b/src/specify_cli/workflows/catalog/command_add.py index d333dad936..b78ea56346 100644 --- a/src/specify_cli/workflows/catalog/command_add.py +++ b/src/specify_cli/workflows/catalog/command_add.py @@ -19,7 +19,7 @@ def workflow_catalog_add( try: status = catalog.add_catalog(url, name) except WorkflowValidationError as exc: - cli.console.print(f"[red]Error:[/red] {exc}") + cli.console.print(f"[red]Error:[/red] {cli._escape_markup(str(exc))}") raise cli.typer.Exit(1) safe_url = cli._escape_markup(url.strip()) diff --git a/src/specify_cli/workflows/command_run.py b/src/specify_cli/workflows/command_run.py index 157edb964b..c31501bf9c 100644 --- a/src/specify_cli/workflows/command_run.py +++ b/src/specify_cli/workflows/command_run.py @@ -123,9 +123,13 @@ def workflow_run( if not json_output: cli.console.print( - f"\n[bold cyan]Running workflow:[/bold cyan] {definition.name} ({definition.id})" + f"\n[bold cyan]Running workflow:[/bold cyan] " + f"{cli._escape_markup(definition.name)} " + f"({cli._escape_markup(definition.id)})" + ) + cli.console.print( + f"[dim]Version: {cli._escape_markup(definition.version)}[/dim]\n" ) - cli.console.print(f"[dim]Version: {definition.version}[/dim]\n") try: with cli._stdout_to_stderr_when(json_output): diff --git a/src/specify_cli/workflows/step/catalog/command_add.py b/src/specify_cli/workflows/step/catalog/command_add.py index 32f0c791e7..a33a1490ba 100644 --- a/src/specify_cli/workflows/step/catalog/command_add.py +++ b/src/specify_cli/workflows/step/catalog/command_add.py @@ -20,7 +20,7 @@ def workflow_step_catalog_add( try: status = catalog.add_catalog(url, name) except StepValidationError as exc: - cli.console.print(f"[red]Error:[/red] {exc}") + cli.console.print(f"[red]Error:[/red] {cli._escape_markup(str(exc))}") raise cli.typer.Exit(1) safe_url = cli._escape_markup(url.strip()) diff --git a/src/specify_cli/workflows/step/command_search.py b/src/specify_cli/workflows/step/command_search.py index 0e905e38d3..2f28bd9caa 100644 --- a/src/specify_cli/workflows/step/command_search.py +++ b/src/specify_cli/workflows/step/command_search.py @@ -20,13 +20,13 @@ def workflow_step_search( try: results = catalog.search(query=query) except StepCatalogError as exc: - cli.console.print(f"[red]Error:[/red] {exc}") + cli.console.print(f"[red]Error:[/red] {cli._escape_markup(str(exc))}") raise cli.typer.Exit(1) if not results: if query: cli.console.print( - f"[yellow]No step types found matching '{query}'.[/yellow]" + f"[yellow]No step types found matching '{cli._escape_markup(query)}'.[/yellow]" ) else: cli.console.print("[yellow]No step types found in catalog.[/yellow]") diff --git a/tests/specify_cli/workflows/catalog/test_command_add.py b/tests/specify_cli/workflows/catalog/test_command_add.py index a81634a5ca..43f795d7aa 100644 --- a/tests/specify_cli/workflows/catalog/test_command_add.py +++ b/tests/specify_cli/workflows/catalog/test_command_add.py @@ -47,3 +47,13 @@ def test_workflow_catalog_add_reports_unchanged(project_dir, monkeypatch): assert unchanged.exit_code == 0, unchanged.output assert "already configured" in unchanged.output + + +def test_workflow_catalog_add_escapes_invalid_url_in_error(project_dir, monkeypatch): + monkeypatch.chdir(project_dir) + + result = CliRunner().invoke(app, ["workflow", "catalog", "add", "https://[/x]"]) + + assert result.exit_code == 1 + assert "https://[/x]" in result.output + assert "MarkupError" not in result.output diff --git a/tests/specify_cli/workflows/step/catalog/test_command_add.py b/tests/specify_cli/workflows/step/catalog/test_command_add.py index 4e39f84834..0d125fd84f 100644 --- a/tests/specify_cli/workflows/step/catalog/test_command_add.py +++ b/tests/specify_cli/workflows/step/catalog/test_command_add.py @@ -49,3 +49,18 @@ def test_workflow_step_catalog_add_reports_unchanged(project_dir, monkeypatch): assert unchanged.exit_code == 0, unchanged.output assert "already configured" in unchanged.output + + +def test_workflow_step_catalog_add_escapes_invalid_url_in_error( + project_dir, monkeypatch +): + monkeypatch.chdir(project_dir) + + result = CliRunner().invoke( + app, + ["workflow", "step", "catalog", "add", "https://[/x]"], + ) + + assert result.exit_code == 1 + assert "https://[/x]" in result.output + assert "MarkupError" not in result.output diff --git a/tests/specify_cli/workflows/step/test_command_search.py b/tests/specify_cli/workflows/step/test_command_search.py index 60f7852c7c..c2e3dcb21d 100644 --- a/tests/specify_cli/workflows/step/test_command_search.py +++ b/tests/specify_cli/workflows/step/test_command_search.py @@ -2,6 +2,12 @@ from typing import ClassVar +import pytest +from typer.testing import CliRunner + +from specify_cli import app +from specify_cli.workflows.step.catalog import StepCatalog, StepCatalogError + class TestWorkflowStepRichMarkup: """Step discovery commands render metadata as literal text.""" @@ -14,14 +20,7 @@ class TestWorkflowStepRichMarkup: "description": "[blue]Description[/blue]", } - def test_search_escapes_catalog_metadata( - self, project_dir, monkeypatch - ): - from typer.testing import CliRunner - - from specify_cli import app - from specify_cli.workflows.step.catalog import StepCatalog - + def test_search_escapes_catalog_metadata(self, project_dir, monkeypatch): metadata = dict(self.METADATA) monkeypatch.chdir(project_dir) monkeypatch.setattr( @@ -35,3 +34,30 @@ def test_search_escapes_catalog_metadata( assert metadata["id"] in result.output assert metadata["version"] in result.output assert metadata["description"] in result.output + + +@pytest.mark.parametrize("query", ["[/x]", "a[red]b"]) +def test_workflow_step_search_displays_query_markup_literally( + project_dir, monkeypatch, query +): + monkeypatch.chdir(project_dir) + monkeypatch.setattr(StepCatalog, "search", lambda _catalog, query=None: []) + + result = CliRunner().invoke(app, ["workflow", "step", "search", query]) + + assert result.exit_code == 0, result.output + assert f"No step types found matching '{query}'." in result.output + + +def test_workflow_step_search_escapes_catalog_error_markup(project_dir, monkeypatch): + monkeypatch.chdir(project_dir) + + def raise_catalog_error(self, query=None): + raise StepCatalogError("Invalid step id [/x]") + + monkeypatch.setattr(StepCatalog, "search", raise_catalog_error) + result = CliRunner().invoke(app, ["workflow", "step", "search"]) + + assert result.exit_code == 1 + assert "Invalid step id [/x]" in result.output + assert "MarkupError" not in result.output diff --git a/tests/specify_cli/workflows/test_command_run.py b/tests/specify_cli/workflows/test_command_run.py index 316af276b5..975b8f949a 100644 --- a/tests/specify_cli/workflows/test_command_run.py +++ b/tests/specify_cli/workflows/test_command_run.py @@ -515,6 +515,17 @@ def test_run_default_output_is_human_not_json(self, project_dir): with pytest.raises(json.JSONDecodeError): json.loads(result.stdout) + def test_run_displays_workflow_name_markup_literally(self, project_dir): + workflow = self._WF_DONE.replace( + 'name: "JSON Done"', 'name: "Build [/x] pipeline"' + ) + wf = self._write_wf(project_dir, workflow, "markup-name") + + result = self._invoke(project_dir, ["workflow", "run", str(wf)]) + + assert result.exit_code == 0, result.output + assert "Running workflow: Build [/x] pipeline" in result.stdout + def test_json_redirect_keeps_stdout_clean(self, capfd): # While a workflow runs under --json, steps can still write to stdout: # the gate step prints its prompt and the prompt step runs a