qontract-reconcile 0.10.1rc606__py3-none-any.whl → 0.10.1rc607__py3-none-any.whl

{qontract_reconcile-0.10.1rc606.dist-info → qontract_reconcile-0.10.1rc607.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.10.1rc606
+Version: 0.10.1rc607
 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
@@ -62,4 +62,5 @@ Requires-Dist: requests-oauthlib ~=1.3
 Requires-Dist: dt ==1.1.61
 Requires-Dist: jsonpatch ~=1.33
 Requires-Dist: jsonpointer ~=2.4
+Requires-Dist: yamllint ==1.34.0
 

{qontract_reconcile-0.10.1rc606.dist-info → qontract_reconcile-0.10.1rc607.dist-info}/RECORD

@@ -393,8 +393,8 @@ reconcile/templates/email.yml.j2,sha256=OZgczNRgXPj2gVYTgwQyHAQrMGu7xp-e4W1rX19G
 reconcile/templates/jira-checkpoint-missinginfo.j2,sha256=c_Vvg-lEENsB3tgxm9B6Y9igCUQhCnFDYh6xw-zcIbU,570
 reconcile/templating/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/templating/renderer.py,sha256=IOZN0ASSKqp4JGXZ1BDba4XosD3nCuqhStxHMGBcxDI,5119
-reconcile/templating/rendering.py,sha256=2kMfstQz12FL-Qfh9OBuzAcYY1OggbFQrCYx1nxERSg,4737
-reconcile/templating/validator.py,sha256=W64nR1eoKVDGewJ4DEX9ZiWWKjFEKg5w5Xi6lrrPBd8,3434
+reconcile/templating/rendering.py,sha256=msMGqCNh7M0c6A1l_7KBmT3GRHH9gsB8htN_9bGtwe4,4949
+reconcile/templating/validator.py,sha256=6ZZs5cREIndgAUHiR1SeDGwaeSLJTJBKHww0nXzgqhQ,4141
 reconcile/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/test/conftest.py,sha256=rQousYrxUz-EwAIbsYO6bIwR1B4CrOz9y_zaUVo2lfI,4466
 reconcile/test/fixtures.py,sha256=9SDWAUlSd1rCx7z3GhULHcpr-I6FyCsXxaFAZIqYQsQ,591
@@ -700,6 +700,7 @@ tools/glitchtip_access_reporter.py,sha256=oPBnk_YoDuljU3v0FaChzOwwnk4vap1xEE67QE
 tools/glitchtip_access_revalidation.py,sha256=8kbBJk04mkq28kWoRDDkfCGIF3GRg3pJrFAh1sW0dbk,2821
 tools/qontract_cli.py,sha256=cnZLJJS-FRUQFUAD90ivt-WEv8NfaemqBvZ9CaFV_kI,110957
 tools/sd_app_sre_alert_report.py,sha256=e9vAdyenUz2f5c8-z-5WY0wv-SJ9aePKDH2r4IwB6pc,5063
+tools/template_validation.py,sha256=XZ6i1iTN2Lknh-8uS-kcbTmYBzJhzl2tLYN6hP33N2Q,3244
 tools/cli_commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tools/cli_commands/gpg_encrypt.py,sha256=w8hl4jIEWk5wKbEFN6fVEOwUJGmdlvOqYodW3XSN7mU,4978
 tools/sre_checkpoints/__init__.py,sha256=CDaDaywJnmRCLyl_NCcvxi-Zc0hTi_3OdwKiFOyS39I,145
@@ -709,8 +710,8 @@ tools/test/test_app_interface_metrics_exporter.py,sha256=SX7qL3D1SIRKFo95FoQztvf
 tools/test/test_qontract_cli.py,sha256=OvalpVRfY4pNmpMaWHHYqBjV68b1eGQjX8SCyTAXb1w,3501
 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.1rc606.dist-info/METADATA,sha256=eUhofv8hXCCHrIOqQ_i7gu9ICj-Yd6JG8k3SibY-ZlY,2349
-qontract_reconcile-0.10.1rc606.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-qontract_reconcile-0.10.1rc606.dist-info/entry_points.txt,sha256=rTjAv28I_CHLM8ID3OPqMI_suoQ9s7tFbim4aYjn9kk,376
-qontract_reconcile-0.10.1rc606.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc606.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc607.dist-info/METADATA,sha256=YA_uMko_z5JCYKe6FRbUNu7lVLlorRq_4HKpwJDrj3Q,2382
+qontract_reconcile-0.10.1rc607.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+qontract_reconcile-0.10.1rc607.dist-info/entry_points.txt,sha256=rIxI5zWtHNlfpDeq1a7pZXAPoqf7HG32KMTN3MeWK_8,429
+qontract_reconcile-0.10.1rc607.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc607.dist-info/RECORD,,

{qontract_reconcile-0.10.1rc606.dist-info → qontract_reconcile-0.10.1rc607.dist-info}/entry_points.txt

@@ -5,3 +5,4 @@ glitchtip-access-reporter = tools.glitchtip_access_reporter:main
 glitchtip-access-revalidation = tools.glitchtip_access_revalidation:main
 qontract-cli = tools.qontract_cli:root
 qontract-reconcile = reconcile.cli:integration
+template-validation = tools.template_validation:main

reconcile/templating/rendering.py

@@ -1,12 +1,13 @@
 import logging
 from abc import ABC, abstractmethod
+from io import StringIO
 from typing import Any, Optional, Protocol
 
 from pydantic import BaseModel
-from ruamel import yaml
 
 from reconcile.utils.jinja2.utils import Jinja2TemplateError, 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
 
 
@@ -40,11 +41,12 @@ class Renderer(ABC):
         self,
         template: Template,
         data: TemplateData,
-        secret_reader: SecretReaderBase,
+        secret_reader: Optional[SecretReaderBase] = None,
     ):
         self.template = template
         self.data = data
         self.secret_reader = secret_reader
+        self.ruaml_instace = create_ruamel_instance()
 
     def _jinja2_render_kwargs(self) -> dict[str, Any]:
         return {**self.data.variables, "current": self.data.current}
@@ -108,7 +110,9 @@ class PatchRenderer(Renderer):
             )
         matched_value = matched_values[0]
 
-        data_to_add = yaml.safe_load(self._render_template(self.template.template))
+        data_to_add = self.ruaml_instace.load(
+            self._render_template(self.template.template)
+        )
 
         if isinstance(matched_value, list):
             if not self.template.patch.identifier:
@@ -136,13 +140,15 @@ class PatchRenderer(Renderer):
         else:
             matched_value.update(data_to_add)
 
-        return yaml.dump(self.data.current, width=4096, Dumper=yaml.RoundTripDumper)
+        with StringIO() as s:
+            self.ruaml_instace.dump(self.data.current, s)
+            return s.getvalue()
 
 
 def create_renderer(
     template: Template,
     data: TemplateData,
-    secret_reader: SecretReaderBase,
+    secret_reader: Optional[SecretReaderBase] = None,
 ) -> Renderer:
     if template.patch:
         return PatchRenderer(template=template, data=data, secret_reader=secret_reader)

reconcile/templating/validator.py

@@ -5,13 +5,17 @@ from typing import Callable, Optional
 from pydantic import BaseModel
 from ruamel import yaml
 
-from reconcile.gql_definitions.templating.templates import TemplateV1, query
-from reconcile.templating.rendering import TemplateData, create_renderer
+from reconcile.gql_definitions.templating.templates import (
+    TemplateTestV1,
+    TemplateV1,
+    query,
+)
+from reconcile.templating.rendering import Renderer, TemplateData, create_renderer
 from reconcile.utils import gql
 from reconcile.utils.runtime.integration import (
     QontractReconcileIntegration,
-    RunParamsTypeVar,
 )
+from reconcile.utils.secret_reader import SecretReaderBase
 
 QONTRACT_INTEGRATION = "template-validator"
 
