💫 Toolkit to help you get started with SDD or any other process!
fix(extensions): delete the catalog config when the last entry is removed (#4909)
Chaoqi96774bc52fd7
diff --git a/src/specify_cli/extensions/catalog/command_remove.py b/src/specify_cli/extensions/catalog/command_remove.pyindex e99bc7faa..23eb6d121 100644--- a/src/specify_cli/extensions/catalog/command_remove.py+++ b/src/specify_cli/extensions/catalog/command_remove.py@@ -5,6 +5,8 @@ Registered by ``catalog.register()``; shared catalog helpers live in"""from __future__ import annotations+import os+import typerfrom rich.markup import escape as _escape_markup@@ -48,19 +50,38 @@ def catalog_remove(_commands.console.print(f"[red]Error:[/red] Catalog '{safe_name}' not found.")raise typer.Exit(1)- config["catalogs"] = catalogs- config_path.write_text(- _commands.yaml.safe_dump(- config,- default_flow_style=False,- sort_keys=False,- allow_unicode=True,- ),- encoding="utf-8",- )+ if catalogs:+ config["catalogs"] = catalogs+ config_path.write_text(+ _commands.yaml.safe_dump(+ config,+ default_flow_style=False,+ sort_keys=False,+ allow_unicode=True,+ ),+ encoding="utf-8",+ )+ else:+ # The catalog loader rejects an existing config with no entries, so+ # delete the file instead of writing ``catalogs: []``.+ try:+ config_path.unlink(missing_ok=True)+ except OSError as error:+ config_label = _escape_markup(+ str(_commands._display_project_path(project_root, config_path))+ )+ _commands.console.print(+ f"[red]Error:[/red] Failed to delete {config_label}: "+ f"{_escape_markup(str(error))}"+ )+ raise typer.Exit(1)_commands.console.print(f"[green]✓[/green] Removed catalog '{safe_name}'")if not catalogs:+ if os.environ.get("SPECKIT_CATALOG_URL"):+ fallback = "the SPECKIT_CATALOG_URL environment variable still takes precedence"+ else:+ fallback = "user configuration or built-in defaults will be used"_commands.console.print(- "\n[dim]No catalogs remain in config. Built-in defaults will be used.[/dim]"+ f"\n[dim]Project catalog override removed; {fallback}.[/dim]")diff --git a/tests/specify_cli/extensions/catalog/test_command_remove.py b/tests/specify_cli/extensions/catalog/test_command_remove.pyindex a66891a12..2892b09d2 100644--- a/tests/specify_cli/extensions/catalog/test_command_remove.py+++ b/tests/specify_cli/extensions/catalog/test_command_remove.py@@ -6,6 +6,7 @@ Mirrors ``specify_cli.extensions.catalog.command_remove``.from __future__ import annotationsimport os+from pathlib import Pathimport yaml@@ -73,3 +74,208 @@ class TestExtensionCatalogRemoveCLI:assert result.exit_code == 0, result.outputoutput = _normalize_cli_output(result.output)assert f"Removed catalog '{catalog_name}'" in output++ def test_extension_catalog_remove_final_entry_restores_defaults(+ self, tmp_path, monkeypatch+ ):+ """The loader rejects an empty ``catalogs`` list, so removing the last+ entry must not leave one behind for follow-up commands to trip on."""+ project = self._make_project(tmp_path)+ monkeypatch.setenv("HOME", str(tmp_path))+ monkeypatch.setenv("USERPROFILE", str(tmp_path))+ monkeypatch.delenv("SPECKIT_CATALOG_URL", raising=False)++ add = self._invoke(+ [+ "extension",+ "catalog",+ "add",+ "https://only.example.com/catalog.json",+ "--name",+ "only",+ ],+ project,+ )+ assert add.exit_code == 0, add.output++ remove = self._invoke(["extension", "catalog", "remove", "only"], project)+ assert remove.exit_code == 0, remove.output+ assert (+ "Project catalog override removed; user configuration or built-in "+ "defaults will be used." in _normalize_cli_output(remove.output)+ )++ listing = self._invoke(["extension", "catalog", "list"], project)+ assert listing.exit_code == 0, listing.output+ output = _normalize_cli_output(listing.output)+ assert "default (priority 1)" in output+ assert "community (priority 2)" in output+ assert "Using built-in default catalog stack" in output+ assert not (project / ".specify" / "extension-catalogs.yml").exists()++ def test_extension_catalog_remove_final_entry_falls_back_to_user_config(+ self, tmp_path, monkeypatch+ ):+ project = self._make_project(tmp_path)+ home = tmp_path / "home"+ (home / ".specify").mkdir(parents=True)+ (home / ".specify" / "extension-catalogs.yml").write_text(+ yaml.safe_dump(+ {+ "catalogs": [+ {+ "name": "user-catalog",+ "url": "https://user.example.com/catalog.json",+ "priority": 5,+ "install_allowed": True,+ "description": "",+ }+ ]+ },+ sort_keys=False,+ ),+ encoding="utf-8",+ )+ monkeypatch.setenv("HOME", str(home))+ monkeypatch.setenv("USERPROFILE", str(home))+ monkeypatch.delenv("SPECKIT_CATALOG_URL", raising=False)++ add = self._invoke(+ [+ "extension",+ "catalog",+ "add",+ "https://only.example.com/catalog.json",+ "--name",+ "only",+ ],+ project,+ )+ assert add.exit_code == 0, add.output++ remove = self._invoke(["extension", "catalog", "remove", "only"], project)+ assert remove.exit_code == 0, remove.output++ listing = self._invoke(["extension", "catalog", "list"], project)+ assert listing.exit_code == 0, listing.output+ output = _normalize_cli_output(listing.output)+ assert "user-catalog (priority 5)" in output+ assert "Config: ~/.specify/extension-catalogs.yml" in output+ assert "only (priority" not in output+ assert "default (priority 1)" not in output++ def test_extension_catalog_remove_final_entry_notes_env_catalog_precedence(+ self, tmp_path, monkeypatch+ ):+ project = self._make_project(tmp_path)+ monkeypatch.setenv("HOME", str(tmp_path))+ monkeypatch.setenv("USERPROFILE", str(tmp_path))+ monkeypatch.setenv("SPECKIT_CATALOG_URL", "https://env.example.com/catalog.json")++ add = self._invoke(+ [+ "extension",+ "catalog",+ "add",+ "https://only.example.com/catalog.json",+ "--name",+ "only",+ ],+ project,+ )+ assert add.exit_code == 0, add.output++ remove = self._invoke(["extension", "catalog", "remove", "only"], project)+ assert remove.exit_code == 0, remove.output+ output = _normalize_cli_output(remove.output)+ assert (+ "Project catalog override removed; the SPECKIT_CATALOG_URL environment "+ "variable still takes precedence." in output+ )+ assert "built-in defaults will be used" not in output++ listing = self._invoke(["extension", "catalog", "list"], project)+ assert listing.exit_code == 0, listing.output+ output = _normalize_cli_output(listing.output)+ assert "https://env.example.com/catalog.json" in output+ assert "Catalog configured via SPECKIT_CATALOG_URL environment variable." in output++ def test_extension_catalog_remove_final_entry_reports_unlink_failure(+ self, tmp_path, monkeypatch+ ):+ project = self._make_project(tmp_path)+ cfg_path = project / ".specify" / "extension-catalogs.yml"+ cfg_path.write_text(+ yaml.safe_dump(+ {+ "catalogs": [+ {+ "name": "only",+ "url": "https://only.example.com/catalog.json",+ "priority": 10,+ "install_allowed": False,+ "description": "",+ }+ ]+ },+ sort_keys=False,+ ),+ encoding="utf-8",+ )+ before = cfg_path.read_text(encoding="utf-8")++ def fail_unlink(self, *args, **kwargs):+ raise OSError("simulated unlink failure")++ monkeypatch.setattr(Path, "unlink", fail_unlink)+ result = self._invoke(["extension", "catalog", "remove", "only"], project)++ assert result.exit_code == 1, result.output+ output = _normalize_cli_output(result.output)+ assert (+ "Failed to delete .specify/extension-catalogs.yml: simulated unlink failure"+ in output+ )+ assert "Removed catalog" not in output+ assert cfg_path.read_text(encoding="utf-8") == before++ def test_extension_catalog_remove_keeps_config_with_remaining_entries(+ self, tmp_path+ ):+ project = self._make_project(tmp_path)+ keep = {+ "name": "keep",+ "url": "https://keep.example.com/catalog.json",+ "priority": 20,+ "install_allowed": False,+ "description": "",+ }+ cfg_path = project / ".specify" / "extension-catalogs.yml"+ cfg_path.write_text(+ yaml.safe_dump(+ {+ "catalogs": [+ {+ "name": "drop",+ "url": "https://drop.example.com/catalog.json",+ "priority": 10,+ "install_allowed": False,+ "description": "",+ },+ keep,+ ]+ },+ sort_keys=False,+ ),+ encoding="utf-8",+ )++ result = self._invoke(["extension", "catalog", "remove", "drop"], project)++ assert result.exit_code == 0, result.output+ assert "Project catalog override removed" not in _normalize_cli_output(+ result.output+ )+ assert yaml.safe_load(cfg_path.read_text(encoding="utf-8")) == {+ "catalogs": [keep]+ }