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

suite_py/__version__.py

@@ -1,2 +1,2 @@
 # -*- encoding: utf-8 -*-
-__version__ = "1.41.2"
+__version__ = "1.41.4"

suite_py/cli.py

@@ -6,23 +6,27 @@
 
 import os
 import sys
+from functools import wraps
 from typing import Optional
 
 import click
 import pkg_resources
 import requests
 from autoupgrade import Package
+from click.exceptions import ClickException
 
 from suite_py.__version__ import __version__
-from suite_py.lib import logger
-from suite_py.lib import metrics
+from suite_py.commands.context import Context
+from suite_py.lib import logger, metrics
 from suite_py.lib.config import Config
 from suite_py.lib.handler import git_handler as git
 from suite_py.lib.handler import prompt_utils
+from suite_py.lib.handler.captainhook_handler import CaptainHook
+from suite_py.lib.handler.okta_handler import Okta
 from suite_py.lib.tokens import Tokens
 
-ALLOW_NO_GIT_SUBCOMMAND = ["login", "qa", "aggregator"]
-ALLOW_NO_HOME_SUBCOMMAND = ["login", "qa", "aggregator"]
+ALLOW_NO_GIT_SUBCOMMAND = ["login", "aggregator"]
+ALLOW_NO_HOME_SUBCOMMAND = ["login", "aggregator"]
 
 
 def maybe_inject_truststore() -> None:
@@ -84,6 +88,22 @@ def upgrade_suite_py_if_needed(break_on_missing_package: bool = False) -> None:
         logger.warning(f"An error occurred whilst trying to upgrade suite-py: {error}")
 
 
+# Catches any exceptions thrown and turns them into a ClickException
+# So they don't print a stacktrace
+def catch_exceptions(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except ClickException as e:
+            raise e
+        except Exception as e:
+            logger.debug("An error occured:", exc_info=True)
+            raise ClickException(f"{str(e)}. rerun with -v for more details") from e
+
+    return wrapper
+
+
 @click.group()
 @click.option(
     "--project",
@@ -98,11 +118,11 @@ def upgrade_suite_py_if_needed(break_on_missing_package: bool = False) -> None:
 )
 @click.option("-v", "--verbose", count=True)
 @click.pass_context
+@catch_exceptions
 def main(ctx, project, timeout, verbose):
     config = Config()
 
     logger.setup(verbose)
-    metrics.setup(config)
 
     logger.debug(f"v{__version__}")
     maybe_inject_truststore()
@@ -114,14 +134,14 @@ def main(ctx, project, timeout, verbose):
     if ctx.invoked_subcommand not in ALLOW_NO_GIT_SUBCOMMAND and not git.is_repo(
         project
     ):
-        print(f"the folder {project} is not a git repo")
-        sys.exit(-1)
+        raise Exception(f"the folder {project} is not a git repo")
 
     if ctx.invoked_subcommand not in ALLOW_NO_HOME_SUBCOMMAND and not os.path.basename(
         project
     ) in os.listdir(config.user["projects_home"]):
-        print(f"the folder {project} is not in {config.user['projects_home']}")
-        sys.exit(-1)
+        raise Exception(
+            f"the folder {project} is not in {config.user['projects_home']}"
+        )
 
     skip_confirmation = False
     if type(config.user.get("skip_confirmation")).__name__ == "bool":
@@ -136,21 +156,31 @@ def main(ctx, project, timeout, verbose):
     if not skip_confirmation and not prompt_utils.ask_confirm(
         f"Do you want to continue on project {os.path.basename(project)}?"
     ):
-        sys.exit()
-
-    ctx.ensure_object(dict)
-    ctx.obj["project"] = os.path.basename(project)
+        return
     if timeout:
         config.user["captainhook_timeout"] = timeout
-    ctx.obj["config"] = config
-    ctx.obj["tokens"] = Tokens()
+
+    project = os.path.basename(project)
+    tokens = Tokens()
+    okta = Okta(config, tokens)
+    captainhook = CaptainHook(config, okta)
+
+    ctx.obj = Context(
+        project=project,
+        tokens=tokens,
+        okta=okta,
+        config=config,
+        captainhook=captainhook,
+    )
+
+    ctx.obj.call(metrics.setup)
 
     # Skip chdir if not needed
     if (
         ctx.invoked_subcommand not in ALLOW_NO_GIT_SUBCOMMAND
         or ctx.invoked_subcommand not in ALLOW_NO_HOME_SUBCOMMAND
     ):
-        os.chdir(os.path.join(config.user["projects_home"], ctx.obj["project"]))
+        os.chdir(os.path.join(config.user["projects_home"], ctx.obj.project))
 
 
 @main.result_callback()
@@ -168,12 +198,11 @@ def cleanup(_obj, _, **_kwargs):
     help="Version to apply. If not passed, you will be prompted to insert or select one from a predefined list",
 )
 @click.pass_obj
-def bump(obj, project: Optional[str] = None, version: Optional[str] = None):
+@catch_exceptions
+def bump(obj: Context, project: Optional[str] = None, version: Optional[str] = None):
     from suite_py.commands.bump import Bump
 
-    Bump(obj["project"], obj["config"], obj["tokens"]).run(
-        project=project, version=version
-    )
+    obj.call(Bump).run(project=project, version=version)
 
 
 @main.command(
@@ -181,10 +210,11 @@ def bump(obj, project: Optional[str] = None, version: Optional[str] = None):
 )
 @click.option("--card", type=click.STRING, help="YouTrack card number (ex. PRIMA-123)")
 @click.pass_obj
+@catch_exceptions
 def cli_create_branch(obj, card):
     from suite_py.commands.create_branch import CreateBranch
 
-    CreateBranch(obj["project"], card, obj["config"], obj["tokens"]).run()
+    obj.call(CreateBranch, card=card).run()
 
 
 @main.command("lock", help="Lock project on staging or prod")
@@ -192,10 +222,11 @@ def cli_create_branch(obj, card):
     "environment", type=click.Choice(("staging", "production", "deploy", "merge"))
 )
 @click.pass_obj
+@catch_exceptions
 def cli_lock_project(obj, environment):
     from suite_py.commands.project_lock import ProjectLock
 
-    ProjectLock(obj["project"], environment, "lock", obj["config"], obj["tokens"]).run()
+    obj.call(ProjectLock, environment=environment, action="lock").run()
 
 
 @main.command("unlock", help="Unlock project on staging or prod")
@@ -203,38 +234,42 @@ def cli_lock_project(obj, environment):
     "environment", type=click.Choice(("staging", "production", "deploy", "merge"))
 )
 @click.pass_obj
+@catch_exceptions
 def cli_unlock_project(obj, environment):
     from suite_py.commands.project_lock import ProjectLock
 
-    ProjectLock(
-        obj["project"], environment, "unlock", obj["config"], obj["tokens"]
-    ).run()
+    obj.call(ProjectLock, environment=environment, action="unlock").run()
 
 
 @main.command("open-pr", help="Open a PR on GitHub")
 @click.pass_obj
+@catch_exceptions
 def cli_open_pr(obj):
     from suite_py.commands.open_pr import OpenPR
+    from suite_py.commands.ask_review import AskReview
 
-    OpenPR(obj["project"], obj["config"], obj["tokens"]).run()
+    ask_review = obj.call(AskReview)
+    obj.call(OpenPR, ask_review=ask_review).run()
 
 
 @main.command("ask-review", help="Requests a PR review")
 @click.pass_obj
+@catch_exceptions
 def cli_ask_review(obj):
     from suite_py.commands.ask_review import AskReview
 
