Provisioning: Interpolate env vars in provisioning files (#16499)

* Add value types with custom unmarshalling logic * Add env support for notifications config * Use env vars in json data tests for values * Add some more complexities to value tests * Update comment with example usage * Set env directly in the tests, removing patching * Update documentation * Add env var to the file reader tests * Add raw value * Post merge fixes * Add comment
2019-04-24 15:39:47 +02:00
parent eb8af01a8a
commit fcebd713a5
14 changed files with 598 additions and 141 deletions
@@ -0,0 +1,210 @@
+package values
+
+import (
+	. "github.com/smartystreets/goconvey/convey"
+	"gopkg.in/yaml.v2"
+	"os"
+	"testing"
+)
+
+func TestValues(t *testing.T) {
+	Convey("Values", t, func() {
+		os.Setenv("INT", "1")
+		os.Setenv("STRING", "test")
+		os.Setenv("BOOL", "true")
+
+		Convey("IntValue", func() {
+			type Data struct {
+				Val IntValue `yaml:"val"`
+			}
+			d := &Data{}
+
+			Convey("Should unmarshal simple number", func() {
+				unmarshalingTest(`val: 1`, d)
+				So(d.Val.Value(), ShouldEqual, 1)
+				So(d.Val.Raw, ShouldEqual, "1")
+			})
+
+			Convey("Should unmarshal env var", func() {
+				unmarshalingTest(`val: $INT`, d)
+				So(d.Val.Value(), ShouldEqual, 1)
+				So(d.Val.Raw, ShouldEqual, "$INT")
+			})
+
+			Convey("Should ignore empty value", func() {
+				unmarshalingTest(`val: `, d)
+				So(d.Val.Value(), ShouldEqual, 0)
+				So(d.Val.Raw, ShouldEqual, "")
+			})
+		})
+
+		Convey("StringValue", func() {
+			type Data struct {
+				Val StringValue `yaml:"val"`
+			}
+			d := &Data{}
+
+			Convey("Should unmarshal simple string", func() {
+				unmarshalingTest(`val: test`, d)
+				So(d.Val.Value(), ShouldEqual, "test")
+				So(d.Val.Raw, ShouldEqual, "test")
+			})
+
+			Convey("Should unmarshal env var", func() {
+				unmarshalingTest(`val: $STRING`, d)
+				So(d.Val.Value(), ShouldEqual, "test")
+				So(d.Val.Raw, ShouldEqual, "$STRING")
+			})
+
+			Convey("Should ignore empty value", func() {
+				unmarshalingTest(`val: `, d)
+				So(d.Val.Value(), ShouldEqual, "")
+				So(d.Val.Raw, ShouldEqual, "")
+			})
+		})
+
+		Convey("BoolValue", func() {
+			type Data struct {
+				Val BoolValue `yaml:"val"`
+			}
+			d := &Data{}
+
+			Convey("Should unmarshal bool value", func() {
+				unmarshalingTest(`val: true`, d)
+				So(d.Val.Value(), ShouldBeTrue)
+				So(d.Val.Raw, ShouldEqual, "true")
+			})
+
+			Convey("Should unmarshal explicit string", func() {
+				unmarshalingTest(`val: "true"`, d)
+				So(d.Val.Value(), ShouldBeTrue)
+				So(d.Val.Raw, ShouldEqual, "true")
+			})
+
+			Convey("Should unmarshal env var", func() {
+				unmarshalingTest(`val: $BOOL`, d)
+				So(d.Val.Value(), ShouldBeTrue)
+				So(d.Val.Raw, ShouldEqual, "$BOOL")
+			})
+
+			Convey("Should ignore empty value", func() {
+				unmarshalingTest(`val: `, d)
+				So(d.Val.Value(), ShouldBeFalse)
+				So(d.Val.Raw, ShouldEqual, "")
+			})
+		})
+
+		Convey("JSONValue", func() {
+
+			type Data struct {
+				Val JSONValue `yaml:"val"`
+			}
+			d := &Data{}
+
+			Convey("Should unmarshal variable nesting", func() {
+				doc := `
+                 val:
+                   one: 1
+                   two: $STRING
+                   three:
+                     - 1
+                     - two
+                     - three:
+                         inside: $STRING
+                   four:
+                     nested:
+                       onemore: $INT
+                   multiline: >
+                     Some text with $STRING
+                   anchor: &label $INT
+                   anchored: *label
+               `
+				unmarshalingTest(doc, d)
+
+				type anyMap = map[interface{}]interface{}
+				So(d.Val.Value(), ShouldResemble, map[string]interface{}{
+					"one": 1,
+					"two": "test",
+					"three": []interface{}{
+						1, "two", anyMap{
+							"three": anyMap{
+								"inside": "test",
+							},
+						},
+					},
+					"four": anyMap{
+						"nested": anyMap{
+							"onemore": "1",
+						},
+					},
+					"multiline": "Some text with test\n",
+					"anchor":    "1",
+					"anchored":  "1",
+				})
+
+				So(d.Val.Raw, ShouldResemble, map[string]interface{}{
+					"one": 1,
+					"two": "$STRING",
+					"three": []interface{}{
+						1, "two", anyMap{
+							"three": anyMap{
+								"inside": "$STRING",
+							},
+						},
+					},
+					"four": anyMap{
+						"nested": anyMap{
+							"onemore": "$INT",
+						},
+					},
+					"multiline": "Some text with $STRING\n",
+					"anchor":    "$INT",
+					"anchored":  "$INT",
+				})
+			})
+		})
+
+		Convey("StringMapValue", func() {
+			type Data struct {
+				Val StringMapValue `yaml:"val"`
+			}
+			d := &Data{}
+
+			Convey("Should unmarshal mapping", func() {
+				doc := `
+                 val:
+                   one: 1
+                   two: "test string"
+                   three: $STRING
+                   four: true
+               `
+				unmarshalingTest(doc, d)
+				So(d.Val.Value(), ShouldResemble, map[string]string{
+					"one":   "1",
+					"two":   "test string",
+					"three": "test",
+					"four":  "true",
+				})
+
+				So(d.Val.Raw, ShouldResemble, map[string]string{
+					"one":   "1",
+					"two":   "test string",
+					"three": "$STRING",
+					"four":  "true",
+				})
+
+			})
+		})
+
+		Reset(func() {
+			os.Unsetenv("INT")
+			os.Unsetenv("STRING")
+			os.Unsetenv("BOOL")
+		})
+	})
+}
+
+func unmarshalingTest(document string, out interface{}) {
+	err := yaml.Unmarshal([]byte(document), out)
+	So(err, ShouldBeNil)
+}