qontract-reconcile 0.10.2.dev310__py3-none-any.whl → 0.10.2.dev439__py3-none-any.whl

reconcile/utils/json.py

@@ -0,0 +1,74 @@
+import json
+from collections.abc import Callable
+from dataclasses import asdict, is_dataclass
+from datetime import date, datetime
+from decimal import Decimal
+from enum import Enum
+from typing import Any, Literal
+
+from pydantic import BaseModel
+from pydantic.main import IncEx
+
+JSON_COMPACT_SEPARATORS = (",", ":")
+
+
+def pydantic_encoder(obj: Any) -> Any:
+    if isinstance(obj, BaseModel):
+        return obj.model_dump()
+
+    if is_dataclass(obj):
+        return asdict(obj)  # type: ignore
+
+    if isinstance(obj, (datetime, date)):
+        return obj.isoformat()
+
+    if isinstance(obj, Enum):
+        return obj.value
+
+    if isinstance(obj, Decimal):
+        return float(obj)
+
+    raise TypeError(
+        f"Object of type '{obj.__class__.__name__}' is not JSON serializable"
+    )
+
+
+def json_dumps(
+    data: Any,
+    *,
+    compact: bool = False,
+    indent: int | None = None,
+    cls: type[json.JSONEncoder] | None = None,
+    defaults: Callable | None = None,
+    # BaseModel dump parameters
+    by_alias: bool = True,
+    exclude_none: bool = False,
+    exclude: IncEx | None = None,
+    mode: Literal["json", "python"] = "json",
+) -> str:
+    """
+    Serialize `data` to a consistent JSON formatted `str` with dict keys sorted.
+
+    Args:
+        data: The data to serialize.
+        compact: If True, use compact separators (no spaces after commas or colons).
+        indent: If specified, pretty-print the JSON with this many spaces of indentation.
+        cls: A custom JSONEncoder subclass to use for serialization.
+    Returns:
+        A JSON formatted string.
+    """
+    if isinstance(data, BaseModel):
+        data = data.model_dump(
+            mode=mode, by_alias=by_alias, exclude_none=exclude_none, exclude=exclude
+        )
+        if mode == "python":
+            defaults = pydantic_encoder
+    separators = JSON_COMPACT_SEPARATORS if compact else None
+    return json.dumps(
+        data,
+        indent=indent,
+        separators=separators,
+        sort_keys=True,
+        cls=cls,
+        default=defaults,
+    )

reconcile/utils/ldap_client.py

@@ -1,5 +1,6 @@
 from collections import defaultdict
 from collections.abc import Iterable
+from typing import Any, Self
 
 from ldap3 import (
     ALL,
@@ -17,15 +18,15 @@ class LdapClient:
     appropriately.
     """
 
-    def __init__(self, base_dn: str, connection: Connection):
+    def __init__(self, base_dn: str, connection: Connection) -> None:
         self.base_dn = base_dn
         self.connection = connection
 
-    def __enter__(self):
+    def __enter__(self) -> Self:
         self.connection.bind()
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         self.connection.unbind()
 
     def get_users(self, uids: Iterable[str]) -> set[str]:

reconcile/utils/lean_terraform_client.py

@@ -6,7 +6,9 @@ from collections.abc import Mapping
 from typing import Any
 
 
-def state_rm_access_key(working_dirs, account, user):
+def state_rm_access_key(
+    working_dirs: Mapping[str, str], account: str, user: str
+) -> bool:
     wd = working_dirs[account]
     init_result = subprocess.run(["terraform", "init"], check=False, cwd=wd)
     if init_result.returncode != 0:

reconcile/utils/membershipsources/app_interface_resolver.py

@@ -55,6 +55,8 @@ def resolve_app_interface_membership_source(
 
 def build_member_list(role: RoleV1) -> list[RoleMember]:
     members: list[RoleMember] = []
-    members.extend([RoleUser(**u.dict()) for u in role.users or []])
-    members.extend([RoleBot(**b.dict()) for b in role.bots or [] if b.org_username])
+    members.extend([RoleUser(**u.model_dump()) for u in role.users or []])
+    members.extend([
+        RoleBot(**b.model_dump()) for b in role.bots or [] if b.org_username
+    ])
     return members

reconcile/utils/membershipsources/models.py

@@ -7,7 +7,6 @@ from typing import (
 
 from pydantic import (
     BaseModel,
-    Extra,
 )
 
 from reconcile.gql_definitions.fragments.membership_source import (
@@ -23,7 +22,7 @@ class User(Protocol):
     @property
     def org_username(self) -> str: ...
 
-    def dict(self, *, by_alias: bool = False) -> dict[str, Any]: ...
+    def model_dump(self, *, by_alias: bool = False) -> dict[str, Any]: ...
 
 
 class Bot(Protocol):
@@ -33,7 +32,7 @@ class Bot(Protocol):
     @property
     def org_username(self) -> str | None: ...
 
-    def dict(self, *, by_alias: bool = False) -> dict[str, Any]: ...
+    def model_dump(self, *, by_alias: bool = False) -> dict[str, Any]: ...
 
 
 class RoleWithMemberships(Protocol):
@@ -50,33 +49,27 @@ class RoleWithMemberships(Protocol):
     def member_sources(self) -> Sequence[RoleMembershipSource] | None: ...
 
 
-class RoleUser(BaseModel):
+class RoleUser(BaseModel, extra="ignore"):
     name: str
     org_username: str
-    github_username: str | None
-    quay_username: str | None
-    pagerduty_username: str | None
-    aws_username: str | None
-    cloudflare_user: str | None
-    public_gpg_key: str | None
+    github_username: str | None = None
+    quay_username: str | None = None
+    pagerduty_username: str | None = None
+    aws_username: str | None = None
+    cloudflare_user: str | None = None
+    public_gpg_key: str | None = None
     tag_on_cluster_updates: bool | None = False
     tag_on_merge_requests: bool | None = False
 
-    class Config:
-        extra = Extra.ignore
 
-
-class RoleBot(BaseModel):
+class RoleBot(BaseModel, extra="ignore"):
     name: str
-    description: str | None
-    org_username: str | None
-    github_username: str | None
-    gitlab_username: str | None
-    openshift_serviceaccount: str | None
-    quay_username: str | None
-
-    class Config:
-        extra = Extra.ignore
+    description: str | None = None
+    org_username: str | None = None
+    github_username: str | None = None
+    gitlab_username: str | None = None
+    openshift_serviceaccount: str | None = None
+    quay_username: str | None = None
 
 
 RoleMember = RoleUser | RoleBot

reconcile/utils/membershipsources/resolver.py

@@ -98,8 +98,10 @@ def resolve_role_members(
         members: list[RoleMember] = []
 
         # bring in the local users and bots ...
-        members.extend(RoleUser(**u.dict()) for u in r.users or [])
-        members.extend(RoleBot(**b.dict()) for b in r.bots or [] if b.org_username)
+        members.extend(RoleUser(**u.model_dump()) for u in r.users or [])
+        members.extend(
+            RoleBot(**b.model_dump()) for b in r.bots or [] if b.org_username
+        )
 
         # ... and enhance with the ones from member sources
         for ms in r.member_sources or []:

reconcile/utils/merge_request_manager/merge_request_manager.py

@@ -1,7 +1,7 @@
 import logging
 from abc import abstractmethod
 from dataclasses import dataclass
-from typing import Any, Generic, TypeVar
+from typing import Any, TypeVar
 
 from gitlab.v4.objects import ProjectMergeRequest
 from pydantic import BaseModel
@@ -17,12 +17,12 @@ T = TypeVar("T", bound=BaseModel)
 
 
 @dataclass
-class OpenMergeRequest(Generic[T]):
+class OpenMergeRequest[T: BaseModel]:
     raw: ProjectMergeRequest
     mr_info: T
 
 
-class MergeRequestManagerBase(Generic[T]):
+class MergeRequestManagerBase[T: BaseModel]:
     """ """
 
     def __init__(self, vcs: VCS, parser: Parser, mr_label: str):
@@ -42,7 +42,7 @@ class MergeRequestManagerBase(Generic[T]):
         expected_data: dict[str, Any],
     ) -> OpenMergeRequest | None:
         for mr in self._open_mrs:
-            mr_info_dict = mr.mr_info.dict()
+            mr_info_dict = mr.mr_info.model_dump()
             if all(mr_info_dict.get(k) == expected_data.get(k) for k in expected_data):
                 return mr
 

reconcile/utils/merge_request_manager/parser.py

@@ -1,5 +1,5 @@
 import re
-from typing import Generic, TypeVar
+from typing import TypeVar
 
 from pydantic import BaseModel
 
@@ -17,7 +17,7 @@ class ParserVersionError(Exception):
 T = TypeVar("T", bound=BaseModel)
 
 
-class Parser(Generic[T]):
+class Parser[T: BaseModel]:
     """This class is only concerned with parsing an MR description rendered by the Renderer."""
 
     def __init__(
@@ -60,8 +60,8 @@ class Parser(Generic[T]):
 
         if self.expected_version != self._find_by_name(self.version_ref, parts[1]):
             raise ParserVersionError("Version is outdated")
-        return self.klass(
-            **data_default_none(
-                self.klass, self._data_from_description(parts[1]), use_defaults=False
-            )
+        data = data_default_none(
+            self.klass, self._data_from_description(parts[1]), use_defaults=False
         )
+        assert isinstance(data, dict)
+        return self.klass(**data)

reconcile/utils/metrics.py

@@ -144,7 +144,7 @@ class GaugeMetric(BaseMetric):
 
     @classmethod
     def metric_family(cls) -> GaugeMetricFamily:
-        labels = [f.alias for f in cls.__fields__.values()]
+        labels = [f.alias or name for name, f in cls.model_fields.items()]
         return GaugeMetricFamily(cls.name(), cls.__doc__ or "", labels=labels)
 
     @classmethod
@@ -167,7 +167,7 @@ class CounterMetric(BaseMetric):
 
     @classmethod
     def metric_family(cls) -> CounterMetricFamily:
-        labels = [f.alias for f in cls.__fields__.values()]
+        labels = [f.alias or name for name, f in cls.model_fields.items()]
         return CounterMetricFamily(cls.name(), cls.__doc__ or "", labels=labels)
 
     @classmethod
@@ -198,7 +198,7 @@ class MetricsContainer:
         """
         Sets the value of the given gauge metric to the given value.
         """
-        label_values = tuple(metric.dict(by_alias=True).values())
+        label_values = tuple(metric.model_dump(by_alias=True).values())
         self._gauges[metric.__class__][label_values] = value
 
     def set_info(self, metric: InfoMetric) -> None:
@@ -213,7 +213,7 @@ class MetricsContainer:
         Increases the value of the given counter by the given amount.
         """
         # all label values need to be strings, so lets convert them
-        label_values = tuple(str(v) for v in counter.dict(by_alias=True).values())
+        label_values = tuple(str(v) for v in counter.model_dump(by_alias=True).values())
         current_value = self._counters[counter.__class__].get(label_values) or 0
         self._counters[counter.__class__][label_values] = current_value + by
 
@@ -270,7 +270,7 @@ class MetricsContainer:
             (
                 metric_class(**{
                     key: labels[i]
-                    for i, key in enumerate(metric_class.__fields__.keys())
+                    for i, key in enumerate(metric_class.model_fields.keys())
                 }),
                 value,
             )