🐛 DSGECO-1727 fix incorrect config key name (#738)

### Description

Fix bug with config validation incorrectly generating error messages
omitting the field name segment resulting in the source of configuration
problems not being obvious

### Test Coverage

- [x]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

Author: phawxby

changes/1727.bugfix

@@ -0,0 +1 @@
+Fix bug with config validation incorrectly generating error messages omitting the field name segment

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

@@ -87,7 +87,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 {
@@ -121,8 +129,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) {
@@ -133,6 +170,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)