Refactor a little, make consts etc

Author: viveksinghggits

docker/mongodb-kubernetes-tests/kubetester/consts.py

@@ -0,0 +1,8 @@
+OPERATOR_VERSION_ENV_VAR_NAME = "OPERATOR_VERSION"
+
+OCI_HELM_REGISTRY_ENV_VAR_NAME = "OCI_HELM_REGISTRY"
+OCI_HELM_REPOSITORY_ENV_VAR_NAME = "OCI_HELM_REPOSITORY"
+OCI_HELM_REGION_ENV_VAR_NAME = "OCI_HELM_REGION"
+
+LEGACY_OPERATOR_CHART = "mongodb/enterprise-operator"
+MCK_HELM_CHART = "mongodb/mongodb-kubernetes"

docker/mongodb-kubernetes-tests/kubetester/helm.py

@@ -6,10 +6,14 @@
 import uuid
 from typing import Dict, List, Optional, Tuple
 
+from kubetester.consts import *
 from tests import test_logger
 
 logger = test_logger.get_test_logger(__name__)
 
+# LOCAL_CRDs_DIR is the dir where local helm chart's CRDs are copied in tests image
+LOCAL_CRDs_DIR = "helm_chart/crds"
+
 
 def helm_template(
     helm_args: Dict,
@@ -211,8 +215,7 @@ def helm_upgrade(
     chart_dir = helm_chart_path if helm_override_path else _helm_chart_dir(helm_chart_path)
 
     if apply_crds_first:
-        local_helm_chart_dir = "helm_chart"
-        apply_crds_from_chart(local_helm_chart_dir)
+        apply_crds_from_chart(LOCAL_CRDs_DIR)
 
     command_args = _create_helm_args(helm_args, helm_options)
     args = [
@@ -233,21 +236,24 @@ def helm_upgrade(
     process_run_and_check(command, check=True, capture_output=True, shell=True)
 
 
+# oci_chart_info returns the respective registry/repo and region information
+# based on the build scenario (dev/staging) tests are being run in. These are
+# read from build_info.json and then set to the tests image as env vars.
 def oci_chart_info():
-    registry = os.environ.get("OCI_HELM_REGISTRY")
-    repository = os.environ.get("OCI_HELM_REPOSITORY")
-    region = os.environ.get("OCI_HELM_REGION")
+    registry = os.environ.get(OCI_HELM_REGISTRY_ENV_VAR_NAME)
+    repository = os.environ.get(OCI_HELM_REPOSITORY_ENV_VAR_NAME)
+    region = os.environ.get(OCI_HELM_REGION_ENV_VAR_NAME)
 
-    print(f"oci chart details in test image is registry {registry}, repo {repository}, region {region}")
+    logger.info(f"oci chart details in test image is registry {registry}, repo {repository}, region {region}")
 
     return registry, f"{repository}/mongodb-kubernetes", region
 
 
-def apply_crds_from_chart(chart_dir: str):
-    crd_files = glob.glob(os.path.join(chart_dir, "crds", "*.yaml"))
+def apply_crds_from_chart(crds_dir: str):
+    crd_files = glob.glob(os.path.join(crds_dir, "*.yaml"))
 
     if not crd_files:
-        raise Exception(f"No CRD files found in chart directory: {chart_dir}")
+        raise Exception(f"No CRD files found in chart directory: {crds_dir}")
 
     logger.info(f"Found {len(crd_files)} CRD files to apply:")
 

docker/mongodb-kubernetes-tests/kubetester/operator.py

@@ -10,6 +10,7 @@
 from kubernetes.client import V1CustomResourceDefinition, V1Deployment, V1Pod
 from kubernetes.client.rest import ApiException
 from kubetester import wait_for_webhook
+from kubetester.consts import *
 from kubetester.create_or_replace_from_yaml import create_or_replace_from_yaml
 from kubetester.helm import (
     helm_install,
@@ -28,6 +29,7 @@
     "opsmanagers.mongodb.com",
 )
 
+
 logger = test_logger.get_test_logger(__name__)
 
 
@@ -54,6 +56,8 @@ def __init__(
         # The Operator will be installed from the following repo, so adding it first
         helm_repo_add("mongodb", "https://mongodb.github.io/helm-charts")
 
+        # helm_chart_path not being passed would mean we are on evg env and would like to
+        # install helm chart from OCI registry.
         if not helm_chart_path:
             # login to the OCI container registry
             registry, repository, region = oci_chart_info()
@@ -66,13 +70,16 @@ def __init__(
             chart_uri = f"oci://{registry}/{repository}"
             helm_chart_path = chart_uri
 
+        # if operator_version is not specified and we are not installing the MCK or MEKO chart
+        # it would mean we want to install OCI published helm chart. Figure out respective version,
+        # it is set in env var `OPERATOR_VERSION` based on build_scenario.
         if not operator_version and helm_chart_path not in (
-            "mongodb/mongodb-kubernetes",
-            "mongodb/enterprise-operator",
+            MCK_HELM_CHART,
+            LEGACY_OPERATOR_CHART,
         ):
-            # most probably we are trying to install current operator which will be installed
-            # from OCI registry. The version (dev/staging) is set in `OPERATOR_VERSION`
-            non_semver_operator_version = os.environ.get("OPERATOR_VERSION")
+            non_semver_operator_version = os.environ.get(OPERATOR_VERSION_ENV_VAR_NAME)
+            # when we publish the helm chart we append `0.0.0+` in the chart version, details are
+            # here https://docs.google.com/document/d/1eJ8iKsI0libbpcJakGjxcPfbrTn8lmcZDbQH1UqMR_g/edit?tab=t.gg5ble8qlesq
             operator_version = f"0.0.0+{non_semver_operator_version}"
 
         if helm_args is None:

docker/mongodb-kubernetes-tests/tests/conftest.py

@@ -20,6 +20,7 @@
     update_configmap,
 )
 from kubetester.awss3client import AwsS3Client
+from kubetester.consts import *
 from kubetester.helm import (
     helm_install_from_chart,
     helm_repo_add,
@@ -60,9 +61,6 @@
 LEGACY_CENTRAL_CLUSTER_NAME: str = "__default"
 LEGACY_DEPLOYMENT_STATE_VERSION: str = "1.27.0"
 
-# Helm charts
-LEGACY_OPERATOR_CHART = "mongodb/enterprise-operator"
-MCK_HELM_CHART = "mongodb/mongodb-kubernetes"
 LOCAL_HELM_CHART_DIR = "helm_chart"
 
 OFFICIAL_OPERATOR_IMAGE_NAME = "mongodb-kubernetes"
@@ -841,22 +839,27 @@ def _install_multi_cluster_operator(
     # The Operator will be installed from the following repo, so adding it first
     helm_repo_add("mongodb", "https://mongodb.github.io/helm-charts")
 
-    # login to the OCI container registry
-    registry, repository, region = oci_chart_info()
-    try:
-        oci_helm_registry_login(registry, region)
-    except Exception as e:
-        raise e
-
-    # figure out the registry URI, based on dev/staging scenario
-    chart_uri = f"oci://{registry}/{repository}"
+    # helm_chart_path not being passed would mean we are on evg env and would like to
+    # install helm chart from OCI registry.
     if not helm_chart_path:
+        # login to the OCI container registry
+        registry, repository, region = oci_chart_info()
+        try:
+            oci_helm_registry_login(registry, region)
+        except Exception as e:
+            raise e
+
+        # figure out the registry URI, based on dev/staging scenario
+        chart_uri = f"oci://{registry}/{repository}"
+
         helm_chart_path = chart_uri
 
     if not custom_operator_version and helm_chart_path not in (MCK_HELM_CHART, LEGACY_OPERATOR_CHART):
-        # most probably we are trying to install current operator which will be installed
-        # from OCI registry. The version (dev/staging) is set in `OPERATOR_VERSION`
-        non_semver_custom_operator_version = os.environ.get("OPERATOR_VERSION")
+        # custom_operator_version is not set and chart is also neither MCK nor MEKO would mean we are trying to install
+        # the operator from OCI registry. The version based on build scenario (dev/staging) is set in `OPERATOR_VERSION` env var.
+        non_semver_custom_operator_version = os.environ.get(OPERATOR_VERSION_ENV_VAR_NAME)
+        # when we publish the helm chart we append `0.0.0+` in the chart version, details are
+        # here https://docs.google.com/document/d/1eJ8iKsI0libbpcJakGjxcPfbrTn8lmcZDbQH1UqMR_g/edit?tab=t.gg5ble8qlesq
         custom_operator_version = f"0.0.0+{non_semver_custom_operator_version}"
 
     prepare_multi_cluster_namespaces(