π« Toolkit to help you get started with SDD or any other process!
fix(bundle): escape Rich markup in bundle CLI error and status output (#4023)
Noor ul ain36da77f86453
diff --git a/src/specify_cli/commands/bundle/__init__.py b/src/specify_cli/commands/bundle/__init__.pyindex 10df8aca1..7ccc6cba3 100644--- a/src/specify_cli/commands/bundle/__init__.py+++ b/src/specify_cli/commands/bundle/__init__.py@@ -45,7 +45,12 @@ def _fail(message: str) -> None:"""Print an actionable error to stderr and exit non-zero."""# Use the stderr console so the error never lands on stdout, which under# ``--json`` carries the machine-readable payload and must stay parseable.- err_console.print(f"[red]Error:[/red] {message}", style=None)+ # Escape the message: every caller passes ``str(exc)`` from a BundlerError+ # that interpolates untrusted data (a CLI argument, a catalog url, a+ # bundle.yml field), so a '[...]' in it would be parsed as a Rich style tag+ # -- silently swallowing the text, or raising MarkupError on an unbalanced+ # closer and replacing the whole message with a traceback.+ err_console.print(f"[red]Error:[/red] {_escape_markup(message)}", style=None)raise typer.Exit(code=1)@@ -332,9 +337,10 @@ def bundle_list(console.print("\n[bold cyan]Installed bundles:[/bold cyan]\n")for record in records:console.print(- f" [bold]{record.bundle_id}[/bold] v{record.version} "+ f" [bold]{_escape_markup(str(record.bundle_id))}[/bold] "+ f"v{_escape_markup(str(record.version))} "f"[dim]({len(record.contributed_components)} components, "- f"installed {record.installed_at})[/dim]"+ f"installed {_escape_markup(str(record.installed_at))})[/dim]")@@ -394,13 +400,13 @@ def bundle_install()console.print(f"[cyan]No Spec Kit project here; initializing with integration "- f"'{init_integration}'β¦[/cyan]"+ f"'{_escape_markup(str(init_integration))}'β¦[/cyan]")_run_init(init_integration, script_type=_default_script_type(), offline=offline)project_root = require_project_root()for overlap in _bundle_overlaps(project_root, manifest, offline=offline):- console.print(f"[yellow]![/yellow] {overlap}")+ console.print(f"[yellow]![/yellow] {_escape_markup(str(overlap))}")# For an already-initialized project, the project's recorded active# integration is authoritative β an explicit --integration must not be@@ -415,7 +421,7 @@ def bundle_install(integration_explicit=bool(integration) and detected is None,)for warning in plan.warnings:- console.print(f"[yellow]![/yellow] {warning}")+ console.print(f"[yellow]![/yellow] {_escape_markup(str(warning))}")result = install_bundle(project_root,@@ -428,7 +434,7 @@ def bundle_install(returnconsole.print(- f"[green]β[/green] Installed '{result.bundle_id}' "+ f"[green]β[/green] Installed '{_escape_markup(str(result.bundle_id))}' "f"({len(result.installed)} added, {len(result.skipped)} already present).")@@ -480,7 +486,10 @@ def bundle_update(integration_explicit=bool(integration) and detected is None,)install_bundle(project_root, plan, installer, manifest=manifest, refresh=True)- console.print(f"[green]β[/green] Updated '{target}' to v{plan.version}.")+ console.print(+ f"[green]β[/green] Updated '{_escape_markup(str(target))}' "+ f"to v{_escape_markup(str(plan.version))}."+ )except BundlerError as exc:_fail(str(exc))return@@ -502,7 +511,7 @@ def bundle_remove(returnconsole.print(- f"[green]β[/green] Removed '{result.bundle_id}' "+ f"[green]β[/green] Removed '{_escape_markup(str(result.bundle_id))}' "f"({len(result.uninstalled)} uninstalled, {len(result.skipped)} kept for other bundles).")@@ -542,13 +551,16 @@ def bundle_validate(returnfor warning in report.warnings:- console.print(f"[yellow]![/yellow] {warning}")+ console.print(f"[yellow]![/yellow] {_escape_markup(str(warning))}")if not report.ok:console.print("[red]Manifest is invalid:[/red]")for error in report.errors:- console.print(f" [red]-[/red] {error}")+ console.print(f" [red]-[/red] {_escape_markup(str(error))}")raise typer.Exit(code=1)- console.print(f"[green]β[/green] {manifest.bundle.id} is well-formed and valid.")+ console.print(+ f"[green]β[/green] {_escape_markup(str(manifest.bundle.id))} "+ "is well-formed and valid."+ )@bundle_app.command("build")@@ -571,8 +583,9 @@ def bundle_build(returnconsole.print(- f"[green]β[/green] Built {result.artifact_path.name} "- f"({result.file_count} files) β {result.artifact_path}"+ f"[green]β[/green] Built {_escape_markup(result.artifact_path.name)} "+ f"({result.file_count} files) β "+ f"{_escape_markup(str(result.artifact_path))}")@@ -591,7 +604,7 @@ def bundle_init(init_integration = _resolve_init_integration(integration, None)console.print(f"[cyan]Initializing a Spec Kit project with integration "- f"'{init_integration}'β¦[/cyan]"+ f"'{_escape_markup(str(init_integration))}'β¦[/cyan]")_run_init(init_integration, script_type=_default_script_type(), offline=offline)project_root = require_project_root()@@ -599,7 +612,10 @@ def bundle_init(_fail(str(exc))return- console.print(f"[green]β[/green] Spec Kit project ready at {project_root}.")+ console.print(+ f"[green]β[/green] Spec Kit project ready at "+ f"{_escape_markup(str(project_root))}."+ )if bundle:bundle_install(bundle, integration=integration, offline=offline)@@ -623,10 +639,11 @@ def catalog_list() -> None:only_builtin = all(s.scope == Scope.BUILTIN for s in sources)for source in sources:console.print(- f" [bold]{source.id}[/bold] priority={source.priority} "+ f" [bold]{_escape_markup(str(source.id))}[/bold] "+ f"priority={source.priority} "f"policy={source.install_policy.value} scope={source.scope.value}")- console.print(f" [dim]{source.url}[/dim]")+ console.print(f" [dim]{_escape_markup(str(source.url))}[/dim]")if only_builtin:console.print("\n[dim]Using the built-in default stack.[/dim]")@@ -651,7 +668,7 @@ def catalog_add(returnconsole.print(- f"[green]β[/green] Added catalog '{source.id}' "+ f"[green]β[/green] Added catalog '{_escape_markup(str(source.id))}' "f"(priority {source.priority}, {source.install_policy.value}).")@@ -670,7 +687,10 @@ def catalog_remove(_fail(str(exc))return- console.print(f"[green]β[/green] Removed catalog source '{removed}'.")+ console.print(+ f"[green]β[/green] Removed catalog source "+ f"'{_escape_markup(str(removed))}'."+ )# ZIP magic-byte signatures used to detect .zip payloads from REST API assetdiff --git a/tests/contract/test_bundle_cli.py b/tests/contract/test_bundle_cli.pyindex 830a22c5d..bed2f8964 100644--- a/tests/contract/test_bundle_cli.py+++ b/tests/contract/test_bundle_cli.py@@ -217,6 +217,31 @@ def test_catalog_remove_builtin_is_refused(project: Path):assert "built-in" in result.output+# Every ``bundle`` error path funnels through ``_fail(str(exc))``, and the+# BundlerError messages interpolate untrusted data -- including the command's+# own argument. An unbalanced closer used to raise MarkupError instead of the+# error, leaving the user with a traceback and no message at all.+ "argv, expected",+ [+ (+ ["bundle", "catalog", "add", "ssh://ex[/red]ample.com/c.json"],+ "ssh://ex[/red]ample.com/c.json",+ ),+ (["bundle", "catalog", "remove", "no[/red]such"], "no[/red]such"),+ (["bundle", "update", "no[/red]such"], "no[/red]such"),+ (["bundle", "remove", "no[/red]such"], "no[/red]such"),+ ],+)+def test_error_paths_escape_rich_markup(project: Path, argv: list, expected: str):+ result = runner.invoke(app, argv)++ assert result.exit_code == 1+ # A MarkupError would surface here as an exception rather than a clean exit.+ assert isinstance(result.exception, SystemExit)+ assert expected in strip_ansi(result.output)++def test_validate_reports_invalid_manifest(project: Path):data = valid_manifest_dict()del data["bundle"]["license"]@@ -237,6 +262,33 @@ def test_validate_accepts_valid_manifest(project: Path):assert "valid" in result.output+def test_validate_escapes_manifest_markup_in_errors(project: Path):+ data = valid_manifest_dict()+ # An invalid constraint is echoed back inside the validation error.+ data["requires"] = {"speckit_version": ">=1.0[/bold]"}+ (project / "bundle.yml").write_text(yaml.safe_dump(data), encoding="utf-8")++ result = runner.invoke(app, ["bundle", "validate", "--offline"])++ assert result.exit_code == 1+ assert isinstance(result.exception, SystemExit)+ assert ">=1.0[/bold]" in strip_ansi(result.output)+++def test_validate_escapes_manifest_markup_in_warnings(project: Path):+ data = valid_manifest_dict()+ # Step ids are not charset-validated, and the unresolved-reference warning+ # echoes them -- so an otherwise *valid* manifest crashed just as readily as+ # an invalid one, on the success path.+ data["provides"]["steps"] = [{"id": "step[/bold]a"}]+ (project / "bundle.yml").write_text(yaml.safe_dump(data), encoding="utf-8")++ result = runner.invoke(app, ["bundle", "validate", "--offline"])++ assert result.exit_code == 0, repr(result.exception)+ assert "step[/bold]a" in strip_ansi(result.output)++def test_validate_rejects_broken_reference(project: Path):# Synthetic component ids resolve to nothing in any catalog β hard failure.(project / "bundle.yml").write_text(@@ -267,6 +319,65 @@ def test_build_produces_artifact(project: Path):assert len(artifacts) == 1+def test_build_escapes_markup_in_output_path(project: Path):+ """The build success line echoes a caller-supplied ``--output`` path.++ Brackets are legal in a directory name on both POSIX and Windows, so the+ artifact is built and *then* misreported: ``[bold]`` is consumed as a style+ tag, and the success line names a path that does not exist on disk.++ A closing tag (``[/red]``) would raise MarkupError outright, but ``/`` is a+ path separator on Windows, so this uses the silent-swallow form to keep the+ fixture portable.+ """+ (project / "bundle.yml").write_text(+ yaml.safe_dump(valid_manifest_dict()), encoding="utf-8"+ )+ (project / "README.md").write_text("# Demo", encoding="utf-8")+ out_dir = project / "dist[bold]out"++ result = runner.invoke(app, ["bundle", "build", "--output", str(out_dir)])++ assert result.exit_code == 0, repr(result.exception)+ assert list(out_dir.glob("*.zip")), "the artifact should still be built"+ assert "dist[bold]out" in strip_ansi(result.output), (+ "the reported path must match the directory actually written"+ )+++def test_list_escapes_markup_in_records(project: Path):+ """``bundle list`` renders record fields that are never charset-validated.++ ``InstalledBundleRecord.from_dict`` accepts any non-empty string for+ ``bundle_id``/``version`` and any string for ``installed_at``, so a records+ file that *loads cleanly* could still crash the command that displays it.+ """+ (project / ".specify" / "bundle-records.json").write_text(+ json.dumps(+ {+ "schema_version": "1.0",+ "bundles": [+ {+ "bundle_id": "demo[/red]id",+ "version": "1.0.0[/bold]",+ "installed_at": "2026-01-01T00:00:00Z[/dim]",+ "contributed_components": [],+ }+ ],+ }+ ),+ encoding="utf-8",+ )++ result = runner.invoke(app, ["bundle", "list"])++ assert result.exit_code == 0, repr(result.exception)+ output = strip_ansi(result.output)+ assert "demo[/red]id" in output+ assert "1.0.0[/bold]" in output+ assert "2026-01-01T00:00:00Z[/dim]" in output++def _mock_manifest_download(monkeypatch, source_path: Path) -> None:"""Mock the HTTPS manifest fetch to return a locally-authored manifest.