Merge pull request #46 from baloise-incubator/feat/new_gitopsconfig_format

Feat/new gitopsconfig format

Author: joachimprinzbach

doc/commands/create-preview.md

@@ -56,3 +56,30 @@ gitopscli create-preview \
 --pr-id 4711 \
 --auto-merge
 ```
+
+## .gitops.config.yaml
+Make sure that your application repository contains a `.gitops.config.yaml` file.
+
+```yaml
+deploymentConfig:
+  # The organisation name of your deployment repo
+  org: DPL
+  # The repostiory name of your deployment repo
+  repository: incubator-non-prod
+  # The name of the application that is used in your deployment repo
+  applicationName: example
+
+previewConfig:
+  route:
+    host:
+      # your router host.
+      #{SHA256_8CHAR_BRANCH_HASH} gets replaced by a shortened hash of your feature branch name
+      template: example-{SHA256_8CHAR_BRANCH_HASH}.example.tld
+  replace:
+    # Paths that should be replaced
+    - path: image.tag
+      variable: GIT_COMMIT # this is the latest git hash of the PR branch
+    - path: route.host
+      variable: ROUTE_HOST # this is the resolved SHA256_8CHAR_BRANCH_HASH from above
+
+```

gitopscli/commands/create_preview.py

@@ -70,27 +70,39 @@ def create_preview_command(
         logging.info("Using the preview template folder: %s", preview_template_folder_name)
         new_preview_folder_name = gitops_config.application_name + "-" + shortened_branch_hash + "-preview"
         logging.info("New folder for preview: %s", new_preview_folder_name)
-        route_host = None
-        logging.info("New folder for preview: %s", new_preview_folder_name)
         branch_preview_env_already_exist = os.path.exists(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 gitops_config.route_paths:
-            route_host = gitops_config.route_host.replace("previewplaceholder", shortened_branch_hash)
-            logging.info("Created route host: %s", route_host)
         if not branch_preview_env_already_exist:
-            __create_new_preview_env(
-                branch, gitops_config, new_preview_folder_name, preview_template_folder_name, root_git, route_host,
-            )
+            __create_new_preview_env(branch, new_preview_folder_name, preview_template_folder_name, root_git)
         new_image_tag = apps_git.get_last_commit_hash()
         logging.info("Using image tag from last app repo commit: %s", new_image_tag)
-        for image_path in gitops_config.image_paths:
-            __replace_image_tag_value(
-                apps_git, image_path, new_image_tag, new_preview_folder_name, parent_id, pr_id, root_git
+        route_host = None
+        value_replaced = False
+        for replacement in gitops_config.replacements:
+            route_host, value_replaced = __replace_value(
+                gitops_config,
+                new_image_tag,
+                new_preview_folder_name,
+                replacement,
+                root_git,
+                route_host,
+                shortened_branch_hash,
+                value_replaced,
             )
+        if not value_replaced:
+            __no_deployment_needed(apps_git, new_image_tag, parent_id, pr_id)
+            sys.exit(0)
+        root_git.commit(f"Upated preview environment for {gitops_config.application_name}.")
         root_git.push(branch)
         logging.info("Pushed branch %s", branch)
         pr_comment_text = f"""
-Preview created successfully. Access it here: https://{route_host}.
+New Preview Environment for {gitops_config.application_name} created successfully. Access it here: 
+https://{route_host}
+"""
+        if branch_preview_env_already_exist:
+            pr_comment_text = f"""
+Preview Environment for {gitops_config.application_name} 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)
@@ -103,16 +115,33 @@ def create_preview_command(
             __merge_pullrequest(branch, pull_request, root_git)
 
 
-def __replace_image_tag_value(apps_git, image_path, new_image_tag, new_preview_folder_name, parent_id, pr_id, root_git):
-    yaml_replace_path = image_path["yamlpath"]
-    logging.info("Replacing property %s with value: %s", yaml_replace_path, new_image_tag)
-    value_replaced = update_yaml_file(
-        root_git.get_full_file_path(new_preview_folder_name + "/values.yaml"), yaml_replace_path, new_image_tag,
+def __replace_value(
+    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)
+    replacement_path_ = replacement["path"]
+    replacement_variable = replacement["variable"]
+    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)
+        logging.info("Created route host: %s", route_host)
+        replacement_value = route_host
+    else:
+        logging.info("Unknown replacement variable: %s", replacement_variable)
+    value_replaced = value_replaced | update_yaml_file(
+        root_git.get_full_file_path(new_preview_folder_name + "/values.yaml"), replacement_path_, replacement_value,
     )
-    if not value_replaced:
-        __no_deployment_needed(apps_git, new_image_tag, parent_id, pr_id)
-        sys.exit(0)
-    root_git.commit(f"changed '{yaml_replace_path}' to '{new_image_tag}'")
+    logging.info("Replacing property %s with value: %s", replacement_path_, replacement_value)
+    return route_host, value_replaced
 
 
 def __no_deployment_needed(apps_git, new_image_tag, parent_id, pr_id):
@@ -125,7 +154,7 @@ def __no_deployment_needed(apps_git, new_image_tag, parent_id, pr_id):
 
 
 def __create_new_preview_env(
-    branch, gitops_config, new_preview_folder_name, preview_template_folder_name, root_git, route_host,
+    branch, new_preview_folder_name, preview_template_folder_name, root_git,
 ):
     shutil.copytree(
         root_git.get_full_file_path(preview_template_folder_name), root_git.get_full_file_path(new_preview_folder_name),
@@ -134,15 +163,7 @@ def __create_new_preview_env(
     logging.info("Looking for Chart.yaml at: %s", chart_file_path)
     if root_git.get_full_file_path(chart_file_path):
         update_yaml_file(root_git.get_full_file_path(chart_file_path), "name", new_preview_folder_name)
-    if gitops_config.route_paths:
-        for route_path in gitops_config.route_paths:
-            yaml_replace_path = route_path["hostpath"]
-            logging.info("Replacing property %s with value: %s", yaml_replace_path, route_host)
-            update_yaml_file(
-                root_git.get_full_file_path(new_preview_folder_name + "/values.yaml"), yaml_replace_path, route_host,
-            )
     root_git.commit(f"Initiated new preview env for branch {branch}'")
-    return route_host
 
 
 def __create_pullrequest(branch, gitops_config, root_git):

gitopscli/yaml/gitops_config.py

@@ -8,24 +8,20 @@ def __init__(self, filename):
 
     @property
     def application_name(self):
-        return self._data.get("application-name")
+        return self._data["deploymentConfig"]["applicationName"]
 
     @property
     def team_config_org(self):
-        return self._data.get("team-config-org")
+        return self._data["deploymentConfig"]["org"]
 
     @property
     def team_config_repo(self):
-        return self._data.get("team-config-repo")
+        return self._data["deploymentConfig"]["repository"]
 
     @property
     def route_host(self):
-        return self._data.get("routehost")
+        return self._data["previewConfig"]["route"]["host"]["template"]
 
     @property
-    def route_paths(self):
-        return self._data.get("routepaths", [])
-
-    @property
-    def image_paths(self):
-        return self._data.get("imagepaths", [])
+    def replacements(self):
+        return self._data["previewConfig"]["replace"]

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="gitopscli",
-    version="0.1.0",
+    version="2.0.0",
     packages=find_packages(),
     entry_points={"console_scripts": ["gitopscli = gitopscli.__main__:main"]},
 )