Feat/schema validation (helm#5350)

* Add the Schema type and a function to read it

* Added a function to read a schema from a file

* Check that values.yaml matches schema

This commit uses the gojsonschema package to validate a values.yaml file
against a corresponding values.schema.yaml file.

* Add functionality to generate a schema from a values.yaml

* Add Schema to Chart and loader

* Clean up implementation in chartutil

* Add tests for helm install with schema

* Add schema validation to helm lint

* Clean up "matchSchema"

* Modify error output

* Add documentation

* Fix a linter issue

* Fix a test that broke during a rebase

* Clean up documentation

* Specify JSONSchema spec

Since JSONSchema is still in a draft state as of this commit, we need to
specify a particular version of the JSONSchema spec

* Switch to using builtin functionality for file extensions

* Switch to using a third-party library for JSON conversion

* Use the constants from the gojsonschema package

* Updates to unit tests

* Minor change to avoid string cast

* Remove JSON Schema generation

* Change Schema type from map[string]interface{} to []byte

* Convert all Schema YAML to JSON

* Fix some tests that were broken by a rebase

* Fix up YAML/JSON conversions

* This checks subcharts for schema validation

The final coalesced values for a given chart will be validated against
that chart's schema, as well as any dependent subchart's schema

* Add unit tests for ValidateAgainstSchema

* Remove nonessential test files

* Remove a misleading unit test

The TestReadSchema unit test was simply testing the ReadValues function,
which is already being validated in the TestReadValues unit test

* Update documentation to reflect changes to subchart schemas

Gopkg.toml

@@ -107,3 +107,6 @@
   go-tests = true
   unused-packages = true
 
+[[constraint]]
+  name = "github.com/xeipuuv/gojsonschema"
+  version = "1.1.0"

cmd/helm/install_test.go

@@ -136,6 +136,53 @@ func TestInstall(t *testing.T) {
 			wantError: true,
 			golden:    "output/install-chart-bad-type.txt",
 		},
+		// Install, values from yaml, schematized
+		{
+			name:   "install with schema file",
+			cmd:    "install schema testdata/testcharts/chart-with-schema",
+			golden: "output/schema.txt",
+		},
+		// Install, values from yaml, schematized with errors
+		{
+			name:      "install with schema file, with errors",
+			cmd:       "install schema testdata/testcharts/chart-with-schema-negative",
+			wantError: true,
+			golden:    "output/schema-negative.txt",
+		},
+		// Install, values from yaml, extra values from yaml, schematized with errors
+		{
+			name:      "install with schema file, extra values from yaml, with errors",
+			cmd:       "install schema testdata/testcharts/chart-with-schema -f testdata/testcharts/chart-with-schema/extra-values.yaml",
+			wantError: true,
+			golden:    "output/schema-negative.txt",
+		},
+		// Install, values from yaml, extra values from cli, schematized with errors
+		{
+			name:      "install with schema file, extra values from cli, with errors",
+			cmd:       "install schema testdata/testcharts/chart-with-schema --set age=-5",
+			wantError: true,
+			golden:    "output/schema-negative-cli.txt",
+		},
+		// Install with subchart, values from yaml, schematized with errors
+		{
+			name:      "install with schema file and schematized subchart, with errors",
+			cmd:       "install schema testdata/testcharts/chart-with-schema-and-subchart",
+			wantError: true,
+			golden:    "output/subchart-schema-negative.txt",
+		},
+		// Install with subchart, values from yaml, extra values from cli, schematized with errors
+		{
+			name:   "install with schema file and schematized subchart, extra values from cli",
+			cmd:    "install schema testdata/testcharts/chart-with-schema-and-subchart --set lastname=doe --set subchart-with-schema.age=25",
+			golden: "output/subchart-schema-cli.txt",
+		},
+		// Install with subchart, values from yaml, extra values from cli, schematized with errors
+		{
+			name:      "install with schema file and schematized subchart, extra values from cli, with errors",
+			cmd:       "install schema testdata/testcharts/chart-with-schema-and-subchart --set lastname=doe --set subchart-with-schema.age=-25",
+			wantError: true,
+			golden:    "output/subchart-schema-cli-negative.txt",
+		},
 	}
 
 	runTestActionCmd(t, tests)

cmd/helm/testdata/output/schema-negative-cli.txt

@@ -0,0 +1,4 @@
+Error: values don't meet the specifications of the schema(s) in the following chart(s):
+empty:
+- age: Must be greater than or equal to 0/1
+

cmd/helm/testdata/output/schema-negative.txt

@@ -0,0 +1,5 @@
+Error: values don't meet the specifications of the schema(s) in the following chart(s):
+empty:
+- (root): employmentInfo is required
+- age: Must be greater than or equal to 0/1
+

cmd/helm/testdata/output/schema.txt

@@ -0,0 +1,5 @@
+NAME: schema
+LAST DEPLOYED: 1977-09-02 22:04:05 +0000 UTC
+NAMESPACE: default
+STATUS: deployed
+

cmd/helm/testdata/output/subchart-schema-cli-negative.txt

@@ -0,0 +1,4 @@
+Error: values don't meet the specifications of the schema(s) in the following chart(s):
+subchart-with-schema:
+- age: Must be greater than or equal to 0/1
+

cmd/helm/testdata/output/subchart-schema-cli.txt

@@ -0,0 +1,5 @@
+NAME: schema
+LAST DEPLOYED: 1977-09-02 22:04:05 +0000 UTC
+NAMESPACE: default
+STATUS: deployed
+

cmd/helm/testdata/output/subchart-schema-negative.txt

@@ -0,0 +1,6 @@
+Error: values don't meet the specifications of the schema(s) in the following chart(s):
+chart-without-schema:
+- (root): lastname is required
+subchart-with-schema:
+- (root): age is required
+

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v1
+name: chart-without-schema
+description: A Helm chart for Kubernetes
+type: application
+version: 0.1.0
+appVersion: 0.1.0

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/charts/subchart-with-schema/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v1
+name: subchart-with-schema
+description: A Helm chart for Kubernetes
+type: application
+version: 0.1.0
+appVersion: 0.1.0

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/charts/subchart-with-schema/templates/empty.yaml

@@ -0,0 +1 @@
+# This file is intentionally blank

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/charts/subchart-with-schema/values.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Values",
+  "type": "object",
+  "properties": {
+    "age": {
+      "description": "Age",
+      "minimum": 0,
+      "type": "integer"
+    }
+  },
+  "required": [
+    "age"
+  ]
+}

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/templates/empty.yaml

@@ -0,0 +1 @@
+# This file is intentionally blank

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/values.schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Values",
+  "type": "object",
+  "properties": {
+    "firstname": {
+      "description": "First name",
+      "type": "string"
+    },
+    "lastname": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "firstname",
+    "lastname"
+  ]
+}

cmd/helm/testdata/testcharts/chart-with-schema-and-subchart/values.yaml

@@ -0,0 +1 @@
+firstname: "John"

cmd/helm/testdata/testcharts/chart-with-schema-negative/Chart.yaml

@@ -0,0 +1,7 @@
+apiVersion: v1
+description: Empty testing chart
+home: https://k8s.io/helm
+name: empty
+sources:
+- https://github.com/kubernetes/helm
+version: 0.1.0

cmd/helm/testdata/testcharts/chart-with-schema-negative/templates/empty.yaml

@@ -0,0 +1 @@
+# This file is intentionally blank

cmd/helm/testdata/testcharts/chart-with-schema-negative/values.schema.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "addresses": {
+      "description": "List of addresses",
+      "items": {
+        "properties": {
+          "city": {
+            "type": "string"
+          },
+          "number": {
+            "type": "number"
+          },
+          "street": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "age": {
+      "description": "Age",
+      "minimum": 0,
+      "type": "integer"
+    },
+    "employmentInfo": {
+      "properties": {
+        "salary": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "salary"
+      ],
+      "type": "object"
+    },
+    "firstname": {
+      "description": "First name",
+      "type": "string"
+    },
+    "lastname": {
+      "type": "string"
+    },
+    "likesCoffee": {
+      "type": "boolean"
+    },
+    "phoneNumbers": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "firstname",
+    "lastname",
+    "addresses",
+    "employmentInfo"
+  ],
+  "title": "Values",
+  "type": "object"
+}

cmd/helm/testdata/testcharts/chart-with-schema-negative/values.yaml

@@ -0,0 +1,14 @@
+firstname: John
+lastname: Doe
+age: -5
+likesCoffee: true
+addresses:
+  - city: Springfield
+    street: Main
+    number: 12345
+  - city: New York
+    street: Broadway
+    number: 67890
+phoneNumbers:
+  - "(888) 888-8888"
+  - "(555) 555-5555"

cmd/helm/testdata/testcharts/chart-with-schema/Chart.yaml

@@ -0,0 +1,7 @@
+apiVersion: v1
+description: Empty testing chart
+home: https://k8s.io/helm
+name: empty
+sources:
+- https://github.com/kubernetes/helm
+version: 0.1.0

cmd/helm/testdata/testcharts/chart-with-schema/extra-values.yaml

@@ -0,0 +1,2 @@
+age: -5
+employmentInfo: null

cmd/helm/testdata/testcharts/chart-with-schema/templates/empty.yaml

@@ -0,0 +1 @@
+# This file is intentionally blank

cmd/helm/testdata/testcharts/chart-with-schema/values.schema.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "addresses": {
+      "description": "List of addresses",
+      "items": {
+        "properties": {
+          "city": {
+            "type": "string"
+          },
+          "number": {
+            "type": "number"
+          },
+          "street": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "age": {
+      "description": "Age",
+      "minimum": 0,
+      "type": "integer"
+    },
+    "employmentInfo": {
+      "properties": {
+        "salary": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "salary"
+      ],
+      "type": "object"
+    },
+    "firstname": {
+      "description": "First name",
+      "type": "string"
+    },
+    "lastname": {
+      "type": "string"
+    },
+    "likesCoffee": {
+      "type": "boolean"
+    },
+    "phoneNumbers": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "firstname",
+    "lastname",
+    "addresses",
+    "employmentInfo"
+  ],
+  "title": "Values",
+  "type": "object"
+}

cmd/helm/testdata/testcharts/chart-with-schema/values.yaml

@@ -0,0 +1,17 @@
+firstname: John
+lastname: Doe
+age: 25
+likesCoffee: true
+employmentInfo:
+  title: Software Developer
+  salary: 100000
+addresses:
+  - city: Springfield
+    street: Main
+    number: 12345
+  - city: New York
+    street: Broadway
+    number: 67890
+phoneNumbers:
+  - "(888) 888-8888"
+  - "(555) 555-5555"