qontract-reconcile 0.10.1rc922__py3-none-any.whl → 0.10.1rc923__py3-none-any.whl

{qontract_reconcile-0.10.1rc922.dist-info → qontract_reconcile-0.10.1rc923.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.10.1rc922
+Version: 0.10.1rc923
 Summary: Collection of tools to reconcile services with their desired state as defined in the app-interface DB.
 Home-page: https://github.com/app-sre/qontract-reconcile
 Author: Red Hat App-SRE Team

{qontract_reconcile-0.10.1rc922.dist-info → qontract_reconcile-0.10.1rc923.dist-info}/RECORD

@@ -366,8 +366,8 @@ reconcile/gql_definitions/status_board/status_board.py,sha256=vHEzncabujkqbjJ-ib
 reconcile/gql_definitions/statuspage/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/gql_definitions/statuspage/statuspages.py,sha256=CTRzjiR9k41LqlkgyoNHwC2JERsoD_Run_aK7jw_Ono,5299
 reconcile/gql_definitions/templating/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/gql_definitions/templating/template_collection.py,sha256=GiCtqtTj8602ppCatuF9HhQkHXDOd76Z9CSJQ1KwBuc,3532
-reconcile/gql_definitions/templating/templates.py,sha256=ejAvQ13zfNMQTz3FWtRUic6dSvio3aAgBKEqt600hbk,2821
+reconcile/gql_definitions/templating/template_collection.py,sha256=QA68QNszPgJY996pPPJmdTULI1gjcT8MDvk1NLKi6_Y,4017
+reconcile/gql_definitions/templating/templates.py,sha256=bV1JWwxDW8opARBOrZ_h5NBsJfM-9aL-povmTZnpTOk,3296
 reconcile/gql_definitions/terraform_cloudflare_dns/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/gql_definitions/terraform_cloudflare_dns/app_interface_cloudflare_dns_settings.py,sha256=eyGX9HcTF6MZbOYZ6Kl6Mg3k6nJTUtwqs9gDxBP_8Dk,1920
 reconcile/gql_definitions/terraform_cloudflare_dns/terraform_cloudflare_zones.py,sha256=dBQ2tyAp-eRZs59mguaTc6-x67JUoSxtZ8mOjbRqDuc,5832
@@ -463,12 +463,12 @@ reconcile/templates/jira-checkpoint-missinginfo.j2,sha256=c_Vvg-lEENsB3tgxm9B6Y9
 reconcile/templates/rosa-classic-cluster-creation.sh.j2,sha256=FVBmnR2FmVModhqOYNBInhF8zk0Qnj9og9KHK5-X9v0,2361
 reconcile/templates/rosa-hcp-cluster-creation.sh.j2,sha256=2wTdv9qvapCvT8NSi_hq8sXhpFSaxRX-V6Cao1diCI8,2393
 reconcile/templating/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/templating/renderer.py,sha256=VQVsQxMjKfftpsgzpd1jJ-bhrsgi8zjDYXYzMfI4vZA,12104
-reconcile/templating/validator.py,sha256=tGI7PwPMAmRJ_-Gg_O7NoZO8ytg_QUeCQAv6G1smitc,4736
+reconcile/templating/renderer.py,sha256=oUUiHHSgD5bcUN3Xf-yoEezAf3LjqN-2GlYhQUTPIZY,13067
+reconcile/templating/validator.py,sha256=5f9f35PCHOOdjb7KZquL2YdabyuAUokPDa4xutSEHIQ,5360
 reconcile/templating/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/templating/lib/merge_request_manager.py,sha256=4oe3EwQOP7CZSraocivbRzzOuVb0ooElaUS2_DGsF50,5603
 reconcile/templating/lib/model.py,sha256=fb6FYYLQjmoh2DjVKO7TEWCuDPf1Q34xmOx0M9Z07ek,324
-reconcile/templating/lib/rendering.py,sha256=ShYt_BOMS75yiJ7lNcI9NoZyQp5wpy_lEmzVETY57dE,5030
+reconcile/templating/lib/rendering.py,sha256=6kt8NCCwB4vLKYal7KtRmBDguIC1p_PIQCRr-vL7p5w,5504
 reconcile/terraform_init/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/terraform_init/integration.py,sha256=glQ9uy8Kj2aTQXCAupwSFeih7reX_xMX_UuWW_ywBMU,6100
 reconcile/terraform_init/merge_request.py,sha256=3CYtgSd7Q9zjKg4wsDz437EPCRfGeZZ8fZ0Y-ChKXJY,1475
@@ -741,7 +741,7 @@ reconcile/utils/internal_groups/models.py,sha256=y_IqBVqfGqNXiu0VudvBWFrm_-uafVm
 reconcile/utils/jinja2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/utils/jinja2/extensions.py,sha256=7K-uo6G2eCWa98MHT8fRPYIKCLQB_5D2keqQ_LyAfHM,1293
 reconcile/utils/jinja2/filters.py,sha256=RVVkpf87FllrPUpqk_8KN-r1IsmnS0bpygAVvsvIr5g,4504
-reconcile/utils/jinja2/utils.py,sha256=BOqB17nFKzzdC13hqOebd-IDcstjkvmlyQJJGNaMbxM,6723
+reconcile/utils/jinja2/utils.py,sha256=nyTS7SafbjQliIg0PZhqK0YGfFL0W2V6XA5CRaqOkrA,7809
 reconcile/utils/jobcontroller/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/utils/jobcontroller/controller.py,sha256=2V_vm5thFx6adW4bMy9CdHXFesuo6S4lSkEpGxkXSM0,14492
 reconcile/utils/jobcontroller/models.py,sha256=tSRAkUX23iyn4YPsWEicFXwRxw3mXb5B2pDOWmXX8wQ,6350
@@ -844,8 +844,8 @@ tools/test/test_qontract_cli.py,sha256=_D61RFGAN5x44CY1tYbouhlGXXABwYfxKSWSQx3Jr
 tools/test/test_saas_promotion_state.py,sha256=dy4kkSSAQ7bC0Xp2CociETGN-2aABEfL6FU5D9Jl00Y,6056
 tools/test/test_sd_app_sre_alert_report.py,sha256=v363r9zM7__0kR5K6mvJoGFcM9BvE33fWAayrqkpojA,2116
 tools/test/test_sre_checkpoints.py,sha256=SKqPPTl9ua0RFdSSofnoQX-JZE6dFLO3LRhfQzqtfh8,2607
-qontract_reconcile-0.10.1rc922.dist-info/METADATA,sha256=RHKa1xgyvZvdV1VeiDykO1dyWDUtbftBqj3cM9Cskx4,2273
-qontract_reconcile-0.10.1rc922.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-qontract_reconcile-0.10.1rc922.dist-info/entry_points.txt,sha256=GKQqCl2j2X1BJQ69een6rHcR26PmnxnONLNOQB-nRjY,491
-qontract_reconcile-0.10.1rc922.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc922.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc923.dist-info/METADATA,sha256=OjR8Y-8f7JvaPxAt_N-8baMq5aI7LwcbOL2Cirs809I,2273
+qontract_reconcile-0.10.1rc923.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qontract_reconcile-0.10.1rc923.dist-info/entry_points.txt,sha256=GKQqCl2j2X1BJQ69een6rHcR26PmnxnONLNOQB-nRjY,491
+qontract_reconcile-0.10.1rc923.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc923.dist-info/RECORD,,

reconcile/gql_definitions/templating/template_collection.py

@@ -45,6 +45,11 @@ query TemplateCollection_v1 {
         identifier
       }
       template
+      templateRenderOptions {
+        trimBlocks
+        lstripBlocks
+        keepTrailingNewline
+      }
     }
   }
 }
