suite-py 1.41.2__py3-none-any.whl → 1.41.4__py3-none-any.whl

suite_py/commands/qa.py

@@ -1,424 +0,0 @@
-# -*- coding: utf-8 -*-
-
-import copy
-import datetime
-import json
-import re
-import sys
-
-from dateutil import parser, tz
-from rich.console import Console
-from rich.table import Table
-
-from suite_py.commands.login import Login
-from suite_py.lib import logger
-from suite_py.lib import metrics
-from suite_py.lib.handler import git_handler as git
-from suite_py.lib.handler import prompt_utils
-from suite_py.lib.handler.drone_handler import DroneHandler
-from suite_py.lib.handler.git_handler import GitHandler
-from suite_py.lib.handler.qainit_handler import QainitHandler
-from suite_py.lib.handler.youtrack_handler import YoutrackHandler
-
-
-class QA:
-    def __init__(self, action, project, config, tokens, flags=None):
-        self._action = action
-        self._project = project
-        self._flags = flags
-        self._config = config
-        self._tokens = tokens
-        self._git = GitHandler(project, config)
-        self._qainit = QainitHandler(project, config, tokens)
-        self._youtrack = YoutrackHandler(config, tokens)
-        self._drone = DroneHandler(config, tokens)
-
-    @metrics.command("qa")
-    def run(self):
-        if not self._qainit.user_info():
-            logger.warning("You're not logged in.")
-            Login(self._config).run()
-
-        if self._action == "list":
-            self._list()
-        elif self._action == "create":
-            self._create()
-        elif self._action == "update":
-            self._update()
-        elif self._action == "delete":
-            self._delete()
-        elif self._action == "freeze":
-            self._freeze()
-        elif self._action == "unfreeze":
-            self._unfreeze()
-        elif self._action == "check":
-            self._check()
-        elif self._action == "describe":
-            self._describe()
-        elif self._action == "update-quota":
-            self._update_quota()
-        elif self._action == "toggle-maintenance":
-            self._toggle_maintenance()
-
-    def _check(self):
-        logger.info(
-            "Checking configuration. If there is an issue, check ~/.suite_py/config.yml file and execute: suite-py login"
-        )
-
-        self._qainit.user_info()
-
-    def _clean_date(self, datetime_str):
-        # expected format: '2021-07-23T14:04:12.000000Z'
-        datetime_object = datetime.datetime.strptime(
-            datetime_str, "%Y-%m-%dT%H:%M:%S.%fZ"
-        )
-        # Define time zones:
-        utc_time_zone = tz.tzutc()
-        local_time_zone = tz.tzlocal()
-        # Convert time zone
-        utc_datetime_object = datetime_object.replace(tzinfo=utc_time_zone)
-        local_datetime_object = utc_datetime_object.astimezone(local_time_zone)
-        return local_datetime_object.strftime("%d/%m/%Y %H:%M:%S %z")
-
-    def _create_instance_table(self):
-        instance_table = Table()
-        instance_table.add_column("Name", style="purple")
-        instance_table.add_column("Hash", style="green", width=32)
-        instance_table.add_column("Card", style="white")
-        instance_table.add_column("Created by", style="white")
-        instance_table.add_column("Updated by", style="white")
-        instance_table.add_column("Deleted by", style="white")
-        instance_table.add_column("Last update", style="white")
-        instance_table.add_column("Status", style="white")
-
-        return instance_table
-
-    def _insert_instance_record(self, table, qa):
-        table.add_row(
-            qa["name"],
-            qa["hash"],
-            qa["card"],
-            (
-                qa.get("created", {}).get("github_username", "/")
-                if qa["created"] is not None
-                else "/"
-            ),
-            (
-                qa.get("updated", {}).get("github_username", "/")
-                if qa["updated"] is not None
-                else "/"
-            ),
-            (
-                qa.get("deleted", {}).get("github_username", "/")
-                if qa["deleted"] is not None
-                else "/"
-            ),
-            self._clean_date(qa["updated_at"]),
-            qa["status"],
-        )
-
-    def _list(self):
-        # init empty table with column (useful for reset)
-        empty_table = self._create_instance_table()
-        table = copy.deepcopy(empty_table)
-        console = Console()
-
-        # execute query with pagination and filtering
-        page_number = 1
-        while True:
-            r = self._qainit.list(
-                self._flags,
-                page=page_number,
-                page_size=self._config.qainit["table_size"],
-            )
-            response = r.json()
-            qa_list = response["list"]
-            for qa in qa_list:
-                self._insert_instance_record(table, qa)
-
-            console.print(table)
-
-            # break conditions
-            if response["page_number"] >= response["total_pages"]:
-                break
-            if not prompt_utils.ask_confirm(
-                f"I found {response['total_entries']} results. Do you want to load a few more?",
-                False,
-            ):
-                break
-            page_number += 1
-            # table reset
-            table = copy.deepcopy(empty_table)
-
-    def _describe(self):
-        qa_hash = self._flags["hash"]
-        jsonify = self._flags["json"]
-
-        r = self._qainit.describe(qa_hash)
-
-        issues = self._check_instance_issues(r)
-        if issues:
-            msg = "an issue" if len(issues) == 1 else f"{len(issues)} issues"
-            logger.warning(f"⚠️  suite-py diagnostic tool found {msg}:")
-            for i in issues:
-                logger.warning(i)
-            logger.warning(
-                "If the problem persist write a detailed message on #team-platform-operations"
-            )
-            sys.exit(-1)
-
-        if jsonify:
-            print(json.dumps(r, sort_keys=True, indent=2))
-        else:
-            # RESOURCES TABLE
-            table = Table()
-            table.add_column("Microservice", style="purple", no_wrap=True)
-            table.add_column("Drone build")
-            table.add_column("Branch", style="white")
-            table.add_column("Last update", style="white")
-            table.add_column("Status", style="white")
-
-            # INSTANCE TABLE
-            instance_table = self._create_instance_table()
-
-            self._insert_instance_record(instance_table, r["list"])
-
-            # DNS TABLE
-            dns_table = Table()
-            dns_table.add_column("Name", style="purple", no_wrap=True)
-            dns_table.add_column("Record", style="green")
-
-            console = Console()
-
-            try:
-                resources_list = sorted(r["list"]["resources"], key=lambda k: k["name"])
-                for resource in resources_list:
-                    if (
-                        (
-                            resource["type"] == "microservice"
-                            or "service" in resource["name"]
-                        )
-                        and "dns" in resource
-                        and resource["dns"] is not None
-                    ):
-                        for key, value in resource["dns"].items():
-                            dns_table.add_row(key, value)
-                    if resource["type"] == "microservice":
-                        drone_url = (
-                            (
-                                "[blue][u]"
-                                + "https://drone-1.prima.it/primait/"
-                                + resource["name"]
-                                + "/"
-                                + resource["promoted_build"]
-                                + "[/u][/blue]"
-                            )
-                            if resource["promoted_build"]
-                            else "Not available"
-                        )
-                        table.add_row(
-                            resource["name"],
-                            drone_url,
-                            (
-                                resource["ref"]
-                                if resource["ref"] == "master"
-                                else f"[green]{resource['ref']}[/green]"
-                            ),
-                            self._clean_date(resource["updated_at"]),
-                            resource["status"],
-                        )
-
-                console.print(instance_table)
-                console.print(dns_table)
-                console.print(table)
-            except TypeError as e:
-                logger.error(f"Unexpected response format: {e}")
-
-    def _delete(self):
-        qa_hashes = self._flags["hashes"]
-        force = self._flags["force"]
-        for qa_hash in qa_hashes:
-            if force:
-                if not self._qainit.force_update(qa_hash):
-                    # this function fails only if the QA is effectively stuck
-                    # and qa init it's unable to solve it
-                    logger.error(
-                        "QA force deletion has failed, please contact #platform-operations team."
-                    )
-                    return
-            self._qainit.delete(qa_hash, force)
-
-    def _freeze(self):
-        self._qainit.freeze(self._flags["hash"])
-
-    def _unfreeze(self):
-        self._qainit.unfreeze(self._flags["hash"])
-
-    def _create(self):
-        user = self._qainit.user_info()
-
-        if not user["quota"]["remaining"] > 0:
-            logger.error("There's no remaining quota for you.")
-            sys.exit("-1")
-
-        if "staging" in self._qainit.url:
-            qa_default_name = (
-                f"staging_{git.get_username()}_{self._git.current_branch_name()}"
-            )
-        else:
-            qa_default_name = f"{git.get_username()}_{self._git.current_branch_name()}"
-
-        qa_name = prompt_utils.ask_questions_input(
-            "Choose the QA name: ", default_text=qa_default_name
-        )
-
-        card_match = re.match(r"[^\/]*_(?P<name>[A-Z]+-\d+)\/", qa_name)
-        default_card_name = (
-            card_match["name"] if card_match else self._config.user["default_slug"]
-        )
-
-        qa_card = prompt_utils.ask_questions_input(
-            "Youtrack issue ID: ", default_text=default_card_name
-        )
-
-        if qa_card != "":
-            try:
-                self._youtrack.get_issue(qa_card)
-            except Exception:
-                logger.error("invalid Youtrack issue ID")
-                sys.exit(-1)
-
-        self._qainit.create(qa_name, qa_card, self._flags["services"])
-
-    def _update(self):
-        self._qainit.update(self._flags["hash"], self._flags["services"])
-
-    def _update_quota(self):
-        username = prompt_utils.ask_questions_input("Insert GitHub username: ")
-        quota = prompt_utils.ask_questions_input("Insert new quota value: ")
-
-        self._qainit.update_user_quota(username, quota)
-
-    def _toggle_maintenance(self):
-        self._qainit.maintenance()
-
-    def _check_instance_issues(self, response):
-        issues = []
-
-        if not response["list"]:
-            issues.append("QA not found")
-
-        # Check if instance status is still pending
-        if response["list"] and response["list"]["status"] in ["creating", "updating"]:
-            microservices = self._filter_list(
-                "type", ["microservice"], response["list"]["resources"]
-            )
-            # 1. Microservices list is empty?
-            if len(microservices) == 0:
-                issues.append("Microservices list is empty, please be patient.")
-                return issues
-
-            # 2. Check if qainit worker is still launching updates
-            if not self._is_update_initiated(microservices, response["list"]):
-                issues.append(
-                    "Qainit is still working on microservices, try again in a while."
-                )
-                issues.append("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
-                return issues
-
-            # 3. Check every resource
-            stale_resources = self._filter_list(
-                "status", ["creating", "updating"], microservices
-            )
-            for resource in stale_resources:
-                issues += self._check_resource_issues(resource)
-
-            # 4. Check is instance is stuck in a stale status
-            if (
-                len(microservices) > 0
-                and len(stale_resources) == 0
-                and self._minutes_elapsed_since_update(response["list"]) >= 5
-            ):
-                logger.warning("Trying to call qainit to force QA update...")
-                if self._qainit.force_update(response["list"]["hash"]):
-                    issues.append(
-                        "Your QA was in a stale status and has been fixed, launch `suite-py describe` again please."
-                    )
-                else:
-                    issues.append(
-                        "Your QA was in a stale status but forced update has failed, please contact #platform-operations team."
-                    )
-
-        return issues
-
-    def _is_update_initiated(self, microservices, instance):
-        microservices_updates = [
-            parser.parse(x["updated_at"]).timestamp() for x in microservices
-        ]
-        max_microservice_update = max(microservices_updates)
-        instance_update = parser.parse(instance["updated_at"]).timestamp()
-
-        return max_microservice_update >= instance_update
-
-    def _minutes_elapsed_since_update(self, instance):
-        return (
-            datetime.datetime.now().timestamp()
-            - parser.parse(instance["updated_at"]).timestamp()
-        ) / 60
-
-    def _check_resource_issues(self, resource):
-        issues = []
-
-        build = self._drone.get_repo_build(resource["name"], resource["promoted_build"])
-
-        if "stages" not in build:
-            issues.append("Suite-py is unable to locate drone build.")
-            return issues
-
-        qainit_step = self._filter_list("name", ["qainit-it"], build["stages"])[0]
-        # Check if build is succeded
-        if build["status"] == "success" or qainit_step["status"] == "error":
-            issues.append(
-                f"Something between Drone and Qainit went wrong, did you try to restart the build? {self._drone.get_repo_build_url(resource['name'], resource['promoted_build'])}"
-            )
-
-        # Check if build is killed
-        elif build["status"] == "killed":
-            issues.append(
-                f"Seems someone killed the build, did you try to restart the build? {self._drone.get_repo_build_url(resource['name'], resource['promoted_build'])}"
-            )
-
-        # Check if build is failed
-        elif build["status"] == "failure":
-            build_pipeline = self._filter_list("name", ["build_qa"], build["stages"])[0]
-            if build_pipeline and build_pipeline["status"] == "failed":
-                issues.append(
-                    f"Something went wrong during microservice build step, check the logs {self._drone.get_build_and_pipeline_url(resource['name'], resource['promoted_build'], build_pipeline['number'])}"
-                )
-
-            deploy_pipeline = self._filter_list(
-                "name", ["deploy-it-qa"], build["stages"]
-            )[0]
-            if deploy_pipeline and deploy_pipeline["status"] == "failed":
-                issues.append(
-                    f"Something went wront during microservice deploy step, check the logs {self._drone.get_build_and_pipeline_url(resource['name'], resource['promoted_build'], deploy_pipeline['number'])}"
-                )
-        # Check if build is running for over an hour
-        elif (
-            build["status"] == "running"
-            and self._difference_in_hours(build["started"]) >= 1
-        ):
-            issues.append(
-                f"It looks like the build is stuck, did you try to restart the build? {self._drone.get_repo_build_url(resource['name'], resource['promoted_build'])}"
-            )
-
-        return issues
-
-    def _filter_list(self, search_key, in_list, search_list):
-        return list(filter(lambda l: l[search_key] in in_list, search_list))
-
-    def _difference_in_hours(self, unix_timestamp):
-        ts = datetime.datetime.fromtimestamp(unix_timestamp)
-        current_ts = datetime.datetime.utcnow()
-
-        return (current_ts - ts).total_seconds() / 60 / 60

suite_py/lib/handler/qainit_handler.py

@@ -1,259 +0,0 @@
-# -*- encoding: utf-8 -*-
-import json
-import sys
-
-import requests
-from github.GithubException import UnknownObjectException
-from halo import Halo
-
-from suite_py.lib import logger
-from suite_py.lib.handler import prompt_utils
-from suite_py.lib.handler.git_handler import GitHandler
-from suite_py.lib.handler.github_handler import GithubHandler
-
-
-class QainitHandler:
-
-    scope_mapping = {
-        "admin": [
-            "update:user-quota",
-            "delete:others-qa",
-            "create:qa",
-            "delete:qa",
-            "describe:qa",
-            "describe:others-qa",
-            "update:qa",
-            "update:others-qa",
-            "list:qa",
-            "list:others-qa",
-            "access:captainhook",
-        ],
-        "dev": [
-            "create:qa",
-            "delete:qa",
-            "describe:qa",
-            "describe:others-qa",
-            "update:qa",
-            "update:others-qa",
-            "list:qa",
-            "list:others-qa",
-            "access:captainhook",
-        ],
-        "external": ["create:qa", "delete:qa", "describe:qa", "list:qa", "update:qa"],
-    }
-
-    def __init__(self, project, config, tokens):
-        self._project = project
-        self._token = tokens.drone
-        self._config = config
-        self.url = self._config.qainit["url"]
-        self.okta_tenant = self._config.okta["tenant"]
-        self.okta_token = self._config.get_cache(f"{self.okta_tenant}_okta_token")
-        self._github = GithubHandler(tokens)
-        self._git = GitHandler(project, config)
-
-        if "url" not in config.qainit:
-            self.usage()
-            sys.exit(-1)
-
-    def usage(self):
-        logger.warning(
-            "Unable to use QA commands: missing qainit config in ~/.suite_py/config.yml"
-        )
-        logger.warning(
-            "Update your config.yml as: https://github.com/primait/suite_py/blob/master/.config.yml.dist"
-        )
-
-    def user_info(self):
-        r = self._execute("GET", "/api/v1/user")
-
-        if r.status_code == 401:
-            return None
-
-        logger.debug(json.dumps(r.json(), indent=2))
-
-        return r.json()
-
-    def update_user_quota(self, username, quota):
-        body = {"github_username": f"{username}", "quota": f"{quota}"}
-        logger.debug(json.dumps(body))
-        r = self._execute(
-            "POST",
-            "/api/v1/user/quota",
-            body=json.dumps(body),
-        )
-
-        logger.info("Quota updated.")
-        logger.debug(json.dumps(r.json(), indent=2))
-
-    def create(self, name, card, services):
-        srv_list = self.create_services_body(services)
-        body = {"name": name, "card": card, "services": srv_list}
-
-        logger.debug(json.dumps(body))
-        r = self._execute(
-            "POST",
-            "/api/v1/qa",
-            body=json.dumps(body),
-        )
-
-        logger.info(f"QA creation initiated. Your namespace hash: {r.json()['hash']}")
-        logger.debug(json.dumps(r.json(), indent=2))
-
-    def update(self, qa_hash, services):
-        srv_list = self.create_services_body(services)
-
-        body = {"services": srv_list}
-        logger.debug(json.dumps(body))
-
-        r = self._execute(
-            "PUT",
-            f"/api/v1/qa/{qa_hash}",
-            body=json.dumps(body),
-        )
-        self.handle_call_result(r, "update", qa_hash)
-
-    def list(self, params, page=1, page_size=10):
-        filters = []
-        status_values = '"created","creating","updated","updating","failed","frozen","freezing","unfreezing"'
-        if len(params["status"]) > 0:
-            status_values = ",".join([f'"{status}"' for status in params["status"]])
-        filters.append(f"status=[{status_values}]")
-
-        if params["user"] is not None:
-            filters.append(f"user={params['user']}")
-
-        if params["card"] is not None:
-            filters.append(f"card={params['card']}")
-
-        filters_string = "&".join(filters)
-
-        return self._execute(
-            "GET",
-            f"/api/v1/qa?{filters_string}&page_size={page_size}&page={page}",
-        )
-
-    def delete(self, qa_hash, force=False):
-        r = self._execute(
-            "DELETE",
-            f"/api/v1/qa/{qa_hash}",
-        )
-        logger.debug(json.dumps(r.json(), indent=2))
-        if r.ok:
-            logger.info(f"QA {qa_hash} deletion initiated")
-        else:
-            logger.error(
-                f"QA {qa_hash} deletion has failed{', try running this command with --force flag' if not force else ''}."
-            )
-
-    def describe(self, qa_hash):
-        r = self._execute(
-            "GET",
-            f"/api/v1/qa/{qa_hash}",
-        ).json()
-        logger.debug(json.dumps(r, indent=2))
-
-        return r
-
-    def create_services_body(self, prj_list):
-        srv_list = []
-        ref = self._git.current_branch_name()
-        for prj in prj_list:
-            with Halo(text="Loading branches...", spinner="dots", color="magenta"):
-                choices = [
-                    {"name": branch.name, "value": branch.name}
-                    for branch in self._github.get_branches(prj)
-                ]
-            if choices:
-                choices.sort(key=lambda x: x["name"])
-                ref = prompt_utils.ask_choices(
-                    f"Select branch for project - {prj}: ", choices, default_text=ref
-                )
-            try:
-                self._github.get_raw_content(prj, ref, ".service.yml")
-            except UnknownObjectException:
-                logger.error(
-                    f".service.yml missing for project: {prj}, can't add microservice to QA"
-                )
-                sys.exit(-1)
-            srv_list.append(
-                {
-                    "name": prj,
-                    "ref": ref,
-                }
-            )
-
-        return srv_list
-
-    def freeze(self, qa_hash):
-        body = {"operation": "freeze"}
-        logger.debug(json.dumps(body))
-        r = self._execute("PUT", f"/api/v1/qa/{qa_hash}", body=json.dumps(body))
-        self.handle_call_result(r, "freezing", qa_hash)
-
-    def unfreeze(self, qa_hash):
-        body = {"operation": "unfreeze"}
-        logger.debug(json.dumps(body))
-        r = self._execute("PUT", f"/api/v1/qa/{qa_hash}", body=json.dumps(body))
-        self.handle_call_result(r, "unfreezing", qa_hash)
-
-    def maintenance(self):
-        r = self._execute("POST", "/api/v1/maintenance")
-        if r.json()["success"]:
-            maintenance = r.json()["maintenance"]
-            logger.info(
-                f"Maintenance mode is now {'enabled' if maintenance else 'disabled'}"
-            )
-
-        logger.debug(json.dumps(r.json(), indent=2))
-
-    def force_update(self, qa_hash):
-        r = self._execute("POST", f"/api/v1/qa/shit-shoveler/force-update/{qa_hash}")
-        if r.status_code == 400:
-            msg = r.json()["message"]
-            if msg == "instance_not_force_updated":
-                logger.error("Failed to force update QA.")
-                return False
-            if msg == "not_in_stale_state":
-                logger.warning("QA is not in a stale state.")
-                return True
-            raise ValueError(
-                "Unexpected return type from qa init shit-shoveler endpoint."
-            )
-        if r.status_code == 500:
-            logger.error("Something went wrong")
-            return False
-        logger.info("QA has been forced to update")
-        logger.debug(json.dumps(r.json(), indent=2))
-        return True
-
-    def _execute(self, request_method, api_endpoint, body=None):
-        api_url = self.url + api_endpoint
-        okta_token = self._config.get_cache(f"{self.okta_tenant}_okta_token")
-
-        headers = {
-            "Content-Type": "application/json",
-            "Authorization": f"Bearer {okta_token}",
-        }
-        logger.debug(request_method)
-        logger.debug(api_url)
-        logger.debug(headers)
-        logger.debug(body)
-        # pylint: disable-next=missing-timeout
-        r = requests.request(request_method, api_url, headers=headers, data=body)
-
-        if r.ok:
-            logger.debug("Call to qainit-evo executed successfully")
-        else:
-            logger.error("Some issue during call to qainit-evo: ")
-            logger.error(f"Status code: {r.status_code}, response: {r.text}")
-            logger.debug(api_endpoint)
-
-        return r
-
-    def handle_call_result(self, req, operation, qa_hash):
-        if req.ok:
-            logger.info(f"QA {operation} initiated")
-        else:
-            logger.debug(json.dumps(req.json(), indent=2))
-            logger.info(f"Run suite-py qa describe {qa_hash} to check the status")