gitops 0.9.22__tar.gz → 0.10.0__tar.gz

{gitops-0.9.22 → gitops-0.10.0}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.1
 Name: gitops
-Version: 0.9.22
+Version: 0.10.0
 Summary: Manage multiple apps across one or more k8s clusters.
 License: BSD
 Author: Jarek Głowacki
 Author-email: jarekwg@gmail.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.11,<4.0
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: server
@@ -20,7 +19,7 @@ Requires-Dist: httpx (>=0.18.1,<0.24.0) ; extra == "server"
 Requires-Dist: humanize (>=3.5.0,<4.0.0)
 Requires-Dist: invoke
 Requires-Dist: kubernetes_asyncio (>=25.1.2,<26.0.0) ; extra == "server"
-Requires-Dist: pyyaml (>=5.1.2)
+Requires-Dist: pyyaml (>=6.0.1)
 Requires-Dist: sentry-sdk (>=1.3.0,<2.0.0) ; extra == "server"
 Requires-Dist: tabulate (>=0.8.9,<0.9.0)
 Requires-Dist: uvicorn (>=0.17.0,<0.18.0) ; extra == "server" or extra == "server"

{gitops-0.9.22 → gitops-0.10.0}/gitops/__init__.py

@@ -5,13 +5,11 @@ from pathlib import Path
 from . import monkeypatches  # NOQA
 from .utils.cli import success, warning
 
-__version__ = "0.9.22"
+__version__ = "0.10.0"
 
 
 # Checking gitops version matches cluster repo version.
-versions_path = (
-    Path(os.environ.get("GITOPS_APPS_DIRECTORY", "apps")).parent.absolute() / "setup.cfg"
-)
+versions_path = Path(os.environ.get("GITOPS_APPS_DIRECTORY", "apps")).parent.absolute() / "setup.cfg"
 if versions_path.exists():
     import configparser
 

{gitops-0.9.22 → gitops-0.10.0}/gitops/common/app.py

@@ -1,7 +1,7 @@
 import json
 import os
 from base64 import b64encode
-from typing import Any, Dict, List, Optional, Union
+from typing import Any
 
 from .utils import load_yaml
 
@@ -20,9 +20,9 @@ class App:
     def __init__(
         self,
         name: str,
-        path: Optional[str] = None,
-        deployments: Optional[Dict] = None,
-        secrets: Optional[Dict] = None,
+        path: str | None = None,
+        deployments: dict | None = None,
+        secrets: dict | None = None,
         load_secrets: bool = True,
         account_id: str = "",
     ):
@@ -60,7 +60,7 @@ class App:
             current_dict = current_dict.setdefault(key, {})
         current_dict[keys[-1]] = value
 
