qontract-reconcile 0.10.2.dev292__tar.gz → 0.10.2.dev293__tar.gz

{qontract_reconcile-0.10.2.dev292 → qontract_reconcile-0.10.2.dev293}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qontract-reconcile
-Version: 0.10.2.dev292
+Version: 0.10.2.dev293
 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.dev292 → qontract_reconcile-0.10.2.dev293}/reconcile/gql_definitions/introspection.json

@@ -6451,6 +6451,18 @@
                             "isDeprecated": false,
                             "deprecationReason": null
                         },
+                        {
+                            "name": "externalOrgId",
+                            "description": null,
+                            "args": [],
+                            "type": {
+                                "kind": "SCALAR",
+                                "name": "String",
+                                "ofType": null
+                            },
+                            "isDeprecated": false,
+                            "deprecationReason": null
+                        },
                         {
                             "name": "environment",
                             "description": null,
@@ -34178,6 +34190,18 @@
                             "isDeprecated": false,
                             "deprecationReason": null
                         },
+                        {
+                            "name": "overwrite",
+                            "description": null,
+                            "args": [],
+                            "type": {
+                                "kind": "SCALAR",
+                                "name": "Boolean",
+                                "ofType": null
+                            },
+                            "isDeprecated": false,
+                            "deprecationReason": null
+                        },
                         {
                             "name": "patch",
                             "description": null,
@@ -41014,6 +41038,18 @@
                             },
                             "isDeprecated": false,
                             "deprecationReason": null
+                        },
+                        {
+                            "name": "promtool_version",
+                            "description": null,
+                            "args": [],
+                            "type": {
+                                "kind": "SCALAR",
+                                "name": "String",
+                                "ofType": null
+                            },
+                            "isDeprecated": false,
+                            "deprecationReason": null
                         }
                     ],
                     "inputFields": null,

{qontract_reconcile-0.10.2.dev292 → qontract_reconcile-0.10.2.dev293}/reconcile/gql_definitions/templating/template_collection.py

@@ -40,6 +40,7 @@ query TemplateCollection_v1($name: String) {
       autoApproved
       condition
       targetPath
+      overwrite
       patch {
         path
         identifier
@@ -92,6 +93,7 @@ class TemplateV1(ConfiguredBaseModel):
     auto_approved: Optional[bool] = Field(..., alias="autoApproved")
     condition: Optional[str] = Field(..., alias="condition")
     target_path: str = Field(..., alias="targetPath")
+    overwrite: Optional[bool] = Field(..., alias="overwrite")
     patch: Optional[TemplatePatchV1] = Field(..., alias="patch")
     template: str = Field(..., alias="template")
     template_render_options: Optional[TemplateRenderOptionsV1] = Field(..., alias="templateRenderOptions")

{qontract_reconcile-0.10.2.dev292 → qontract_reconcile-0.10.2.dev293}/reconcile/gql_definitions/templating/templates.py

@@ -24,6 +24,7 @@ query Templatev1 {
     name
     autoApproved
     condition
+    overwrite
     patch {
       path
       identifier
@@ -78,6 +79,7 @@ class TemplateV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
     auto_approved: Optional[bool] = Field(..., alias="autoApproved")
     condition: Optional[str] = Field(..., alias="condition")
+    overwrite: Optional[bool] = Field(..., alias="overwrite")
     patch: Optional[TemplatePatchV1] = Field(..., alias="patch")
     target_path: str = Field(..., alias="targetPath")
     template: str = Field(..., alias="template")

{qontract_reconcile-0.10.2.dev292 → qontract_reconcile-0.10.2.dev293}/reconcile/templating/lib/rendering.py

@@ -1,5 +1,6 @@
 import logging
 from abc import ABC, abstractmethod
+from functools import cached_property
 from io import StringIO
 from typing import Any, Protocol
 
@@ -33,6 +34,7 @@ class Template(Protocol):
     condition: str | None
     target_path: str
     template: str
+    overwrite: bool | None
 
     def dict(self) -> dict[str, str]: ...
 
@@ -77,14 +79,28 @@ class Renderer(ABC):
         """
         pass
 
+    @abstractmethod
+    def target_exist(self) -> bool:
+        """
+        if target (file or patch block) already exists.
+        """
+        pass
+
     def render_target_path(self) -> str:
         return self._render_template(self.template.target_path).strip()
 
     def render_condition(self) -> bool:
-        return self._render_template(self.template.condition or "True") == "True"
+        if self._render_template(self.template.condition or "True") != "True":
+            return False
+        if self.template.overwrite:
+            return True
+        return not self.target_exist()
 
 
 class FullRenderer(Renderer):
+    def target_exist(self) -> bool:
+        return self.data.current is not None
+
     def render_output(self) -> str:
         """
         Take the variables from Template Data and render the template with it.
@@ -95,6 +111,12 @@ class FullRenderer(Renderer):
 
 
 class PatchRenderer(Renderer):
+    def target_exist(self) -> bool:
+        if isinstance(self._matched_value, list):
+            dta_identifier = self._get_identifier(self._data_to_add)
+            return self._find_index(self._matched_value, dta_identifier) is not None
+        return True
+
     def render_output(self) -> str:
         """
         Takes the variables from Template Data and render the template with it.
@@ -105,70 +127,69 @@ class PatchRenderer(Renderer):
 
         This method returns the entire file as a string.
         """
-        if self.template.patch is None:  # here to satisfy mypy
-            raise ValueError("PatchRenderer requires a patch")
-
-        p = parse_jsonpath(self._render_template(self.template.patch.path))
-
-        matched_values = [match.value for match in p.find(self.data.current)]
-
-        if len(matched_values) != 1:
-            raise ValueError(
-                f"Expected exactly one match for {self.template.patch.path}, got {len(matched_values)}"
-            )
-        matched_value = matched_values[0]
-
-        data_to_add = self.ruamel_instance.load(
-            self._render_template(self.template.template)
-        )
-
-        if isinstance(matched_value, list):
-
-            def get_identifier(data: dict[str, Any]) -> Any:
-                assert self.template.patch is not None  # mypy
-                if not self.template.patch.identifier:
-                    raise ValueError(
-                        f"Expected identifier in patch for list at {self.template}"
-                    )
-                if self.template.patch.identifier.startswith(
-                    "$"
-                ) and not self.template.patch.identifier.startswith("$ref"):
-                    # jsonpath and list of strings support
-                    if matches := [
-                        match.value
-                        for match in parse_jsonpath(
-                            self.template.patch.identifier
-                        ).find(data)
-                    ]:
-                        return matches[0]
-                    return None
-                return data.get(self.template.patch.identifier)
-
-            dta_identifier = get_identifier(data_to_add)
+        if isinstance(self._matched_value, list):
+            dta_identifier = self._get_identifier(self._data_to_add)
             if not dta_identifier:
+                assert self.template.patch is not None  # mypy
                 raise ValueError(
                     f"Expected identifier {self.template.patch.identifier} in data to add"
                 )
-
-            index = next(
-                (
-                    index
-                    for index, data in enumerate(matched_value)
-                    if get_identifier(data) == dta_identifier
-                ),
-                None,
-            )
-            if index is None:
-                matched_value.append(data_to_add)
+            if (
+                index := self._find_index(self._matched_value, dta_identifier)
+            ) is not None:
+                self._matched_value[index] = self._data_to_add
             else:
-                matched_value[index] = data_to_add
+                self._matched_value.append(self._data_to_add)
         else:
-            matched_value.update(data_to_add)
+            self._matched_value.update(self._data_to_add)
 
         with StringIO() as s:
             self.ruamel_instance.dump(self.data.current, s)
             return s.getvalue()
 
+    @cached_property
+    def _matched_value(self) -> Any:
+        assert self.template.patch is not None  # mypy
+        p = parse_jsonpath(self._render_template(self.template.patch.path))
+        matched_values = [match.value for match in p.find(self.data.current)]
+        if len(matched_values) != 1:
+            raise ValueError(
+                f"Expected exactly one match for {self.template.patch.path}, got {len(matched_values)}"
+            )
+        return matched_values[0]
+
+    @cached_property
+    def _data_to_add(self) -> Any:
+        return self.ruamel_instance.load(self._render_template(self.template.template))
+
+    def _get_identifier(self, data: dict[str, Any]) -> Any:
+        assert self.template.patch is not None  # mypy
+        if not self.template.patch.identifier:
+            raise ValueError(
+                f"Expected identifier in patch for list at {self.template}"
+            )
+        if self.template.patch.identifier.startswith(
+            "$"
+        ) and not self.template.patch.identifier.startswith("$ref"):
+            # jsonpath and list of strings support
+            if matches := [
+                match.value
+                for match in parse_jsonpath(self.template.patch.identifier).find(data)
+            ]:
+                return matches[0]
+            return None
+        return data.get(self.template.patch.identifier)
+
+    def _find_index(
+        self,
+        matched_value: list,
+        dta_identifier: Any,
+    ) -> int | None:
+        for index, data in enumerate(matched_value):
+            if self._get_identifier(data) == dta_identifier:
+                return index
+        return None
+
 
 def create_renderer(
     template: Template,

{qontract_reconcile-0.10.2.dev292 → qontract_reconcile-0.10.2.dev293}/reconcile/templating/renderer.py

@@ -104,14 +104,17 @@ class LocalFilePersistence(FilePersistence):
     def read(self, path: str) -> str | None:
         return self._read_local_file(join_path(self.app_interface_data_path, path))
 
-    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
-        if self.dry_run:
-            return
+    def flush(self) -> None:
         for output in self.outputs:
             filepath = Path(join_path(self.app_interface_data_path, output.path))
             filepath.parent.mkdir(parents=True, exist_ok=True)
             filepath.write_text(output.content, encoding="utf-8")
 
+    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
+        if self.dry_run:
+            return
+        self.flush()
+
 
 class PersistenceTransaction(FilePersistence):
     """