some cleanup + improve namings and logs

Author: christiansiegel

gitopscli/commands/create_pr_preview.py

@@ -1,13 +1,9 @@
 import logging
-import os
-import uuid
 
 from gitopscli.commands.create_preview import create_preview_command
 from gitopscli.git.create_git import create_git
 from gitopscli.io.tmp_dir import create_tmp_dir, delete_tmp_dir
 
-# pylint: disable=too-many-statements
-
 
 def create_pr_preview_command(
     command,
@@ -25,7 +21,6 @@ def create_pr_preview_command(
     assert command == "create-pr-preview"
 
     apps_tmp_dir = create_tmp_dir()
-    root_tmp_dir = create_tmp_dir()
 
     try:
         apps_git = create_git(
@@ -55,66 +50,54 @@ def create_pr_preview_command(
             git_provider,
             git_provider_url,
             git_hash,
-            pr_branch,
-            create_deployment_already_up_to_date_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),
+            pr_branch,  # <- preview_id
+            __create_deployment_already_up_to_date_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 create_deployment_already_up_to_date_callback(parent_id, pr_id):
+def __create_deployment_already_up_to_date_callback(parent_id, pr_id):
     def deployment_already_up_to_date_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)
+        __add_pull_request_comment(
+            apps_git, pr_id, parent_id, f"The version `{new_image_tag}` has already been deployed. Nothing to do here."
+        )
 
     return deployment_already_up_to_date_callback
 
 
-def create_deployment_new_callback(parent_id, pr_id, pr_branch):
+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)
+        app_name = gitops_config.application_name
+        __add_pull_request_comment(
+            apps_git,
+            pr_id,
+            parent_id,
+            f"""\
+New preview environment for `{app_name}` and branch `{pr_branch}` created successfully. Access it here:
+https://{route_host}""",
+        )
 
     return deployment_new_callback
 
 
-def create_deployment_exist_callback(parent_id, pr_id, pr_branch):
+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)
+        app_name = gitops_config.application_name
+        __add_pull_request_comment(
+            apps_git,
+            pr_id,
+            parent_id,
+            f"""\
+Preview environment for `{app_name}` and branch `{pr_branch}` updated successfully. Access it here:
+https://{route_host}""",
+        )
 
     return deployment_exist_callback
 
 
-def __create_pullrequest(branch, gitops_config, root_git):
-    title = "Updated preview environment for " + gitops_config.application_name
-    description = f"""\
-This Pull Request is automatically created through [gitopscli](https://github.com/baloise/gitopscli)."""
-    pull_request = root_git.create_pull_request(branch, "master", title, description)
-    logging.info("Pull request created: %s", {root_git.get_pull_request_url(pull_request)})
-    return pull_request
-
-
-def __merge_pullrequest(branch, pull_request, root_git):
-    root_git.merge_pull_request(pull_request)
-    logging.info("Pull request merged")
-    root_git.delete_branch(branch)
-    logging.info("Branch '%s' deleted", branch)
-
-
-def __create_tmp_dir():
-    tmp_dir = f"/tmp/gitopscli/{uuid.uuid4()}"
-    os.makedirs(tmp_dir)
-    logging.info("Created directory %s", tmp_dir)
-    return tmp_dir
+def __add_pull_request_comment(apps_git, pr_id, parent_id, pr_comment_text):
+    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)

gitopscli/commands/create_preview.py

@@ -10,9 +10,6 @@
 from gitopscli.gitops_exception import GitOpsException
 
 
-# pylint: disable=too-many-statements
-
-
 def create_preview_command(
     username,
     password,
@@ -66,7 +63,6 @@ def create_preview_command(
         root_git.checkout("master")
         logging.info("Config repo branch master checkout successful")
 
-        config_branch = f"master"
         preview_template_folder_name = ".preview-templates/" + gitops_config.application_name
         if os.path.isdir(root_git.get_full_file_path(preview_template_folder_name)):
             logging.info("Using the preview template folder: %s", preview_template_folder_name)
@@ -76,17 +72,17 @@ def create_preview_command(
         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)
-        if not branch_preview_env_already_exist:
+        preview_env_already_exist = os.path.isdir(root_git.get_full_file_path(new_preview_folder_name))
+        logging.info("Is preview env already existing? %s", preview_env_already_exist)
+        if not preview_env_already_exist:
             __create_new_preview_env(
                 git_hash,
                 new_preview_folder_name,
                 preview_template_folder_name,
                 root_git,
                 gitops_config.application_name,
             )
-        logging.info("Using image tag from last app repo commit: %s", git_hash)
+        logging.info("Using image tag from git hash: %s", git_hash)
         route_host = None
         value_replaced = False
         for replacement in gitops_config.replacements:
@@ -101,20 +97,21 @@ def create_preview_command(
                 value_replaced,
             )
         if not value_replaced:
+            logging.info("The image tag %s has already been deployed. Doing nothing.", git_hash)
             if deployment_already_up_to_date_callback:
                 deployment_already_up_to_date_callback(apps_git, git_hash)
             return
 
-        if branch_preview_env_already_exist:
+        root_git.commit(f"Update preview environment for '{gitops_config.application_name}' and git hash '{git_hash}'.")
+        root_git.push("master")
+        logging.info("Pushed branch master")
+
+        if preview_env_already_exist:
             if deployment_exists_callback:
                 deployment_exists_callback(apps_git, gitops_config, route_host)
         else:
             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)
-        logging.info("Pushed branch %s", config_branch)
     finally:
         delete_tmp_dir(apps_tmp_dir)
         delete_tmp_dir(root_tmp_dir)
@@ -127,7 +124,7 @@ def __replace_value(
     replacement,
     root_git,
     route_host,
-    shortened_branch_hash,
+    hashed_preview_id,
     value_replaced,
 ):
     replacement_value = None
@@ -137,7 +134,7 @@ def __replace_value(
     if replacement_variable == "GIT_COMMIT":
         replacement_value = new_image_tag
     elif replacement_variable == "ROUTE_HOST":
-        route_host = gitops_config.route_host.replace("{SHA256_8CHAR_BRANCH_HASH}", shortened_branch_hash)
+        route_host = gitops_config.route_host.replace("{SHA256_8CHAR_BRANCH_HASH}", hashed_preview_id)
         logging.info("Created route host: %s", route_host)
         replacement_value = route_host
     else: