APIversion added to the params file (#1022)

kudobuilder · Nov 1, 2019 · a071e91 · a071e91
1 parent 061b1eb
commit a071e91
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 5 deletions.
diff --git a/pkg/kudoctl/cmd/testdata/index.yaml.golden b/pkg/kudoctl/cmd/testdata/index.yaml.golden
@@ -2,7 +2,7 @@ apiVersion: v1
 entries:
   zookeeper:
   - appVersion: 3.4.10
-    digest: cbacc2e23ef1accc9308acbeff92f1aa8d2ddf712c76f50c114e817fb1a2a166
+    digest: fa9ba293e60d0770e686eab2618dadce896bdb556e1afd4554705487863f2089
     maintainers:
     - email: [email protected]
       name: Alena Varkockova

diff --git a/pkg/kudoctl/packages/package.go b/pkg/kudoctl/packages/package.go
@@ -44,7 +44,8 @@ type PackageFiles struct {
 }
 
 type ParametersFile struct {
-	Params []v1beta1.Parameter `json:"parameters"`
+	APIVersion string              `json:"apiVersion,omitempty"`
+	Params     []v1beta1.Parameter `json:"parameters"`
 }
 
 // Operator is a representation of the KEP-9 Operator YAML
@@ -125,6 +126,13 @@ func readParametersFile(fileBytes []byte) (ParametersFile, error) {
 	if err := yaml.Unmarshal(fileBytes, &paramsFile); err != nil {
 		return paramsFile, err
 	}
+	if paramsFile.APIVersion == "" {
+		paramsFile.APIVersion = APIVersion
+	}
+	if paramsFile.APIVersion != APIVersion {
+		return paramsFile, fmt.Errorf("expecting supported API version %s but got %s", APIVersion, paramsFile.APIVersion)
+	}
+
 	return paramsFile, nil
 }
 

diff --git a/pkg/kudoctl/packages/package_test.go b/pkg/kudoctl/packages/package_test.go
@@ -120,16 +120,19 @@ func loadResourcesFromPath(goldenPath string) (*Resources, error) {
 
 func Test_readParametersFile(t *testing.T) {
 	noParams := `
+apiVersion: kudo.dev/v1beta1
 parameters:
 `
 	param := `
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: example
 `
 	example := make([]v1beta1.Parameter, 1)
 	example[0] = v1beta1.Parameter{Name: "example"}
 
 	bad := `
+apiVersion: kudo.dev/v1beta1
 parameters:
 	- oops:
 `
@@ -139,9 +142,9 @@ parameters:
 		want      ParametersFile
 		wantErr   bool
 	}{
-		{"no data", []byte{}, ParametersFile{}, false},
-		{"no parameters", []byte(noParams), ParametersFile{}, false},
-		{"parameters", []byte(param), ParametersFile{example}, false},
+		{"no data", []byte{}, ParametersFile{APIVersion: APIVersion}, false},
+		{"no parameters", []byte(noParams), ParametersFile{APIVersion: APIVersion}, false},
+		{"parameters", []byte(param), ParametersFile{APIVersion, example}, false},
 		{"bad data", []byte(bad), ParametersFile{}, true},
 	}
 	for _, tt := range tests {

diff --git a/pkg/kudoctl/packages/testdata/zk.tgz b/pkg/kudoctl/packages/testdata/zk.tgz
diff --git a/pkg/kudoctl/packages/testdata/zk/params.yaml b/pkg/kudoctl/packages/testdata/zk/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: memory
     description: Amount of memory to provide to Zookeeper pods

diff --git a/test/e2e/cli-install-uninstall/first-operator/params.yaml b/test/e2e/cli-install-uninstall/first-operator/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: replicas
     description: Number of replicas that should be run as part of the deployment

diff --git a/test/integration/cli-install/cli-install-operator/params.yaml b/test/integration/cli-install/cli-install-operator/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: memory
     description: Amount of memory to provide to Zookeeper pods

diff --git a/test/integration/first-operator-test/first-operator/params.yaml b/test/integration/first-operator-test/first-operator/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: replicas
     description: Number of replicas that should be run as part of the deployment

diff --git a/test/integration/install-existing-crds-in-operator/crd-operator/params.yaml b/test/integration/install-existing-crds-in-operator/crd-operator/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: version
     description: Version of image

diff --git a/test/integration/operator-with-custom-crd/operator/params.yaml b/test/integration/operator-with-custom-crd/operator/params.yaml
@@ -1 +1,2 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
diff --git a/test/integration/upgrade-command/first-operator/params.yaml b/test/integration/upgrade-command/first-operator/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: version
     description: Version of image

diff --git a/test/integration/upgrade-command/second-operator/params.yaml b/test/integration/upgrade-command/second-operator/params.yaml
@@ -1,3 +1,4 @@
+apiVersion: kudo.dev/v1beta1
 parameters:
   - name: version
     description: Version of image