-    AskReview(obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(AskReview).run()
 
 
 @main.command(
     "merge-pr", help="Merge the selected branch to master if all checks are OK"
 )
 @click.pass_obj
+@catch_exceptions
 def cli_merge_pr(obj):
     from suite_py.commands.merge_pr import MergePR
 
-    MergePR(obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(MergePR).run()
 
 
 @main.group("release", help="Manage releases")
@@ -251,40 +286,38 @@ def release():
     help="Trigger deploy with Drone CI after release creation (Github Actions based microservices will be automatically deployed on production)",
 )
 @click.pass_obj
+@catch_exceptions
 def cli_release_create(obj, deploy):
     from suite_py.commands.release import Release
 
-    Release(
-        "create",
-        obj["project"],
-        obj["config"],
-        obj["tokens"],
-        flags={"deploy": deploy},
-    ).run()
+    obj.call(Release, action="create", flags={"deploy": deploy}).run()
 
 
 @release.command("deploy", help="Deploy a github release with Drone CI")
 @click.pass_obj
+@catch_exceptions
 def cli_release_deploy(obj):
     from suite_py.commands.release import Release
 
-    Release("deploy", obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Release, action="deploy").run()
 
 
 @release.command("rollback", help="Rollback a deployment")
 @click.pass_obj
+@catch_exceptions
 def cli_release_rollback(obj):
     from suite_py.commands.release import Release
 
-    Release("rollback", obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Release, "rollback").run()
 
 
 @main.command("deploy", help="Deploy master branch in production")
 @click.pass_obj
+@catch_exceptions
 def cli_deploy(obj):
     from suite_py.commands.deploy import Deploy
 
-    Deploy(obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Deploy).run()
 
 
 @main.group("docker", help="Manage docker images")
@@ -294,60 +327,67 @@ def docker():
 
 @docker.command("release", help="Release new docker image")
 @click.pass_obj
+@catch_exceptions
 def cli_docker_release(obj):
     from suite_py.commands.docker import Docker
 
-    Docker("release", obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Docker, action="release").run()
 
 
 @docker.command("versions", help="List all available versions of specific image")
 @click.pass_obj
+@catch_exceptions
 def cli_docker_versions(obj):
     from suite_py.commands.docker import Docker
 
-    Docker("versions", obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Docker, action="versions").run()
 
 
 @main.command("status", help="Current status of a project")
 @click.pass_obj
+@catch_exceptions
 def cli_status(obj):
     from suite_py.commands.status import Status
 
-    Status(obj["project"], obj["config"]).run()
+    obj.call(Status, action="versions").run()
 
 
 @main.command("check", help="Verify authorisations for third party services")
 @click.pass_obj
+@catch_exceptions
 def cli_check(obj):
     from suite_py.commands.check import Check
 
-    Check(obj["config"], obj["tokens"]).run()
+    obj.call(Check).run()
 
 
 @main.command("id", help="Get the ID of the hosts where the task is running")
 @click.argument("environment", type=click.Choice(("staging", "production")))
 @click.pass_obj
+@catch_exceptions
 def cli_id(obj, environment):
     from suite_py.commands.id import ID
 
-    ID(obj["project"], obj["config"], environment).run()
+    obj.call(ID, environment=environment).run()
 
 
 @main.command("ip", help="Get the IP addresses of the hosts where the task is running")
 @click.argument("environment", type=click.Choice(("staging", "production")))
 @click.pass_obj
+@catch_exceptions
 def cli_ip(obj, environment):
     from suite_py.commands.ip import IP
 
-    IP(obj["project"], obj["config"], environment).run()
+    obj.call(IP, environment=environment).run()
 
 
 @main.command("generator", help="Generate different files from templates")
 @click.pass_obj
+@catch_exceptions
 def cli_generator(obj):
     from suite_py.commands.generator import Generator
 
-    Generator(obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Generator).run()
 
 
 @main.group(
@@ -374,153 +414,29 @@ def aggregator(ctx, show_list, change):
 
 @aggregator.command("list", help="List all aggregators with the current record")
 @click.pass_obj
+@catch_exceptions
 def cli_aggregator_list(obj):
     from suite_py.commands.aggregator import Aggregator
 
-    Aggregator(obj["config"], "list").run()
+    obj.call(Aggregator, action="list").run()
 
 
 @aggregator.command("change", help="Change aggregator record")
 @click.pass_obj
+@catch_exceptions
 def cli_aggregator_change(obj):
     from suite_py.commands.aggregator import Aggregator
 
-    Aggregator(obj["config"], "change").run()
+    obj.call(Aggregator, action="list").run()
 
 
 @main.command("login", help="manage login against Auth0")
 @click.pass_obj
+@catch_exceptions
 def login(obj):
     from suite_py.commands.login import Login
 
-    Login(obj["config"]).run()
-
-
-@main.group("qa", help="Manage QA envs")
-def qa():
-    pass
-
-
-@qa.command("update-quota", help="Update quota in QA for a user")
-@click.pass_obj
-def cli_qa_update_quota(obj):
-    from suite_py.commands.qa import QA
-
-    QA("update-quota", obj["project"], obj["config"], obj["tokens"]).run()
-
-
-@qa.command("list", help="List QA envs for user: all to show qa of all users.")
-@click.option("-u", "--user", "user", required=False)
-@click.option("-s", "--status", "status", multiple=True, type=str)
-@click.option("-c", "--card", "card", type=str)
-@click.pass_obj
-def cli_qa_list(obj, user, status, card):
-    from suite_py.commands.qa import QA
-
-    QA(
-        "list",
-        obj["project"],
-        obj["config"],
-        obj["tokens"],
-        {"user": user, "status": status, "card": card},
-    ).run()
-
-
-@qa.command("create", help="Create QA env")
-@click.argument("microservices", nargs=-1, required=True)
-@click.pass_obj
-def cli_qa_create(obj, microservices):
-    from suite_py.commands.qa import QA
-
-    QA(
-        "create",
-        obj["project"],
-        obj["config"],
-        obj["tokens"],
-        {"services": microservices},
-    ).run()
-
-
-@qa.command("update", help="Update QA env")
-@click.argument("qa_hash", required=True)
-@click.argument("microservices", nargs=-1, required=True)
-@click.pass_obj
-def cli_qa_update(obj, qa_hash, microservices):
-    from suite_py.commands.qa import QA
-
-    QA(
-        "update",
-        obj["project"],
-        obj["config"],
-        obj["tokens"],
-        {"hash": qa_hash, "services": microservices},
-    ).run()
-
-
-@qa.command("delete", help="Delete QA env")
-@click.argument("qa_hashes", nargs=-1, required=True)
-@click.option("--force", is_flag=True, default=False, help="Force QA deletion")
-@click.pass_obj
-def cli_qa_delete(obj, qa_hashes, force):
-    from suite_py.commands.qa import QA
-
-    QA(
-        "delete",
-        obj["project"],
-        obj["config"],
-        obj["tokens"],
-        {"hashes": qa_hashes, "force": force},
-    ).run()
-
-
-@qa.command("freeze", help="Freeze QA env")
-@click.argument("qa_hash", required=True)
-@click.pass_obj
-def cli_qa_freeze(obj, qa_hash):
-    from suite_py.commands.qa import QA
-
-    QA("freeze", obj["project"], obj["config"], obj["tokens"], {"hash": qa_hash}).run()
-
-
-@qa.command("unfreeze", help="Unfreeze QA env")
-@click.argument("qa_hash", required=True)
-@click.pass_obj
-def cli_qa_unfreeze(obj, qa_hash):
-    from suite_py.commands.qa import QA
-
-    QA(
-        "unfreeze", obj["project"], obj["config"], obj["tokens"], {"hash": qa_hash}
-    ).run()
-
-
-@qa.command("check", help="Check QA conf")
-@click.pass_obj
-def cli_qa_check(obj):
-    from suite_py.commands.qa import QA
-
-    QA("check", obj["project"], obj["config"], obj["tokens"]).run()
-
-
-@qa.command("describe", help="Describe QA environment")
-@click.argument("qa_hash", required=True)
-@click.option("--json", is_flag=True, default=False, help="Get response as JSON")
-@click.pass_obj
-def cli_qa_describe(obj, qa_hash, json):
-    from suite_py.commands.qa import QA
-
-    flags = {"hash": qa_hash, "json": json}
-    QA("describe", obj["project"], obj["config"], obj["tokens"], flags).run()
-
-
-@qa.command(
-    "toggle-maintenance",
-    help="Toggle maintenance mode (requires 'manage:maintenance' permission)",
-)
-@click.pass_obj
-def cli_qa_toggle_maintenance(obj):
-    from suite_py.commands.qa import QA
-
-    QA("toggle-maintenance", obj["project"], obj["config"], obj["tokens"]).run()
+    obj.call(Login).run()
 
 
 @main.group(
@@ -534,20 +450,26 @@ def secret():
 @click.option("-b", "--base-profile", "base_profile", required=False)
 @click.option("-f", "--secret-file", "secret_file", required=False)
 @click.pass_obj
+@catch_exceptions
 def cli_secret_create(obj, base_profile, secret_file):
     from suite_py.commands.secret import Secret
 
-    Secret(obj["project"], obj["config"], "create", base_profile, secret_file).run()
+    obj.call(
+        Secret, action="create", base_profile=base_profile, secret_file=secret_file
+    ).run()
 
 
 @secret.command("grant", help="Grant permissions to an existing secret")
 @click.option("-b", "--base-profile", "base_profile", required=False)
 @click.option("-f", "--secret-file", "secret_file", required=False)
 @click.pass_obj
+@catch_exceptions
 def cli_secret_grant(obj, base_profile, secret_file):
     from suite_py.commands.secret import Secret
 
-    Secret(obj["project"], obj["config"], "grant", base_profile, secret_file).run()
+    obj.call(
+        Secret, action="grant", base_profile=base_profile, secret_file=secret_file
+    ).run()
 
 
 @main.command("batch-job", help="Run batch job on kube")
@@ -569,22 +491,22 @@ def cli_secret_grant(obj, base_profile, secret_file):
     help="Mebibytes or gibibyte format. E.g: 256Mi or 1Gi",
 )
 @click.pass_obj
+@catch_exceptions
 def cli_run_batch_job(obj, environment, cpu_request, memory_request):
     from suite_py.commands.batch_job import BatchJob
 
-    BatchJob(
-        obj["project"],
-        obj["config"],
-        obj["tokens"],
-        environment,
-        cpu_request,
-        memory_request,
+    obj.call(
+        BatchJob,
+        environment=environment,
+        cpu_request=cpu_request,
+        memory_request=memory_request,
     ).run()
 
 
 @main.command("set-token", help="Create or update a service token")
 @click.pass_obj
+@catch_exceptions
 def cli_set_token(obj):
     from suite_py.commands.set_token import SetToken
 
-    SetToken(obj["tokens"]).run()
+    obj.call(SetToken).run()

suite_py/commands/aggregator.py

@@ -7,15 +7,13 @@ from kubernetes import client, config
 from rich.console import Console
 from rich.table import Table
 
-from suite_py.lib import logger
-from suite_py.lib import metrics
+from suite_py.lib import logger, metrics
 from suite_py.lib.handler import prompt_utils
-from suite_py.lib.handler.captainhook_handler import CaptainHook
 
 
 class Aggregator:
-    def __init__(self, config, command):
-        self._captainhook = CaptainHook(config)
+    def __init__(self, captainhook, command):
+        self._captainhook = captainhook
         self._command = command
 
     @metrics.command("aggregator")

suite_py/commands/ask_review.py

@@ -1,9 +1,7 @@
 # -*- coding: utf-8 -*-
 import sys
 
-from suite_py.lib import logger
-from suite_py.lib import metrics
-from suite_py.lib.handler.captainhook_handler import CaptainHook
+from suite_py.lib import logger, metrics
 from suite_py.lib.handler.frequent_reviewers_handler import FrequentReviewersHandler
 from suite_py.lib.handler.git_handler import GitHandler
 from suite_py.lib.handler.github_handler import GithubHandler
@@ -12,11 +10,11 @@ from suite_py.lib.handler.youtrack_handler import YoutrackHandler
 
 
 class AskReview:
-    def __init__(self, project, config, tokens):
+    def __init__(self, project, captainhook, config, tokens):
         self._project = project
         self._config = config
         self._youtrack = YoutrackHandler(config, tokens)
-        self._captainhook = CaptainHook(config)
+        self._captainhook = captainhook
         self._git = GitHandler(project, config)
         self._github = GithubHandler(tokens)
         self._frequent_reviewers = FrequentReviewersHandler(config)

suite_py/commands/batch_job.py

@@ -5,8 +5,7 @@ import textwrap
 
 import semver
 
-from suite_py.lib import logger
-from suite_py.lib import metrics
+from suite_py.lib import logger, metrics
 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

suite_py/commands/bump.py

@@ -8,8 +8,7 @@ from typing import Any, Dict, List, Optional, cast
 
 from yaml import safe_load
 
-from suite_py.lib import logger
-from suite_py.lib import metrics
+from suite_py.lib import logger, metrics
 from suite_py.lib.handler.changelog_handler import ChangelogHandler
 from suite_py.lib.handler.git_handler import GitHandler
 from suite_py.lib.handler.github_handler import GithubHandler

suite_py/commands/check.py

@@ -1,9 +1,7 @@
 # -*- coding: utf-8 -*-
 
-from suite_py.lib import logger
-from suite_py.lib import metrics
+from suite_py.lib import logger, metrics
 from suite_py.lib.handler import prompt_utils
-from suite_py.lib.handler.captainhook_handler import CaptainHook
 from suite_py.lib.handler.drone_handler import DroneHandler
 from suite_py.lib.handler.github_handler import GithubHandler
 from suite_py.lib.handler.youtrack_handler import YoutrackHandler
@@ -11,13 +9,13 @@ from suite_py.lib.symbol import CHECKMARK, CROSSMARK
 
 
 class Check:
-    def __init__(self, config, tokens):
+    def __init__(self, captainhook, config, tokens):
         self.config = config
         self._invalid_or_missing_tokens = []
         self._tokens = tokens
         self._youtrack = YoutrackHandler(config, tokens)
         self._github = GithubHandler(tokens)
-        self._captainhook = CaptainHook(config)
+        self._captainhook = captainhook
         self._drone = DroneHandler(config, tokens)
 
         self._checks = [

suite_py/commands/context.py

@@ -0,0 +1,26 @@
+import dataclasses
+from inspect import signature
+
+from suite_py.lib.config import Config
+from suite_py.lib.handler.captainhook_handler import CaptainHook
+from suite_py.lib.handler.okta_handler import Okta
+from suite_py.lib.tokens import Tokens
+
+
+@dataclasses.dataclass
+class Context:
+    project: str
+    config: Config
+    captainhook: CaptainHook
+    tokens: Tokens
+    okta: Okta
+
+    # Call the function to_call with kwargs, injecting fields from self as default arguments
+    def call(self, to_call, **kwargs):
+        provided = dataclasses.asdict(self)
+        needed = signature(to_call).parameters.keys()
+        provided = {k: provided[k] for k in needed if k in provided}
+
+        kwargs = provided | kwargs
+
+        return to_call(**kwargs)