suite-py 1.40.3__py3-none-any.whl → 1.41.1__py3-none-any.whl

suite_py/__version__.py

@@ -1,2 +1,2 @@
 # -*- encoding: utf-8 -*-
-__version__ = "1.40.2"
+__version__ = "1.41.1"

suite_py/cli.py

@@ -4,7 +4,6 @@
 # for performance reasons, so turn off the lint warning
 # pylint: disable=import-outside-toplevel
 
-import logging
 import os
 import sys
 from typing import Optional
@@ -16,6 +15,7 @@ from autoupgrade import Package
 
 from suite_py.__version__ import __version__
 from suite_py.lib import logger
+from suite_py.lib import 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
@@ -99,11 +99,14 @@ def upgrade_suite_py_if_needed(break_on_missing_package: bool = False) -> None:
 @click.option("-v", "--verbose", count=True)
 @click.pass_context
 def main(ctx, project, timeout, verbose):
+    config = Config()
+
+    logger.setup(verbose)
+    metrics.setup(config)
+
+    logger.debug(f"v{__version__}")
     maybe_inject_truststore()
     upgrade_suite_py_if_needed(break_on_missing_package=False)
-    print(f"v{__version__}")
-
-    config = Config()
 
     if ctx.invoked_subcommand not in ALLOW_NO_GIT_SUBCOMMAND:
         project = git.get_root_folder(project)
@@ -135,10 +138,6 @@ def main(ctx, project, timeout, verbose):
     ):
         sys.exit()
 
-    if verbose:
-        logger.setLevel(logging.DEBUG)
-        logger.debug("Logging as 'DEBUG'")
-
     ctx.ensure_object(dict)
     ctx.obj["project"] = os.path.basename(project)
     if timeout:
@@ -154,6 +153,12 @@ def main(ctx, project, timeout, verbose):
         os.chdir(os.path.join(config.user["projects_home"], ctx.obj["project"]))
 
 
+@main.result_callback()
+@click.pass_obj
+def cleanup(_obj, _, **_kwargs):
+    metrics.async_upload()
+
+
 @main.command("bump", help="Bumps the project version based on the .versions.yml file")
 @click.option("--project", required=False, type=str)
 @click.option(

suite_py/commands/aggregator.py

@@ -8,6 +8,7 @@ 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.handler import prompt_utils
 from suite_py.lib.handler.captainhook_handler import CaptainHook
 
@@ -17,6 +18,7 @@ class Aggregator:
         self._captainhook = CaptainHook(config)
         self._command = command
 
+    @metrics.command("aggregator")
     def run(self):
         if self._command == "list":
             self._list_aggregators()

suite_py/commands/ask_review.py

@@ -2,6 +2,7 @@
 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.handler.frequent_reviewers_handler import FrequentReviewersHandler
 from suite_py.lib.handler.git_handler import GitHandler
@@ -20,7 +21,9 @@ class AskReview:
         self._github = GithubHandler(tokens)
         self._frequent_reviewers = FrequentReviewersHandler(config)
 
+    @metrics.command("ask-review")
     def run(self):
+
         users = self._maybe_get_users_list()
         pr = self._get_pr()
         youtrack_reviewers = self._ask_reviewer(users)

suite_py/commands/batch_job.py

@@ -6,6 +6,7 @@ import textwrap
 import semver
 
 from suite_py.lib import logger
+from suite_py.lib import 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
@@ -28,6 +29,7 @@ class BatchJob:
         self._countries = _parse_available_countries(self._drone)
         self._repo = self._github.get_repo(project)
 
+    @metrics.command("batch-job")
     def run(self):
         country = prompt_utils.ask_choices(
             "Which country do you want to run the job on?",

suite_py/commands/bump.py

@@ -9,6 +9,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.handler.changelog_handler import ChangelogHandler
 from suite_py.lib.handler.git_handler import GitHandler
 from suite_py.lib.handler.github_handler import GithubHandler
@@ -28,7 +29,9 @@ class Bump:
         _git = GitHandler(project, config)
         self._version = VersionHandler(_repo=self._repo, _git=_git, _github=_github)
 
+    @metrics.command("bump")
     def run(self, project: Optional[str] = None, version: Optional[str] = None) -> None:
+
         configurations = read_bump_configs_from_yaml(Path(".versions.yml"))
         version_config = (
             configurations[project] if project else configurations["base_project"]

suite_py/commands/check.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 from suite_py.lib import logger
+from suite_py.lib import 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
@@ -27,6 +28,7 @@ class Check:
             ("AWS", self._check_aws),
         ]
 
+    @metrics.command("check")
     def run(self):
         # Services
         for service, check in self._checks:

suite_py/commands/create_branch.py

@@ -5,6 +5,7 @@ import sys
 import requests
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler import prompt_utils
 from suite_py.lib.handler.git_handler import GitHandler, is_branch_name_valid
 from suite_py.lib.handler.youtrack_handler import YoutrackHandler
@@ -18,6 +19,7 @@ class CreateBranch:
         self._youtrack = YoutrackHandler(config, tokens)
         self._git = GitHandler(project, config)
 
+    @metrics.command("create-branch")
     def run(self):
         if not self._git.is_detached() and self._git.is_dirty():
             # Default behaviour is to pull when not detached.

suite_py/commands/deploy.py

@@ -5,6 +5,7 @@ import sys
 from suite_py.commands import common
 from suite_py.commands.release import _parse_available_countries
 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.captainhook_handler import CaptainHook
@@ -31,6 +32,7 @@ class Deploy:
         self._countries = _parse_available_countries(self._drone)
         self._version = VersionHandler(self._repo, self._git, self._github)
 
+    @metrics.command("deploy")
     def run(self):
         self._stop_if_prod_locked()
 

suite_py/commands/docker.py

@@ -4,6 +4,7 @@ import sys
 from halo import Halo
 
 from suite_py.lib import logger
+from suite_py.lib import 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
@@ -23,6 +24,7 @@ class Docker:
         self._git = GitHandler(project, config)
         self._drone = DroneHandler(config, tokens, repo=project)
 
+    @metrics.command("docker")
     def run(self):
         if self._project != "docker":
             logger.error("`suite-py docker` must run inside docker repository.")

suite_py/commands/generator.py

@@ -10,6 +10,7 @@ import yaml
 from jinja2 import DebugUndefined, Environment, FileSystemLoader
 
 from suite_py.lib import logger
+from suite_py.lib import 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
@@ -30,7 +31,9 @@ class Generator:
         )
         self._github = GithubHandler(tokens)
 
+    @metrics.command("generator")
     def run(self):
+
         logger.warning(
             "This command requires shellcheck and shfmt, please install these tools before continuing"
         )

suite_py/commands/id.py

@@ -4,6 +4,7 @@ import re
 from pptree import Node, print_tree
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler.aws_handler import Aws
 
 
@@ -13,6 +14,7 @@ class ID:
         self._env = env
         self._aws = Aws(config)
 
+    @metrics.command("id")
     def run(self):
 
         clusters_names = self._aws.get_ecs_clusters(self._env)

suite_py/commands/ip.py

@@ -5,6 +5,7 @@ import re
 from pptree import Node, print_tree
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler.aws_handler import Aws
 
 
@@ -14,6 +15,7 @@ class IP:
         self._env = env
         self._aws = Aws(config)
 
+    @metrics.command("ip")
     def run(self):
 
         clusters_names = self._aws.get_ecs_clusters(self._env)

suite_py/commands/login.py

@@ -13,6 +13,7 @@ from flask import Flask, render_template, request
 from werkzeug.serving import make_server
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 
 # Global vars for comunication between flask thread and main cli function
 received_callback = None
@@ -99,6 +100,7 @@ class Login:
     def generate_challenge(self, a_verifier):
         return self.url_encode_no_padding(hashlib.sha256(a_verifier.encode()).digest())
 
+    @metrics.command("login")
     def run(self):
         global received_callback
 

suite_py/commands/merge_pr.py

@@ -4,6 +4,7 @@ import sys
 from halo import Halo
 
 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.captainhook_handler import CaptainHook
@@ -24,6 +25,7 @@ class MergePR:
         self._github = GithubHandler(tokens)
         self._drone = DroneHandler(config, tokens, repo=project)
 
+    @metrics.command("merge-pr")
     def run(self):
         # pylint: disable=too-many-branches
         self._stop_if_master_locked()

suite_py/commands/open_pr.py

@@ -5,6 +5,7 @@ from github import GithubException
 
 from suite_py.commands.ask_review import AskReview
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler import prompt_utils
 from suite_py.lib.handler.git_handler import GitHandler, get_commit_logs
 from suite_py.lib.handler.github_handler import GithubHandler
@@ -21,6 +22,7 @@ class OpenPR:
         self._branch_name = self._git.current_branch_name()
         self._github = GithubHandler(tokens)
 
+    @metrics.command("open-pr")
     def run(self):
         if not self._git.remote_branch_exists(self._branch_name):
             logger.warning(f"No branch named {self._branch_name} found on GitHub")

suite_py/commands/project_lock.py

@@ -4,6 +4,7 @@ import sys
 import requests
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler.captainhook_handler import CaptainHook
 
 
@@ -14,6 +15,7 @@ class ProjectLock:
         self._action = action
         self._captainhook = CaptainHook(config, tokens=tokens)
 
+    @metrics.command("manage-project-lock")
     def run(self):
         if self._action == "lock":
             try:

suite_py/commands/qa.py

@@ -12,6 +12,7 @@ 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
@@ -32,6 +33,7 @@ class QA:
         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.")
@@ -96,15 +98,21 @@ class QA:
             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 "/",
+            (
+                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"],
         )
@@ -211,9 +219,11 @@ class QA:
                         table.add_row(
                             resource["name"],
                             drone_url,
-                            resource["ref"]
-                            if resource["ref"] == "master"
-                            else f"[green]{resource['ref']}[/green]",
+                            (
+                                resource["ref"]
+                                if resource["ref"] == "master"
+                                else f"[green]{resource['ref']}[/green]"
+                            ),
                             self._clean_date(resource["updated_at"]),
                             resource["status"],
                         )

suite_py/commands/release.py

@@ -7,6 +7,7 @@ from halo import Halo
 
 from suite_py.commands import common
 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.captainhook_handler import CaptainHook
@@ -35,6 +36,7 @@ class Release:
         self._drone = DroneHandler(config, tokens, repo=project)
         self._version = VersionHandler(self._repo, self._git, self._github)
 
+    @metrics.command("release")
     def run(self):
         self._stop_if_prod_locked()
         self._git.fetch()

suite_py/commands/secret.py

@@ -6,6 +6,7 @@ import sys
 import yaml
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler import prompt_utils
 from suite_py.lib.handler.vault_handler import VaultHandler
 
@@ -43,6 +44,7 @@ class Secret:
         self._base_profile = base_profile
         self._secret_file = secret_file
 
+    @metrics.command("secret")
     def run(self):
         if self._base_profile is not None:
             self._config.vault["base_secret_profile"] = self._base_profile

suite_py/commands/set_token.py

@@ -1,6 +1,7 @@
 import sys
 
 from suite_py.lib import logger
+from suite_py.lib import metrics
 from suite_py.lib.handler import prompt_utils
 from suite_py.lib.tokens import Tokens
 
@@ -9,6 +10,7 @@ class SetToken:
     def __init__(self, tokens: Tokens):
         self._tokens = tokens
 
+    @metrics.command("set-token")
     def run(self):
         selected = self._select_token()
         if not selected or selected.lower() != selected or selected.strip() != selected:

suite_py/commands/status.py

@@ -2,6 +2,7 @@
 from halo import Halo
 
 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.symbol import CHECKMARK, CROSSMARK
 
@@ -11,6 +12,7 @@ class Status:
         self._project = project
         self._captainhook = CaptainHook(config)
 
+    @metrics.command("status")
     def run(self):
         with Halo(text="Contacting Captainhook...", spinner="dots", color="magenta"):
             staging_status = self._captainhook.status(self._project, "staging").json()

suite_py/lib/handler/captainhook_handler.py

@@ -56,33 +56,42 @@ class CaptainHook:
         data = {"aggregator": aggregator, "qa_address": qa_address}
         return self.send_put_request("/cloudflare/aggregators", data)
 
-    def send_post_request(self, endpoint, data):
+    def send_metrics(self, metrics):
+        self.send_post_request("/suite_py/metrics/", json=metrics).raise_for_status()
+
+    def send_post_request(self, endpoint, data=None, json=None):
         try:
             r = requests.post(
                 f"{self._baseurl}{endpoint}",
                 headers=self._headers,
                 data=data,
+                json=json,
                 timeout=self._timeout,
             )
 
             return self._response(r)
-        except Exception:
-            logger.error("Unable to contact Captainhook, are you using the VPN?")
-            sys.exit(-1)
+        except Exception as e:
+            logger.error(
+                "Unable to contact Captainhook, are you logged in/using the VPN?"
+            )
+            raise e
 
-    def send_put_request(self, endpoint, data):
+    def send_put_request(self, endpoint, data=None, json=None):
         try:
             r = requests.put(
                 f"{self._baseurl}{endpoint}",
                 headers=self._headers,
                 data=data,
+                json=json,
                 timeout=self._timeout,
             )
 
             return self._response(r)
-        except Exception:
-            logger.error("Unable to contact Captainhook, are you using the VPN?")
-            sys.exit(-1)
+        except Exception as e:
+            logger.error(
+                "Unable to contact Captainhook, are you logged in/using the VPN?"
+            )
+            raise e
 
     def send_get_request(self, endpoint):
         try:
@@ -93,9 +102,11 @@ class CaptainHook:
             )
 
             return self._response(r)
-        except Exception:
-            logger.error("Unable to contact Captainhook, are you using the VPN?")
-            sys.exit(-1)
+        except Exception as e:
+            logger.error(
+                "Unable to contact Captainhook, are you logged in/using the VPN?"
+            )
+            raise e
 
     def _response(self, response):
         if response.status_code == 401:

suite_py/lib/handler/drone_handler.py

@@ -217,7 +217,7 @@ class DroneHandler:
             subprocess.run(
                 ["drone", "fmt", "--save", ".drone.yml"], cwd=self._path, check=True
             )
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"{self._repo}: unable to format the .drone.yml {e}")
             sys.exit(-1)
 
@@ -226,7 +226,7 @@ class DroneHandler:
             subprocess.run(
                 ["drone", "lint", "--trusted", ".drone.yml"], cwd=self._path, check=True
             )
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"{self._path}: the .drone.yml is not valid {e}")
             sys.exit(-1)
 
@@ -237,7 +237,7 @@ class DroneHandler:
                 cwd=self._path,
                 check=True,
             )
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"{self._repo}: unable to sign the .drone.yml {e}")
             sys.exit(-1)
 

suite_py/lib/handler/git_handler.py

@@ -52,7 +52,7 @@ class GitHandler:
                 )
                 if not self.is_detached():  # Skip pulling if detached
                     self.pull(rebase=True)
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)
 
