Merge branch 'master' into enum-parsing

Author: joshjennings98

CHANGELOG.md

@@ -14,6 +14,16 @@ beta releases are not included in this history.
 
 [//]: # (begin_release_notes)
 
+"1.131.1" (2025-10-30)
+======================
+
+Bugfixes
+--------
+
+- Fix bug with config validation incorrectly generating error messages omitting the field name segment (#1727)
+- Dependency upgrade: v5-5.4.0 (#20251030110347)
+
+
 "1.131.0" (2025-10-27)
 ======================
 

utils/config/error.go

@@ -56,6 +56,7 @@ type validationError struct {
 	mapStructureTree   []string
 	mapStructurePrefix *string
 	reason             string
+	fieldName          string
 }
 
 func (v *validationError) GetTree() []string {
@@ -80,9 +81,11 @@ func (v *validationError) RecordField(fieldName string, mapStructureFieldName *s
 		treeMap = append(treeMap, strings.ToUpper(strings.TrimSpace(*mapStructureFieldName)))
 		treeMap = append(treeMap, v.mapStructureTree...)
 		v.mapStructureTree = treeMap
+	} else {
+		v.fieldName = fieldName
 	}
-	v.mapStructurePrefix = mapStructurePrefix
 
+	v.mapStructurePrefix = mapStructurePrefix
 }
 
 func (v *validationError) RecordPrefix(mapStructurePrefix string) {
@@ -114,6 +117,10 @@ func (v *validationError) GetMapStructurePath() string {
 		if v.mapStructurePrefix != nil {
 			mapstructureStr = fmt.Sprintf("%v_%v", strings.ToUpper(strings.TrimSpace(*v.mapStructurePrefix)), mapstructureStr)
 		}
+
+		if v.fieldName != "" {
+			mapstructureStr = fmt.Sprintf("%v_%v", mapstructureStr, strings.ToUpper(strings.TrimSpace(v.fieldName)))
+		}
 	}
 	return mapstructureStr
 }

utils/config/service_configuration_test.go

@@ -91,7 +91,15 @@ func DefaultDeepConfiguration() *DeepConfig {
 }
 
 func (cfg *DeepConfig) Validate() error {
-	return nil
+	// Validate Embedded Structs
+	err := ValidateEmbedded(cfg)
+	if err != nil {
+		return err
+	}
+
+	return validation.ValidateStruct(cfg,
+		validation.Field(&cfg.TestConfigDeep, validation.Required),
+	)
 }
 
 func (cfg *ConfigurationTest) Validate() error {
@@ -125,8 +133,37 @@ func TestErrorFormatting(t *testing.T) {
 	cfg := DefaultConfiguration()
 	err := cfg.Validate()
 	require.Error(t, err)
+
+	errortest.AssertError(t, err, commonerrors.ErrInvalid)
+	assert.Contains(t, err.Error(), "invalid: structure failed validation: (TestConfig->db) [DUMMYCONFIG_DB] cannot be blank")
+}
+
+func TestDeepErrorFormatting(t *testing.T) {
+	defaults := DefaultDeepConfiguration()
+	err := defaults.Validate()
+	require.Error(t, err)
+
 	errortest.AssertError(t, err, commonerrors.ErrInvalid)
-	assert.Contains(t, err.Error(), "invalid: structure failed validation: (TestConfig->db) [DUMMYCONFIG] cannot be blank")
+	assert.Contains(t, err.Error(), "invalid: structure failed validation: (TestConfigDeep->TestConfig->db) [DEEP_CONFIG_DUMMYCONFIG_DB] cannot be blank")
+
+	err = os.Setenv("TEST_DEEP_CONFIG_DUMMYCONFIG_DB", "a test db")
+	require.NoError(t, err)
+	err = os.Setenv("TEST_DEEP_CONFIG_DUMMYCONFIG_DUMMY_HOST", "a test host")
+	require.NoError(t, err)
+	err = os.Setenv("TEST_DEEP_CONFIG_DUMMYCONFIG_PASSWORD", "a test password")
+	require.NoError(t, err)
+	err = os.Setenv("TEST_DEEP_CONFIG_DUMMYCONFIG_USER", "a test user")
+	require.NoError(t, err)
+	err = os.Setenv("TEST_DEEP_CONFIG_DUMMY_CONFIG_DB", "a test user")
+	require.NoError(t, err)
+
+	t.Run("defined mapstructure", func(t *testing.T) {
+		configTest2 := &DeepConfig{}
+		err = LoadFromSystem("test", configTest2, defaults)
+
+		errortest.AssertError(t, err, commonerrors.ErrInvalid)
+		assert.Contains(t, err.Error(), "invalid: structure failed validation: (TestConfigDeep->TestConfig2->dummy_host) [TEST_DEEP_CONFIG_DUMMY_CONFIG_DUMMY_HOST] cannot be blank")
+	})
 }
 
 func TestServiceConfigurationLoad(t *testing.T) {
@@ -137,6 +174,9 @@ func TestServiceConfigurationLoad(t *testing.T) {
 	err := Load("test", configTest, defaults)
 	// Some required values are missing.
 	require.Error(t, err)
+
+	assert.ErrorContains(t, err, "(TestConfig->db) [TEST_DUMMYCONFIG_DB] cannot be blank")
+
 	errortest.RequireError(t, err, commonerrors.ErrInvalid)
 	errortest.RequireError(t, configTest.Validate(), commonerrors.ErrInvalid)
 

utils/go.mod

@@ -22,7 +22,7 @@ require (
 	github.com/go-logr/zapr v1.3.0
 	github.com/go-ozzo/ozzo-validation/v4 v4.3.0
 	github.com/go-viper/mapstructure/v2 v2.4.0
-	github.com/gofrs/uuid/v5 v5.3.2
+	github.com/gofrs/uuid/v5 v5.4.0
 	github.com/gogs/chardet v0.0.0-20211120154057-b7413eaefb8f
 	github.com/hashicorp/go-cleanhttp v0.5.2
 	github.com/hashicorp/go-hclog v1.6.3

utils/go.sum

@@ -99,8 +99,8 @@ github.com/godbus/dbus v4.1.0+incompatible/go.mod h1:/YcGZj5zSblfDWMMoOzV4fas9FZ
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
 github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
-github.com/gofrs/uuid/v5 v5.3.2 h1:2jfO8j3XgSwlz/wHqemAEugfnTlikAYHhnqQ8Xh4fE0=
-github.com/gofrs/uuid/v5 v5.3.2/go.mod h1:CDOjlDMVAtN56jqyRUZh58JT31Tiw7/oQyEXZV+9bD8=
+github.com/gofrs/uuid/v5 v5.4.0 h1:EfbpCTjqMuGyq5ZJwxqzn3Cbr2d0rUZU7v5ycAk/e/0=
+github.com/gofrs/uuid/v5 v5.4.0/go.mod h1:CDOjlDMVAtN56jqyRUZh58JT31Tiw7/oQyEXZV+9bD8=
 github.com/gogs/chardet v0.0.0-20211120154057-b7413eaefb8f h1:3BSP1Tbs2djlpprl7wCLuiqMaUh5SJkkzI2gDs+FgLs=
 github.com/gogs/chardet v0.0.0-20211120154057-b7413eaefb8f/go.mod h1:Pcatq5tYkCW2Q6yrR2VRHlbHpZ/R4/7qyL1TCF7vl14=
 github.com/golang/glog v0.0.0-20210429001901-424d2337a529/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=

utils/module.properties

@@ -1,5 +1,5 @@
-Version=1.131.0
+Version=1.131.1
 MajorVersion=1
 MinorVersion=131
-PatchVersion=0
-CommitHash=7b5785efbcef070d14a6479e3097c7861cfb537e
+PatchVersion=1
+CommitHash=4c3b0e9f017c84cfeaee68bfb286e02feebd1fce