Merge pull request #62 from jcsirot/add-immutable-param-field

Update the ParameterDefinition struct with the 'immutable' field
cnabio · Jul 18, 2019 · acbc0d1 · acbc0d1
2 parents 10de618 + cbf59e4
commit acbc0d1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/bundle/bundle_test.go b/bundle/bundle_test.go
@@ -441,6 +441,9 @@ func TestBundleMarshallAllThings(t *testing.T) {
 				Type:            "string",
 				ContentEncoding: "base64",
 			},
+			"productKeyType": {
+				Type: "string",
+			},
 		},
 		Parameters: &ParametersDefinition{
 			Fields: map[string]ParameterDefinition{
@@ -468,6 +471,13 @@ func TestBundleMarshallAllThings(t *testing.T) {
 						EnvironmentVariable: "REPLICA_COUNT",
 					},
 				},
+				"productKey": {
+					Definition: "productKeyType",
+					Destination: &Location{
+						EnvironmentVariable: "PRODUCT_KEY",
+					},
+					Immutable: true,
+				},
 			},
 			Required: []string{"port", "host"},
 		},

diff --git a/bundle/parameters.go b/bundle/parameters.go
@@ -11,4 +11,5 @@ type ParameterDefinition struct {
 	ApplyTo     []string  `json:"applyTo,omitempty" mapstructure:"applyTo,omitempty"`
 	Description string    `json:"description,omitempty" mapstructure:"description"`
 	Destination *Location `json:"destination,omitemtpty" mapstructure:"destination"`
+	Immutable   bool      `json:"immutable,omitempty" mapstructure:"immutable,omitempty"`
 }
diff --git a/testdata/bundles/canonical-bundle.json b/testdata/bundles/canonical-bundle.json
@@ -1 +1 @@
-{"credentials":{"password":{"description":"a password","env":"PASSWORD","path":"/cnab/app/path"}},"definitions":{"clientCert":{"contentEncoding":"base64","type":"string"},"enabledType":{"default":false,"type":"boolean"},"hostType":{"default":"locahost.localdomain","type":"string"},"portType":{"default":1234,"type":"integer"},"replicaCountType":{"default":3,"type":"integer"}},"description":"something","images":{"server":{"description":"complicated","image":"nginx:1.0","imageType":"docker"}},"invocationImages":[{"image":"deislabs/invocation-image:1.0","imageType":"docker","labels":{"os":"Linux"}}],"name":"testBundle","outputs":{"fields":{"clientCert":{"definition":"clientCert","path":"/cnab/app/outputs/blah"}}},"parameters":{"fields":{"enabled":{"definition":"enabledType","destination":{"env":"ENABLED"}},"host":{"definition":"hostType","destination":{"env":"HOST"}},"port":{"definition":"portType","destination":{"env":"PORT"}},"replicaCount":{"definition":"replicaCountType","destination":{"env":"REPLICA_COUNT"}}},"required":["port","host"]},"schemaVersion":"v1.0.0-WD","version":"1.0"}
+{"credentials":{"password":{"description":"a password","env":"PASSWORD","path":"/cnab/app/path"}},"definitions":{"clientCert":{"contentEncoding":"base64","type":"string"},"enabledType":{"default":false,"type":"boolean"},"hostType":{"default":"locahost.localdomain","type":"string"},"portType":{"default":1234,"type":"integer"},"productKeyType":{"type":"string"},"replicaCountType":{"default":3,"type":"integer"}},"description":"something","images":{"server":{"description":"complicated","image":"nginx:1.0","imageType":"docker"}},"invocationImages":[{"image":"deislabs/invocation-image:1.0","imageType":"docker","labels":{"os":"Linux"}}],"name":"testBundle","outputs":{"fields":{"clientCert":{"definition":"clientCert","path":"/cnab/app/outputs/blah"}}},"parameters":{"fields":{"enabled":{"definition":"enabledType","destination":{"env":"ENABLED"}},"host":{"definition":"hostType","destination":{"env":"HOST"}},"port":{"definition":"portType","destination":{"env":"PORT"}},"productKey":{"definition":"productKeyType","destination":{"env":"PRODUCT_KEY"},"immutable":true},"replicaCount":{"definition":"replicaCountType","destination":{"env":"REPLICA_COUNT"}}},"required":["port","host"]},"schemaVersion":"v1.0.0-WD","version":"1.0"}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"credentials":{"password":{"description":"a password","env":"PASSWORD","path":"/cnab/app/path"}},"definitions":{"clientCert":{"contentEncoding":"base64","type":"string"},"enabledType":{"default":false,"type":"boolean"},"hostType":{"default":"locahost.localdomain","type":"string"},"portType":{"default":1234,"type":"integer"},"replicaCountType":{"default":3,"type":"integer"}},"description":"something","images":{"server":{"description":"complicated","image":"nginx:1.0","imageType":"docker"}},"invocationImages":[{"image":"deislabs/invocation-image:1.0","imageType":"docker","labels":{"os":"Linux"}}],"name":"testBundle","outputs":{"fields":{"clientCert":{"definition":"clientCert","path":"/cnab/app/outputs/blah"}}},"parameters":{"fields":{"enabled":{"definition":"enabledType","destination":{"env":"ENABLED"}},"host":{"definition":"hostType","destination":{"env":"HOST"}},"port":{"definition":"portType","destination":{"env":"PORT"}},"replicaCount":{"definition":"replicaCountType","destination":{"env":"REPLICA_COUNT"}}},"required":["port","host"]},"schemaVersion":"v1.0.0-WD","version":"1.0"}
		{"credentials":{"password":{"description":"a password","env":"PASSWORD","path":"/cnab/app/path"}},"definitions":{"clientCert":{"contentEncoding":"base64","type":"string"},"enabledType":{"default":false,"type":"boolean"},"hostType":{"default":"locahost.localdomain","type":"string"},"portType":{"default":1234,"type":"integer"},"productKeyType":{"type":"string"},"replicaCountType":{"default":3,"type":"integer"}},"description":"something","images":{"server":{"description":"complicated","image":"nginx:1.0","imageType":"docker"}},"invocationImages":[{"image":"deislabs/invocation-image:1.0","imageType":"docker","labels":{"os":"Linux"}}],"name":"testBundle","outputs":{"fields":{"clientCert":{"definition":"clientCert","path":"/cnab/app/outputs/blah"}}},"parameters":{"fields":{"enabled":{"definition":"enabledType","destination":{"env":"ENABLED"}},"host":{"definition":"hostType","destination":{"env":"HOST"}},"port":{"definition":"portType","destination":{"env":"PORT"}},"productKey":{"definition":"productKeyType","destination":{"env":"PRODUCT_KEY"},"immutable":true},"replicaCount":{"definition":"replicaCountType","destination":{"env":"REPLICA_COUNT"}}},"required":["port","host"]},"schemaVersion":"v1.0.0-WD","version":"1.0"}