@@ -74,14 +74,14 @@ class GitHandler:
                     stdout=subprocess.DEVNULL,
                     stderr=subprocess.DEVNULL,
                 )
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)
 
     def add(self):
         try:
             subprocess.run(["git", "add", "."], cwd=self._path, check=True)
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)
 
@@ -95,7 +95,7 @@ class GitHandler:
                     stdout=subprocess.DEVNULL,
                     stderr=subprocess.DEVNULL,
                 )
-            except (CalledProcessError) as e:
+            except CalledProcessError as e:
                 logger.error(f"Error during command execution: {e}")
                 sys.exit(-1)
 
@@ -118,7 +118,7 @@ class GitHandler:
                         stdout=subprocess.DEVNULL,
                         stderr=subprocess.DEVNULL,
                     )
-            except (CalledProcessError) as e:
+            except CalledProcessError as e:
                 logger.error(f"Error during command execution: {e}")
                 sys.exit(-1)
 
@@ -139,7 +139,7 @@ class GitHandler:
                     stdout=subprocess.DEVNULL,
                     stderr=subprocess.DEVNULL,
                 )
-            except (CalledProcessError) as e:
+            except CalledProcessError as e:
                 logger.error(f"Error during command execution: {e}")
                 sys.exit(-1)
 
@@ -153,7 +153,7 @@ class GitHandler:
                     stdout=subprocess.DEVNULL,
                     stderr=subprocess.DEVNULL,
                 )
-            except (CalledProcessError) as e:
+            except CalledProcessError as e:
                 logger.error(f"Error during command execution: {e}")
                 sys.exit(-1)
 
@@ -232,7 +232,7 @@ class GitHandler:
                 check=True,
             ).stdout.decode("utf-8")
             return re.sub("\n", "", output)
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)
 
@@ -254,7 +254,7 @@ class GitHandler:
             ).stdout.decode("utf-8")
 
             return len(output) != 0
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)
 

suite_py/lib/handler/metrics_handler.py

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+
+import multiprocessing
+import os
+import platform
+
+from suite_py.lib import logger
+from suite_py.lib.config import Config
+from suite_py.lib.handler.captainhook_handler import CaptainHook
+
+
+# Collects metrics and sends them to datadog through captainhook
+class Metrics:
+    def __init__(self, config: Config):
+        self._config = config
+
+    # Emits the command_executed metric
+    def command_executed(self, command: str, success: None | bool = True):
+        metric_data = {
+            "type": "command_executed",
+            "os": platform.system(),
+            "command": command,
+            "success": success,
+        }
+
+        self._create_metric(metric_data)
+
+    def _create_metric(self, metric):
+        # Instead of trying to submit metrics all at once first we save them to a file first
+        # That way we can batch metric submissions and retry them if they fail (eg. because the user isn't authenticated with okta)
+        metrics = self._config.get_cookie("metrics", [])
+        if not isinstance(metrics, list):
+            logger.warning(
+                f"Metrics cookie is not a list! Replacing {metrics} with an empty list"
+            )
+            metrics = []
+
+        logger.debug(f"creating metric: {metric}")
+        metrics.append(metric)
+        self._config.put_cookie("metrics", metrics)
+
+    # Upload metrics in a detached background process
+    def async_upload(self):
+        # Double fork to detach the process
+        def child():
+            if (
+                # Windows doesn't support forking.
+                # There aren't any windows users that we know of so we can just block application exit
+                # If windows users appear we should fix this
+                os.name == "posix"
+                and
+                # Forking here is safe since we are running in a fresh process spawned by multiprocessing
+                os.fork() != 0
+            ):
+                return
+
+            self.upload()
+
+        # Fall back to a sync upload if async fails
+        try:
+            p = multiprocessing.Process(target=child)
+            p.start()
+            p.join()
+        except Exception:
+            logger.debug(
+                "Error uploading metrics asynchronously, trying sync:", exc_info=True
+            )
+            self.upload()
+
+    def upload(self):
+        captainhook = CaptainHook(self._config)
+
+        metrics = self._config.get_cookie("metrics", [])
+        # Prevent double uploads
+        #
+        # This isn't atomic and could still lead to the same metrics being uploaded twice
+        # but this occuring is unlikely enough that it shouldn't significantly influence our stats
+        self._config.put_cookie("metrics", [])
+        try:
+            if len(metrics) != 0:
+                captainhook.send_metrics(metrics)
+        except Exception:
+            # Upload failed, try again later
+            self._config.put_cookie("metrics", metrics)

