💫 Toolkit to help you get started with SDD or any other process!
fix: reject trailing newlines in extension IDs (#5186)
Manfred Riem2a23a848f888
diff --git a/src/specify_cli/extensions/__init__.py b/src/specify_cli/extensions/__init__.pyindex f6005f601..c5f47bf9b 100644--- a/src/specify_cli/extensions/__init__.py+++ b/src/specify_cli/extensions/__init__.py@@ -324,7 +324,7 @@ class ExtensionManifest:)# Validate extension ID format- if not re.match(r"^[a-z0-9-]+$", ext["id"]):+ if not re.fullmatch(r"[a-z0-9-]+", ext["id"]):raise ValidationError(f"Invalid extension ID '{ext['id']}': ""must be lowercase alphanumeric with hyphens only"diff --git a/src/specify_cli/extensions/_commands.py b/src/specify_cli/extensions/_commands.pyindex 08fe6747f..8019656fb 100644--- a/src/specify_cli/extensions/_commands.py+++ b/src/specify_cli/extensions/_commands.py@@ -64,9 +64,9 @@ def _command_safe_id(raw_id: object, placeholder: str = "<extension-id>") -> str``foo; rm -rf ~`` could otherwise be interpolated into a command weexplicitly encourage the user to copy and run. ``rich.markup.escape`` onlyneutralizes Rich markup, not shell metacharacters, so it is not sufficient- here. Only emit the real ID when it matches the same+ here. Only emit the real ID when its entire value matches the samelowercase-alphanumeric-and-hyphen rule ``ExtensionManifest`` enforces- (``^[a-z0-9-]+$``); otherwise fall back to a literal placeholder so the+ (a full match of ``[a-z0-9-]+``); otherwise fall back to a literal placeholder so theprinted command never carries catalog-controlled shell text.A leading hyphen is additionally rejected: an ID like ``--force`` satisfies@@ -78,7 +78,7 @@ def _command_safe_id(raw_id: object, placeholder: str = "<extension-id>") -> strtext = str(raw_id)if text.startswith("-"):return placeholder- if VALID_EXTENSION_ARTIFACT_NAME_PATTERN.match(text):+ if VALID_EXTENSION_ARTIFACT_NAME_PATTERN.fullmatch(text):return textreturn placeholderdiff --git a/tests/specify_cli/extensions/test_command_add.py b/tests/specify_cli/extensions/test_command_add.pyindex f898fa052..4b6770670 100644--- a/tests/specify_cli/extensions/test_command_add.py+++ b/tests/specify_cli/extensions/test_command_add.py@@ -400,7 +400,8 @@ class TestExtensionAddCLI:# It must not emit the space-containing display name as the command target.assert "add Jira Integration --from" not in output- def test_add_discovery_only_error_neutralizes_unsafe_id(self, tmp_path):+ @pytest.mark.parametrize("malicious_id", ["foo; rm -rf ~", "foo\n"])+ def test_add_discovery_only_error_neutralizes_unsafe_id(self, tmp_path, malicious_id):"""A catalog-controlled ID with shell metacharacters must never beinterpolated into the suggested command; it is replaced by a literalplaceholder so copying the command can't execute injected shell text."""@@ -413,7 +414,6 @@ class TestExtensionAddCLI:(project_dir / ".specify").mkdir()(project_dir / ".specify" / "extensions").mkdir(parents=True)- malicious_id = "foo; rm -rf ~"mock_catalog = MagicMock()mock_catalog.get_extension_info.return_value = {"id": malicious_id,diff --git a/tests/specify_cli/extensions/test_command_search.py b/tests/specify_cli/extensions/test_command_search.pyindex c2e8e949f..e44dad7a5 100644--- a/tests/specify_cli/extensions/test_command_search.py+++ b/tests/specify_cli/extensions/test_command_search.py@@ -22,6 +22,39 @@ from specify_cli.extensions import (class TestExtensionSearchCLI:"""CLI tests for ``specify extension search``."""+ @pytest.mark.parametrize("install_allowed", [True, False])+ @pytest.mark.parametrize(+ ("extension_id", "command_id"),+ [+ ("acme-thing", "acme-thing"),+ ("acme-thing\n", "<extension-id>"),+ ],+ )+ def test_search_install_suggestion_uses_safe_catalog_id(+ self, project_dir, install_allowed, extension_id, command_id+ ):+ entry = {+ "id": extension_id,+ "name": "Example",+ "version": "1.0.0",+ "description": "Example extension",+ "_install_allowed": install_allowed,+ "_catalog_name": "test-catalog",+ }++ with patch.object(ExtensionCatalog, "_get_merged_extensions", return_value=[entry]), \+ patch("specify_cli.extensions._commands._require_specify_project",+ return_value=project_dir):+ result = CliRunner().invoke(app, ["extension", "search"])++ assert result.exit_code == 0, result.output+ output = " ".join(result.output.split())+ assert f"specify extension add {command_id}" in output+ if not install_allowed:+ assert f"specify extension add {command_id} --from <archive-url>" in output+ if extension_id != command_id:+ assert "acme-thing" not in result.output+@pytest.mark.parametrize("downloads", ["1500", "[/red]foo"])def test_search_survives_non_numeric_downloads(self, temp_dir, downloads):"""`specify extension search` must not abort when a catalog entry'sdiff --git a/tests/test_extensions.py b/tests/test_extensions.pyindex ed4353ce5..5c5634128 100644--- a/tests/test_extensions.py+++ b/tests/test_extensions.py@@ -384,11 +384,25 @@ class TestExtensionManifest:with pytest.raises(ValidationError, match="not valid UTF-8"):ExtensionManifest(manifest_path)- def test_invalid_extension_id(self, temp_dir, valid_manifest_data):+ @pytest.mark.parametrize(+ "extension_id",+ [+ "Invalid_ID",+ "",+ "../test-ext",+ "test-ext\n",+ "test-ext\r\n",+ "test\next",+ "test-ext ",+ " test-ext",+ ],+ )+ def test_invalid_extension_id(self, temp_dir, valid_manifest_data, extension_id):"""Test manifest with invalid extension ID format."""import yaml- valid_manifest_data["extension"]["id"] = "Invalid_ID" # Uppercase not allowed+ valid_manifest_data["extension"]["id"] = extension_id+ valid_manifest_data["provides"]["commands"] = []manifest_path = temp_dir / "extension.yml"with open(manifest_path, 'w') as f: