qontract-reconcile 0.10.1rc879__py3-none-any.whl → 0.10.1rc894__py3-none-any.whl

reconcile/utils/secret_reader.py

@@ -5,9 +5,7 @@ from abc import (
 from collections.abc import Mapping
 from typing import (
     Any,
-    Optional,
     Protocol,
-    Union,
     runtime_checkable,
 )
 
@@ -37,20 +35,20 @@ class HasSecret(Protocol):
 
     path: str
     field: str
-    version: Optional[int]
-    q_format: Optional[str]
+    version: int | None
+    q_format: str | None
 
 
 class SecretReaderBase(ABC):
     @abstractmethod
     def _read(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> str:
         raise NotImplementedError()
 
     @abstractmethod
     def _read_all(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> dict[str, str]:
         raise NotImplementedError()
 
@@ -97,7 +95,7 @@ class SecretReaderBase(ABC):
         )
 
     def read_with_parameters(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> str:
         return self._read(
             path=path,
@@ -107,7 +105,7 @@ class SecretReaderBase(ABC):
         )
 
     def read_all_with_parameters(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> dict[str, str]:
         return self._read_all(
             path=path,
@@ -117,7 +115,7 @@ class SecretReaderBase(ABC):
         )
 
     def _parameters_to_dict(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> dict[str, Any]:
         return {
             "path": path,
@@ -127,7 +125,7 @@ class SecretReaderBase(ABC):
         }
 
     @staticmethod
-    def to_dict(secret: HasSecret) -> dict[str, Union[str, int, None]]:
+    def to_dict(secret: HasSecret) -> dict[str, str | int | None]:
         """Convenient method to convert Secret class to dictionary."""
         return {
             "path": secret.path,
@@ -142,7 +140,7 @@ class VaultSecretReader(SecretReaderBase):
     Read secrets from vault via a vault_client
     """
 
-    def __init__(self, vault_client: Optional[VaultClient] = None):
+    def __init__(self, vault_client: VaultClient | None = None):
         self._vault_client = vault_client
 
     @property
@@ -152,7 +150,7 @@ class VaultSecretReader(SecretReaderBase):
         return self._vault_client
 
     def _read_all(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> dict[str, str]:
         try:
             data = self.vault_client.read_all(  # type: ignore[attr-defined] # mypy doesn't recognize the VaultClient.__new__ method
@@ -172,7 +170,7 @@ class VaultSecretReader(SecretReaderBase):
         return data
 
     def _read(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> str:
         try:
             data = self.vault_client.read(  # type: ignore[attr-defined] # mypy doesn't recognize the VaultClient.__new__ method
@@ -194,7 +192,7 @@ class ConfigSecretReader(SecretReaderBase):
     """
 
     def _read(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> str:
         try:
             data = config.read(
@@ -210,7 +208,7 @@ class ConfigSecretReader(SecretReaderBase):
         return data
 
     def _read_all(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> dict[str, str]:
         try:
             data = config.read_all(
@@ -242,13 +240,13 @@ class SecretReader(SecretReaderBase):
     Consider using create_secret_reader() instead.
     """
 
-    def __init__(self, settings: Optional[Mapping] = None) -> None:
+    def __init__(self, settings: Mapping | None = None) -> None:
         """
         :param settings: app-interface-settings object. It is a dictionary
         containing `value: true` if Vault is to be used as the secret backend.
         """
         self.settings = settings
-        self._vault_client: Optional[VaultClient] = None
+        self._vault_client: VaultClient | None = None
 
     @property
     def vault_client(self) -> VaultClient:
@@ -257,7 +255,7 @@ class SecretReader(SecretReaderBase):
         return self._vault_client
 
     def _read(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> str:
         """Returns a value of a key from Vault secret or configuration file.
         The input secret is a dictionary which contains the following fields:
@@ -292,7 +290,7 @@ class SecretReader(SecretReaderBase):
         return data
 
     def _read_all(
-        self, path: str, field: str, format: Optional[str], version: Optional[int]
+        self, path: str, field: str, format: str | None, version: int | None
     ) -> dict[str, str]:
         """Returns a dictionary of keys and values
         from Vault secret or configuration file.

reconcile/utils/slack_api.py

@@ -9,9 +9,7 @@ from collections.abc import (
 )
 from typing import (
     Any,
-    Optional,
     Protocol,
-    Union,
 )
 
 from slack_sdk import WebClient
@@ -46,17 +44,17 @@ class ServerErrorRetryHandler(RetryHandler):
         *,
         state: RetryState,
         request: HttpRequest,
-        response: Optional[HttpResponse] = None,
-        error: Optional[Exception] = None,
+        response: HttpResponse | None = None,
+        error: Exception | None = None,
     ) -> bool:
         return response is not None and response.status_code >= 500
 
 
 class HasClientGlobalConfig(Protocol):
-    max_retries: Optional[int]
-    timeout: Optional[int]
+    max_retries: int | None
+    timeout: int | None
 
-    def dict(self) -> dict[str, Optional[int]]: ...
+    def dict(self) -> dict[str, int | None]: ...
 
 
 class HasClientMethodConfig(Protocol):
@@ -68,10 +66,10 @@ class HasClientMethodConfig(Protocol):
 
 class HasClientConfig(Protocol):
     @property
-    def q_global(self) -> Optional[HasClientGlobalConfig]: ...
+    def q_global(self) -> HasClientGlobalConfig | None: ...
 
     @property
-    def methods(self) -> Optional[Sequence[HasClientMethodConfig]]: ...
+    def methods(self) -> Sequence[HasClientMethodConfig] | None: ...
 
 
 class SlackApiConfig:
@@ -95,7 +93,7 @@ class SlackApiConfig:
         """
         self._methods[method_name] = method_config
 
-    def get_method_config(self, method_name: str) -> Optional[dict[str, Any]]:
+    def get_method_config(self, method_name: str) -> dict[str, Any] | None:
         """
         Get Slack method configuration.
         :param method_name: the name of a method (ex. users.list)
@@ -165,10 +163,10 @@ class SlackApi:
         self,
         workspace_name: str,
         token: str,
-        api_config: Optional[SlackApiConfig] = None,
+        api_config: SlackApiConfig | None = None,
         init_usergroups: bool = True,
-        channel: Optional[str] = None,
-        slack_url: Optional[str] = None,
+        channel: str | None = None,
+        slack_url: str | None = None,
         **chat_kwargs: Any,
     ) -> None:
         """
@@ -295,7 +293,7 @@ class SlackApi:
         if not info.data["channel"]["is_member"]:  # type: ignore[call-overload]
             self._sc.conversations_join(channel=channel_id)
 
-    def get_usergroup_id(self, handle: str) -> Optional[str]:
+    def get_usergroup_id(self, handle: str) -> str | None:
         try:
             return self.get_usergroup(handle)["id"]
         except UsergroupNotFoundException:
@@ -449,7 +447,7 @@ class SlackApi:
         result_key = "members" if resource == "users" else resource
         api_key = "conversations" if resource == "channels" else resource
         results = {}
-        additional_kwargs: dict[str, Union[str, int]] = {"cursor": ""}
+        additional_kwargs: dict[str, str | int] = {"cursor": ""}
 
         method_config = self.config.get_method_config(f"{api_key}.list")
         if method_config:
@@ -459,7 +457,7 @@ class SlackApi:
             slack_request.labels(f"{api_key}.list", "GET").inc()
 
             result = self._sc.api_call(
-                "{}.list".format(api_key), http_verb="GET", params=additional_kwargs
+                f"{api_key}.list", http_verb="GET", params=additional_kwargs
             )
 
             for r in result[result_key]:
@@ -487,7 +485,7 @@ class SlackApi:
         return self._enterprise_user_id_to_user_ids.get(user_id, user_id)
 
     def get_flat_conversation_history(
-        self, from_timestamp: int, to_timestamp: Optional[int]
+        self, from_timestamp: int, to_timestamp: int | None
     ) -> list[dict[str, Any]]:
         """Calls conversation_history method to get all messages in a channel between
         from_timestamp to to_timestamp ignoring threads"""

reconcile/utils/smtp_client.py

@@ -4,7 +4,6 @@ from email.header import Header
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from email.utils import formataddr
-from typing import Optional
 
 from pydantic import (
     BaseModel,
@@ -54,7 +53,7 @@ class SmtpClient:
         self.passwd = server.password
         self.mail_address = mail_address
         self.timeout = timeout
-        self._client: Optional[smtplib.SMTP] = None
+        self._client: smtplib.SMTP | None = None
 
     @property
     def client(self) -> smtplib.SMTP:

reconcile/utils/sqs_gateway.py

@@ -46,9 +46,7 @@ class SQSGateway:
             a["name"] for a in accounts if a["uid"] == queue_account_uid
         ]
         if len(queue_account_name) != 1:
-            raise SQSGatewayInitError(
-                "account uid not found: {}".format(queue_account_uid)
-            )
+            raise SQSGatewayInitError(f"account uid not found: {queue_account_uid}")
         return queue_account_name[0]
 
     def send_message(self, body):

reconcile/utils/state.py

@@ -8,7 +8,6 @@ from dataclasses import dataclass, field
 from typing import (
     TYPE_CHECKING,
     Any,
-    Optional,
     Self,
 )
 
@@ -46,7 +45,7 @@ class StateInaccessibleException(Exception):
 
 def init_state(
     integration: str,
-    secret_reader: Optional[SecretReaderBase] = None,
+    secret_reader: SecretReaderBase | None = None,
 ) -> "State":
     if not secret_reader:
         vault_settings = get_app_interface_vault_settings()

reconcile/utils/terraform/config_client.py

@@ -4,7 +4,6 @@ from abc import (
     abstractmethod,
 )
 from collections.abc import Iterable
-from typing import Optional
 
 from reconcile.utils.exceptions import PrintToFileInGitRepositoryError
 from reconcile.utils.external_resource_spec import (
@@ -34,7 +33,7 @@ class TerraformConfigClient(ABC):
     @abstractmethod
     def dump(
         self,
-        existing_dir: Optional[str] = None,
+        existing_dir: str | None = None,
     ) -> str:
         """Dump the Terraform JSON configuration to the filesystem."""
 
@@ -65,7 +64,7 @@ class TerraformConfigClientCollection:
     def add_specs(
         self,
         specs: Iterable[ExternalResourceSpec],
-        account_filter: Optional[str] = None,
+        account_filter: str | None = None,
     ) -> None:
         """
         Add external resource specs
@@ -94,8 +93,8 @@ class TerraformConfigClientCollection:
 
     def dump(
         self,
-        print_to_file: Optional[str] = None,
-        existing_dirs: Optional[dict[str, str]] = None,
+        print_to_file: str | None = None,
+        existing_dirs: dict[str, str] | None = None,
     ) -> dict[str, str]:
         """
         Dump the Terraform JSON config to the filesystem.

reconcile/utils/terraform_client.py

@@ -20,7 +20,6 @@ from threading import Lock
 from typing import (
     IO,
     Any,
-    Optional,
     cast,
 )
 
@@ -81,7 +80,7 @@ class TerraformClient:  # pylint: disable=too-many-public-methods
         accounts: Iterable[Mapping[str, Any]],
         working_dirs: Mapping[str, str],
         thread_pool_size: int,
-        aws_api: Optional[AWSApi] = None,
+        aws_api: AWSApi | None = None,
         init_users=False,
     ):
         self.integration = integration
@@ -209,6 +208,15 @@ class TerraformClient:  # pylint: disable=too-many-public-methods
             self.created_users.extend(created_users)
         return disabled_deletions_detected, errors
 
+    def safe_plan(self, enable_deletion: bool) -> None:
+        """Raises exception if errors are detected at plan step"""
+        disable_deletions_detected, errors = self.plan(enable_deletion)
+
+        if errors:
+            raise RuntimeError("Terraform plan has errors")
+        if disable_deletions_detected:
+            raise RuntimeError("Terraform plan has disabled deletions detected")
+
     @retry()
     def terraform_plan(
         self, spec: TerraformSpec, enable_deletion: bool
@@ -463,12 +471,8 @@ class TerraformClient:  # pylint: disable=too-many-public-methods
         if output is None:
             return data
 
-        enc_pass_pfx = "{}_{}".format(
-            self.integration_prefix, self.OUTPUT_TYPE_PASSWORDS
-        )
-        console_urls_pfx = "{}_{}".format(
-            self.integration_prefix, self.OUTPUT_TYPE_CONSOLEURLS
-        )
+        enc_pass_pfx = f"{self.integration_prefix}_{self.OUTPUT_TYPE_PASSWORDS}"
+        console_urls_pfx = f"{self.integration_prefix}_{self.OUTPUT_TYPE_CONSOLEURLS}"
         for k, v in output.items():
             # the integration creates outputs of the form
             # 0.11: output_secret_name[secret_key] = secret_value

reconcile/utils/terrascript/cloudflare_client.py

@@ -5,10 +5,6 @@ from abc import (
 )
 from collections.abc import Iterable
 from dataclasses import dataclass
-from typing import (
-    Optional,
-    Union,
-)
 
 from terrascript import (
     Backend,
@@ -175,7 +171,7 @@ class TerrascriptCloudflareClient(TerraformConfigClient):
             resources_to_add = create_cloudflare_terrascript_resource(spec)
             self._add_resources(resources_to_add)
 
-    def dump(self, existing_dir: Optional[str] = None) -> str:
+    def dump(self, existing_dir: str | None = None) -> str:
         """Write the Terraform JSON representation of the resources to disk"""
         if existing_dir is None:
             working_dir = tempfile.mkdtemp(prefix=TMP_DIR_PREFIX)
@@ -192,9 +188,7 @@ class TerrascriptCloudflareClient(TerraformConfigClient):
         """Return the Terraform JSON representation of the resources"""
         return str(self._terrascript)
 
-    def _add_resources(
-        self, tf_resources: Iterable[Union[Resource, Output, Data]]
-    ) -> None:
+    def _add_resources(self, tf_resources: Iterable[Resource | Output | Data]) -> None:
         for resource in tf_resources:
             self._terrascript.add(resource)
 
@@ -277,7 +271,7 @@ class TerrascriptCloudflareClientFactory:
         cls,
         tf_state_s3: TerraformStateS3,
         cf_acct: CloudflareAccount,
-        sharding_strategy: Optional[TerraformS3StateNamingStrategy],
+        sharding_strategy: TerraformS3StateNamingStrategy | None,
         secret_reader: SecretReaderBase,
         is_managed_account: bool,
         provider_rps: int = DEFAULT_PROVIDER_RPS,
@@ -300,7 +294,7 @@ class TerrascriptCloudflareClientFactory:
 
 def _get_terraform_s3_state_key_name(
     integration: Integration,
-    sharding_strategy: Optional[TerraformS3StateNamingStrategy],
+    sharding_strategy: TerraformS3StateNamingStrategy | None,
 ) -> str:
     if sharding_strategy is None:
         sharding_strategy = Default()

reconcile/utils/terrascript/cloudflare_resources.py

@@ -2,10 +2,7 @@ from collections.abc import (
     Iterable,
     MutableMapping,
 )
-from typing import (
-    Any,
-    Union,
-)
+from typing import Any
 
 from terrascript import (
     Data,
@@ -90,7 +87,7 @@ class cloudflare_account_roles(Data):
 # TODO: rename to include object?
 def create_cloudflare_terrascript_resource(
     spec: ExternalResourceSpec,
-) -> list[Union[Resource, Output, Data]]:
+) -> list[Resource | Output | Data]:
     """
     Create the required Cloudflare Terrascript resources as defined by the external
     resources spec.
@@ -117,7 +114,7 @@ def create_cloudflare_terrascript_resource(
 class CloudflareWorkerScriptTerrascriptResource(TerrascriptResource):
     """Generate a cloudflare_worker_script resource"""
 
-    def populate(self) -> list[Union[Resource, Output]]:
+    def populate(self) -> list[Resource | Output]:
         values = ResourceValueResolver(self._spec).resolve()
 
         gh_repo = values["content_from_github"]["repo"]
@@ -164,7 +161,7 @@ class CloudflareZoneTerrascriptResource(TerrascriptResource):
 
     def _create_cloudflare_certificate_pack(
         self, zone: Resource, zone_certs: Iterable[MutableMapping[str, Any]]
-    ) -> list[Union[Resource, Output]]:
+    ) -> list[Resource | Output]:
         resources = []
         for cert_values in zone_certs:
             identifier = safe_resource_id(cert_values.pop("identifier"))
@@ -192,7 +189,7 @@ class CloudflareZoneTerrascriptResource(TerrascriptResource):
         self,
         zone: Resource,
         zone_custom_ssl: Iterable[MutableMapping[str, Any]],
-    ) -> list[Union[Resource, Output]]:
+    ) -> list[Resource | Output]:
         vault_settings = get_app_interface_vault_settings()
         secret_reader = create_secret_reader(use_vault=vault_settings.vault)
 
@@ -221,7 +218,7 @@ class CloudflareZoneTerrascriptResource(TerrascriptResource):
             resources.append(custom_ssl)
         return resources
 
-    def populate(self) -> list[Union[Resource, Output]]:
+    def populate(self) -> list[Resource | Output]:
         resources = []
 
         values = ResourceValueResolver(self._spec).resolve()
@@ -313,7 +310,7 @@ class CloudflareZoneTerrascriptResource(TerrascriptResource):
 
 
 class CloudflareAccountMemberTerrascriptResource(TerrascriptResource):
-    def populate(self) -> list[Union[Resource, Output]]:
+    def populate(self) -> list[Resource | Output]:
         resources = []
         values = ResourceValueResolver(self._spec).resolve()
         data_source_cloudflare_account_roles = values.pop("cloudflare_account_roles")
@@ -340,7 +337,7 @@ class CloudflareLogpushJob(TerrascriptResource):
         we are defining this as inner class.
         """
 
-    def populate(self) -> list[Union[Resource, Output, Data]]:
+    def populate(self) -> list[Resource | Output | Data]:
         resources = []
         values = ResourceValueResolver(self._spec).resolve()
         zone = values.pop("zone_name", None)
@@ -373,7 +370,7 @@ class CloudflareLogpushOwnershipChallengeResource(TerrascriptResource):
         we are defining this as inner class.
         """
 
-    def populate(self) -> list[Union[Resource, Output, Data]]:
+    def populate(self) -> list[Resource | Output | Data]:
         resources = []
         values = ResourceValueResolver(self._spec).resolve()
         destination_conf = values.get("destination_conf")
@@ -412,7 +409,7 @@ class CloudflareLogpullRetention(TerrascriptResource):
         we are defining this as inner class.
         """
 
-    def populate(self) -> list[Union[Resource, Output, Data]]:
+    def populate(self) -> list[Resource | Output | Data]:
         resources = []
         values = ResourceValueResolver(self._spec).resolve()
 

reconcile/utils/terrascript/models.py

@@ -1,5 +1,4 @@
 from dataclasses import dataclass
-from typing import Optional
 
 from reconcile.utils.secret_reader import HasSecret
 
@@ -22,6 +21,6 @@ class TerraformStateS3:
 class CloudflareAccount:
     name: str
     api_credentials: HasSecret
-    enforce_twofactor: Optional[bool]
-    type: Optional[str]
+    enforce_twofactor: bool | None
+    type: str | None
     provider_version: str

reconcile/utils/terrascript/resources.py

@@ -3,7 +3,6 @@ from abc import (
     abstractmethod,
 )
 from collections.abc import Iterable
-from typing import Union
 
 from terrascript import (
     Data,
@@ -40,5 +39,5 @@ class TerrascriptResource(ABC):
         ]
 
     @abstractmethod
-    def populate(self) -> list[Union[Resource, Output, Data]]:
+    def populate(self) -> list[Resource | Output | Data]:
         """Calling this method should return the Terrascript resources to be created."""