osm_lcm/odu_libs/workflows.py

#######################################################################################
# Copyright ETSI Contributors and Others.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#######################################################################################


import asyncio
import traceback
from math import ceil


async def check_workflow_status(self, workflow_name):
    self.logger.info(f"check_workflow_status Enter: {workflow_name}")
    try:
        return await self.readiness_loop(
            item="workflow",
            name=workflow_name,
            namespace="osm-workflows",
            flag="Completed",
            timeout=300,
        )
    except Exception as e:
        return False, f"Unexpected exception: {e}"


async def readiness_loop(self, item, name, namespace, flag, timeout):
    self.logger.info("readiness_loop Enter")
    self.logger.info(
        f"{item} {name}. Namespace: {namespace}. Flag: {flag}. Timeout: {timeout}"
    )
    item_api_map = {
        "workflow": {
            "api_group": "argoproj.io",
            "api_plural": "workflows",
            "api_version": "v1alpha1",
        },
        "kustomization": {
            "api_group": "kustomize.toolkit.fluxcd.io",
            "api_plural": "kustomizations",
            "api_version": "v1",
        },
        "cluster_aws": {
            "api_group": "eks.aws.upbound.io",
            "api_plural": "clusters",
            "api_version": "v1beta1",
        },
        "cluster_azure": {
            "api_group": "containerservice.azure.upbound.io",
            "api_plural": "kubernetesclusters",
            "api_version": "v1beta1",
        },
        "cluster_gcp": {
            "api_group": "container.gcp.upbound.io",
            "api_plural": "clusters",
            "api_version": "v1beta2",
        },
    }
    counter = 1
    retry_time = self._odu_checkloop_retry_time
    max_iterations = ceil(timeout / retry_time)
    api_group = item_api_map[item]["api_group"]
    api_plural = item_api_map[item]["api_plural"]
    api_version = item_api_map[item]["api_version"]

    while counter <= max_iterations:
        generic_object = await self._kubectl.get_generic_object(
            api_group=api_group,
            api_plural=api_plural,
            api_version=api_version,
            namespace=namespace,
            name=name,
        )
        if generic_object:
            # self.logger.debug(f"{yaml.safe_dump(generic_object)}")
            conditions = generic_object.get("status", {}).get("conditions", [])
        else:
            conditions = []
        self.logger.info(
            f"Iteration {counter}/{max_iterations}. {item} status conditions: {conditions}"
        )
        result = next((item for item in conditions if item["type"] == flag), {})
        if result.get("status", "False") == "True":
            self.logger.info(
                f"{item} {name} reached the status {flag} in {counter} iterations (aprox {counter*retry_time} seconds)"
            )
            return True, "COMPLETED"
        await asyncio.sleep(retry_time)
        counter += 1
    return (
        False,
        "{item} {name} was not ready after {max_iterations} iterations (aprox {timeout} seconds)",
    )


async def common_check_list(self, checkings_list):
    try:
        for checking in checkings_list:
            if checking["enable"]:
                status, message = await self.readiness_loop(
                    item=checking["item"],
                    name=checking["name"],
                    namespace=checking["namespace"],
                    flag=checking["flag"],
                    timeout=checking["timeout"],
                )
                if not status:
                    return status, message
    except Exception as e:
        self.logger.debug(traceback.format_exc())
        self.logger.debug(f"Exception: {e}", exc_info=True)
        return False, f"Unexpected exception: {e}"
    return True, "OK"