resolving some identified bugs

Author: erikschlegel

src/api/generate_name.py

@@ -7,7 +7,7 @@
 bp = Blueprint("names", __name__)
 
 
-@bp.route("/generate_name")
+@bp.route("/")
 def generate_name():
     starts_with = request.args.get("starts_with")
     name_choices = names

src/api/manifests/copy-credentials.yaml.tmpl

@@ -0,0 +1,25 @@
+---
+apiVersion: source.toolkit.fluxcd.io/v1beta1
+kind: GitRepository
+metadata:
+  name: credentials-copy
+  namespace: ${SERVICE_NAME}-istio-svc
+spec:
+  interval: 1m0s
+  ref:
+    branch: main
+  url: https://github.com/runyontr/credentials-copy
+---
+apiVersion: helm.toolkit.fluxcd.io/v2beta1
+kind: HelmRelease
+metadata:
+  name: credentials
+  namespace: ${SERVICE_NAME}-istio-svc
+spec:
+  chart:
+    spec:
+      chart: chart
+      sourceRef:
+        kind: GitRepository
+        name: credentials-copy
+  interval: 1m0s

src/api/manifests/helm-release.yaml.tmpl

@@ -19,8 +19,5 @@ spec:
     - name: bigbang
       namespace: bigbang
   valuesFrom:
-    - kind: Secret
-      name: common-bb
-      valuesKey: values.yaml
-    - kind: ConfigMap
-      name: common
+  - kind: ConfigMap
+    name: common

src/api/manifests/kustomization.yaml.tmpl

@@ -1,7 +1,10 @@
+namespace: ${SERVICE_NAME}-istio-svc
+
 resources:
   - namespace.yaml
   - repository.yaml
   - helm-release.yaml
+  - copy-credentials.yaml
 
 configMapGenerator:
   - name: common

src/api/manifests/repository.yaml.tmpl

@@ -10,5 +10,4 @@ spec:
   interval: 1m
   url: https://github.com/csemissionplatformops/big-bang-istio-service.git
   ref:
-    branch: main
-    tag: 0.0.12
+    branch: main

src/hooks/postdeploy.py

@@ -22,6 +22,9 @@ def set_env_from_azd():
         os.environ[key] = value
 
 def get_services_to_deploy(yaml_template) -> dict:
+    """
+    Parses the yaml file and returns a dictionary containing the services to deploy.
+    """
     template_file = os.path.join(CWD, yaml_template)
 
     with open(template_file, "r", encoding="utf-8") as stream:
@@ -37,6 +40,9 @@ def get_services_to_deploy(yaml_template) -> dict:
             print("Error loading yaml file: ", ex)
 
 def pre_req_assertions(deployment_template):
+    """
+    Asserts that the required environment variables and files exist.
+    """
     azure_dir = os.path.join(CWD, ".azure")
     template_file = os.path.join(CWD, deployment_template)
 
@@ -53,6 +59,15 @@ def pre_req_assertions(deployment_template):
             "The template_dir folder does not exist. Please run 'azd init'"
         )
 