@@ -76,6 +81,12 @@ class TemplatePatchV1(ConfiguredBaseModel):
     identifier: Optional[str] = Field(..., alias="identifier")
 
 
+class TemplateRenderOptionsV1(ConfiguredBaseModel):
+    trim_blocks: Optional[bool] = Field(..., alias="trimBlocks")
+    lstrip_blocks: Optional[bool] = Field(..., alias="lstripBlocks")
+    keep_trailing_newline: Optional[bool] = Field(..., alias="keepTrailingNewline")
+
+
 class TemplateV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
     auto_approved: Optional[bool] = Field(..., alias="autoApproved")
@@ -83,6 +94,7 @@ class TemplateV1(ConfiguredBaseModel):
     target_path: str = Field(..., alias="targetPath")
     patch: Optional[TemplatePatchV1] = Field(..., alias="patch")
     template: str = Field(..., alias="template")
+    template_render_options: Optional[TemplateRenderOptionsV1] = Field(..., alias="templateRenderOptions")
 
 
 class TemplateCollectionV1(ConfiguredBaseModel):

reconcile/gql_definitions/templating/templates.py

@@ -38,6 +38,11 @@ query Templatev1 {
       expectedTargetPath
       expectedToRender
     }
+    templateRenderOptions {
+      trimBlocks
+      lstripBlocks
+      keepTrailingNewline
+    }
   }
 }
 """
@@ -63,6 +68,12 @@ class TemplateTestV1(ConfiguredBaseModel):
     expected_to_render: Optional[bool] = Field(..., alias="expectedToRender")
 
 
+class TemplateRenderOptionsV1(ConfiguredBaseModel):
+    trim_blocks: Optional[bool] = Field(..., alias="trimBlocks")
+    lstrip_blocks: Optional[bool] = Field(..., alias="lstripBlocks")
+    keep_trailing_newline: Optional[bool] = Field(..., alias="keepTrailingNewline")
+
+
 class TemplateV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
     auto_approved: Optional[bool] = Field(..., alias="autoApproved")
@@ -71,6 +82,7 @@ class TemplateV1(ConfiguredBaseModel):
     target_path: str = Field(..., alias="targetPath")
     template: str = Field(..., alias="template")
     template_test: list[TemplateTestV1] = Field(..., alias="templateTest")
+    template_render_options: Optional[TemplateRenderOptionsV1] = Field(..., alias="templateRenderOptions")
 
 
 class Templatev1QueryData(ConfiguredBaseModel):

reconcile/templating/lib/rendering.py

@@ -5,7 +5,11 @@ from typing import Any, Protocol
 
 from pydantic import BaseModel
 
-from reconcile.utils.jinja2.utils import Jinja2TemplateError, process_jinja2_template
+from reconcile.utils.jinja2.utils import (
+    Jinja2TemplateError,
+    TemplateRenderOptions,
+    process_jinja2_template,
+)
 from reconcile.utils.jsonpath import parse_jsonpath
 from reconcile.utils.ruamel import create_ruamel_instance
 from reconcile.utils.secret_reader import SecretReaderBase
@@ -43,11 +47,13 @@ class Renderer(ABC):
         template: Template,
         data: TemplateData,
         secret_reader: SecretReaderBase | None = None,
+        template_render_options: TemplateRenderOptions | None = None,
     ):
         self.template = template
         self.data = data
         self.secret_reader = secret_reader
         self.ruamel_instance = create_ruamel_instance(explicit_start=True)
+        self.template_render_options = template_render_options
 
     def _jinja2_render_kwargs(self) -> dict[str, Any]:
         return {**self.data.variables, "current": self.data.current}
@@ -58,6 +64,7 @@ class Renderer(ABC):
                 body=template,
                 vars=self._jinja2_render_kwargs(),
                 secret_reader=self.secret_reader,
+                template_render_options=self.template_render_options,
             )
         except Jinja2TemplateError as e:
             logging.error(f"Error rendering template {self.template.name}: {e}")
@@ -150,11 +157,18 @@ def create_renderer(
     template: Template,
     data: TemplateData,
     secret_reader: SecretReaderBase | None = None,
+    template_render_options: TemplateRenderOptions | None = None,
 ) -> Renderer:
     if template.patch:
-        return PatchRenderer(template=template, data=data, secret_reader=secret_reader)
+        return PatchRenderer(
+            template=template,
+            data=data,
+            secret_reader=secret_reader,
+            template_render_options=template_render_options,
+        )
     return FullRenderer(
         template=template,
         data=data,
         secret_reader=secret_reader,
+        template_render_options=template_render_options,
     )

reconcile/templating/renderer.py

@@ -23,6 +23,7 @@ from reconcile.templating.lib.merge_request_manager import (
 )
 from reconcile.templating.lib.model import TemplateInput, TemplateOutput
 from reconcile.templating.lib.rendering import (
+    Renderer,
     TemplateData,
     create_renderer,
 )
@@ -32,12 +33,13 @@ from reconcile.typed_queries.gitlab_instances import get_gitlab_instances
 from reconcile.utils import gql
 from reconcile.utils.git import clone
 from reconcile.utils.gql import GqlApi, init_from_config
-from reconcile.utils.jinja2.utils import process_jinja2_template
+from reconcile.utils.jinja2.utils import TemplateRenderOptions, process_jinja2_template
 from reconcile.utils.ruamel import create_ruamel_instance
 from reconcile.utils.runtime.integration import (
     PydanticRunParams,
     QontractReconcileIntegration,
 )
+from reconcile.utils.secret_reader import SecretReaderBase
 from reconcile.utils.vcs import VCS
 
 QONTRACT_INTEGRATION = "template-renderer"
@@ -207,6 +209,31 @@ class TemplateRendererIntegration(QontractReconcileIntegration):
     def __init__(self, params: TemplateRendererIntegrationParams) -> None:
         super().__init__(params)
 
+    @staticmethod
+    def _create_renderer(
+        template: TemplateV1,
+        variables: dict,
+        secret_reader: SecretReaderBase | None = None,
+    ) -> Renderer:
+        return create_renderer(
+            template,
+            TemplateData(
+                variables=variables,
+            ),
+            secret_reader=secret_reader,
+            template_render_options=TemplateRenderOptions.create(
+                trim_blocks=template.template_render_options.trim_blocks
+                if template.template_render_options
+                else None,
+                lstrip_blocks=template.template_render_options.lstrip_blocks
+                if template.template_render_options
+                else None,
+                keep_trailing_newline=template.template_render_options.keep_trailing_newline
+                if template.template_render_options
+                else None,
+            ),
+        )
+
     def process_template(
         self,
         template: TemplateV1,
@@ -215,12 +242,8 @@ class TemplateRendererIntegration(QontractReconcileIntegration):
         ruaml_instance: yaml.YAML,
         template_input: TemplateInput,
     ) -> TemplateOutput | None:
-        r = create_renderer(
-            template,
-            TemplateData(
-                variables=variables,
-            ),
-            secret_reader=self.secret_reader,
+        r = TemplateRendererIntegration._create_renderer(
+            template, variables, secret_reader=self.secret_reader
         )
         target_path = r.render_target_path()
 

reconcile/templating/validator.py

@@ -12,6 +12,7 @@ from reconcile.gql_definitions.templating.templates import (
 )
 from reconcile.templating.lib.rendering import Renderer, TemplateData, create_renderer
 from reconcile.utils import gql
+from reconcile.utils.jinja2.utils import TemplateRenderOptions
 from reconcile.utils.ruamel import create_ruamel_instance
 from reconcile.utils.runtime.integration import (
     QontractReconcileIntegration,
@@ -50,6 +51,17 @@ class TemplateValidatorIntegration(QontractReconcileIntegration):
                 current=ruaml_instance.load(template_test.current or ""),
             ),
             secret_reader=secret_reader,
+            template_render_options=TemplateRenderOptions.create(
+                trim_blocks=template.template_render_options.trim_blocks
+                if template.template_render_options
+                else None,
+                lstrip_blocks=template.template_render_options.lstrip_blocks
+                if template.template_render_options
+                else None,
+                keep_trailing_newline=template.template_render_options.keep_trailing_newline
+                if template.template_render_options
+                else None,
+            ),
         )
 
     @staticmethod

reconcile/utils/jinja2/utils.py

@@ -1,8 +1,9 @@
 from functools import cache
-from typing import Any
+from typing import Any, Self
 
 import jinja2
 from jinja2.sandbox import SandboxedEnvironment
+from pydantic import BaseModel
 from sretoolbox.utils import retry
 
 from reconcile import queries
@@ -31,18 +32,46 @@ class Jinja2TemplateError(Exception):
         super().__init__("error processing jinja2 template: " + str(msg))
 
 
+class TemplateRenderOptions(BaseModel):
+    trim_blocks: bool
+    lstrip_blocks: bool
+    keep_trailing_newline: bool
+
+    class Config:
+        frozen = True
+
+    @classmethod
+    def create(
+        cls,
+        trim_blocks: bool | None = None,
+        lstrip_blocks: bool | None = None,
+        keep_trailing_newline: bool | None = None,
+    ) -> Self:
+        return cls(
+            trim_blocks=trim_blocks or False,
+            lstrip_blocks=lstrip_blocks or False,
+            keep_trailing_newline=keep_trailing_newline or False,
+        )
+
+
 @cache
-def compile_jinja2_template(body: str, extra_curly: bool = False) -> Any:
-    env: dict = {}
+def compile_jinja2_template(
+    body: str,
+    extra_curly: bool = False,
+    template_render_options: TemplateRenderOptions | None = None,
+) -> Any:
+    if not template_render_options:
+        template_render_options = TemplateRenderOptions.create()
+    env: dict[str, Any] = template_render_options.dict()
     if extra_curly:
-        env = {
+        env.update({
             "block_start_string": "{{%",
             "block_end_string": "%}}",
             "variable_start_string": "{{{",
             "variable_end_string": "}}}",
             "comment_start_string": "{{#",
             "comment_end_string": "#}}",
-        }
+        })
 
     jinja_env = SandboxedEnvironment(
         extensions=[B64EncodeExtension, RaiseErrorExtension],
@@ -154,6 +183,7 @@ def process_jinja2_template(
     extra_curly: bool = False,
     settings: dict[str, Any] | None = None,
     secret_reader: SecretReaderBase | None = None,
+    template_render_options: TemplateRenderOptions | None = None,
 ) -> Any:
     if vars is None:
         vars = {}
@@ -187,7 +217,7 @@ def process_jinja2_template(
         for k, v in vars["_template_mocks"].items():
             vars[k] = lambda *args, **kwargs: v
     try:
-        template = compile_jinja2_template(body, extra_curly)
+        template = compile_jinja2_template(body, extra_curly, template_render_options)
         r = template.render(vars)
     except Exception as e:
         raise Jinja2TemplateError(e)
@@ -197,9 +227,10 @@ def process_jinja2_template(
 def process_extracurlyjinja2_template(
     body: str,
     vars: dict[str, Any] | None = None,
-    extra_curly: bool = True,
+    extra_curly: bool = True,  # ignored. Just to be compatible with process_jinja2_template
     settings: dict[str, Any] | None = None,
     secret_reader: SecretReaderBase | None = None,
+    template_render_options: TemplateRenderOptions | None = None,
 ) -> Any:
     if vars is None:
         vars = {}
@@ -209,6 +240,7 @@ def process_extracurlyjinja2_template(
         extra_curly=True,
         settings=settings,
         secret_reader=secret_reader,
+        template_render_options=template_render_options,
     )