Merge pull request #70 from kaleido-io/add_sub_array

feat: Add nested array config

Author: EnriqueL8

pkg/config/config.go

@@ -123,6 +123,8 @@ type ArraySection interface {
 	ArraySize() int
 	ArrayEntry(i int) Section
 	SubSection(name string) Section
+	SubArray(name string) ArraySection
+	SetDefault(key string, defValue interface{})
 }
 
 // RootKey key are the known configuration keys
@@ -351,6 +353,14 @@ func (c *configSection) SubArray(name string) ArraySection {
 	return a
 }
 
+func (c *configArray) SubArray(name string) ArraySection {
+	return &configArray{
+		base:     keyName(c.base+"[]", name),
+		parent:   c,
+		defaults: make(map[string][]interface{}),
+	}
+}
+
 func (c *configArray) ArraySize() int {
 	val := viper.Get(c.base)
 	vt := reflect.TypeOf(val)
@@ -435,6 +445,12 @@ func (c *configSection) SetDefault(k string, defValue interface{}) {
 	c.AddChild(key, defValue)
 }
 
+func (c *configArray) SetDefault(k string, defValue interface{}) {
+	key := keyName(c.base+"[]", k)
+	viper.SetDefault(key, defValue)
+	c.AddChild(key, defValue)
+}
+
 func GetConfig() fftypes.JSONObject {
 	keysMutex.Lock()
 	defer keysMutex.Unlock()

pkg/config/config_test.go

@@ -198,6 +198,84 @@ plugins:
 	assert.Equal(t, "defname", bobheaders.ArrayEntry(1).GetString("name"))
 }
 
+func TestNestedArrays(t *testing.T) {
+	defer RootConfigReset()
+
+	namespacesRoot := RootSection("namespaces")
+	predefined := namespacesRoot.SubArray("predefined")
+	predefined.AddKnownKey("name")
+	predefined.AddKnownKey("key1", "default value")
+	tlsConfigs := predefined.SubArray("tlsConfigs")
+	tlsConfigs.SetDefault("testdefault", "test")
+	tlsConfigs.AddKnownKey("name")
+	tlsConfigs.SubSection("tls").AddKnownKey("enabled")
+	tlsConfigs.SubSection("tls").SetDefault("testdefault", "test")
+	viper.SetConfigType("yaml")
+	err := viper.ReadConfig(strings.NewReader(`
+namespaces:
+  predefined:
+  - name: myns
+    tlsConfigs:
+    - name: myconfig
+      tls:
+        enabled: true
+`))
+	assert.NoError(t, err)
+	assert.Equal(t, 1, predefined.ArraySize())
+	assert.Equal(t, 0, RootArray("nonexistent").ArraySize())
+	ns := predefined.ArrayEntry(0)
+	assert.Equal(t, "myns", ns.GetString("name"))
+	assert.Equal(t, "default value", ns.GetString("key1"))
+	nsTLSConfigs := ns.SubArray("tlsConfigs")
+	assert.Equal(t, 1, nsTLSConfigs.ArraySize())
+	tlsConfig := nsTLSConfigs.ArrayEntry(0)
+	assert.Equal(t, "myconfig", tlsConfig.GetString("name"))
+	assert.Equal(t, "test", tlsConfig.GetString("testdefault"))
+	assert.Equal(t, true, tlsConfig.SubSection("tls").GetBool("enabled"))
+	assert.Equal(t, "test", tlsConfig.SubSection("tls").GetString("testdefault"))
+}
+func TestNestedArraysObjectDefault(t *testing.T) {
+	defer RootConfigReset()
+
+	namespacesRoot := RootSection("namespaces")
+	predefined := namespacesRoot.SubArray("predefined")
+	predefined.AddKnownKey("name")
+	predefined.AddKnownKey("key1", "default value")
+	newSection := predefined.SubSection("new")
+	tlsConfigs := newSection.SubArray("tlsConfigs")
+	tlsConfigs.SetDefault("testdefault", "test")
+	tlsConfigs.AddKnownKey("name")
+	tlsConfigs.SubSection("tls").AddKnownKey("enabled")
+	tlsConfigs.SubSection("tls").SetDefault("testdefault", "test")
+	viper.SetConfigType("yaml")
+	// thing.stuff[].watsit.hoojars[].mydefault
+
+	err := viper.ReadConfig(strings.NewReader(`
+namespaces:
+  predefined:
+  - name: myns
+    new:
+      tlsConfigs:
+      - name: myconfig
+        tls:
+          enabled: true
+`))
+	assert.NoError(t, err)
+	assert.Equal(t, 1, predefined.ArraySize())
+	assert.Equal(t, 0, RootArray("nonexistent").ArraySize())
+	ns := predefined.ArrayEntry(0)
+	assert.Equal(t, "myns", ns.GetString("name"))
+	assert.Equal(t, "default value", ns.GetString("key1"))
+	section := ns.SubSection("new")
+	nsTLSConfigs := section.SubArray("tlsConfigs")
+	assert.Equal(t, 1, nsTLSConfigs.ArraySize())
+	tlsConfig := nsTLSConfigs.ArrayEntry(0)
+	assert.Equal(t, "myconfig", tlsConfig.GetString("name"))
+	assert.Equal(t, "test", tlsConfig.GetString("testdefault"))
+	assert.Equal(t, true, tlsConfig.SubSection("tls").GetBool("enabled"))
+	assert.Equal(t, "test", tlsConfig.SubSection("tls").GetString("testdefault"))
+}
+
 func TestMapOfAdminOverridePlugins(t *testing.T) {
 	defer RootConfigReset()