@@ -31,70 +35,95 @@ class TemplateDiff(BaseModel):
 
 
 class TemplateValidatorIntegration(QontractReconcileIntegration):
-    def __init__(self, params: RunParamsTypeVar) -> None:
-        super().__init__(params)
-        self.diffs: list[TemplateDiff] = []
-
-    def diff_result(
-        self, template_name: str, test_name: str, output: str, expected: str
-    ) -> None:
-        diff = list(
-            context_diff(
-                output.splitlines(keepends=True), expected.splitlines(keepends=True)
-            )
+    @staticmethod
+    def _create_renderer(
+        template: TemplateV1,
+        template_test: TemplateTestV1,
+        secret_reader: Optional[SecretReaderBase] = None,
+    ) -> Renderer:
+        return create_renderer(
+            template,
+            TemplateData(
+                variables=template_test.variables or {},
+                current=yaml.load(
+                    template_test.current or "", Loader=yaml.RoundTripLoader
+                ),
+            ),
+            secret_reader=secret_reader,
+        )
+
+    @staticmethod
+    def validate_template(
+        template: TemplateV1,
+        template_test: TemplateTestV1,
+        secret_reader: Optional[SecretReaderBase] = None,
+    ) -> list[TemplateDiff]:
+        diffs: list[TemplateDiff] = []
+
+        r = TemplateValidatorIntegration._create_renderer(
+            template, template_test, secret_reader=secret_reader
         )
-        if diff:
-            self.diffs.append(
-                TemplateDiff(template=template_name, test=test_name, diff="".join(diff))
+
+        # Check target path
+        if template_test.expected_target_path:
+            rendered_target_path = r.render_target_path().strip()
+            if rendered_target_path != template_test.expected_target_path.strip():
+                diffs.append(
+                    TemplateDiff(
+                        template=template.name,
+                        test=template_test.name,
+                        diff=f"Target path mismatch, got: {rendered_target_path}, expected: {template_test.expected_target_path}",
+                    )
+                )
+
+        # Check condition
+        should_render = r.render_condition()
+        if (
+            template_test.expected_to_render is not None
+            and template_test.expected_to_render != should_render
+        ):
+            diffs.append(
+                TemplateDiff(
+                    template=template.name,
+                    test=template_test.name,
+                    diff=f"Condition mismatch, got: {should_render}, expected: {template_test.expected_to_render}",
+                )
             )
 
+        # Check template output
+        if should_render:
+            output = r.render_output()
+            diff = list(
+                context_diff(
+                    output.splitlines(keepends=True),
+                    template_test.expected_output.splitlines(keepends=True),
+                )
+            )
+            if diff:
+                diffs.append(
+                    TemplateDiff(
+                        template=template.name,
+                        test=template_test.name,
+                        diff="".join(diff),
+                    )
+                )
+
+        return diffs
+
     def run(self, dry_run: bool) -> None:
+        diffs: list[TemplateDiff] = []
+
         for template in get_templates():
             for test in template.template_test:
                 logging.info(f"Running test {test.name} for template {template.name}")
-                r = create_renderer(
-                    template,
-                    TemplateData(
-                        variables=test.variables or {},
-                        current=yaml.load(
-                            test.current or "", Loader=yaml.RoundTripLoader
-                        ),
-                    ),
-                    secret_reader=self.secret_reader,
-                )
-                if test.expected_target_path:
-                    self.diff_result(
-                        template.name,
-                        test.name,
-                        r.render_target_path().strip(),
-                        test.expected_target_path.strip(),
-                    )
-                should_render = r.render_condition()
-                if (
-                    test.expected_to_render is not None
-                    and test.expected_to_render != should_render
-                ):
-                    self.diffs.append(
-                        TemplateDiff(
-                            template=template.name,
-                            test=test.name,
-                            diff=f"Condition mismatch, got: {should_render}, expected: {test.expected_to_render}",
-                        )
-                    )
-                if should_render:
-                    self.diff_result(
-                        template.name,
-                        test.name,
-                        r.render_output().strip(),
-                        test.expected_output.strip(),
-                    )
+                diffs.extend(self.validate_template(template, test, self.secret_reader))
 
-        if self.diffs:
-            for diff in self.diffs:
+        if diffs:
+            for diff in diffs:
                 logging.error(
                     f"template: {diff.template}, test: {diff.test}: {diff.diff}"
                 )
-            raise ValueError("Template validation")
+            raise ValueError("Template validation failed")
 
     @property
     def name(self) -> str:

tools/template_validation.py

@@ -0,0 +1,107 @@
+import json
+import os.path
+import sys
+
+import click
+from yamllint import linter  # type: ignore
+from yamllint.config import YamlLintConfig  # type: ignore
+
+from reconcile.gql_definitions.templating.templates import TemplateV1
+from reconcile.templating.validator import TemplateDiff, TemplateValidatorIntegration
+from reconcile.utils.models import data_default_none
+from reconcile.utils.ruamel import create_ruamel_instance
+
+
+def load_clean_yaml(ai_path: str, path: str) -> dict:
+    if not path.startswith("/data/"):
+        to_load = os.path.join(ai_path, "data", path.lstrip("/"))
+    else:
+        to_load = os.path.join(ai_path, path.lstrip("/"))
+
+    y = load_yaml(to_load)
+
+    if "$schema" in y:
+        del y["$schema"]
+    return y
+
+
+def load_yaml(to_load: str) -> dict:
+    ruamel_instance = create_ruamel_instance()
+    with open(to_load, "r", encoding="utf-8") as file:
+        return ruamel_instance.load(file)
+
+
+def print_lint_problems(lint_problems: list[linter.LintProblem]) -> None:
+    print("--------- LINTING ISSUES ---------")
+    print(f"Found {len(lint_problems)} lint problems:")
+    for problem in lint_problems:
+        print(f"Lint error in line: {problem.line}, {problem.desc}")
+    print("--------- END LINTING ISSUES ---------")
+
+
+def print_test_diffs(diffs: list[TemplateDiff]) -> None:
+    print("--------- TEMPLATE TEST DIFF ---------")
+    print("Template validation failed")
+    for d in diffs:
+        for line in d.diff.splitlines():
+            if line:
+                print(f"{line}")
+    print("--------- END TEMPLATE TEST DIFF ---------")
+
+
+@click.command()
+@click.option(
+    "--ai-path",
+    help="Path to the bundle file",
+    default=None,
+    required=True,
+)
+@click.option(
+    "--template-path",
+    help="Path to the template file",
+    default=None,
+    required=True,
+)
+def main(ai_path: str, template_path: str) -> None:
+    okay = True
+    templateRaw = load_clean_yaml(ai_path, template_path)
+
+    tests = []
+    for testRaw in templateRaw["templateTest"]:
+        test_yaml = load_clean_yaml(ai_path, testRaw["$ref"])
+        variables = json.dumps(test_yaml["variables"])
+        test_yaml["variables"] = variables
+        tests.append(test_yaml)
+
+    templateRaw["templateTest"] = tests
+    template: TemplateV1 = TemplateV1(**data_default_none(TemplateV1, templateRaw))
+
+    # templates_to_validate = {}
+    for test in template.template_test:
+        diffs: list[TemplateDiff] = []
+        print("Running tests:", test.name)
+        diffs.extend(TemplateValidatorIntegration.validate_template(template, test))
+
+        renderer = TemplateValidatorIntegration._create_renderer(template, test)
+        if renderer.render_condition():
+            output = renderer.render_output()
+            lint_problems = list(
+                linter.run(output, YamlLintConfig(file=f"{ai_path}/.yamllint"), "")
+            )
+            if lint_problems:
+                okay = False
+                print_lint_problems(lint_problems)
+
+        if diffs:
+            okay = False
+            print_test_diffs(diffs)
+
+    if okay:
+        print("... passed")
+        sys.exit(0)
+    print("... failed")
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()  # pylint: disable=no-value-for-parameter