Add more strict Helm Chart schema checks for image pullPolicy & dags …

…accessMode (#15040) `values.schema.json` can be used to help check the structure & the values in `values.yaml`. - In this PR I extend the `values.schema.json` to ensure we have more strict checks on the values users add in `values.yaml`. - Tests are added.
apache · Mar 26, 2021 · 28859ca · 28859ca
1 parent 614be87
commit 28859ca
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 9 deletions.
diff --git a/chart/tests/test_basic_helm_chart.py b/chart/tests/test_basic_helm_chart.py
@@ -19,6 +19,7 @@
 from typing import Any, Dict, List, Union
 
 import jmespath
+from parameterized import parameterized
 
 from tests.helm_template_generator import render_chart
 
@@ -146,3 +147,41 @@ def test_unsupported_executor(self):
             'executor must be one of the following: "LocalExecutor", "CeleryExecutor", '
             '"KubernetesExecutor", "CeleryKubernetesExecutor"' in ex_ctx.exception.stderr.decode()
         )
+
+    @parameterized.expand(
+        [
+            ("airflow",),
+            ("pod_template",),
+            ("flower",),
+            ("statsd",),
+            ("redis",),
+            ("pgbouncer",),
+            ("pgbouncerExporter",),
+            ("gitSync",),
+        ]
+    )
+    def test_invalid_pull_policy(self, image):
+        with self.assertRaises(CalledProcessError) as ex_ctx:
+            render_chart(
+                "TEST-BASIC",
+                {
+                    "images": {image: {"pullPolicy": "InvalidPolicy"}},
+                },
+            )
+        assert (
+            'pullPolicy must be one of the following: "Always", "Never", "IfNotPresent"'
+            in ex_ctx.exception.stderr.decode()
+        )
+
+    def test_invalid_dags_access_mode(self):
+        with self.assertRaises(CalledProcessError) as ex_ctx:
+            render_chart(
+                "TEST-BASIC",
+                {
+                    "dags": {"persistence": {"accessMode": "InvalidMode"}},
+                },
+            )
+        assert (
+            'accessMode must be one of the following: "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany"'
+            in ex_ctx.exception.stderr.decode()
+        )
diff --git a/chart/values.schema.json b/chart/values.schema.json
@@ -192,7 +192,8 @@
                         },
                         "pullPolicy": {
                             "description": "The airflow image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -216,7 +217,8 @@
                         },
                         "pullPolicy": {
                             "description": "The pod_template image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -240,7 +242,8 @@
                         },
                         "pullPolicy": {
                             "description": "The flower image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -258,7 +261,8 @@
                         },
                         "pullPolicy": {
                             "description": "The statsd image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -276,7 +280,8 @@
                         },
                         "pullPolicy": {
                             "description": "The redis image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -294,7 +299,8 @@
                         },
                         "pullPolicy": {
                             "description": "The PgBouncer image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -312,7 +318,8 @@
                         },
                         "pullPolicy": {
                             "description": "The PgBouncer exporter image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 },
@@ -330,7 +337,8 @@
                         },
                         "pullPolicy": {
                             "description": "The gitSync image pull policy.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["Always", "Never", "IfNotPresent"]
                         }
                     }
                 }
@@ -1386,7 +1394,8 @@
                         },
                         "accessMode": {
                             "description": "Access mode of the persistent volume.",
-                            "type": "string"
+                            "type": "string",
+                            "enum": ["ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany"]
                         },
                         "existingClaim": {
                             "description": "The name of an existing PVC to use.",