kapitan 0.35.2.dev33__tar.gz → 0.35.2.dev35__tar.gz

{kapitan-0.35.2.dev33 → kapitan-0.35.2.dev35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kapitan
-Version: 0.35.2.dev33
+Version: 0.35.2.dev35
 Summary: Generic templated configuration management for Kubernetes, Terraform and other things
 Project-URL: Homepage, https://kapitan.dev
 Project-URL: Repository, https://github.com/kapicorp/kapitan

{kapitan-0.35.2.dev33 → kapitan-0.35.2.dev35}/kapitan/refs/cmd_parser.py

@@ -28,6 +28,13 @@ from kapitan.utils import fatal_error, search_target_token_paths
 logger = logging.getLogger(__name__)
 
 
+def _validate_token_name(token_name):
+    if token_name.count(":") != 1:
+        raise KapitanError(
+            f"Invalid token name: {token_name}. Token names must be in the format <type>:<path>, e.g. gpg:my/secret"
+        )
+
+
 def handle_refs_command(args):
     ref_controller = RefController(args.refs_path)
 
@@ -80,6 +87,8 @@ def ref_write(args, ref_controller):
                 f"parameters.kapitan.secrets not defined in {args.target_name}"
             ) from e
 
+    _validate_token_name(token_name)
+
     type_name, token_path = token_name.split(":")
 
     try:
@@ -264,6 +273,8 @@ def secret_update(args, ref_controller):
                 f"parameters.kapitan.secrets not defined in {args.target_name}"
             )
 
+    _validate_token_name(token_name)
+
     type_name, token_path = token_name.split(":")
 
     if type_name not in KapitanReferencesTypes:

{kapitan-0.35.2.dev33 → kapitan-0.35.2.dev35}/kapitan/utils.py

@@ -50,6 +50,16 @@ try:
 except ImportError:
     from yaml import SafeLoader as YamlLoader
 
+# PyYAML SafeLoader lacks constructor for 'tag:yaml.org,2002:value' (bare '=').
+# Some charts emit this, causing a ConstructorError. Treat it as a scalar string.
+# https://github.com/yaml/pyyaml/issues/89
+# https://github.com/kapicorp/kapitan/issues/1415
+for _YamlLoader in {YamlLoader, yaml.SafeLoader}:
+    _YamlLoader.add_constructor(
+        "tag:yaml.org,2002:value",
+        lambda loader, node: loader.construct_scalar(node),
+    )
+
 
 def fatal_error(message):
     "Logs error message, sys.exit(1)"

{kapitan-0.35.2.dev33 → kapitan-0.35.2.dev35}/tests/test_cli.py

@@ -18,6 +18,7 @@ import pytest
 
 from kapitan.cli import build_parser
 from kapitan.cli import main as kapitan
+from kapitan.errors import KapitanError
 from kapitan.refs.secrets.vaultkv import VaultSecret
 from tests.vault_server import get_shared_vault_server
 
@@ -416,6 +417,28 @@ class CliFuncsTest(unittest.TestCase):
 
         os.remove(test_tag_file)
 
+    def test_cli_secret_write_invalid_ref_name(self):
+        """
+        run $ kapitan refs --write my-ref-name -f content.txt
+        expect KapitanError with clear message
+        """
+        test_secret_content = "secret_value!"
+        test_secret_file = tempfile.mktemp()
+        with open(test_secret_file, "w") as fp:
+            fp.write(test_secret_content)
+
+        with self.assertRaises(KapitanError) as cm:
+            kapitan(
+                "refs",
+                "--write",
+                "my-ref-name",
+                "-f",
+                test_secret_file,
+                "--refs-path",
+                REFS_PATH,
+            )
+        self.assertIn("Invalid token name: my-ref-name", str(cm.exception))
+
     def test_cli_secret_write_plain_ref(self):
         """
         run $ kapitan refs --write plain:test_secret

{kapitan-0.35.2.dev33 → kapitan-0.35.2.dev35}/tests/test_utils.py

@@ -14,8 +14,11 @@ import stat
 import tempfile
 import unittest
 
+import yaml
+
 from kapitan.utils import (
     SafeCopyError,
+    YamlLoader,
     compare_versions,
     copy_tree,
     deep_get,
@@ -121,6 +124,25 @@ class CopyTreeTest(unittest.TestCase):
         shutil.rmtree(self.temp_dir)
 
 
+class YamlLoaderValueTagTest(unittest.TestCase):
+    """Regression test for PyYAML ConstructorError on bare '=' (value tag).
+
+    https://github.com/kapicorp/kapitan/issues/1415
+    """
+
+    def test_bare_equal_sign(self):
+        result = yaml.load("=", Loader=YamlLoader)
+        self.assertEqual(result, "=")
+
+    def test_list_with_equal_sign(self):
+        result = yaml.load("- =", Loader=YamlLoader)
+        self.assertEqual(result, ["="])
+
+    def test_nested_equal_sign(self):
+        result = yaml.load("items:\n  - =", Loader=YamlLoader)
+        self.assertEqual(result, {"items": ["="]})
+
+
 class PruneEmptyTest(unittest.TestCase):
     """Test prune_empty removes empty collections recursively."""