💫 Toolkit to help you get started with SDD or any other process!
fix(workflows): accept equivalent version spellings in archive updates (#5155)
Gaven Lan Ren246b9d053351
diff --git a/src/specify_cli/workflows/_commands.py b/src/specify_cli/workflows/_commands.pyindex 8cd60c7f4..30fcbd305 100644--- a/src/specify_cli/workflows/_commands.py+++ b/src/specify_cli/workflows/_commands.py@@ -728,6 +728,16 @@ def _validate_local_workflow_package(package_dir: Path) -> None:raise ValueError(f"Workflow package contains unsupported file: {path}")+def _workflow_versions_match(actual: object, expected: str) -> bool:+ """Compare workflow versions without treating equivalent spellings as changes."""+ from packaging import version as pkg_version++ try:+ return pkg_version.Version(str(actual)) == pkg_version.Version(expected)+ except pkg_version.InvalidVersion:+ return str(actual) == expected++def _install_workflow_package(project_root: Path,workflows_dir: Path,@@ -737,6 +747,7 @@ def _install_workflow_package(expected_id: str | None = None,expected_version: str | None = None,expected_requires: dict[str, Any] | None = None,+ exact_version: bool = False,expected_installed_version: str | None = None,catalog_info: dict[str, Any] | None = None,) -> None:@@ -774,7 +785,11 @@ def _install_workflow_package(f"workflow ID ({_escape_markup(repr(expected_id))}).")raise typer.Exit(1)- if expected_version is not None and str(definition.version) != expected_version:+ if expected_version is not None and not (+ str(definition.version) == expected_version+ if exact_version+ else _workflow_versions_match(definition.version, expected_version)+ ):console.print(f"[red]Error:[/red] Downloaded workflow version "f"({_escape_markup(str(definition.version))}) does not match the catalog "@@ -824,7 +839,9 @@ def _install_workflow_package(if expected_installed_version is not None and (not isinstance(existing, dict)or existing.get("source") != "catalog"- or str(existing.get("version")) != expected_installed_version+ or not _workflow_versions_match(+ existing.get("version"), expected_installed_version+ )):console.print(f"[yellow]Warning:[/yellow] Workflow "@@ -1123,16 +1140,6 @@ def _install_workflow_from_catalog(from .catalog import WorkflowCatalog, WorkflowCatalogErrorfrom .engine import WorkflowDefinition- def versions_match(actual: object, expected: str) -> bool:- from packaging import version as pkg_version-- try:- return pkg_version.Version(str(actual)) == pkg_version.Version(- expected- )- except pkg_version.InvalidVersion:- return str(actual) == expected-safe_wf_id = _escape_markup(workflow_id)if selected_info is not None:@@ -1335,6 +1342,7 @@ def _install_workflow_from_catalog(expected_requires=(info.get("requires") if requested_version is not None else None),+ exact_version=requested_version is not None,expected_installed_version=expected_installed_version,catalog_info={**info, "url": workflow_url},)@@ -1389,7 +1397,7 @@ def _install_workflow_from_catalog(if expected_version is not None and not (str(definition.version) == expected_versionif requested_version is not None- else versions_match(definition.version, expected_version)+ else _workflow_versions_match(definition.version, expected_version)):_safe_discard_staged_workflow_file(staged_file, workflow_dir, existed_before)console.print(@@ -1424,7 +1432,7 @@ def _install_workflow_from_catalog(if (not isinstance(current, dict)or current.get("source") != "catalog"- or not versions_match(+ or not _workflow_versions_match(current.get("version"), expected_installed_version)):diff --git a/tests/specify_cli/workflows/test_command_update.py b/tests/specify_cli/workflows/test_command_update.pyindex 3ecd0ae9f..476df9e5e 100644--- a/tests/specify_cli/workflows/test_command_update.py+++ b/tests/specify_cli/workflows/test_command_update.py@@ -2,13 +2,17 @@from __future__ import annotations+import ioimport jsonimport osimport statimport sys+import tarfile+import zipfilefrom pathlib import Pathimport pytest+from packaging.version import Version@@ -113,6 +117,25 @@ steps:def __exit__(self, *a):return False+ @staticmethod+ def _workflow_download(data, source_type):+ """Build equivalent YAML and complete archive downloads."""+ if source_type == "yml":+ return "https://example.com/workflow.yml", data+ output = io.BytesIO()+ files = {"workflow.yml": data, "README.md": b"Workflow companion file"}+ if source_type == "zip":+ with zipfile.ZipFile(output, "w") as archive:+ for name, content in files.items():+ archive.writestr(name, content)+ else:+ with tarfile.open(fileobj=output, mode="w:gz") as archive:+ for name, content in files.items():+ entry = tarfile.TarInfo(name)+ entry.size = len(content)+ archive.addfile(entry, io.BytesIO(content))+ return f"https://example.com/workflow.{source_type}", output.getvalue()+def test_update_no_workflows_installed(self, project_dir, monkeypatch):from typer.testing import CliRunnerfrom specify_cli import app@@ -199,26 +222,41 @@ steps:assert "All checked workflows are up to date" in result.outputassert "skipped" in result.output- def test_update_installs_newer_catalog_version(self, project_dir, monkeypatch):+ @pytest.mark.parametrize("source_type", ["yml", "zip", "tar.gz"])+ @pytest.mark.parametrize(+ ("installed_version", "available_version"),+ [+ ("1.0.0", "2.0.0"),+ ("2024.01.15", "2024.02.01"),+ ("2024.01.15", "2024.2.1"),+ ("2024.1.15", "2024.02.01"),+ ],+ )+ def test_update_installs_newer_catalog_version(+ self, project_dir, monkeypatch, source_type, installed_version, available_version+ ):from unittest.mock import patchfrom typer.testing import CliRunnerfrom specify_cli import appfrom specify_cli.workflows.catalog import WorkflowCatalog, WorkflowRegistrymonkeypatch.chdir(project_dir)+ url, data = self._workflow_download(+ self.WORKFLOW_YAML.format(version=available_version).encode(), source_type+ )registry = WorkflowRegistry(project_dir)registry.add("align-wf", {"name": "Align Workflow",- "version": "1.0.0",+ "version": installed_version,"description": "CLI alignment test workflow","source": "catalog","catalog_name": "test-catalog",- "url": "https://example.com/workflow.yml",+ "url": url,})wf_dir = project_dir / ".specify" / "workflows" / "align-wf"wf_dir.mkdir(parents=True)(wf_dir / "workflow.yml").write_text(- self.WORKFLOW_YAML.format(version="1.0.0"), encoding="utf-8"+ self.WORKFLOW_YAML.format(version=installed_version), encoding="utf-8")monkeypatch.setattr(@@ -227,13 +265,12 @@ steps:lambda self, wid: {"id": wid,"name": "Align Workflow",- "version": "2.0.0",- "url": "https://example.com/workflow.yml",+ "version": available_version,+ "url": url,"_install_allowed": True,"_catalog_name": "test-catalog",},)- data = self.WORKFLOW_YAML.format(version="2.0.0").encode()runner = CliRunner()with patch("specify_cli.authentication.http.open_url",@@ -241,10 +278,14 @@ steps:):result = runner.invoke(app, ["workflow", "update"], input="y\n")assert result.exit_code == 0, result.output- assert "1.0.0" in result.output and "2.0.0" in result.output+ assert f"{Version(installed_version)} → {Version(available_version)}" in result.outputmeta = WorkflowRegistry(project_dir).get("align-wf")- assert meta["version"] == "2.0.0"- assert "2.0.0" in (wf_dir / "workflow.yml").read_text(encoding="utf-8")+ assert meta["version"] == available_version+ assert (wf_dir / "workflow.yml").read_text(encoding="utf-8") == (+ self.WORKFLOW_YAML.format(version=available_version)+ )+ if source_type != "yml":+ assert (wf_dir / "README.md").read_bytes() == b"Workflow companion file"def test_update_installs_newer_workflow_with_project_custom_step(self, project_dir, monkeypatch@@ -575,7 +616,10 @@ steps:# The previously installed workflow must survive.assert "1.0.0" in (wf_dir / "workflow.yml").read_text(encoding="utf-8")- def test_update_rejects_version_mismatch_from_stale_url(self, project_dir, monkeypatch):+ @pytest.mark.parametrize("source_type", ["yml", "zip", "tar.gz"])+ def test_update_rejects_version_mismatch_from_stale_url(+ self, project_dir, monkeypatch, source_type+ ):"""A URL serving a different version than the catalog advertised must fail the update."""from unittest.mock import patchfrom typer.testing import CliRunner@@ -583,13 +627,16 @@ steps:from specify_cli.workflows.catalog import WorkflowCatalog, WorkflowRegistrymonkeypatch.chdir(project_dir)+ url, data = self._workflow_download(+ self.WORKFLOW_YAML.format(version="1.0.0").encode(), source_type+ )WorkflowRegistry(project_dir).add("align-wf", {"name": "Align Workflow","version": "1.0.0","description": "CLI alignment test workflow","source": "catalog","catalog_name": "test-catalog",- "url": "https://example.com/workflow.yml",+ "url": url,})wf_dir = project_dir / ".specify" / "workflows" / "align-wf"wf_dir.mkdir(parents=True)@@ -604,23 +651,24 @@ steps:"id": wid,"name": "Align Workflow","version": "2.0.0",- "url": "https://example.com/workflow.yml",+ "url": url,"_install_allowed": True,"_catalog_name": "test-catalog",},)# The URL still serves the old 1.0.0 payload.- data = self.WORKFLOW_YAML.format(version="1.0.0").encode()runner = CliRunner()with patch("specify_cli.authentication.http.open_url",side_effect=lambda url, timeout=None, extra_headers=None, redirect_validator=None: self._FakeResponse(data, url),):result = runner.invoke(app, ["workflow", "update"], input="y\n")+ assert result.exit_code == 1, result.outputassert "does not match the catalog version" in result.outputassert "Failed to update" in result.outputmeta = WorkflowRegistry(project_dir).get("align-wf")assert meta["version"] == "1.0.0"+ assert not (wf_dir / "README.md").exists()assert "1.0.0" in (wf_dir / "workflow.yml").read_text(encoding="utf-8")def test_update_preserves_disabled_state(self, project_dir, monkeypatch):@@ -924,12 +972,13 @@ steps:]assert leftovers == []+ @pytest.mark.parametrize("source_type", ["yml", "zip", "tar.gz"])@pytest.mark.parametrize(("replacement_source", "replacement_version"),[("local", "1.0.0"), ("catalog", "1.5.0")],)def test_update_rechecks_registry_after_confirmation(- self, project_dir, monkeypatch, replacement_source, replacement_version+ self, project_dir, monkeypatch, replacement_source, replacement_version, source_type):from unittest.mock import patch@@ -939,6 +988,9 @@ steps:from specify_cli.workflows.catalog import WorkflowCatalog, WorkflowRegistrymonkeypatch.chdir(project_dir)+ url, catalog_data = self._workflow_download(+ self.WORKFLOW_YAML.format(version="2.0.0").encode(), source_type+ )registry = WorkflowRegistry(project_dir)registry.add("align-wf",@@ -947,7 +999,7 @@ steps:"version": "1.0.0","description": "","source": "catalog",- "url": "https://example.com/workflow.yml",+ "url": url,},)workflow_file = (@@ -975,7 +1027,7 @@ steps:"id": wid,"name": "Align Workflow","version": "2.0.0",- "url": "https://example.com/workflow.yml",+ "url": url,"_install_allowed": True,"_catalog_name": "test-catalog",},@@ -995,7 +1047,6 @@ steps:return Truemonkeypatch.setattr(_commands.typer, "confirm", replace_while_confirming)- catalog_data = self.WORKFLOW_YAML.format(version="2.0.0").encode()with patch("specify_cli.authentication.http.open_url",side_effect=lambda url, timeout=None, extra_headers=None,