use hashed preview id to pass the k8s namespace name restriction

Author: m4rc0z

gitopscli/commands/create_pr_preview.py

@@ -58,49 +58,49 @@ def create_pr_preview_command(
             git_provider_url,
             git_hash,
             preview_id,
-            deployment_replaced(parent_id, pr_id),
-            deployment_exist(parent_id, pr_id, pr_branch),
-            deployment_new(parent_id, pr_id, pr_branch),
+            create_deployment_replaced_callback(parent_id, pr_id),
+            create_deployment_exist_callback(parent_id, pr_id, pr_branch),
+            create_deployment_new_callback(parent_id, pr_id, pr_branch),
         )
     finally:
         delete_tmp_dir(apps_tmp_dir)
         delete_tmp_dir(root_tmp_dir)
 
 
-def deployment_replaced(parent_id, pr_id):
-    def inner_func(apps_git, new_image_tag):
+def create_deployment_replaced_callback(parent_id, pr_id):
+    def deployment_replaced_callback(apps_git, new_image_tag):
         logging.info("The image tag %s has already been deployed. Doing nothing.", new_image_tag)
         pr_comment_text = f"""
         The version `{new_image_tag}` has already been deployed. Nothing to do here.
         """
         logging.info("Creating PullRequest comment for pr with id %s and content: %s", pr_id, pr_comment_text)
         apps_git.add_pull_request_comment(pr_id, pr_comment_text, parent_id)
 
-    return inner_func
+    return deployment_replaced_callback
 
 
-def deployment_new(parent_id, pr_id, pr_branch):
-    def inner_func(apps_git, gitops_config, route_host):
+def create_deployment_new_callback(parent_id, pr_id, pr_branch):
+    def deployment_new_callback(apps_git, gitops_config, route_host):
         pr_comment_text = f"""
         New preview environment for `{gitops_config.application_name}` and branch `{pr_branch}` created successfully. Access it here:
         https://{route_host}
         """
         logging.info("Creating PullRequest comment for pr with id %s and content: %s", pr_id, pr_comment_text)
         apps_git.add_pull_request_comment(pr_id, pr_comment_text, parent_id)
 
-    return inner_func
+    return deployment_new_callback
 
 
-def deployment_exist(parent_id, pr_id, pr_branch):
-    def inner_func(apps_git, gitops_config, route_host):
+def create_deployment_exist_callback(parent_id, pr_id, pr_branch):
+    def deployment_exist_callback(apps_git, gitops_config, route_host):
         pr_comment_text = f"""
         Preview environment for `{gitops_config.application_name}` and branch `{pr_branch}` updated successfully. Access it here:
         https://{route_host}
         """
         logging.info("Creating PullRequest comment for pr with id %s and content: %s", pr_id, pr_comment_text)
         apps_git.add_pull_request_comment(pr_id, pr_comment_text, parent_id)
 
-    return inner_func
+    return deployment_exist_callback
 
 
 def __create_pullrequest(branch, gitops_config, root_git):

gitopscli/commands/create_preview.py

@@ -1,3 +1,4 @@
+import hashlib
 import logging
 import os
 import shutil
@@ -8,25 +9,25 @@
 from gitopscli.io.tmp_dir import create_tmp_dir, delete_tmp_dir
 from gitopscli.gitops_exception import GitOpsException
 
+
 # pylint: disable=too-many-statements
 
 
 def create_preview_command(
-    username,
-    password,
-    git_user,
-    git_email,
-    organisation,
-    repository_name,
-    git_provider,
-    git_provider_url,
-    git_hash,
-    preview_id,
-    deployment_replaced=None,
-    deployment_exists=None,
-    deployment_new=None,
+        username,
+        password,
+        git_user,
+        git_email,
+        organisation,
+        repository_name,
+        git_provider,
+        git_provider_url,
+        git_hash,
+        preview_id,
+        deployment_replaced_callback=None,
+        deployment_exists_callback=None,
+        deployment_new_callback=None,
 ):
-
     apps_tmp_dir = create_tmp_dir()
     root_tmp_dir = create_tmp_dir()
 
@@ -72,7 +73,8 @@ def create_preview_command(
         else:
             raise GitOpsException(f"The preview template folder does not exist: {preview_template_folder_name}")
 
-        new_preview_folder_name = gitops_config.application_name + "-" + preview_id + "-preview"
+        hashed_preview_id = hashlib.sha256(preview_id.encode("utf-8")).hexdigest()[:8]
+        new_preview_folder_name = gitops_config.application_name + "-" + hashed_preview_id + "-preview"
         logging.info("New folder for preview: %s", new_preview_folder_name)
         branch_preview_env_already_exist = os.path.isdir(root_git.get_full_file_path(new_preview_folder_name))
         logging.info("Is preview env already existing for branch? %s", branch_preview_env_already_exist)
@@ -100,16 +102,16 @@ def create_preview_command(
                 value_replaced,
             )
         if not value_replaced:
-            if deployment_replaced:
-                deployment_replaced(apps_git, new_image_tag)
+            if deployment_replaced_callback:
+                deployment_replaced_callback(apps_git, new_image_tag)
             return
 
         if branch_preview_env_already_exist:
-            if deployment_exists:
-                deployment_exists(apps_git, gitops_config, route_host)
+            if deployment_exists_callback:
+                deployment_exists_callback(apps_git, gitops_config, route_host)
         else:
-            if deployment_new:
-                deployment_new(apps_git, gitops_config, route_host)
+            if deployment_new_callback:
+                deployment_new_callback(apps_git, gitops_config, route_host)
 
         root_git.commit(f"Update preview environment for '{gitops_config.application_name}' and git hash '{git_hash}'.")
         root_git.push(config_branch)
@@ -120,14 +122,14 @@ def create_preview_command(
 
 
 def __replace_value(
-    gitops_config,
-    new_image_tag,
-    new_preview_folder_name,
-    replacement,
-    root_git,
-    route_host,
-    shortened_branch_hash,
-    value_replaced,
+        gitops_config,
+        new_image_tag,
+        new_preview_folder_name,
+        replacement,
+        root_git,
+        route_host,
+        shortened_branch_hash,
+        value_replaced,
 ):
     replacement_value = None
     logging.info("Replacement: %s", replacement)
@@ -152,7 +154,7 @@ def __replace_value(
 
 
 def __create_new_preview_env(
-    git_hash, new_preview_folder_name, preview_template_folder_name, root_git, app_name,
+        git_hash, new_preview_folder_name, preview_template_folder_name, root_git, app_name,
 ):
     shutil.copytree(
         root_git.get_full_file_path(preview_template_folder_name), root_git.get_full_file_path(new_preview_folder_name),

gitopscli/commands/delete_preview.py

@@ -1,3 +1,4 @@
+import hashlib
 import logging
 import os
 import uuid
@@ -60,7 +61,8 @@ def delete_preview_command(
         root_git.checkout("master")
         logging.info("Config repo branch master checkout successful")
         config_branch = "master"
-        preview_folder_name = gitops_config.application_name + "-" + preview_id + "-preview"
+        hashed_preview_id = hashlib.sha256(preview_id.encode("utf-8")).hexdigest()[:8]
+        preview_folder_name = gitops_config.application_name + "-" + hashed_preview_id + "-preview"
         logging.info("Preview folder name: %s", preview_folder_name)
         branch_preview_env_exists = os.path.exists(root_git.get_full_file_path(preview_folder_name))
         logging.info("Is preview env already existing for branch? %s", branch_preview_env_exists)