feat(template): allow renaming templates by using aliases (#3347)

Author: mohammad-alisafaee

renku/command/view_model/template.py

@@ -27,27 +27,29 @@ class TemplateViewModel:
 
     def __init__(
         self,
+        aliases: List[str],
         description: str,
         icon: Optional[str],
         id: str,
         immutable_files: Optional[List[str]],
         name: str,
+        parameters: List[TemplateParameter],
         reference: Optional[str],
         source: Optional[str],
-        parameters: List[TemplateParameter],
         version: Optional[str],
         versions: List[str],
     ):
+        self.aliases: List[str] = aliases
         self.description: str = description
         self.icon = icon
         self.id: str = id
         self.immutable_files: Optional[List[str]] = immutable_files
         self.name: str = name
-        self.reference = reference
-        self.source = source
         self.parameters: List[TemplateParameterViewModel] = [
             TemplateParameterViewModel.from_template_parameter(p) for p in parameters
         ]
+        self.reference = reference
+        self.source = source
         self.version = version
         self.versions = versions
 
@@ -62,15 +64,16 @@ def from_template(cls, template: Template) -> "TemplateViewModel":
             TemplateViewModel: View model for a template.
         """
         return cls(
-            source=template.source,
-            reference=template.reference,
-            version=template.version,
-            id=template.id,
-            name=template.name,
+            aliases=template.aliases,
             description=template.description,
-            parameters=template.parameters,
             icon=template.icon,
+            id=template.id,
             immutable_files=template.immutable_files,
+            name=template.name,
+            parameters=template.parameters,
+            reference=template.reference,
+            source=template.source,
+            version=template.version,
             versions=template.get_all_references(),
         )
 
@@ -115,21 +118,31 @@ class TemplateChangeViewModel:
     """A view model for resulting changes from a template set/update."""
 
     def __init__(
-        self, id: str, source: Optional[str], reference: Optional[str], version: Optional[str], file_changes: List[str]
+        self,
+        file_changes: List[str],
+        id: str,
+        old_id: Optional[str],
+        reference: Optional[str],
+        source: Optional[str],
+        version: Optional[str],
     ):
+        self.file_changes = file_changes
         self.id: str = id
-        self.source = source
+        self.old_id: Optional[str] = old_id if old_id != id else ""
         self.reference = reference
+        self.source = source
         self.version = version
-        self.file_changes = file_changes
 
     @classmethod
-    def from_template(cls, template: RenderedTemplate, actions: Dict[str, FileAction]) -> "TemplateChangeViewModel":
+    def from_template(
+        cls, template: RenderedTemplate, actions: Dict[str, FileAction], old_id: Optional[str] = None
+    ) -> "TemplateChangeViewModel":
         """Create view model from ``Template``.
 
         Args:
             template(RenderedTemplate): Input rendered template.
             actions(Dict[str, FileAction]): Mapping of paths to actions taken when rendering the template.
+            old_id(Optional[str]: Current template Id.
 
         Returns:
             TemplateChangeViewModel: View model for the template change.
@@ -151,9 +164,10 @@ def from_template(cls, template: RenderedTemplate, actions: Dict[str, FileAction
         ]
 
         return cls(
+            file_changes=file_changes,
             id=template.template.id,
-            source=template.template.source,
+            old_id=old_id,
             reference=template.template.reference,
+            source=template.template.source,
             version=template.template.version,
-            file_changes=file_changes,
         )

renku/core/init.py

@@ -376,6 +376,7 @@ def create_from_template_local(
 
     template = Template(
         id=metadata["__template_id__"],
+        aliases=[],
         name="",
         description="",
         parameters={},

renku/core/template/__init__.py

@@ -1,6 +1,5 @@
-#
-# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
-# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+# Copyright Swiss Data Science Center (SDSC). A partnership between
+# École Polytechnique Fédérale de Lausanne (EPFL) and
 # Eidgenössische Technische Hochschule Zürich (ETHZ).
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

renku/core/template/template.py

@@ -1,6 +1,5 @@
-#
-# Copyright 2020 - Swiss Data Science Center (SDSC)
-# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+# Copyright Swiss Data Science Center (SDSC). A partnership between
+# École Polytechnique Fédérale de Lausanne (EPFL) and
 # Eidgenössische Technische Hochschule Zürich (ETHZ).
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -383,14 +382,14 @@ def fetch(cls, source: Optional[str], reference: Optional[str]) -> "EmbeddedTemp
         from renku import __template_version__
 
         template_path = importlib_resources.files("renku") / "templates"
-        with importlib_resources.as_file(template_path) as folder:
-            path = Path(folder)
+        with importlib_resources.as_file(template_path) as templates:
+            path = Path(templates)
 
         return cls(path=path, source="renku", reference=__template_version__, version=__template_version__)
 
     def get_all_references(self, id) -> List[str]:
         """Return all available references for a template id."""
-        template_exists = any(t.id == id for t in self.templates)
+        template_exists = any(id == t.id or id in t.aliases for t in self.templates)
         return [self.reference] if template_exists and self.reference is not None else []
 
     def get_latest_reference_and_version(
@@ -412,7 +411,7 @@ def get_latest_reference_and_version(
     def get_template(self, id, reference: Optional[str]) -> "Template":
         """Return all available versions for a template id."""
         try:
-            return next(t for t in self.templates if t.id == id)
+            return next(t for t in self.templates if id == t.id or id in t.aliases)
         except StopIteration:
             raise errors.TemplateNotFoundError(f"The template with id '{id}' is not available.")
 
@@ -495,7 +494,7 @@ def _has_template_at(self, id: str, reference: str) -> bool:
         except (errors.FileNotFound, errors.InvalidTemplateError):
             return False
         else:
-            return any(t.id == id for t in manifest.templates)
+            return any(id == t.id or id in t.aliases for t in manifest.templates)
 
     def get_template(self, id, reference: Optional[str]) -> "Template":
         """Return a template at a specific reference."""
@@ -515,8 +514,9 @@ def get_template(self, id, reference: Optional[str]) -> "Template":
             else:
                 self.manifest = manifest
 
-        template = next((t for t in self.templates if t.id == id), None)
+        template = next((t for t in self.templates if id == t.id or id in t.aliases), None)
         if template is None:
+            reference = reference or "HEAD"
             raise errors.TemplateNotFoundError(f"The template with id '{id}' is not available at '{reference}'.")
 
         return template

renku/core/template/usecase.py

@@ -1,6 +1,5 @@
-#
-# Copyright 2020 - Swiss Data Science Center (SDSC)
-# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
+# Copyright Swiss Data Science Center (SDSC). A partnership between
+# École Polytechnique Fédérale de Lausanne (EPFL) and
 # Eidgenössische Technische Hochschule Zürich (ETHZ).
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -228,7 +227,9 @@ def update_template(force: bool, interactive: bool, dry_run: bool) -> Optional[T
         input_parameters=None,
     )
 
-    return TemplateChangeViewModel.from_template(template=rendered_template, actions=actions)
+    return TemplateChangeViewModel.from_template(
+        template=rendered_template, actions=actions, old_id=template_metadata.id
+    )
 
 
 @inject.autoparams("project_gateway")

renku/domain_model/template.py

@@ -130,6 +130,7 @@ def templates(self) -> List["Template"]:
             self._templates = [
                 Template(
                     id=cast(str, t.get("id") or t.get("folder")),
+                    aliases=t.get("aliases", []),
                     name=cast(str, t.get("name")),
                     description=cast(str, t.get("description")),
                     parameters=cast(Dict[str, Dict[str, Any]], t.get("variables") or t.get("parameters")),
@@ -161,6 +162,8 @@ def validate(self, manifest_only: bool = False) -> List[str]:
         elif not isinstance(self._content, list):
             raise errors.InvalidTemplateError(f"Invalid manifest content type: '{type(self._content).__name__}'")
 
+        existing_ids: Set[str] = set()
+
         # NOTE: First check if required fields exists for creating Template instances
         for template_entry in self._content:
             if not isinstance(template_entry, dict):
@@ -172,6 +175,15 @@ def validate(self, manifest_only: bool = False) -> List[str]:
             if not template_entry.get("id"):
                 warnings.append(f"Template '{id}' should use 'id' attribute instead of 'folder'.")
 
+            # NOTE: Check for duplicate IDs and aliases
+            aliases = {id}
+            aliases.update(template_entry.get("aliases", []))
+            duplicates = existing_ids.intersection(aliases)
+            if duplicates:
+                duplicates_str = ", ".join(sorted(f"'{d}'" for d in duplicates))
+                raise errors.InvalidTemplateError(f"Found duplicate IDs or aliases: {duplicates_str}")
+            existing_ids.update(aliases)
+
             parameters = template_entry.get("variables")
             if parameters:
                 if not isinstance(parameters, dict):
@@ -209,6 +221,7 @@ def __init__(
         parameters: Dict[str, Dict[str, Any]],
         icon: str,
         ssh_supported: bool,
+        aliases: List[str],
         immutable_files: List[str],
         allow_update: bool,
         source: Optional[str],
@@ -226,6 +239,7 @@ def __init__(
         self.description: str = description
         self.icon = icon
         self.ssh_supported = ssh_supported
+        self.aliases: List[str] = aliases
         self.immutable_files: List[str] = immutable_files or []
         self.allow_update: bool = allow_update
         parameters = parameters or {}
@@ -235,6 +249,9 @@ def __init__(
 
         self._templates_source: Optional[TemplatesSource] = templates_source
 
+    def __repr__(self) -> str:
+        return f"<Template {self.id}@{self.version}>"
+
     @property
     def templates_source(self) -> Optional[TemplatesSource]:
         """Return template's source."""

renku/ui/cli/template.py

@@ -334,6 +334,7 @@ def print_template_parameters():
                 click.echo(print_name("    Default value: ") + print_value(p.default))
 
     click.echo(print_name("Id: ") + print_value(template.id))
+    click.echo(print_name("Id aliases: ") + print_value(template.aliases))
     click.echo(print_name("Name: ") + print_value(template.name))
     click.echo(print_name("Source: ") + print_value(template.source))
     click.echo(print_name("Reference: ") + print_value(to_string(template.reference)))
@@ -369,6 +370,7 @@ def _print_template_change(changes: "TemplateChangeViewModel"):
     print_value = functools.partial(click.style, bold=True)
 
     click.echo(print_name("Id: ") + print_value(changes.id))
+    click.echo(print_name("Old Id: ") + print_value(changes.old_id))
     click.echo(print_name("Source: ") + print_value(changes.source))
     click.echo(print_name("New reference: ") + print_value(to_string(changes.reference)))
     click.echo(print_name("New version: ") + print_value(to_string(changes.version)))

tests/cli/test_template.py

@@ -480,3 +480,17 @@ def test_template_dockerfile_checksum_update(runner, project, with_injection):
 
         assert not project.repository.is_dirty()
         assert __version__ in dockerfile.read_text()
+
+
+def test_template_update_with_renames(runner, project_with_template, templates_source, with_injection):
+    """Test updating a renamed template."""
+    templates_source.rename(id="dummy", new_name="new-name", version="2.2.42")
+
+    result = runner.invoke(cli, ["template", "update"])
+
+    assert result.exit_code == 0, result.output
+
+    with with_injection():
+        assert "2.2.42" == project_context.project.template_metadata.template_ref
+        assert "new-name" == project_context.project.template_metadata.template_id
+        assert not project_with_template.repository.is_dirty()

tests/core/models/test_template.py

@@ -84,6 +84,7 @@ def test_templates_manifest():
               variables: {}
               icon: python.png
             - id: R
+              aliases: ["R-minimal", "R-base"]
               name: R Project
               description: An R-based Renku project
               variables:
@@ -98,12 +99,14 @@ def test_templates_manifest():
     assert 2 == len(manifest.templates)
 
     template = next(t for t in manifest.templates if t.id == "python")
+    assert [] == template.aliases
     assert "Python Project" == template.name
     assert "A Python-based Renku project" == template.description
     assert "python.png" == template.icon
     assert [] == template.parameters
 
     template = next(t for t in manifest.templates if t.id == "R")
+    assert ["R-minimal", "R-base"] == template.aliases
     assert "R Project" == template.name
     assert "An R-based Renku project" == template.description
     assert "R.png" == template.icon
@@ -142,6 +145,7 @@ def test_templates_manifest_invalid_yaml(tmp_path):
         ("- no-id: python", "Template doesn't have an id:"),
         ("- id: python\n  variables: p1", "Invalid template variable type on template 'python': 'str'"),
         ("- id: python\n  variables:\n    p1: 42", "Invalid parameter type 'int' for 'p1'"),
+        ("- id: python\n  name: Python\n  aliases: [R]\n- id: R\n  name: R\n", "Found duplicate IDs or aliases: 'R'"),
     ],
 )
 def test_templates_manifest_invalid_content(tmp_path, content, message):