suite_py/lib/handler/vault_handler.py

@@ -23,6 +23,6 @@ class VaultHandler:
             )  # .stdout.read()
             c.wait()
             return c
-        except (CalledProcessError) as e:
+        except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)

suite_py/lib/handler/version_handler.py

@@ -1,5 +1,5 @@
 import dataclasses
-from typing import Dict, List, Optional, Literal
+from typing import Dict, List, Literal, Optional
 
 import semver
 from halo import Halo

suite_py/lib/logger.py

@@ -1,18 +1,19 @@
 # -*- encoding: utf-8 -*-
 import logging
-
 import logzero
 from logzero import logger as _logger
 
 DEFAULT_FORMAT = "%(color)s[%(levelname)1.4s]%(end_color)s %(message)s"
 # Set a custom formatter
 formatter = logzero.LogFormatter(fmt=DEFAULT_FORMAT)
-logzero.setup_default_logger(formatter=formatter)
-_logger.setLevel(logging.INFO)
 
 
-def setLevel(level):
+def setup(verbose):
+    logzero.setup_default_logger(formatter=formatter)
+    level = logging.DEBUG if verbose else logging.INFO
+
     _logger.setLevel(level)
+    _logger.debug("Logging as %s", level)
 
 
 def debug(message, *args, **kwargs):

suite_py/lib/metrics.py

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+import functools
+from suite_py.lib.config import Config
+from suite_py.lib.handler.metrics_handler import Metrics
+
+_metrics_handler = None
+
+
+def _metrics() -> Metrics:
+    if _metrics_handler:
+        return _metrics_handler
+
+    raise Exception(
+        "command_executed called before logger.setup(). This is a bug, please report it"
+    )
+
+
+def setup(config: Config):
+    global _metrics_handler
+    _metrics_handler = Metrics(config)
+
+
+def command_executed(command):
+    _metrics().command_executed(command)
+
+
+def async_upload():
+    _metrics().async_upload()
+
+
+# Decorator that emits the command_executed metric with the given command name,
+# and sets the success paramter to false if the function exited by throwing an error
+def command(command: str):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            try:
+                res = func(*args, **kwargs)
+                _metrics().command_executed(command, success=True)
+                return res
+            except Exception as e:
+                _metrics().command_executed(command, success=False)
+                raise e
+            # We use sys.exit everywhere, report those
+            except SystemExit as e:
+                # Report sys.exit(0) and sys.exit() as successes
+                success = e.code in (0, None)
+                _metrics().command_executed(command, success=success)
+
+                raise e
+
+        return wrapper
+
+    return decorator

