qontract-reconcile 0.10.2.dev314__tar.gz → 0.10.2.dev316__tar.gz

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qontract-reconcile
-Version: 0.10.2.dev314
+Version: 0.10.2.dev316
 Summary: Collection of tools to reconcile services with their desired state as defined in the app-interface DB.
 Project-URL: homepage, https://github.com/app-sre/qontract-reconcile
 Project-URL: repository, https://github.com/app-sre/qontract-reconcile

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/pyproject.toml

@@ -262,26 +262,11 @@ disallow_incomplete_defs = true
 [[tool.mypy.overrides]]
 # Untyped modules
 module = [
-    "reconcile.requests_sender",
-    "reconcile.sendgrid_teammates",
-    "reconcile.status_page_components",
-    "reconcile.status",
-    "reconcile.template_tester",
-    "reconcile.terraform_aws_route53",
-    "reconcile.terraform_cloudflare_resources",
-    "reconcile.terraform_users",
     "reconcile.utils.gpg",
     "reconcile.utils.imap_client",
     "reconcile.utils.jjb_client",
     "reconcile.utils.ldap_client",
     "reconcile.utils.lean_terraform_client",
-    "reconcile.utils.mr.app_interface_reporter",
-    "reconcile.utils.mr.aws_access",
-    "reconcile.utils.mr.base",
-    "reconcile.utils.mr.clusters_updates",
-    "reconcile.utils.mr.ocm_upgrade_scheduler_org_updates",
-    "reconcile.utils.mr.user_maintenance",
-    "reconcile.utils.mr",
     "reconcile.utils.oc",
     "reconcile.utils.ocm_base_client",
     "reconcile.utils.ocm.ocm",
@@ -326,16 +311,13 @@ module = [
     "reconcile.test.test_openshift_saas_deploy",
     "reconcile.test.test_openshift_upgrade_watcher",
     "reconcile.test.test_prometheus_rules_tester",
-    "reconcile.test.test_requests_sender",
     "reconcile.test.test_saasherder_allowed_secret_paths",
     "reconcile.test.test_secret_reader",
     "reconcile.test.test_slack_base",
     "reconcile.test.test_slack_usergroups",
     "reconcile.test.test_terraform_cloudflare_dns",
-    "reconcile.test.test_terraform_cloudflare_resources",
     "reconcile.test.test_terraform_repo",
     "reconcile.test.test_terraform_resources",
-    "reconcile.test.test_terraform_users",
     "reconcile.test.test_three_way_diff_strategy",
     "reconcile.test.test_typed_queries.conftest",
     "reconcile.test.test_typed_queries.test_clusters_with_peering",
@@ -350,8 +332,6 @@ module = [
     "reconcile.test.utils.test_jjb_client",
     "reconcile.test.utils.test_jsonpath",
     "reconcile.test.utils.test_models",
-    "reconcile.test.utils.test_mr_clusters_updates",
-    "reconcile.test.utils.test_mr",
     "reconcile.test.utils.test_oc",
     "reconcile.test.utils.test_ocm",
     "reconcile.test.utils.test_parse_dhms_duration",

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/requests_sender.py

@@ -1,6 +1,8 @@
 import logging
 import sys
+from collections.abc import Callable, Mapping
 from subprocess import CalledProcessError
+from typing import Any
 
 from reconcile import (
     queries,
@@ -44,7 +46,9 @@ Encrypted credentials:
 """
 
 
-def get_encrypted_credentials(credentials_name, user, settings):
+def get_encrypted_credentials(
+    credentials_name: str, user: Mapping[str, Any], settings: Mapping[str, Any]
+) -> str | None:
     credentials_map = settings["credentials"]
     credentials_map_item = [c for c in credentials_map if c["name"] == credentials_name]
     if len(credentials_map_item) != 1:
@@ -59,7 +63,7 @@ def get_encrypted_credentials(credentials_name, user, settings):
 
 
 @defer
-def run(dry_run, defer=None):
+def run(dry_run: bool, defer: Callable | None = None) -> None:
     settings = queries.get_app_interface_settings()
     vault_settings = get_app_interface_vault_settings()
     secret_reader = create_secret_reader(use_vault=vault_settings.vault)
@@ -76,7 +80,8 @@ def run(dry_run, defer=None):
         integration=QONTRACT_INTEGRATION,
         secret_reader=secret_reader,
     )
-    defer(state.cleanup)
+    if defer:
+        defer(state.cleanup)
     credentials_requests = queries.get_credentials_requests()
 
     # validate no 2 requests have the same name

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/sendgrid_teammates.py

@@ -1,5 +1,7 @@
 import logging
 import sys
+from collections.abc import Iterable, Mapping
+from typing import Any
 
 import sendgrid
 from sretoolbox.utils import retry
@@ -17,18 +19,22 @@ class SendGridAPIError(Exception):
 
 
 class Teammate:
-    def __init__(self, email, pending_token=None, username=None):
+    def __init__(
+        self, email: str, pending_token: str | None = None, username: str | None = None
+    ) -> None:
         self.email = email
-        self.username = username or email.split("@")[0]
+        self.username = username or email.split("@", maxsplit=1)[0]
         self.pending_token = pending_token
 
     @property
-    def pending(self):
+    def pending(self) -> bool:
         return bool(self.pending_token)
 
 
-def fetch_desired_state(users):
-    desired_state = {}
+def fetch_desired_state(
+    users: Iterable[Mapping[str, Any]],
+) -> dict[str, list[Teammate]]:
+    desired_state: dict[str, list[Teammate]] = {}
     for user in users:
         roles = user.get("roles") or []
         for role in roles:
@@ -42,7 +48,7 @@ def fetch_desired_state(users):
 
 
 @retry()
-def fetch_current_state(sg_client):
+def fetch_current_state(sg_client: sendgrid.SendGridAPIClient) -> list[Teammate]:
     state = []
     limit = 100
 
@@ -79,7 +85,7 @@ def fetch_current_state(sg_client):
     return state
 
 
-def raise_if_error(response):
+def raise_if_error(response: Any) -> None:
     """
     Raises an SendGridAPIError if the request has returned an error
     """
@@ -87,7 +93,12 @@ def raise_if_error(response):
         raise SendGridAPIError(response.body.decode("utf-8"))
 
 
-def act(dry_run, sg_client, desired_state, current_state):
+def act(
+    dry_run: bool,
+    sg_client: sendgrid.SendGridAPIClient,
+    desired_state: Iterable[Teammate],
+    current_state: Iterable[Teammate],
+) -> bool:
     """
     Reconciles current state with desired state.
 
@@ -145,7 +156,7 @@ def act(dry_run, sg_client, desired_state, current_state):
     return error
 
 
-def run(dry_run):
+def run(dry_run: bool) -> None:
     settings = queries.get_app_interface_settings()
     secret_reader = SecretReader(settings=settings)
 

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/status.py

@@ -11,7 +11,7 @@ class ExitCodes:
 class _RunningState:
     _state: dict[Any, Any] = {}
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.__dict__ = self._state
 
 
@@ -22,7 +22,7 @@ class RunningState(_RunningState):
     by the callers.
     """
 
-    def __getattr__(self, item):
+    def __getattr__(self, item: str) -> None:
         """
         Default value for attributes not explicitly created is None.
         """

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/terraform_aws_route53.py

@@ -1,6 +1,7 @@
 import logging
 import sys
 from collections.abc import (
+    Callable,
     Iterable,
     Mapping,
 )
@@ -25,8 +26,10 @@ QONTRACT_INTEGRATION_VERSION = make_semver(0, 1, 0)
 
 
 def build_desired_state(
-    zones: Iterable[Mapping], all_accounts: Iterable[Mapping], settings: Mapping
-) -> list[dict]:
+    zones: Iterable[Mapping[str, Any]],
+    all_accounts: Iterable[Mapping[str, Any]],
+    settings: Mapping[str, Any],
+) -> list[dict[str, Any]]:
     """
     Build the desired state from the app-interface resources
 
@@ -36,7 +39,7 @@ def build_desired_state(
     :rtype: list of dict
     """
 
-    desired_state = []
+    desired_state: list[dict[str, Any]] = []
     for zone in zones:
         account = zone["account"]
         account_name = account["name"]
@@ -208,8 +211,8 @@ def run(
     enable_deletion: bool = True,
     thread_pool_size: int = DEFAULT_THREAD_POOL_SIZE,
     account_name: str | None = None,
-    defer=None,
-):
+    defer: Callable | None = None,
+) -> None:
     settings = queries.get_app_interface_settings()
     zones = queries.get_dns_zones(account_name=account_name)
 
@@ -255,7 +258,8 @@ def run(
     if tf is None:
         sys.exit(ExitCodes.ERROR)
 
-    defer(tf.cleanup)
+    if defer:
+        defer(tf.cleanup)
 
     _, err = tf.plan(enable_deletion)
     if err:
@@ -269,7 +273,7 @@ def run(
         sys.exit(ExitCodes.ERROR)
 
 
-def early_exit_desired_state(*args, **kwargs) -> dict[str, Any]:
+def early_exit_desired_state(*args: Any, **kwargs: Any) -> dict[str, Any]:
     return {
         "zones": queries.get_dns_zones(),
     }

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/terraform_cloudflare_resources.py

@@ -1,6 +1,6 @@
 import logging
 import sys
-from collections.abc import Iterable
+from collections.abc import Callable, Iterable
 from typing import (
     Any,
     cast,
@@ -193,7 +193,7 @@ def _populate_oc_resources(
     spec: CurrentStateSpec,
     ri: ResourceInventory,
     account_names: Iterable[str] | None,
-):
+) -> None:
     """
     This was taken from terraform_resources and might be a later candidate for DRY.
     """
@@ -315,7 +315,7 @@ def run(
     vault_output_path: str = "",
     internal: bool | None = None,
     use_jump_host: bool = True,
-    defer=None,
+    defer: Callable | None = None,
 ) -> None:
     vault_settings = get_app_interface_vault_settings()
     secret_reader = create_secret_reader(use_vault=vault_settings.vault)
@@ -392,7 +392,8 @@ def run(
         working_dirs,
         thread_pool_size,
     )
-    defer(tf.cleanup)
+    if defer:
+        defer(tf.cleanup)
 
     disabled_deletions_detected, err = tf.plan(enable_deletion)
     if err:
@@ -440,7 +441,7 @@ def _get_cloudflare_desired_state() -> tuple[
     return query_accounts, query_resources
 
 
-def early_exit_desired_state(*args, **kwargs) -> dict[str, Any]:
+def early_exit_desired_state(*args: Any, **kwargs: Any) -> dict[str, Any]:
     desired_state = _get_cloudflare_desired_state()
 
     return {state.__repr_name__(): state.dict() for state in desired_state}

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/terraform_users.py

@@ -1,4 +1,5 @@
 import sys
+from collections.abc import Iterable, Mapping
 from textwrap import indent
 from typing import (
     Any,
@@ -95,9 +96,9 @@ def get_tf_roles() -> list[Role]:
 
 
 def _filter_participating_aws_accounts(
-    accounts: list,
-    roles: list[dict[str, Any]],
-) -> list:
+    accounts: Iterable[dict[str, Any]],
+    roles: Iterable[Mapping[str, Any]],
+) -> list[dict[str, Any]]:
     participating_aws_account_names: set[str] = set()
     for role in roles:
         participating_aws_account_names.update(
@@ -111,7 +112,7 @@ def _filter_participating_aws_accounts(
 
 
 def setup(
-    print_to_file,
+    print_to_file: str | None,
     thread_pool_size: int,
     skip_reencrypt_accounts: list[str],
     appsre_pgp_key: str | None = None,
@@ -146,10 +147,10 @@ def setup(
 
 
 def send_email_invites(
-    new_users,
+    new_users: Iterable[tuple[str, str, str, str]],
     smtp_client: SmtpClient,
-    skip_reencrypt_accounts: list[str],
-):
+    skip_reencrypt_accounts: Iterable[str],
+) -> None:
     msg_template = """
 You have been invited to join the {} AWS account!
 Below you will find credentials for the first sign in.
@@ -189,9 +190,9 @@ Encrypted password: {}
 def write_user_to_vault(
     vault_client: _VaultClient,
     vault_path: str,
-    new_users: list[tuple[str, str, str, str]],
-    skip_reencrypt_accounts: list[str],
-):
+    new_users: Iterable[tuple[str, str, str, str]],
+    skip_reencrypt_accounts: Iterable[str],
+) -> None:
     for account, console_url, user_name, enc_password in new_users:
         if account in skip_reencrypt_accounts:
             continue
@@ -208,13 +209,13 @@ def write_user_to_vault(
         vault_client.write(desired_secret, decode_base64=False)
 
 
-def cleanup_and_exit(tf=None, status=False):
+def cleanup_and_exit(tf: Terraform | None = None, status: bool = False) -> None:
     if tf is not None:
         tf.cleanup()
     sys.exit(status)
 
 
-def get_reencrypt_settings():
+def get_reencrypt_settings() -> tuple[list[str], str | None, Any]:
     all_reencrypt_settings = query(
         query_func=gql.get_api().query
     ).pgp_reencryption_settings
@@ -243,7 +244,7 @@ def run(
     thread_pool_size: int = DEFAULT_THREAD_POOL_SIZE,
     send_mails: bool = True,
     account_name: str | None = None,
-):
+) -> None:
     skip_accounts, appsre_pgp_key, reencrypt_settings = get_reencrypt_settings()
 
     # setup errors should skip resources that will lead
@@ -319,7 +320,7 @@ def run(
     cleanup_and_exit(tf, setup_err)
 
 
-def early_exit_desired_state(*args, **kwargs) -> dict[str, Any]:
+def early_exit_desired_state(*args: Any, **kwargs: Any) -> dict[str, Any]:
     """
     Finding diffs in deeply nested structures is time/resource consuming.
     Having a unique known property to identify objects makes it easier to match
@@ -330,11 +331,11 @@ def early_exit_desired_state(*args, **kwargs) -> dict[str, Any]:
     for the DeepDiff library used in qontract-reconcile.
     """
 
-    def add_account_identity(acc):
+    def add_account_identity(acc: dict[str, Any]) -> dict[str, Any]:
         acc[IDENTIFIER_FIELD_NAME] = acc["path"]
         return acc
 
-    def add_role_identity(role):
+    def add_role_identity(role: dict[str, Any]) -> dict[str, Any]:
         role[IDENTIFIER_FIELD_NAME] = role["name"]
         return role
 

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/__init__.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from reconcile.utils.mr.app_interface_reporter import CreateAppInterfaceReporter
 from reconcile.utils.mr.aws_access import CreateDeleteAwsAccessKey
 from reconcile.utils.mr.base import (
@@ -44,7 +46,7 @@ class UnknownMergeRequestTypeError(Exception):
     """
 
 
-def init_from_sqs_message(message) -> MergeRequestBase:
+def init_from_sqs_message(message: dict[str, Any]) -> MergeRequestBase:
     # First, let's find the classes that are inheriting from
     # MergeRequestBase and create a map where the class.name is
     # the key and the class itself is the value.

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/app_interface_reporter.py

@@ -1,3 +1,4 @@
+from collections.abc import Iterable
 from datetime import datetime
 from pathlib import Path
 
@@ -14,7 +15,9 @@ from reconcile.utils.mr.labels import AUTO_MERGE
 class CreateAppInterfaceReporter(MergeRequestBase):
     name = "create_app_interface_reporter_mr"
 
-    def __init__(self, reports, email_body, reports_path):
+    def __init__(
+        self, reports: Iterable[dict[str, str]], email_body: str, reports_path: str
+    ) -> None:
         self.reports = reports
         self.email_body = email_body
         self.reports_path = reports_path

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/aws_access.py

@@ -18,7 +18,7 @@ BODY_TEMPLATE = PROJ_ROOT / "templates" / "aws_access_key_email.j2"
 class CreateDeleteAwsAccessKey(MergeRequestBase):
     name = "create_delete_aws_access_key_mr"
 
-    def __init__(self, account, path, key):
+    def __init__(self, account: str, path: str, key: str):
         self.account = account
         self.path = path.lstrip("/")
         self.key = key

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/base.py

@@ -45,14 +45,14 @@ class MergeRequestBase(ABC):
 
     name = "merge-request-base"
 
-    def __init__(self):
+    def __init__(self) -> None:
         # Let's first get all the attributes from the instance
         # and use for the SQS Msg payload. With that, the msg
         # to the SQS is enough to create a new, similar, instance
         # of the child class.
         self.sqs_msg_data = {**self.__dict__}
 
-        self.labels = [DO_NOT_MERGE_HOLD]
+        self.labels: Iterable[str] = [DO_NOT_MERGE_HOLD]
 
         random_id = str(uuid4())[:6]
         self.branch = f"{self.name}-{random_id}"

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/clusters_updates.py

@@ -1,4 +1,6 @@
+from collections.abc import Mapping
 from io import StringIO
+from typing import Any
 
 from ruamel.yaml import YAML
 
@@ -15,7 +17,7 @@ yaml.width = 4096
 class CreateClustersUpdates(MergeRequestBase):
     name = "create_clusters_updates_mr"
 
-    def __init__(self, clusters_updates):
+    def __init__(self, clusters_updates: Mapping[str, dict[str, Any]]):
         self.clusters_updates = clusters_updates
 
         super().__init__()
@@ -30,7 +32,7 @@ class CreateClustersUpdates(MergeRequestBase):
     def description(self) -> str:
         return DecisionCommand.APPROVED.value
 
-    def process(self, gitlab_cli: GitLabApi):
+    def process(self, gitlab_cli: GitLabApi) -> None:
         changes = False
         for cluster_name, cluster_updates in self.clusters_updates.items():
             if not cluster_updates:

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/ocm_upgrade_scheduler_org_updates.py

@@ -1,3 +1,6 @@
+from collections.abc import Mapping
+from typing import Any
+
 from ruamel import yaml
 
 from reconcile.utils.gitlab_api import GitLabApi
@@ -8,7 +11,7 @@ from reconcile.utils.mr.labels import AUTO_MERGE
 class CreateOCMUpgradeSchedulerOrgUpdates(MergeRequestBase):
     name = "create_ocm_upgrade_scheduler_org_updates_mr"
 
-    def __init__(self, updates_info):
+    def __init__(self, updates_info: Mapping[str, Any]):
         self.updates_info = updates_info
 
         super().__init__()

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/reconcile/utils/mr/user_maintenance.py

@@ -24,14 +24,14 @@ class PathSpec(BaseModel):
     path: str
 
     @validator("path")
-    def prepend_data_to_path(cls, v):
+    def prepend_data_to_path(cls, v: str) -> str:
         return "data" + v
 
 
 class CreateDeleteUserAppInterface(MergeRequestBase):
     name = "create_delete_user_mr"
 
-    def __init__(self, username, paths: Iterable[PathSpec]):
+    def __init__(self, username: str, paths: Iterable[PathSpec]) -> None:
         self.username = username
         self.paths = paths
 
@@ -120,7 +120,7 @@ class CreateDeleteUserInfra(MergeRequestBase):
 
     name = "create_ssh_key_mr"
 
-    def __init__(self, usernames):
+    def __init__(self, usernames: Iterable[str]):
         self.usernames = usernames
 
         super().__init__()
@@ -135,7 +135,7 @@ class CreateDeleteUserInfra(MergeRequestBase):
     def description(self) -> str:
         return "delete user(s)"
 
-    def process(self, gitlab_cli):
+    def process(self, gitlab_cli: GitLabApi) -> None:
         raw_file = gitlab_cli.get_raw_file(
             project=gitlab_cli.project,
             path=self.PLAYBOOK,

{qontract_reconcile-0.10.2.dev314 → qontract_reconcile-0.10.2.dev316}/tools/qontract_cli.py

@@ -1299,7 +1299,7 @@ def user_credentials_migrate_output(ctx: click.Context, account_name: str) -> No
     skip_accounts, appsre_pgp_key, _ = tfu.get_reencrypt_settings()
 
     accounts, working_dirs, _, aws_api = tfu.setup(
-        False,
+        None,
         1,
         skip_accounts,
         account_name=account_name,