feat: Support template version creation on push (HEXA-1182) (#226)

Author: yolanfery

openhexa/cli/api.py

@@ -562,6 +562,17 @@ def upload_pipeline(
                     pipelineVersion {
                         id
                         versionName
+                        pipeline {
+                            id
+                            permissions {
+                                createTemplateVersion
+                            }
+                            template {
+                                id
+                                code
+                                name
+                            }
+                        }
                     }
                 }
             }
@@ -598,6 +609,73 @@ def upload_pipeline(
     return data["uploadPipeline"]["pipelineVersion"]
 
 
+class PipelineTemplateVersionCreateErrorCode(enum.Enum):
+    """Enumeration of possible pipeline template version create error codes."""
+
+    PERMISSION_DENIED = "PERMISSION_DENIED"
+    WORKSPACE_NOT_FOUND = "WORKSPACE_NOT_FOUND"
+    PIPELINE_NOT_FOUND = "PIPELINE_NOT_FOUND"
+    PIPELINE_VERSION_NOT_FOUND = "PIPELINE_VERSION_NOT_FOUND"
+
+
+def create_pipeline_template_version(
+    workspace_slug: str, pipeline_id: str, pipeline_version_id: str, changelog: str = None
+):
+    """Create a pipeline template version using the API."""
+    data = graphql(
+        """
+    mutation createPipelineTemplateVersion($input: CreatePipelineTemplateVersionInput!) {
+        createPipelineTemplateVersion(input: $input) {
+            success
+            errors
+            pipelineTemplate {
+                id
+                name
+                code
+                currentVersion {
+                    id
+                    versionNumber
+                }
+            }
+        }
+    }
+    """,
+        {
+            "input": {
+                "workspaceSlug": workspace_slug,
+                "pipelineId": pipeline_id,
+                "pipelineVersionId": pipeline_version_id,
+                "changelog": changelog,
+            }
+        },
+    )
+    if not data["createPipelineTemplateVersion"]["success"]:
+        if (
+            PipelineTemplateVersionCreateErrorCode.PERMISSION_DENIED.value
+            in data["createPipelineTemplateVersion"]["errors"]
+        ):
+            raise PermissionDenied("Permission denied")
+        elif (
+            PipelineTemplateVersionCreateErrorCode.WORKSPACE_NOT_FOUND.value
+            in data["createPipelineTemplateVersion"]["errors"]
+        ):
+            raise Exception("Workspace not found")
+        elif (
+            PipelineTemplateVersionCreateErrorCode.PIPELINE_NOT_FOUND.value
+            in data["createPipelineTemplateVersion"]["errors"]
+        ):
+            raise Exception("Pipeline not found")
+        elif (
+            PipelineTemplateVersionCreateErrorCode.PIPELINE_VERSION_NOT_FOUND.value
+            in data["createPipelineTemplateVersion"]["errors"]
+        ):
+            raise Exception("Pipeline version not found for this pipeline")
+        else:
+            raise Exception(data["createPipelineTemplateVersion"]["errors"])
+
+    return data["createPipelineTemplateVersion"]["pipelineTemplate"]
+
+
 def is_dhis2_connection_up(workspace_slug: str, connection_slug: str) -> bool:
     """DHIS2 connection status."""
     response = graphql(
@@ -615,4 +693,4 @@ def is_dhis2_connection_up(workspace_slug: str, connection_slug: str) -> bool:
             "connectionSlug": connection_slug,
         },
     )
-    response["data"]["connectionBySlug"]["status"] == "UP"
+    return response["data"]["connectionBySlug"]["status"] == "UP"

openhexa/cli/cli.py

@@ -2,6 +2,7 @@
 
 import json
 import signal
+import urllib
 from datetime import datetime
 from importlib.metadata import version
 from pathlib import Path
@@ -17,6 +18,7 @@
     PipelineDirectoryError,
     create_pipeline,
     create_pipeline_structure,
+    create_pipeline_template_version,
     delete_pipeline,
     download_pipeline_sourcecode,
     ensure_is_pipeline_dir,
@@ -224,6 +226,40 @@ def pipelines_init(name: str):
         )
 
 