{suite_py-1.40.3.dist-info → suite_py-1.41.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: suite-py
-Version: 1.40.3
+Version: 1.41.1
 Summary: 
 Author: larrywax, EugenioLaghi, michelangelomo
 Author-email: devops@prima.it
@@ -19,7 +19,7 @@ Requires-Dist: PyGithub (>=1.57)
 Requires-Dist: PyYaml (>=5.4)
 Requires-Dist: Werkzeug (==2.0.2)
 Requires-Dist: autoupgrade-prima (>=0.6)
-Requires-Dist: black (>=22.6.0,<23.0.0)
+Requires-Dist: black (>=22.6,<25.0)
 Requires-Dist: boto3 (>=1.17.84)
 Requires-Dist: cement (>=3.0)
 Requires-Dist: colorama (>=0.4.3)
@@ -38,7 +38,7 @@ Requires-Dist: pytest (>=7.0.0)
 Requires-Dist: python-dateutil (>=2.8.2)
 Requires-Dist: requests (>=2.26.0)
 Requires-Dist: requests-toolbelt (>=0.9.1)
-Requires-Dist: rich (==13.7.0)
+Requires-Dist: rich (==13.7.1)
 Requires-Dist: semver (>=2.13.0,<3.0.0)
 Requires-Dist: termcolor (>=1.1.0)
 Requires-Dist: truststore (>=0.7,<0.9) ; python_version >= "3.10"

suite_py-1.41.1.dist-info/RECORD

@@ -0,0 +1,53 @@
+suite_py/__init__.py,sha256=REmi3D0X2G1ZWnYpKs8Ffm3NIj-Hw6dMuvz2b9NW344,142
+suite_py/__version__.py,sha256=QVX2FgKuN1mAfnqMbQHnZFcn7VYFoFOT6sna6gRSbAE,49
+suite_py/cli.py,sha256=Rpt93UMFkcgzXlFG_zeDZn_roWRrP6eByyT9XclQi-w,17491
+suite_py/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+suite_py/commands/aggregator.py,sha256=2bPjtg0p_2oBLR5-wzy0borjiNSv93rsiirgRFqSXUg,5839
+suite_py/commands/ask_review.py,sha256=Bc3Nf2ZtK0E0gf8ub_I-oCWQQloNnAaUbbbQvB8oHcE,3872
+suite_py/commands/batch_job.py,sha256=zqF7aPM_tzPAHmq1kyLaMd1Md7NTcMXDFQwKfqhjqqI,7474
+suite_py/commands/bump.py,sha256=E-WbS5wsqVwjF-58RZRkwaZuaVEDiNxYLkqAApKpXos,5430
+suite_py/commands/check.py,sha256=Lz1j6a-x42NQOYlkaVVwGCLYNKsDG36t5CYzuXgVaWk,4158
+suite_py/commands/common.py,sha256=aWCEvO3hqdheuMUmZcHuc9EGZPQTk7VkzkHJk283MxQ,566
+suite_py/commands/create_branch.py,sha256=NTXWPEembys8g_CFx_0TWy4KnEFXOEEI2SJdF41O3Oc,4448
+suite_py/commands/deploy.py,sha256=ma33WxyHBjpR0k9lwdM7tM90L3mzBgNrpYlpJxD0ppE,8172
+suite_py/commands/docker.py,sha256=J7pyOSD0B0doPjMeqJKxClwOL6GQ8lDcTh_hG7_vrqU,2956
+suite_py/commands/generator.py,sha256=1ysn75QxpiwjVuJaO-EcvUm751kGVKx3zQvt7EJEuXs,8534
+suite_py/commands/id.py,sha256=u66ALNOZy3cv3CJnbmTOv1J2tbjWBh97XGV5JUzyHC4,2022
+suite_py/commands/ip.py,sha256=KV4asKVwU1q4_64Y490jLP01RYjqkAk4euz4VZ3Ko6w,2420
+suite_py/commands/login.py,sha256=FW-Q5FJfPcrGxynUE7X74tzZF-Pvo-ZdNxcNbqwqxqM,6039
+suite_py/commands/merge_pr.py,sha256=BsHXW_t165f73wcwt__M-FtlTO1AetWAjcSrabXMCpA,5697
+suite_py/commands/open_pr.py,sha256=gNT3XuLNrjhiaLHX3Vw50XfIx7HT1wqFU_cBmLU17ow,7220
+suite_py/commands/project_lock.py,sha256=Lck7UMuZQY0DWPSotufsxuhglrlOfxluNjE1DnwkVhE,2024
+suite_py/commands/qa.py,sha256=TQxu7HE6ryr_zpXb3bXcOXFHv5HrLRCKXtw8SzsEN1A,16251
+suite_py/commands/release.py,sha256=dfXV0FL28AMsLJXamGN2BpqnZxOAturSGyMl3TJTttY,16718
+suite_py/commands/secret.py,sha256=K8VxC5tL-_64TxiDrYlSUfwZB2eDzKaaRutr3YWhQq4,8019
+suite_py/commands/set_token.py,sha256=2DYdJUtpvrcdlGZLUfZcMvTFDDtATE0gLgy4P5Hgti0,1532
+suite_py/commands/status.py,sha256=ph3_vdnyoa6L4Zv_pL5LxR6glnac8sJ3ow76D9nhsH4,1136
+suite_py/commands/templates/login.html,sha256=fJLls2SB84oZTSrxTdA5q1PqfvIHcCD4fhVWfyco7Ig,861
+suite_py/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+suite_py/lib/config.py,sha256=_XyegvK9RntZuEyCfi72Aavaw4aw1MLH4-pCDu3VuNc,4017
+suite_py/lib/handler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+suite_py/lib/handler/aws_handler.py,sha256=dRvRDicikfRbuFtCLPbevaX-yC-fO4LwXFdyqLPJ8OI,8815
+suite_py/lib/handler/captainhook_handler.py,sha256=uOlWpvFihhfy5J690loXOcvFs5sWgeom_SuNL2OqTq4,3731
+suite_py/lib/handler/changelog_handler.py,sha256=-ppnRl3smBA_ys8tPqXmytS4eyntlwfawC2fiXFcwlw,4818
+suite_py/lib/handler/drone_handler.py,sha256=rmtzu30OQyG3vRPlbZKsQhHN9zbguPtXO0RpDjYOTPA,8967
+suite_py/lib/handler/frequent_reviewers_handler.py,sha256=EIJX5FEMWzrxuXS9A17hu1vfxgJSOHSBX_ahCEZ2FVA,2185
+suite_py/lib/handler/git_handler.py,sha256=boxhl9lQz6fjEJ10ib1KrDW-geCVjhA_6nKwv2ll01g,11333
+suite_py/lib/handler/github_handler.py,sha256=AnFL54yOZ5GDIU91wQat4s-d1WTcmg_B_5M7-Rop3wA,2900
+suite_py/lib/handler/metrics_handler.py,sha256=huJoNvJOu_Tl5t_L6zbB4vq9vSMSh0RHV-qUlQz9OGE,2961
+suite_py/lib/handler/prompt_utils.py,sha256=vgk1O7h-iYEAZv1sXtMh8xIgH1djI398rzxRIgZWZcg,2474
+suite_py/lib/handler/qainit_handler.py,sha256=F1sDQ7ktvSkQ73xH7DlZO3J728BSGQ8l5pJabniQniw,8632
+suite_py/lib/handler/vault_handler.py,sha256=r4osw7qwz3ZFmLg2U1oFPdtRFcXzDXiaWBZC01cYK_w,871
+suite_py/lib/handler/version_handler.py,sha256=DXTx4yCAbFVC6CdMqPJ-LiN5YM-dT2zklG8POyKTP5A,6774
+suite_py/lib/handler/youtrack_handler.py,sha256=eTGBBXjlN_ay1cawtnZ2IG6l78dDyKdMN1x6PxcvtA0,7499
+suite_py/lib/logger.py,sha256=cs0XH4pwP3IOjvsOpoY9DEDKsn4p3LwKmvfW-NEoL4U,781
+suite_py/lib/metrics.py,sha256=HpLki7K2thKa_zrU3oe942EdYSKWuU43rtag1YVQ1QQ,1502
+suite_py/lib/requests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+suite_py/lib/requests/auth.py,sha256=wN_WtGFmDUWRFilWzOmUaRBvP2n3EPpPMqex9Zjddko,228
+suite_py/lib/requests/session.py,sha256=P32H3cWnCWunu91WIj2iDM5U3HzaBglg60VN_C9JBL4,267
+suite_py/lib/symbol.py,sha256=z3QYBuNIwD3qQ3zF-cLOomIr_-C3bO_u5UIDAHMiyTo,60
+suite_py/lib/tokens.py,sha256=BPmNEP8-YGwyE6EK4vBgLwc-AU3wwqpsM2a1xJYtz7g,5449
+suite_py-1.41.1.dist-info/METADATA,sha256=1BseewR9jZ9k54z8UKcr4tlvxrsGXbAE_Ps5iplrW1c,1596
+suite_py-1.41.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+suite_py-1.41.1.dist-info/entry_points.txt,sha256=dVKLC-9Infy-dHJT_MkK6LcDjOgBCJ8lfPkURJhBjxE,46
+suite_py-1.41.1.dist-info/RECORD,,

suite_py-1.40.3.dist-info/RECORD

@@ -1,51 +0,0 @@
-suite_py/__init__.py,sha256=REmi3D0X2G1ZWnYpKs8Ffm3NIj-Hw6dMuvz2b9NW344,142
-suite_py/__version__.py,sha256=kYaA_Pt2Ur3E7Aiml1IhaTWCYD2G8sGOnA9_vaHxovQ,49
-suite_py/cli.py,sha256=pAu1aaILwYLQHWV25nO_9Nmdf2ljprX08V2w_e1T180,17410
-suite_py/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-suite_py/commands/aggregator.py,sha256=F5f1dD00zgCUFa4Af8kfKlZKwogBJ-RvIRaYyB4fu94,5771
-suite_py/commands/ask_review.py,sha256=u-4c0N23kq4ab9vR0LfPf0P89sP6F6umQdFWxnutxzM,3803
-suite_py/commands/batch_job.py,sha256=G9zyIXUuxGw2ZXZJEWXzSmHaJ7Kl4qRQdsHGZxctgd8,7407
-suite_py/commands/bump.py,sha256=Bv4QrMJP5L5mO7LK3OHE0SN0dmAngRf6OXgVy9XkU-8,5367
-suite_py/commands/check.py,sha256=_rPfHzaVzffMZ3lR_aYf9Hl-qWmKsyygcFOIqxTdC3A,4095
-suite_py/commands/common.py,sha256=aWCEvO3hqdheuMUmZcHuc9EGZPQTk7VkzkHJk283MxQ,566
-suite_py/commands/create_branch.py,sha256=6rhvx3uVHaQgryyYNnSMuX7XXal9fGhYeGyIaZQTJ_Y,4377
-suite_py/commands/deploy.py,sha256=XnSaiN_mtXVxXYf_KCFsqpIE3r4-rPydQNNMIF-PNwg,8108
-suite_py/commands/docker.py,sha256=HNC6rLW17TiL5FbN6rGEbswmTVM104fteMG_9qjkjSk,2892
-suite_py/commands/generator.py,sha256=Mdss5OHdut6EElhyR2VIavNwHc9e5OB0LctJyIFoWuI,8466
-suite_py/commands/id.py,sha256=maeS6Q2r7ehglD_LexWjjYB7JsHiPRnjxUjVqdgLf1g,1962
-suite_py/commands/ip.py,sha256=2RZTv4Fy7I1O1hZmsEIoKAKp0z1z33FDccTo3VArDoE,2360
-suite_py/commands/login.py,sha256=jz-QpB5h7o36A2A3rnwIOwiFdiwgKeIgEuPLv_oe9rk,5976
-suite_py/commands/merge_pr.py,sha256=ANFnwn9UwRMj77MS8zGX1skN6skhwe9GL9MUnqIZ6H4,5631
-suite_py/commands/open_pr.py,sha256=JZJC9WpEk9_azNdrAZd92mjW_TPtjGuTlBApuAqNiJM,7155
-suite_py/commands/project_lock.py,sha256=A0r_252SctnMUXS7F8WGP1sKmYpXwCJWrg2-QPytZJY,1947
-suite_py/commands/qa.py,sha256=uTsC_jdykrwHYnFybilomK49sVfAVp4jIrdh_o9FdqI,15999
-suite_py/commands/release.py,sha256=iEdbhzaj-PTntu2vKnJcisrwG95FUoJ9GqOLj-q85s0,16653
-suite_py/commands/secret.py,sha256=FGiiYN4fqcgfgRWA72HYYMh3-zElG8xhhES4EyO7xGk,7955
-suite_py/commands/set_token.py,sha256=C99Yp3HGKSuKEcFrG7xhKgY_pqZSKkXuVTkdCirS-2g,1465
-suite_py/commands/status.py,sha256=ez5f2ZMIlnIKfAeD7zsaFAuOuAgRqBBVPf5VpzIljeE,1072
-suite_py/commands/templates/login.html,sha256=fJLls2SB84oZTSrxTdA5q1PqfvIHcCD4fhVWfyco7Ig,861
-suite_py/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-suite_py/lib/config.py,sha256=_XyegvK9RntZuEyCfi72Aavaw4aw1MLH4-pCDu3VuNc,4017
-suite_py/lib/handler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-suite_py/lib/handler/aws_handler.py,sha256=dRvRDicikfRbuFtCLPbevaX-yC-fO4LwXFdyqLPJ8OI,8815
-suite_py/lib/handler/captainhook_handler.py,sha256=XsXD8P5zgNRXdUt52cP5N8Gv3LRfYjj9job6tgHiOuI,3401
-suite_py/lib/handler/changelog_handler.py,sha256=-ppnRl3smBA_ys8tPqXmytS4eyntlwfawC2fiXFcwlw,4818
-suite_py/lib/handler/drone_handler.py,sha256=QD7f08oL-L-cEjcx-W5XYwGhD2HJiSSe2S0gHYJv5Ns,8973
-suite_py/lib/handler/frequent_reviewers_handler.py,sha256=EIJX5FEMWzrxuXS9A17hu1vfxgJSOHSBX_ahCEZ2FVA,2185
-suite_py/lib/handler/git_handler.py,sha256=d1MgwpH5DCi5-cy8Zl5o7Mwd9K9zNhJUdFoPMnMHYlo,11351
-suite_py/lib/handler/github_handler.py,sha256=AnFL54yOZ5GDIU91wQat4s-d1WTcmg_B_5M7-Rop3wA,2900
-suite_py/lib/handler/prompt_utils.py,sha256=vgk1O7h-iYEAZv1sXtMh8xIgH1djI398rzxRIgZWZcg,2474
-suite_py/lib/handler/qainit_handler.py,sha256=F1sDQ7ktvSkQ73xH7DlZO3J728BSGQ8l5pJabniQniw,8632
-suite_py/lib/handler/vault_handler.py,sha256=cnYfBJ2nuSTACKxdbquGANKONocT2OIXzGLA3oYVH1Y,873
-suite_py/lib/handler/version_handler.py,sha256=eBOVmKJdbyoJVSGX5IFcCzT-YKT4lAz_QsxMF9cI2uA,6774
-suite_py/lib/handler/youtrack_handler.py,sha256=eTGBBXjlN_ay1cawtnZ2IG6l78dDyKdMN1x6PxcvtA0,7499
-suite_py/lib/logger.py,sha256=et7U_mRJkEbXgvu7tGVzffUvBcKR1jbJXvnaDqsoZTI,712
-suite_py/lib/requests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-suite_py/lib/requests/auth.py,sha256=wN_WtGFmDUWRFilWzOmUaRBvP2n3EPpPMqex9Zjddko,228
-suite_py/lib/requests/session.py,sha256=P32H3cWnCWunu91WIj2iDM5U3HzaBglg60VN_C9JBL4,267
-suite_py/lib/symbol.py,sha256=z3QYBuNIwD3qQ3zF-cLOomIr_-C3bO_u5UIDAHMiyTo,60
-suite_py/lib/tokens.py,sha256=BPmNEP8-YGwyE6EK4vBgLwc-AU3wwqpsM2a1xJYtz7g,5449
-suite_py-1.40.3.dist-info/METADATA,sha256=ZjjZIGylHX-ebv2VhYwMVatGb2mjWMcLf-omv2octKc,1600
-suite_py-1.40.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-suite_py-1.40.3.dist-info/entry_points.txt,sha256=dVKLC-9Infy-dHJT_MkK6LcDjOgBCJ8lfPkURJhBjxE,46
-suite_py-1.40.3.dist-info/RECORD,,