+    if os.environ.get("SERVICE_API_IMAGE_NAME") is None:
+        raise ValueError(
+            "No SERVICE_API_IMAGE_NAME environment variable found. Please set the \
+        SERVICE_API_IMAGE_NAME environment variable."
+        )
+
+    os.environ['SERVICE_API_IMAGE_REPO'] = os.environ['SERVICE_API_IMAGE_NAME'].split(':')[0]
+    os.environ['SERVICE_API_IMAGE_TAG'] = os.environ['SERVICE_API_IMAGE_NAME'].split(':')[1]
+
 def copy_manifest_dir_tree_to_repo(manifest_path, repo_path):
     """
     Recursively searches for files ending with a .tmpl extension under manifest_path
@@ -67,8 +82,8 @@ def ignore_func(_, files):
 if __name__ == "__main__":
     print("Post-Deplouy hook running...")
 
-    pre_req_assertions(TEMPLATE_FILE)
     set_env_from_azd()
+    pre_req_assertions(TEMPLATE_FILE)
     environment_name = os.environ.get("AZURE_AKS_ENVIRONMENT_NAME")
     git_client = GithubClient()
 

src/hooks/wrappers/github.py

@@ -4,7 +4,14 @@
 import git
 
 class GithubClient:
+    """
+    A class that provides methods for interacting with the GitHub API 
+    and performing common Git operations.
+    """
     def login(self):
+        """
+        Logs in to GitHub using either the GITHUB_TOKEN environment variable or the gh CLI.
+        """
         gh_pat = os.environ.get("GITHUB_TOKEN")
 
         if gh_pat is None:
@@ -19,6 +26,9 @@ def login(self):
         os.environ["GITHUB_TOKEN"] = gh_pat
 
     def __login_with_pat(self, gh_pat):
+        """
+        Logs in to GitHub using a personal access token (PAT).
+        """
         with tempfile.TemporaryDirectory() as td_hndl:
             token_file = os.path.join(td_hndl, 'token')
             with open(token_file, 'w', encoding="utf-8") as file_hndl:
@@ -27,6 +37,9 @@ def __login_with_pat(self, gh_pat):
                 self.__run_gh_cli_command("auth", ["login", f"--with-token < {token_file}"])
 
     def clone_repo(self, repo_name, target_branch, directory):
+        """
+        Clones a GitHub repository to a local directory.
+        """
         if repo_name is None:
             raise ValueError("repo_name cannot be None")
 
@@ -38,6 +51,9 @@ def clone_repo(self, repo_name, target_branch, directory):
             print(f"Error cloning repo {repo_name}: Exception: {ex}")
 
     def push_changes(self, repo_dir, commit_message):
+        """
+        Pushes changes to a GitHub repository.
+        """
         if repo_dir is None:
             raise ValueError("repo_dir cannot be None")
 
@@ -53,16 +69,25 @@ def push_changes(self, repo_dir, commit_message):
             print(f"Error pushing changes: Exception: {ex}")
 
     def __run_command(self, command):
+        """
+        Runs a command in the shell and returns its output.
+        """
         try:
             output = subprocess.check_output(command, stderr=subprocess.STDOUT, \
                                              universal_newlines=True, shell=True)
             return output.strip()
         except subprocess.CalledProcessError as ex:
             print(f"Error: {ex.output}")
             return None
-            
+
     def __run_gh_cli_command(self, command, args):
+        """
+        Runs a command in the gh CLI and returns its output.
+        """
         return self.__run_command(["gh", command] + args)
 
     def __unset_gh_pat(self):
-        del os.environ["GITHUB_TOKEN"]
+        """
+        Unsets the GITHUB_TOKEN environment variable.
+        """
+        del os.environ["GITHUB_TOKEN"]

src/hooks/wrappers/renderer.py

@@ -3,13 +3,31 @@
 import yaml
 
 class RenderEngine:
+    """
+    The RenderEngine class provides functionality to render K8 templates 
+    and add a service to a kustomization file.
+    """
     def __init__(self, path, kustomization_path, service_name):
+        """
+        Initializes a new instance of the RenderEngine class.
+
+        Args:
+            path (str): The path to the directory containing the templates to render.
+            kustomization_path (str): The path to the kustomization file.
+            service_name (str): The name of the service to add to the kustomization file.
+        """
         self.path = path
         self.service_name = service_name
         self.kustomization_path = kustomization_path
         self.remove_template_file = True
 
     def __retrieve_files_to_render(self):
+        """
+        Retrieves a list of files to render.
+
+        Returns:
+            A list of files to render.
+        """
         files_to_render = []
         for root, _, files in os.walk(self.path):
             for file in files:
@@ -18,6 +36,9 @@ def __retrieve_files_to_render(self):
         return files_to_render
 
     def render(self):
+        """
+        Renders the templates and adds the service to the kustomization file.
+        """
         files_to_render = self.__retrieve_files_to_render()
         for file in files_to_render:
             print(f"Rendering {file}")
@@ -29,6 +50,15 @@ def render(self):
         self.__add_service_to_kustomization_resources()
 
     def __run_command(self, command):
+        """
+        Runs a shell command.
+
+        Args:
+            command (str): The command to run.
+
+        Returns:
+            The output of the command.
+        """
         try:
             output = subprocess.check_output(command, stderr=subprocess.STDOUT, \
                                              universal_newlines=True, shell=True)
@@ -38,27 +68,40 @@ def __run_command(self, command):
             return None
 
     def __add_service_to_kustomization_resources(self):
+        """
+        Adds the service to the kustomization file.
+        """
         # verify that the kustomization file exists
         if not os.path.exists(self.kustomization_path):
             raise ValueError(
                 f"The kustomization file {self.kustomization_path} does not exist."
             )
 
-        print(f"Adding {self.service_name} to {self.kustomization_path}")
-
         with open(self.kustomization_path, "r", encoding="utf-8") as r_stream:
             yaml_dict = yaml.safe_load(r_stream)
             # check if the resources key exists
 
             if "resources" not in yaml_dict:
                 raise ValueError("No resources found in kustomization yaml file.")
 
-            yaml_dict["resources"].append(f"./services/{self.service_name}")
-            # Write the updated yaml to the kustomization file\
-            with open(self.kustomization_path, "w", encoding="utf-8") as w_stream:
-                yaml.safe_dump(yaml_dict, w_stream, default_flow_style=False, sort_keys=False)
+            # Check if the service already exists in the resources
+            if f"./services/{self.service_name}" not in yaml_dict["resources"]:
+                yaml_dict["resources"].append(f"./services/{self.service_name}")
+                # Write the updated yaml to the kustomization file\
+                with open(self.kustomization_path, "w", encoding="utf-8") as w_stream:
+                    print(f"Adding {self.service_name} to {self.kustomization_path}")
+                    yaml.safe_dump(yaml_dict, w_stream, default_flow_style=False, sort_keys=False)
 
     def __run_command(self, command):
+        """
+        Runs a shell command.
+
+        Args:
+            command (str): The command to run.
+
+        Returns:
+            The output of the command.
+        """
         try:
             output = subprocess.check_output(command, stderr=subprocess.STDOUT, \
                                              universal_newlines=True, shell=True)