kubernator 1.0.23.dev20251016050525__py3-none-any.whl → 1.0.24.dev20251028221359__py3-none-any.whl

kubernator/__init__.py

@@ -16,7 +16,7 @@
 #   limitations under the License.
 #
 
-__version__ = "1.0.23.dev20251016050525"
+__version__ = "1.0.24.dev20251028221359"
 
 
 def _main():

kubernator/api.py

@@ -20,10 +20,10 @@ import fnmatch
 import json
 import logging
 import os
-import io
 import platform
 import re
 import sys
+import textwrap
 import traceback
 import urllib.parse
 from collections.abc import Callable
@@ -48,6 +48,7 @@ from jinja2 import (Environment,
                     pass_context)
 from jsonschema import validators
 from platformdirs import user_cache_dir
+from yaml import MarkedYAMLError
 
 from kubernator._json_path import jp  # noqa: F401
 from kubernator._k8s_client_patches import (URLLIB_HEADERS_PATCH,
@@ -59,6 +60,43 @@ _CACHE_HEADER_TRANSLATION = {"etag": "if-none-match",
 _CACHE_HEADERS = ("etag", "last-modified")
 
 
+def to_json(obj: Union[dict, list]):
+    return json.dumps(obj)
+
+
+def to_yaml_str(s: str):
+    return repr(s)
+
+
+def to_json_yaml_str(obj: Union[dict, list]):
+    """
+    Takes `obj`, dumps as json representation, converts json representation to YAML string literal.
+    """
+    return to_yaml_str(to_json(obj))
+
+
+def to_yaml_str_block(s: str, indent: int = 4, pretty_indent: int = 2):
+    """
+    Takes a multiline string, dedents it then indents it `indent` spaces for in-yaml alignment and
+    `pretty-indent` spaces for in-block alignment.
+    """
+    return (f"|+{pretty_indent}\n" +
+            textwrap.indent(textwrap.dedent(s), " " * (indent + pretty_indent)))
+
+
+def to_json_yaml_str_block(obj: Union[str, dict, list], indent: int = 4, pretty_indent=2):
+    """
+    Takes an `obj`, serializes it as pretty JSON with `pretty_indent` in-json indentation and then
+    passes it to `to_yaml_str_block`.
+    """
+    return to_yaml_str_block(json.dumps(obj, indent=pretty_indent), indent=indent, pretty_indent=pretty_indent)
+
+
+def to_yaml(obj: Union[dict, list], level_indent: int, indent: int):
+    s = yaml.safe_dump(obj, indent=indent)
+    return "\n" + textwrap.indent(s, " " * level_indent)
+
+
 class TemplateEngine:
     VARIABLE_START_STRING = "{${"
     VARIABLE_END_STRING = "}$}"
@@ -97,7 +135,15 @@ class TemplateEngine:
                                variable_end_string=self.VARIABLE_END_STRING,
                                autoescape=False,
                                finalize=variable_finalizer,
-                               undefined=logging_undefined)
+                               undefined=logging_undefined,
+                               )
+
+        self.env.filters["to_json"] = to_json
+        self.env.filters["to_yaml_str"] = to_yaml_str
+        self.env.filters["to_yaml"] = to_yaml
+        self.env.filters["to_yaml_str_block"] = to_yaml_str_block
+        self.env.filters["to_json_yaml_str_block"] = to_json_yaml_str_block
+        self.env.filters["to_json_yaml_str"] = to_json_yaml_str
 
     def from_string(self, template):
         return self.env.from_string(template)
@@ -136,9 +182,18 @@ def scan_dir(logger, path: Path, path_filter: Callable[[os.DirEntry], bool], exc
                 yield path / f
 
 
+def parse_yaml_docs(document: str, source=None):
+    try:
+        return list(d for d in yaml.safe_load_all(document) if d)
+    except MarkedYAMLError:
+        raise
+
+
 class FileType(Enum):
-    JSON = (json.load,)
-    YAML = (yaml.safe_load_all,)
+    TEXT = (lambda x: x,)
+    BINARY = (lambda x: x,)
+    JSON = (json.loads,)
+    YAML = (parse_yaml_docs,)
 
     def __init__(self, func):
         self.func = func
@@ -147,13 +202,13 @@ class FileType(Enum):
 def _load_file(logger, path: Path, file_type: FileType, source=None,
                template_engine: Optional[TemplateEngine] = None,
                template_context: Optional[dict] = None) -> Iterable[dict]:
-    with open(path, "rb" if not template_engine else "rt") as f:
+    with open(path, "rb" if file_type == FileType.BINARY else "rt") as f:
         try:
-            if template_engine:
+            if template_engine and not file_type == FileType.BINARY:
                 raw_data = template_engine.from_string(f.read()).render(template_context)
-                f.close()
-                f = io.StringIO(raw_data)
-            data = file_type.func(f)
+            else:
+                raw_data = f.read()
+            data = file_type.func(raw_data)
             if isinstance(data, GeneratorType):
                 data = list(data)
             return data

kubernator/plugins/k8s.py

@@ -112,6 +112,7 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
 
         self._transformers = []
         self._validators = []
+        self._manifest_patchers = []
         self._summary = 0, 0, 0
         self._template_engine = TemplateEngine(logger)
 
@@ -150,6 +151,7 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
                                    add_transformer=self.api_add_transformer,
                                    remove_transformer=self.api_remove_transformer,
                                    add_validator=self.api_remove_validator,
+                                   add_manifest_patcher=self.api_add_manifest_patcher,
                                    get_api_versions=self.get_api_versions,
                                    create_resource=self.create_resource,
                                    disable_client_patches=disable_client_patches,
@@ -373,6 +375,10 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
         if validator not in self._validators:
             self._validators.append(validator)
 
+    def api_add_manifest_patcher(self, patcher):
+        if patcher not in self._manifest_patchers:
+            self._manifest_patchers.append(patcher)
+
     def api_remove_transformer(self, transformer):
         if transformer in self._transformers:
             self._transformers.remove(transformer)
@@ -391,6 +397,17 @@ class KubernetesPlugin(KubernatorPlugin, K8SResourcePluginMixin):
             frame = frame.f_back
         return ValueError((msg % args) if args else msg).with_traceback(tb)
 
+    def _patch_manifest(self,
+                        manifest: dict,
+                        resource_description: str):
+        for patcher in reversed(self._manifest_patchers):
+            logger.debug("Applying patcher %s to %s",
+                         getattr(patcher, "__name__", patcher),
+                         resource_description)
+            manifest = patcher(manifest, resource_description) or manifest
+
+        return manifest
+
     def _transform_resource(self, resources: Sequence[K8SResource], resource: K8SResource) -> K8SResource:
         for transformer in reversed(self._transformers):
             logger.debug("Applying transformer %s to %s from %s",

kubernator/plugins/k8s_api.py

@@ -23,7 +23,6 @@ from collections import namedtuple
 from collections.abc import Callable, Mapping, MutableMapping, Sequence, Iterable
 from enum import Enum, auto
 from functools import partial
-from io import StringIO
 from pathlib import Path
 from typing import Union, Optional
 
@@ -34,7 +33,7 @@ from jsonschema.exceptions import ValidationError
 from jsonschema.validators import extend, Draft7Validator
 from openapi_schema_validator import OAS31Validator
 
-from kubernator.api import load_file, FileType, load_remote_file, calling_frame_source
+from kubernator.api import load_file, FileType, load_remote_file, calling_frame_source, parse_yaml_docs
 
 K8S_WARNING_HEADER = re.compile(r'(?:,\s*)?(\d{3})\s+(\S+)\s+"(.+?)(?<!\\)"(?:\s+\"(.+?)(?<!\\)\")?\s*')
 UPPER_FOLLOWED_BY_LOWER_RE = re.compile(r"(.)([A-Z][a-z]+)")
@@ -524,7 +523,7 @@ class K8SResourcePluginMixin:
             source = calling_frame_source()
 
         if isinstance(manifests, str):
-            manifests = list(yaml.safe_load_all(StringIO(manifests)))
+            manifests = list(parse_yaml_docs(manifests, source))
 
         if isinstance(manifests, (Mapping, dict)):
             return self.add_resource(manifests, source)
@@ -557,7 +556,7 @@ class K8SResourcePluginMixin:
             source = calling_frame_source()
 
         if isinstance(manifests, str):
-            manifests = list(yaml.safe_load_all(StringIO(manifests)))
+            manifests = list(parse_yaml_docs(manifests, source))
 
         if isinstance(manifests, (Mapping, dict)):
             return self.add_crd(manifests, source)
@@ -614,8 +613,13 @@ class K8SResourcePluginMixin:
 
     def _create_resource(self, manifest: dict, source: Union[str, Path] = None):
         resource_description = K8SResource.get_manifest_description(manifest, source)
-        self.logger.debug("Validating K8S manifest for %s", resource_description)
 
+        new_manifest = self._patch_manifest(manifest, resource_description)
+        if new_manifest != manifest:
+            manifest = new_manifest
+            resource_description = K8SResource.get_manifest_description(manifest, source)
+
+        self.logger.debug("Validating K8S manifest for %s", resource_description)
         errors = list(self._validate_resource(manifest, source))
         if errors:
             for error in errors:
@@ -644,6 +648,11 @@ class K8SResourcePluginMixin:
 
         return resource
 
+    def _patch_manifest(self,
+                        manifest: dict,
+                        resource_description: str):
+        return manifest
+
     def _transform_resource(self,
                             resources: Sequence[K8SResource],
                             resource: K8SResource) -> K8SResource:

kubernator/plugins/kubectl.py

@@ -16,7 +16,6 @@
 #   limitations under the License.
 #
 
-import io
 import json
 import logging
 import os
@@ -121,7 +120,7 @@ class KubectlPlugin(KubernatorPlugin):
             args += ["-n", namespace]
         args += ["-o", "yaml"]
 
-        res = list(yaml.safe_load_all(io.StringIO(self.context.kubectl.run_capturing(*args))))
+        res = list(yaml.safe_load_all(self.context.kubectl.run_capturing(*args)))
         if len(res):
             if len(res) > 1:
                 return res

{kubernator-1.0.23.dev20251016050525.dist-info → kubernator-1.0.24.dev20251028221359.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kubernator
-Version: 1.0.23.dev20251016050525
+Version: 1.0.24.dev20251028221359
 Summary: Kubernator is the a pluggable framework for K8S provisioning
 Home-page: https://github.com/karellen/kubernator
 Author: Express Systems USA, Inc.

{kubernator-1.0.23.dev20251016050525.dist-info → kubernator-1.0.24.dev20251028221359.dist-info}/RECORD

@@ -1,9 +1,9 @@
 kubernator/LICENSE,sha256=wKKdOCMTCPQRV5gDkVLAsXX8qSnRJ5owk7yWPO1KZNo,11387
-kubernator/__init__.py,sha256=5Jv1CmY-id1D3S3zLQ3LLcy6PVGc7WlSa6Sj3I56beI,933
+kubernator/__init__.py,sha256=WHARX7iD1ynhZP3A9V92ZVg_I8fgalutzhfkByBwLAw,933
 kubernator/__main__.py,sha256=f0S60wgpLu--1UlOhzfWail-xt8zyIuODodX98_yPN0,707
 kubernator/_json_path.py,sha256=pjQKXxgbpQWETYBIrIuJZHgugF92IbEAM19AC7JUmAQ,3162
 kubernator/_k8s_client_patches.py,sha256=PEeWPInnW38NDyK7G24_Dmw-x7xHpN3vJWZeckdqgK0,76892
-kubernator/api.py,sha256=nLHzhgKocgduBDT22-nlAhpR2xCS6z24jb8NTic0yNc,29547
+kubernator/api.py,sha256=Dm-zStoFNcif_2Rw28PqhtyWvudx-Z2PHdntVSgbFNc,31431
 kubernator/app.py,sha256=ETgysPcIKEDsMTbdIw00-enSLip7Z2cECJrRxjf9ciw,21214
 kubernator/merge.py,sha256=eW5fajnDdI2n8aUqRfTmdG6GWDvDtcVKPKsp3fiB5Nk,5882
 kubernator/proc.py,sha256=43jrpTe1FCdhDIK0b6hnB6XqU_m7iYu3wbzJyzO3pl0,5979
@@ -13,19 +13,19 @@ kubernator/plugins/eks.py,sha256=xe7vyPHNwuP8gEYDSzPyBkm-RkAtP64wCOqs9U5I7xI,227
 kubernator/plugins/gke.py,sha256=HZc-Bu2W8MvF50EgoAcZ8W-CAVEWJ4y8f4yG_3s8C1w,3429
 kubernator/plugins/helm.py,sha256=2563hLr0uJucw0xo9JLfbCtpGPRZ5e5gYTnapQrqy3w,12036
 kubernator/plugins/istio.py,sha256=UFSBJo-I2x4F-ZO5WCSMpConOr_oYNZZb66DNOI_nME,15399
-kubernator/plugins/k8s.py,sha256=A2qSOjkPasgBEc1Le2UXuSKTItd0Qz63E6Vv8WVQ0hQ,27307
-kubernator/plugins/k8s_api.py,sha256=IkiegYwHJUasH5BlBxLo2_064cuzOGr3OJ1ToGy1p-s,27527
+kubernator/plugins/k8s.py,sha256=Y9QSaRzX5BDE_-nmlwjHYgVOEZK4Zs_hvnJIZ8PxZyQ,28030
+kubernator/plugins/k8s_api.py,sha256=dP4W8AFgH6mTvsbwd10EGfmG55wG3E0SZ7RGQpDgpdw,27897
 kubernator/plugins/kops.py,sha256=-yhpEjydz9E7Ep24WtEs93rLTXtw4yakdgVqXlIj1ww,9688
 kubernator/plugins/kubeconfig.py,sha256=uwtHmF2I6LiTPrC3M88G5SfYxDWtuh0MqcMfrHHoNRA,2178
-kubernator/plugins/kubectl.py,sha256=hV6rnTj0XmQe5QJp3p6fNK3EQrWdNlam0qxsK3IkD5g,5125
+kubernator/plugins/kubectl.py,sha256=kz2BKJrg0M2yRJ4Tug9rZgjSEURbT5ybVx4fScDZt58,5102
 kubernator/plugins/minikube.py,sha256=zbboER1VsCvIsh-yUE3_XpzPNcT4c6vh1LigDonEm3U,12384
 kubernator/plugins/template.py,sha256=542nyS4ZNgdwJHEoIA5aLP1d4C312ydd7sPM9ZFbHuI,8357
 kubernator/plugins/terraform.py,sha256=a1MPl9G8Rznjd28uMRdYWrjpFDLlFAVmLFH4hFEsMsQ,5285
 kubernator/plugins/terragrunt.py,sha256=-qN8tTqPUXJ9O7CEiJVUB0GSUQU3DUTkv-aWdIIsm7Q,5051
-kubernator-1.0.23.dev20251016050525.dist-info/METADATA,sha256=BWAjtLDqU_LtP7LceuFmKkVPNjv4x6QznztRFqdBH4k,10840
-kubernator-1.0.23.dev20251016050525.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kubernator-1.0.23.dev20251016050525.dist-info/entry_points.txt,sha256=IWDtHzyTleRqDSuVRXEr5GImrI7z_kh21t5DWZ8ldcQ,47
-kubernator-1.0.23.dev20251016050525.dist-info/namespace_packages.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-kubernator-1.0.23.dev20251016050525.dist-info/top_level.txt,sha256=_z1CxWeKMI55ckf2vC8HqjbCn_E2Y_P5RdrhE_QWcIs,11
-kubernator-1.0.23.dev20251016050525.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-kubernator-1.0.23.dev20251016050525.dist-info/RECORD,,
+kubernator-1.0.24.dev20251028221359.dist-info/METADATA,sha256=zcqg9pH8ANX4v_ia4HNPMGPv7pXhnJtojPg6tdq0YDM,10840
+kubernator-1.0.24.dev20251028221359.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kubernator-1.0.24.dev20251028221359.dist-info/entry_points.txt,sha256=IWDtHzyTleRqDSuVRXEr5GImrI7z_kh21t5DWZ8ldcQ,47
+kubernator-1.0.24.dev20251028221359.dist-info/namespace_packages.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+kubernator-1.0.24.dev20251028221359.dist-info/top_level.txt,sha256=_z1CxWeKMI55ckf2vC8HqjbCn_E2Y_P5RdrhE_QWcIs,11
+kubernator-1.0.24.dev20251028221359.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+kubernator-1.0.24.dev20251028221359.dist-info/RECORD,,