Fix `environment-to-ini` inherited key bug (#27543) (#27546)

Backport #27543 by @wxiaoguang

Fix  #27541

The INI package has a quirk: by default, the keys are inherited.
When maintaining the keys, the newly added sub key should not be
affected by the parent key.

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

diff --git a/modules/setting/config_env.go b/modules/setting/config_env.go
index b30e44de30a0dddacd0efe0c95dc1660aa1cb237..242f40914a159bd9cfa5dfda16a5012ffe043889 100644 (file)
--- a/modules/setting/config_env.go
+++ b/modules/setting/config_env.go
@@ -149,8 +149,9 @@ func EnvironmentToConfig(cfg ConfigProvider, envs []string) (changed bool) {
                                continue
                        }
                }
-               key := section.Key(keyName)
+               key := ConfigSectionKey(section, keyName)
                if key == nil {
+                       changed = true
                        key, err = section.NewKey(keyName, keyValue)
                        if err != nil {
                                log.Error("Error creating key: %s in section: %s with value: %s : %v", keyName, sectionName, keyValue, err)

diff --git a/modules/setting/config_env_test.go b/modules/setting/config_env_test.go
index e14d5ecb414f1e013707378a30daa923330fbd94..7d07c479a17df80d6e3e37920ae18596e09ba916 100644 (file)
--- a/modules/setting/config_env_test.go
+++ b/modules/setting/config_env_test.go
@@ -115,3 +115,29 @@ key = old
        EnvironmentToConfig(cfg, []string{"GITEA__sec__key__FILE=" + tmpFile})
        assert.Equal(t, "value-from-file\n", cfg.Section("sec").Key("key").String())
 }
+
+func TestEnvironmentToConfigSubSecKey(t *testing.T) {
+       // the INI package has a quirk: by default, the keys are inherited.
+       // when maintaining the keys, the newly added sub key should not be affected by the parent key.
+       cfg, err := NewConfigProviderFromData(`
+[sec]
+key = some
+`)
+       assert.NoError(t, err)
+
+       changed := EnvironmentToConfig(cfg, []string{"GITEA__sec_0X2E_sub__key=some"})
+       assert.True(t, changed)
+
+       tmpFile := t.TempDir() + "/test-sub-sec-key.ini"
+       defer os.Remove(tmpFile)
+       err = cfg.SaveTo(tmpFile)
+       assert.NoError(t, err)
+       bs, err := os.ReadFile(tmpFile)
+       assert.NoError(t, err)
+       assert.Equal(t, `[sec]
+key = some
+
+[sec.sub]
+key = some
+`, string(bs))
+}