Config: Allow escaping dots in keys via '[unsplit.key]' syntax (#8512)

* Config: allow escaping dots in keys via '[unsplit.key]' syntax

Author: barkbay

NOTICE.txt

@@ -134,11 +134,11 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 --------------------------------------------------------------------------------
 Module  : github.com/elastic/go-ucfg
-Version : v0.8.8
-Time    : 2024-03-18T20:24:48Z
+Version : v0.8.9-0.20250307075119-2a22403faaea
+Time    : 2025-03-07T07:51:19Z
 Licence : Apache-2.0
 
-Contents of probable licence file $GOMODCACHE/github.com/elastic/[email protected].8/LICENSE:
+Contents of probable licence file $GOMODCACHE/github.com/elastic/[email protected].9-0.20250307075119-2a22403faaea/LICENSE:
 
                                  Apache License
                            Version 2.0, January 2004

docs/reference/third-party-dependencies.md

@@ -20,7 +20,7 @@ This page lists the third-party dependencies used to build {{eck}}.
 | [github.com/Masterminds/sprig/v3](https://github.com/Masterminds/sprig) | v3.3.0 | MIT |
 | [github.com/blang/semver/v4](https://github.com/blang/semver) | v4.0.0 | MIT |
 | [github.com/davecgh/go-spew](https://github.com/davecgh/go-spew) | v1.1.2-0.20180830191138-d8f796af33cc | ISC |
-| [github.com/elastic/go-ucfg](https://github.com/elastic/go-ucfg) | v0.8.8 | Apache-2.0 |
+| [github.com/elastic/go-ucfg](https://github.com/elastic/go-ucfg) | v0.8.9-0.20250307075119-2a22403faaea | Apache-2.0 |
 | [github.com/ghodss/yaml](https://github.com/ghodss/yaml) | v1.0.0 | MIT |
 | [github.com/gkampitakis/go-snaps](https://github.com/gkampitakis/go-snaps) | v0.5.8 | MIT |
 | [github.com/go-logr/logr](https://github.com/go-logr/logr) | v1.4.2 | Apache-2.0 |

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/Masterminds/sprig/v3 v3.3.0
 	github.com/blang/semver/v4 v4.0.0
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc
-	github.com/elastic/go-ucfg v0.8.8
+	github.com/elastic/go-ucfg v0.8.9-0.20250307075119-2a22403faaea
 	github.com/ghodss/yaml v1.0.0
 	github.com/gkampitakis/go-snaps v0.5.8
 	github.com/go-logr/logr v1.4.2

go.sum

@@ -42,8 +42,8 @@ github.com/docker/docker-credential-helpers v0.8.2 h1:bX3YxiGzFP5sOXWc3bTPEXdEaZ
 github.com/docker/docker-credential-helpers v0.8.2/go.mod h1:P3ci7E3lwkZg6XiHdRKft1KckHiO9a2rNtyFbZ/ry9M=
 github.com/elastic/go-sysinfo v1.15.1 h1:zBmTnFEXxIQ3iwcQuk7MzaUotmKRp3OabbbWM8TdzIQ=
 github.com/elastic/go-sysinfo v1.15.1/go.mod h1:jPSuTgXG+dhhh0GKIyI2Cso+w5lPJ5PvVqKlL8LV/Hk=
-github.com/elastic/go-ucfg v0.8.8 h1:54KIF/2zFKfl0MzsSOCGOsZ3O2bnjFQJ0nDJcLhviyk=
-github.com/elastic/go-ucfg v0.8.8/go.mod h1:4E8mPOLSUV9hQ7sgLEJ4bvt0KhMuDJa8joDT2QGAEKA=
+github.com/elastic/go-ucfg v0.8.9-0.20250307075119-2a22403faaea h1:SX+ZnuBacMQVu1sNniwUEpi9i3dBaYlbg1WDioQh/ho=
+github.com/elastic/go-ucfg v0.8.9-0.20250307075119-2a22403faaea/go.mod h1:4E8mPOLSUV9hQ7sgLEJ4bvt0KhMuDJa8joDT2QGAEKA=
 github.com/elastic/go-windows v1.0.2 h1:yoLLsAsV5cfg9FLhZ9EXZ2n2sQFKeDYrHenkcivY4vI=
 github.com/elastic/go-windows v1.0.2/go.mod h1:bGcDpBzXgYSqM0Gx3DM4+UxFj300SZLixie9u9ixLM8=
 github.com/emicklei/go-restful/v3 v3.12.1 h1:PJMDIM/ak7btuL8Ex0iYET9hxM3CI2sjZtzpL63nKAU=

pkg/controller/common/settings/canonical_config.go

@@ -22,7 +22,7 @@ import (
 type CanonicalConfig ucfg.Config
 
 // Options are config options for the YAML file. Currently contains only support for dotted keys.
-var Options = []ucfg.Option{ucfg.PathSep("."), ucfg.AppendValues}
+var Options = []ucfg.Option{ucfg.PathSep("."), ucfg.AppendValues, ucfg.EscapePath()}
 
 // NewCanonicalConfig creates a new empty config.
 func NewCanonicalConfig() *CanonicalConfig {

pkg/controller/common/settings/canonical_config_test.go

@@ -13,16 +13,19 @@ import (
 
 func TestCanonicalConfig_Render(t *testing.T) {
 	config := MustCanonicalConfig(map[string]interface{}{
-		"aaa":        "aa  a",
-		"bbb":        "b  bb",
-		"aab":        "a a a",
-		"key":        map[string]interface{}{"emptyarray": []string{}},
-		"withquotes": "aa\"bb\"aa",
-		"zz":         "zzz  z z z",
+		"[escaped.key]": map[string]interface{}{"[another.escaped.key]": "value"},
+		"aaa":           "aa  a",
+		"bbb":           "b  bb",
+		"aab":           "a a a",
+		"key":           map[string]interface{}{"emptyarray": []string{}},
+		"withquotes":    "aa\"bb\"aa",
+		"zz":            "zzz  z z z",
 	})
 	output, err := config.Render()
 	require.NoError(t, err)
-	expected := []byte(`aaa: aa  a
+	expected := []byte(`'[escaped.key]':
+    '[another.escaped.key]': value
+aaa: aa  a
 aab: a a a
 bbb: b  bb
 key: