Skip to content

πŸ’« Toolkit to help you get started with SDD or any other process!

fix(presets): tolerate non-string and non-list catalog fields in preset search/info (#3769)

Noor ul ain05cb3cba3410
diff --git a/.github/security-audit-requirements.txt b/.github/security-audit-requirements.txt
index fa5d5b8dc..7acbecd44 100644
--- a/.github/security-audit-requirements.txt
+++ b/.github/security-audit-requirements.txt
@@ -1,6 +1,6 @@
-annotated-doc==0.0.4 \
- --hash=sha256:571ac1dc6991c450b25a9c2d84a3705e2ae7a53467b5d111c24fa8baabbed320 \
- --hash=sha256:fbcda96e87e9c92ad167c2e53839e57503ecfda18804ea28102353485033faa4
+annotated-doc==0.0.5 \
+ --hash=sha256:117bac03a25ede5df5440e855b32d556049ca169ead221505badf432fed4b101 \
+ --hash=sha256:c7e58ce09192557605d8bbd92836d7e1d520ac9580096042c0bfd197efacf1bb
# via typer
click==8.4.2 \
--hash=sha256:9a6cea6e60b17ebe0a44c5cc636d94f09bd66142c1cd7d8b4cd731c4917a15f6 \
diff --git a/src/specify_cli/presets/__init__.py b/src/specify_cli/presets/__init__.py
index e16a9d325..3ea63d4d1 100644
--- a/src/specify_cli/presets/__init__.py
+++ b/src/specify_cli/presets/__init__.py
@@ -4513,23 +4513,34 @@ class PresetCatalog:
results = []
for pack_id, pack_data in packs.items():
- if author and pack_data.get("author", "").lower() != author.lower():
- continue
+ if author:
+ author_val = pack_data.get("author", "")
+ if not isinstance(author_val, str):
+ author_val = str(author_val) if author_val is not None else ""
+ if author_val.lower() != author.lower():
+ continue
- if tag and tag.lower() not in [
- str(t).lower() for t in pack_data.get("tags", [])
- ]:
- continue
+ if tag:
+ raw_tags = pack_data.get("tags", [])
+ tags_list = raw_tags if isinstance(raw_tags, list) else []
+ if tag.lower() not in [
+ str(t).lower() for t in tags_list
+ ]:
+ continue
if query:
query_lower = query.lower()
+ raw_tags = pack_data.get("tags", [])
+ tags_list = raw_tags if isinstance(raw_tags, list) else []
+ name_val = pack_data.get("name", "")
+ desc_val = pack_data.get("description", "")
searchable_text = " ".join(
[
- pack_data.get("name", ""),
- pack_data.get("description", ""),
+ str(name_val) if name_val is not None else "",
+ str(desc_val) if desc_val is not None else "",
pack_id,
]
- + [str(t) for t in pack_data.get("tags", [])]
+ + [str(t) for t in tags_list]
).lower()
if query_lower not in searchable_text:
diff --git a/src/specify_cli/presets/_commands.py b/src/specify_cli/presets/_commands.py
index dfa0c41d1..35269af85 100644
--- a/src/specify_cli/presets/_commands.py
+++ b/src/specify_cli/presets/_commands.py
@@ -61,8 +61,9 @@ def preset_list():
pri = pack.get('priority', 10)
console.print(f" [bold]{pack['name']}[/bold] ({pack['id']}) v{pack['version']} β€” {status} β€” priority {pri}")
console.print(f" {pack['description']}")
- if pack.get("tags"):
- tags_str = _escape_markup(", ".join(str(t) for t in pack["tags"]))
+ tags = pack.get("tags", [])
+ if isinstance(tags, list) and tags:
+ tags_str = _escape_markup(", ".join(str(t) for t in tags))
console.print(f" [dim]Tags: {tags_str}[/dim]")
console.print(f" [dim]Templates: {pack['template_count']}[/dim]")
console.print()
@@ -293,8 +294,9 @@ def preset_search(
for pack in results:
console.print(f" [bold]{pack.get('name', pack['id'])}[/bold] ({pack['id']}) v{pack.get('version', '?')}")
console.print(f" {pack.get('description', '')}")
- if pack.get("tags"):
- tags_str = ", ".join(str(t) for t in pack["tags"])
+ tags = pack.get("tags", [])
+ if isinstance(tags, list) and tags:
+ tags_str = _escape_markup(", ".join(str(t) for t in tags))
console.print(f" [dim]Tags: {tags_str}[/dim]")
console.print()
@@ -384,8 +386,9 @@ def preset_info(
console.print(f" Description: {local_pack.description}")
if local_pack.author:
console.print(f" Author: {local_pack.author}")
- if local_pack.tags:
- console.print(f" Tags: {', '.join(str(t) for t in local_pack.tags)}")
+ local_tags = local_pack.tags
+ if isinstance(local_tags, list) and local_tags:
+ console.print(f" Tags: {', '.join(str(t) for t in local_tags)}")
console.print(f" Templates: {len(local_pack.templates)}")
for tmpl in local_pack.templates:
console.print(f" - {tmpl['name']} ({tmpl['type']}): {tmpl.get('description', '')}")
@@ -420,8 +423,9 @@ def preset_info(
console.print(f" Description: {pack_info.get('description', '')}")
if pack_info.get("author"):
console.print(f" Author: {pack_info['author']}")
- if pack_info.get("tags"):
- console.print(f" Tags: {', '.join(str(t) for t in pack_info['tags'])}")
+ catalog_tags = pack_info.get("tags", [])
+ if isinstance(catalog_tags, list) and catalog_tags:
+ console.print(f" Tags: {', '.join(str(t) for t in catalog_tags)}")
if pack_info.get("repository"):
console.print(f" Repository: {pack_info['repository']}")
if pack_info.get("license"):
diff --git a/tests/test_presets.py b/tests/test_presets.py
index 5edd8ac71..f3a03b0f7 100644
--- a/tests/test_presets.py
+++ b/tests/test_presets.py
@@ -11933,18 +11933,21 @@ class TestPresetTagsNonString:
this with ``str(t) for t in ...`` β€” presets must match.
"""
- def _seed_catalog(self, project_dir, tags):
+ def _seed_catalog(self, project_dir, tags, extra=None):
catalog = PresetCatalog(project_dir)
catalog.cache_dir.mkdir(parents=True, exist_ok=True)
+ pack = {
+ "name": "Numeric Tags",
+ "description": "Preset with non-string tags",
+ "version": "1.0.0",
+ "tags": tags,
+ }
+ if extra:
+ pack.update(extra)
catalog_data = {
"schema_version": "1.0",
"presets": {
- "numeric-tags": {
- "name": "Numeric Tags",
- "description": "Preset with non-string tags",
- "version": "1.0.0",
- "tags": tags,
- },
+ "numeric-tags": pack,
},
}
catalog.cache_file.write_text(json.dumps(catalog_data))
@@ -11988,3 +11991,116 @@ class TestPresetTagsNonString:
assert result.exit_code == 0, result.output
plain = strip_ansi(result.output)
assert "Tags: 1, 2" in plain
+
+ def _default_only(self, catalog):
+ return [PresetCatalogEntry(
+ url=catalog.DEFAULT_CATALOG_URL, name="default", priority=1, install_allowed=True
+ )]
+
+ def test_search_by_author_tolerates_non_string_author(self, project_dir):
+ """``--author`` must not crash on a numeric catalog ``author``.
+
+ ``PresetCatalog.search`` called ``.lower()`` straight on the raw value,
+ raising ``AttributeError: 'int' object has no attribute 'lower'``. The
+ sibling extension/integration catalogs coerce with ``str(...)`` first.
+ """
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ catalog = self._seed_catalog(project_dir, ["ci"], extra={"author": 789})
+
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch.object(PresetCatalog, "get_active_catalogs",
+ return_value=self._default_only(catalog)):
+ result = CliRunner().invoke(app, ["preset", "search", "--author", "789"])
+
+ assert result.exit_code == 0, result.output
+ assert "Numeric Tags" in strip_ansi(result.output)
+
+ def test_search_query_tolerates_non_string_name_and_description(self, project_dir):
+ """A query search must not crash on numeric ``name``/``description``.
+
+ The searchable-text join passed the raw values through, raising
+ ``TypeError: sequence item 0: expected str instance, int found``.
+ """
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ catalog = self._seed_catalog(
+ project_dir, ["ci"], extra={"name": 123, "description": 456}
+ )
+
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch.object(PresetCatalog, "get_active_catalogs",
+ return_value=self._default_only(catalog)):
+ result = CliRunner().invoke(app, ["preset", "search", "123"])
+
+ assert result.exit_code == 0, result.output
+ assert "numeric-tags" in strip_ansi(result.output)
+
+ def test_search_tolerates_non_list_tags(self, project_dir):
+ """A scalar ``tags:`` value must not crash the tag filter or display.
+
+ ``tags: 5`` is truthy but not iterable, so both the ``--tag`` filter and
+ the result-display join raised ``TypeError: 'int' object is not
+ iterable``. Siblings guard with ``isinstance(raw_tags, list)``.
+ """
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ catalog = self._seed_catalog(project_dir, 5)
+
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch.object(PresetCatalog, "get_active_catalogs",
+ return_value=self._default_only(catalog)):
+ filtered = CliRunner().invoke(app, ["preset", "search", "--tag", "ci"])
+ displayed = CliRunner().invoke(app, ["preset", "search", "Numeric"])
+
+ assert filtered.exit_code == 0, filtered.output
+ assert "No presets found" in strip_ansi(filtered.output)
+
+ assert displayed.exit_code == 0, displayed.output
+ plain = strip_ansi(displayed.output)
+ assert "Numeric Tags" in plain
+ assert "Tags:" not in plain
+
+ def test_info_tolerates_non_list_tags(self, project_dir):
+ """``preset info`` must not crash rendering a scalar ``tags:`` value."""
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ catalog = self._seed_catalog(project_dir, 5)
+
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch.object(PresetCatalog, "get_active_catalogs",
+ return_value=self._default_only(catalog)):
+ result = CliRunner().invoke(app, ["preset", "info", "numeric-tags"])
+
+ assert result.exit_code == 0, result.output
+ plain = strip_ansi(result.output)
+ assert "numeric-tags" in plain
+ assert "Tags:" not in plain
+
+ def test_search_escapes_rich_markup_in_tags(self, project_dir):
+ """Bracketed tag text must survive Rich markup parsing.
+
+ ``preset search`` printed tags unescaped, so a tag like ``[bold]`` was
+ swallowed as a style tag. ``preset list`` already escaped this.
+ """
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ catalog = self._seed_catalog(project_dir, ["[bold]ci"])
+
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch.object(PresetCatalog, "get_active_catalogs",
+ return_value=self._default_only(catalog)):
+ result = CliRunner().invoke(app, ["preset", "search", "Numeric"])
+
+ assert result.exit_code == 0, result.output
+ assert "[bold]ci" in strip_ansi(result.output)