-    def _make_values(self, deployments: Dict, secrets: Dict) -> Dict:
+    def _make_values(self, deployments: dict, secrets: dict) -> dict:
         values = {
             **deployments,
             "secrets": {**{k: b64encode(v.encode()).decode() for k, v in secrets.items()}},
@@ -75,7 +75,7 @@ class App:
         values.pop("images", None)
         return values
 
-    def _make_image(self, deployment_config: Dict):
+    def _make_image(self, deployment_config: dict):
         if "image-tag" in deployment_config:
             return deployment_config["images"]["template"].format(
                 account_id=self.account_id,
@@ -119,16 +119,12 @@ class App:
         return self.values.get("cluster", "")
 
     @property
-    def tags(self) -> List[str]:
+    def tags(self) -> list[str]:
         return self.values.get("tags", [])
 
     @property
     def service_account_name(self) -> str:
-        return (
-            self.values.get("serviceAccount", {}).get("name")
-            or self.values.get("serviceAccountName")
-            or "default"
-        )
+        return self.values.get("serviceAccount", {}).get("name") or self.values.get("serviceAccountName") or "default"
 
 
 class Chart:
@@ -153,7 +149,7 @@ class Chart:
       chart: https://github.com/uptick/workforce
     """
 
-    def __init__(self, definition: Union[Dict, str]):
+    def __init__(self, definition: dict | str):
         if isinstance(definition, str):
             # for backwards compat, any chart definition which is a string, is a git repo
             self.type = "git"
@@ -169,9 +165,7 @@ class Chart:
             self.version = definition.get("version")
             self.path = definition.get("path")
         else:
-            raise Exception(
-                "Chart definition must be either a dict or string. Instead it is: {definition}"
-            )
+            raise Exception("Chart definition must be either a dict or string. Instead it is: {definition}")
 
         if self.git_repo_url and "@" in self.git_repo_url:
             self.git_repo_url, self.git_sha = self.git_repo_url.split("@")

{gitops-0.9.22 → gitops-0.10.0}/gitops/common/utils.py

@@ -1,22 +1,21 @@
 import os
-from typing import Dict
 
 import yaml
 
 
-def load_yaml(path) -> Dict:
-    with open(path, "r") as file:
+def load_yaml(path) -> dict:
+    with open(path) as file:
         return resolve_values(yaml.safe_load(file), path)
 
 
-def resolve_values(values, path) -> Dict:
+def resolve_values(values, path) -> dict:
     if "extends" not in values:
         return values
     parent_values = load_yaml(os.path.join(os.path.dirname(path), values["extends"]))
     return deep_merge(parent_values, values)
 
 
-def deep_merge(parent: Dict, child: Dict) -> Dict:
+def deep_merge(parent: dict, child: dict) -> dict:
     """Deeply merge two dictionaries.
 
     Dictionary entries will be followed and merged, anything else will be

{gitops-0.9.22 → gitops-0.10.0}/gitops/core.py

@@ -31,7 +31,7 @@ def summary(ctx, filter="", exclude=""):
 
 
 @task
-def bump(
+def bump(  # noqa: C901
     ctx,
     filter,
     exclude="",
@@ -105,10 +105,7 @@ def bump(
             print(f"Redeploying {colourise(app_name, Fore.LIGHTGREEN_EX)}")
             update_app(app_name, **{"bump": str(uuid.uuid4())})
         else:
-            print(
-                f"Skipping {colourise(app_name, Fore.LIGHTGREEN_EX)}: already on"
-                f" {colour_image(new_image_tag)}"
-            )
+            print(f"Skipping {colourise(app_name, Fore.LIGHTGREEN_EX)}: already on" f" {colour_image(new_image_tag)}")
     if redeploy:
         commit_message = f"Redeploying {filter}"
     else:
@@ -166,18 +163,12 @@ def command(
     if sequential or (not interactive) or len(apps) == 1:
         for app in apps:
             # For each app, just run the coroutine and print the output
-            print(
-                asyncio.run(
-                    run_job(app, command, cleanup=cleanup, sequential=True, cpu=cpu, memory=memory)
-                )
-            )
+            print(asyncio.run(run_job(app, command, cleanup=cleanup, sequential=True, cpu=cpu, memory=memory)))
     else:
         # Build list of coroutines, and execute them all at once
         jobs = [
             (
-                run_job(
-                    app, command, cleanup=cleanup, sequential=sequential, cpu=cpu, memory=memory
-                ),
+                run_job(app, command, cleanup=cleanup, sequential=sequential, cpu=cpu, memory=memory),
                 app.name,
             )
             for app in apps
@@ -257,10 +248,8 @@ def _getenv(env_or_secrets, filter, exclude, filter_values):
     for app in apps:
         print("-" * 20, progress(app.name), sep="\n")
         values = app.values.get(env_or_secrets)
-        if type(values) == dict:
-            filtered_values = (
-                {k: v for k, v in values.items() if k in filter_values} if filter_values else values
-            )
+        if isinstance(values, dict):
+            filtered_values = {k: v for k, v in values.items() if k in filter_values} if filter_values else values
             for k, v in filtered_values.items():
                 print(f"{k}={v}")
         else:

{gitops-0.9.22 → gitops-0.10.0}/gitops/db.py

@@ -129,13 +129,11 @@ def proxy(
     except ValueError:
         # app_name was not a valid dsn
         app = get_app_details(app_name, load_secrets=True)
-        database_url = base64.b64decode(
-            app.values["secrets"]["DATABASE_URL"].encode("ascii")
-        ).decode("ascii")
+        database_url = base64.b64decode(app.values["secrets"]["DATABASE_URL"].encode("ascii")).decode("ascii")
         database_dsn = dsnparse.parse(database_url)
 
     if not local_port:
-        local_port = random.randint(1000, 9999)
+        local_port = random.randint(1000, 9999)  # noqa
 
     # Maybe we need to connect via RDS IAM instead!
     modified_dsn = dsnparse.parse(database_url)
@@ -154,15 +152,11 @@ def proxy(
 
     bastion_instance_id = bastion_instance_id or os.environ.get("GITOPS_BASTION_INSTANCE_ID")
     if not bastion_instance_id:
-        raise Exception(
-            "Please set GITOPS_BASTION_INSTANCE_ID environment variable for db proxy to work."
-        )
+        raise Exception("Please set GITOPS_BASTION_INSTANCE_ID environment variable for db proxy to work.")
 
     aws_availability_zone = aws_availability_zone or os.environ.get("GITOPS_AWS_AVAILABILITY_ZONE")
     if not aws_availability_zone:
-        raise Exception(
-            "Please set GITOPS_AWS_AVAILABILITY_ZONE environment variable for db proxy to work."
-        )
+        raise Exception("Please set GITOPS_AWS_AVAILABILITY_ZONE environment variable for db proxy to work.")
 
     print(progress(f"Creating a proxy to the RDS instance of: {app_name} "))
 
@@ -222,17 +216,10 @@ def logs(ctx, app_name, last=24):
         )
         for line in log_file["LogFileData"].split("\n"):
             if line:
-                try:
-                    print(
-                        str(
-                            datetime.datetime.fromisoformat(line[:19])
-                            .replace(tzinfo=datetime.timezone.utc)
-                            .astimezone()
-                        )
-                        + line[23:]
-                    )
-                except Exception:
-                    print(line)
+                print(
+                    str(datetime.datetime.fromisoformat(line[:19]).replace(tzinfo=datetime.timezone.utc).astimezone())
+                    + line[23:]
+                )
 
 
 @task

{gitops-0.9.22 → gitops-0.10.0}/gitops/shorthands.py

@@ -50,9 +50,7 @@ def shell_plus(ctx, app, cleanup=True, cpu=0, memory=0):
     app = get_app_details(app)
     if "production" in app.tags:
         confirm_dangerous_command()
-    asyncio.run(
-        run_job(app, f"{UNSAFE_MANAGE_PY} shell_plus", cleanup=cleanup, cpu=cpu, memory=memory)
-    )
+    asyncio.run(run_job(app, f"{UNSAFE_MANAGE_PY} shell_plus", cleanup=cleanup, cpu=cpu, memory=memory))
     print(success("Done!"))
 
 

{gitops-0.9.22 → gitops-0.10.0}/gitops/utils/__init__.py

@@ -9,9 +9,7 @@ CACHE = {}
 
 
 def gen_secret(length=64):
-    return "".join(
-        random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(length)
-    )
+    return "".join(random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(length))
 
 
 def get_account_id():

{gitops-0.9.22 → gitops-0.10.0}/gitops/utils/apps.py

@@ -1,6 +1,5 @@
-import os
+import sys
 from pathlib import PosixPath
-from typing import List, Union
 
 from colorama import Fore
 from tabulate import tabulate
@@ -11,7 +10,7 @@ from gitops.utils import yaml as yaml
 
 from . import get_account_id
 from .cli import colourise, confirm, warning
-from .exceptions import AppDoesNotExist, AppOperationAborted
+from .exceptions import AppDirectoryDoesNotExist, AppDoesNotExist, AppOperationAborted
 from .images import colour_image
 from .tags import colour_tags, validate_tags
 
@@ -22,7 +21,7 @@ def is_valid_app_directory(directory: PosixPath) -> bool:
     return all(file_paths)
 
 
-def get_app_details(app_name: str, load_secrets: bool = True) -> App:
+def get_app_details(app_name: str, load_secrets: bool = True, exit_if_not_found: bool = True) -> App:
     account_id = get_account_id() if load_secrets else "UNKNOWN"
     try:
         app = App(
@@ -31,19 +30,23 @@ def get_app_details(app_name: str, load_secrets: bool = True) -> App:
             load_secrets=load_secrets,
             account_id=account_id,
         )
-    except FileNotFoundError:
-        # Check if apps dir doesn't exist, or just that one app
-        if os.path.exists("apps"):
-            raise AppDoesNotExist(app_name)
+    except FileNotFoundError as e:
+        msg, exc = "", Exception
+        if get_apps_directory().exists():
+            msg, exc = f"There's no app with the name '{app_name}', silly.", AppDoesNotExist
         else:
-            raise AppDoesNotExist()
+            msg, exc = "Could not find an 'apps' directory. Are you in a cluster repo?", AppDirectoryDoesNotExist
+        if exit_if_not_found:
+            sys.exit(warning(msg))
+        else:
+            raise exc(msg) from e
 
     return app
 
 
 def update_app(app_name: str, **kwargs):
     filename = get_apps_directory() / app_name / "deployment.yml"
-    with open(filename, "r") as f:
+    with open(filename) as f:
         data = yaml.safe_load(f)
     for k, v in kwargs.items():
         if k not in DEPLOYMENT_ATTRIBUTES:
@@ -57,14 +60,14 @@ def update_app(app_name: str, **kwargs):
         yaml.dump(data, f, default_flow_style=False)
 
 
-def get_apps(
-    filter: Union[List[str], str] = "",
-    exclude: Union[List[str], str] = "",
+def get_apps(  # noqa: C901
+    filter: list[str] | str = "",
+    exclude: list[str] | str = "",
     mode="PROMPT",
     autoexclude_inactive=True,
     message=None,
     load_secrets=True,
-) -> List[App]:
+) -> list[App]:
     """Return apps that contain ALL of the tags listed in `filter` and NONE of the tags listed in
     `exclude`. The incoming filter and exclude params may come in as a list or commastring.
     For the purpose of this filtering, app names and image tag prefixes are also considered as
@@ -87,12 +90,12 @@ def get_apps(
         exclude.add("inactive")
 
     apps = []
-    existing_tags = set()
+    existing_tags = {"suspended", "inactive", "release", "qa", "no_shutdown"}
 
     try:
         directory = sorted(get_apps_directory().iterdir())
-    except FileNotFoundError:
-        raise AppDoesNotExist()
+    except FileNotFoundError as e:
+        raise AppDoesNotExist() from e
     for entry in directory:
         if not entry.is_dir():
             continue
@@ -125,7 +128,7 @@ def get_apps(
     return apps
 
 
-def preview_apps(apps: List[App]):
+def preview_apps(apps: list[App]):
     """Produce a summary of apps, their tags, and their expected images & replicas.
     May not necessarily reflect actual app statuses if recent changes haven't yet been pushed to
     the remote, or the deployment has failed.
@@ -134,7 +137,7 @@ def preview_apps(apps: List[App]):
     for app in apps:
         table.append(
             [
-                colourise(app.name, Fore.RED, lambda _: "inactive" in app.tags),
+                colourise(app.name, Fore.RED, lambda _: "inactive" in app.tags),  # noqa
                 colour_image(app.image_tag),
                 app.cluster,
                 colourise(

{gitops-0.9.22 → gitops-0.10.0}/gitops/utils/async_runner.py

@@ -76,18 +76,11 @@ async def print_async_complete(task, x, y, status_y_offset, win_info, sem):
 
 
 async def async_run(cmd):
-    proc = await asyncio.create_subprocess_shell(
-        cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE
-    )
+    proc = await asyncio.create_subprocess_shell(cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
 
     stdout, stderr = await proc.communicate()
     return (
         stdout,
         stderr,
-        (
-            success("[stdout]\n")
-            + f"{stdout.decode()}\n"
-            + warning("[stderr]\n")
-            + f"{stderr.decode()}\n"
-        ),
+        (success("[stdout]\n") + f"{stdout.decode()}\n" + warning("[stderr]\n") + f"{stderr.decode()}\n"),
     )

gitops-0.10.0/gitops/utils/exceptions.py

@@ -0,0 +1,14 @@
+class AppOperationAborted(Exception):
+    pass
+
+
+class AppDoesNotExist(Exception):
+    pass
+
+
+class AppDirectoryDoesNotExist(Exception):
+    pass
+
+
+class CommandError(Exception):
+    pass

{gitops-0.9.22 → gitops-0.10.0}/gitops/utils/images.py

@@ -29,9 +29,7 @@ def get_latest_image(repository_name: str, prefix: str) -> str:
     ):
         for image in ecr_response["imageDetails"]:
             if prefix != "":
-                if prefix_tags := [
-                    tag for tag in image["imageTags"] if tag.startswith(prefix + "-")
-                ]:
+                if prefix_tags := [tag for tag in image["imageTags"] if tag.startswith(prefix + "-")]:
                     results.append((prefix_tags[0], image["imagePushedAt"]))
             else:
                 if prefix_tags := [tag for tag in image["imageTags"] if "-" not in tag]:
@@ -69,4 +67,4 @@ def color_hash(bit):
         Fore.MAGENTA,
         Fore.CYAN,
         Fore.WHITE,
-    ][int.from_bytes(md5(bit.encode()).digest(), "big") % 7]
+    ][int.from_bytes(md5(bit.encode()).digest(), "big") % 7]  # noqa: S324

{gitops-0.9.22 → gitops-0.10.0}/gitops/utils/kube.py

@@ -12,7 +12,7 @@ from base64 import b64encode
 from contextlib import contextmanager
 from datetime import datetime
 from functools import wraps
-from typing import Dict, TypedDict
+from typing import TypedDict
 
 import boto3
 import humanize
@@ -105,7 +105,7 @@ def download_backup(product, prefix, index, path=None, datestamp=False):
 def copy_db(ctx, source, destination, context=""):
     """Copy database between two applications."""
     with tempfile.NamedTemporaryFile("wt", suffix=".yml") as tmp:
-        job = open("copy-db-job.yml", "r").read()
+        job = open("copy-db-job.yml").read()
         job = job.replace("{{ source }}", source)
         job = job.replace("{{ destination }}", destination)
         tmp.write(job)
@@ -125,9 +125,7 @@ def copy_db(ctx, source, destination, context=""):
         )
         print("done")
         run(
-            ("kubectl delete -n workforce job copy-db-{source}-{destination}").format(
-                source=source, destination=destination
-            ),
+            (f"kubectl delete -n workforce job copy-db-{source}-{destination}"),
             hide=True,
         )
 
@@ -140,7 +138,7 @@ def get_backups(product, prefix):
         name = obj.key.split("/")[-1].split(".")[0]
         if not name:
             continue
-        dt = datetime.strptime(name, "%Y-%m-%d_%H-%M-%S")
+        dt = datetime.strptime(name, "%Y-%m-%d_%H-%M-%S").astimezone(None)
         all_backups.append((name, dt, obj.size, obj.key))
     return sorted(all_backups, key=lambda x: x[1])
 
@@ -154,9 +152,9 @@ def get_backup_datestamp(url):
 def get_secret(name, base64=False):
     try:
         value = os.environ[name]
-    except KeyError:
+    except KeyError as e:
         msg = f"Variable {Fore.RED}{name}{Fore.RESET} missing from environment."
-        raise CommandError(msg)
+        raise CommandError(msg) from e
     if base64:
         value = b64encode(value.encode()).decode()
     else:
@@ -183,15 +181,13 @@ def run_wrapper(intro):
 
 def make_key(length=64):
     """Generate a sequence of random characters."""
-    return "".join(
-        random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(length)
-    )
+    return "".join(random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(length))
 
 
 def render_template(
     template: str,
-    values: Dict = None,
-    extra_labels: Dict = None,
+    values: dict = None,
+    extra_labels: dict = None,
     container_resources: ContainerResources = None,
 ) -> str:
     """Given a yaml of a K8s Job, replace template values and add extra labels to the pod spec"""
@@ -214,13 +210,13 @@ def render_template(
 
 async def _run_job(
     path,
-    values: Dict = None,
+    values: dict = None,
     context="",
     namespace="default",
     attach=False,
     cleanup=True,
     sequential=True,
-    extra_labels: Dict = None,
+    extra_labels: dict = None,
     container_resources: ContainerResources = None,
 ):
     name = values["name"]
@@ -228,7 +224,7 @@ async def _run_job(
     with tempfile.NamedTemporaryFile("wt", suffix=".yml") as tmp:
         # Generate yaml template to render
         rendered_template = render_template(
-            open(get_apps_directory() / ".." / path, "r").read(),
+            open(get_apps_directory() / ".." / path).read(),
             values,
             extra_labels,
             container_resources=container_resources,
@@ -293,20 +289,14 @@ async def _run_job(
 
 async def wait_for_pod(context, namespace, pod):
     while True:
-        cmd = (
-            "kubectl get pod"
-            f" --context {context}"
-            f" -n {namespace}"
-            ' -o jsonpath="{.status.phase}"'
-            f" {pod}"
-        )
+        cmd = "kubectl get pod" f" --context {context}" f" -n {namespace}" ' -o jsonpath="{.status.phase}"' f" {pod}"
         stdout, _, _ = await async_run(cmd)
         stdout = stdout.decode().lower()
         if stdout != "pending":
             return stdout
 
 
-def retry(*args, max_attempts=3, delay=1):
+def retry(*args, max_attempts=3, delay=1):  # noqa: C901
     """A decorator for retrying a function.
 
     After `max_attempts` failed attempts the last thrown exception

{gitops-0.9.22 → gitops-0.10.0}/pyproject.toml

@@ -1,15 +1,15 @@
 [tool.poetry]
 name = "gitops"
-version = "0.9.22"
+version = "0.10.0"
 description = "Manage multiple apps across one or more k8s clusters."
 authors = ["Jarek Głowacki <jarekwg@gmail.com>"]
 license = "BSD"
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.11"
 # CLI requirements
 invoke = "*"
-pyyaml = ">=5.1.2"
+pyyaml = ">=6.0.1"
 dsnparse = "*"
 colorama = "^0.4.4"
 boto3 = "*"
@@ -33,14 +33,14 @@ server = [
 ]
 
 [tool.poetry.dev-dependencies]
-#Flake 9 is flake 8 with pyproject support =_=.
+ruff = "^0.2.0"
 isort = "*"
 ipdb = "*"
 python-dotenv = "*"
 pytest = "*"
 requests = "^2.25.1"
 pre-commit = "^2.13.0"
-mypy = "^0.941"
+mypy = "^1.8.0"
 black = "*"
 pytest-asyncio = "^0.20.3"
 
@@ -56,12 +56,11 @@ gitops = 'gitops.main:program.run'
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-##### Tooling configuraiton
-[tool.black]
-line-length = 100
-target-version = ['py38']
-experimental_string_processing = true
-
-[tool.isort]
-profile = 'black'
-multi_line_output = 3
+[tool.nitpick]
+# Generated by the 'nitpick init' command
+# More info at https://nitpick.rtfd.io/en/latest/configuration.html
+style = [
+    'https://raw.githubusercontent.com/uptick/.github/main/nitpick/python.toml',
+    'py://nitpick/resources/any/commitizen',
+]
+cache = "never"

gitops-0.9.22/gitops/utils/exceptions.py

@@ -1,22 +0,0 @@
-import sys
-
-from .cli import warning
-
-
-class AppOperationAborted(Exception):
-    pass
-
-
-class AppDoesNotExist(Exception):
-    def __init__(self, app_name=None):
-        # Funky hack to stomp on traceback.
-        if app_name:
-            message = f"There's no app with the name '{app_name}', silly."
-        else:
-            message = "Could not find an 'apps' directory. Are you in a cluster repo?"
-        self.args = (warning(message),)
-        sys.exit(self)
-
-
-class CommandError(Exception):
-    pass