+def propose_to_create_template_version(workspace, pipeline_version, yes):
+    """Propose to create a new version of the template if the pipeline is based on a template."""
+    pipeline = pipeline_version["pipeline"]
+    if pipeline["template"] and pipeline["permissions"]["createTemplateVersion"]:
+        if not yes:
+            click.confirm(
+                f"The template {click.style(pipeline['template']['name'], bold=True)} is based on this pipeline, do you want to publish a new version of the template as well?",
+                True,
+                abort=True,
+            )
+        changelog = (
+            ""
+            if yes
+            else click.prompt(
+                f"{click.style('Changelog', bold=True)} (optional)", type=str, default="", show_default=False
+            )
+        )
+        try:
+            template = create_pipeline_template_version(workspace, pipeline["id"], pipeline_version["id"], changelog)
+            template_code_url = urllib.parse.quote(template["code"])
+            click.echo(
+                click.style(
+                    f"✅ New version '{template['currentVersion']['versionNumber']}' of the template '{template['name']}' created! You can view the new template version in OpenHEXA on {click.style(f'{settings.public_api_url}/workspaces/{workspace}/templates/{template_code_url}/versions', fg='bright_blue', underline=True)}",
+                    fg="green",
+                )
+            )
+        except Exception as e:
+            _terminate(
+                f'❌ Error while creating template version: "{e}"',
+                err=True,
+                exception=e,
+            )
+
+
 @pipelines.command("push")
 @click.argument(
     "path",
@@ -317,11 +353,12 @@ def pipelines_push(
             )
             click.confirm(confirmation_message, default=True, abort=True)
 
+        uploaded_pipeline_version = None
         try:
-            uploaded_pipeline = upload_pipeline(path, name, description=description, link=link)
+            uploaded_pipeline_version = upload_pipeline(path, name, description=description, link=link)
             click.echo(
                 click.style(
-                    f"✅ New version '{uploaded_pipeline['versionName']}' created! You can view the pipeline in OpenHEXA on {click.style(f'{settings.public_api_url}/workspaces/{workspace}/pipelines/{pipeline.code}', fg='bright_blue', underline=True)}",
+                    f"✅ New version '{uploaded_pipeline_version['versionName']}' created! You can view the pipeline in OpenHEXA on {click.style(f'{settings.public_api_url}/workspaces/{workspace}/pipelines/{pipeline.code}', fg='bright_blue', underline=True)}",
                     fg="green",
                 )
             )
@@ -337,6 +374,7 @@ def pipelines_push(
                 err=True,
                 exception=e,
             )
+        propose_to_create_template_version(workspace, uploaded_pipeline_version, yes)
 
 
 @pipelines.command("download")

tests/test_cli.py

@@ -19,6 +19,15 @@
 python_code = "print('pipeline.py file')"
 version = "v1.0"
 pipeline_name = "MyPipeline"
+pipeline_id = "pipeline_id"
+pipeline_version_id = "pipeline_version_id"
+template = {
+    "id": "template_id",
+    "name": "test_template",
+    "code": "template_code",
+    "currentVersion": {"versionNumber": "1.0"},
+}
+changelog = "Changelog for the new version"
 
 
 def create_zip_with_pipeline():
@@ -116,8 +125,9 @@ def test_download_pipeline(self, mock_graphql):
     @patch("openhexa.cli.api.graphql")
     @patch("openhexa.cli.cli.get_pipeline")
     @patch("openhexa.cli.cli.upload_pipeline")
+    @patch("openhexa.cli.cli.create_pipeline_template_version")
     @patch.dict(os.environ, {"HEXA_API_URL": "https://www.bluesquarehub.com/", "HEXA_WORKSPACE": "workspace"})
-    def test_push_pipeline(self, mock_upload_pipeline, mock_get_pipeline, mock_graphql):
+    def test_push_pipeline(self, mock_create_template, mock_upload_pipeline, mock_get_pipeline, mock_graphql):
         """Test pushing a pipeline."""
         with self.runner.isolated_filesystem() as tmp:
             with open(Path(tmp) / python_file_name, "w") as f:
@@ -126,9 +136,20 @@ def test_push_pipeline(self, mock_upload_pipeline, mock_get_pipeline, mock_graph
             mock_pipeline = MagicMock(spec=Pipeline)
             mock_pipeline.code = pipeline_name
             mock_get_pipeline.return_value = mock_pipeline
-            mock_upload_pipeline.return_value = {"versionName": version}
-
-            result = self.runner.invoke(pipelines_push, [tmp, "--name", version])
+            mock_upload_pipeline.return_value = {
+                "versionName": version,
+                "pipeline": {
+                    "id": pipeline_id,
+                    "permissions": {"createTemplateVersion": True},
+                    "template": template,
+                },
+                "id": pipeline_version_id,
+            }
+            mock_create_template.return_value = template
+
+            result = self.runner.invoke(
+                pipelines_push, [tmp, "--name", version], input="\n".join(["Y", "Y", changelog]) + "\n"
+            )
             self.assertEqual(result.exit_code, 0)
             self.assertIn(
                 (
@@ -138,6 +159,14 @@ def test_push_pipeline(self, mock_upload_pipeline, mock_get_pipeline, mock_graph
                 result.output,
             )
             self.assertTrue(mock_upload_pipeline.called)
+            mock_create_template.assert_called_with("workspace", pipeline_id, pipeline_version_id, changelog)
+            self.assertIn(
+                (
+                    f"✅ New version '{template['currentVersion']['versionNumber']}' of the template '{template['name']}' created! "
+                    f"You can view the new template version in OpenHEXA on https://www.bluesquarehub.com/workspaces/workspace/templates/{template['code']}/versions"
+                ),
+                result.output,
+            )
 
     @patch("openhexa.cli.api.graphql")
     def test_workspaces_add_not_found(self, mock_graphql):