github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

config: Fix handling of invalid OS env config overrides

Browse source 
Fixes #8709
This commit is contained in:
Bjørn Erik Pedersen 2021-06-29 09:38:05 +02:00
parent 8290720107
commit 49fedbc51c
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
2 changed files with 93 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
config/defaultConfigProvider.go
View file

@ -169,6 +169,9 @@ func (c *defaultConfigProvider) Set(k string, v interface{}) {
} }
key, m := c.getNestedKeyAndMap(k, true) key, m := c.getNestedKeyAndMap(k, true)
if m == nil {
return
}
if existing, found := m[key]; found { if existing, found := m[key]; found {
if p1, ok := existing.(maps.Params); ok { if p1, ok := existing.(maps.Params); ok {
@ -289,6 +292,9 @@ func (c *defaultConfigProvider) Merge(k string, v interface{}) {
} }
key, m := c.getNestedKeyAndMap(k, true) key, m := c.getNestedKeyAndMap(k, true)
if m == nil {
return
}
if existing, found := m[key]; found { if existing, found := m[key]; found {
if p1, ok := existing.(maps.Params); ok { if p1, ok := existing.(maps.Params); ok {
@ -422,7 +428,12 @@ func (c *defaultConfigProvider) getNestedKeyAndMap(key string, create bool) (str
return "", nil return "", nil
} }
} }
current = next.(maps.Params) var ok bool
current, ok = next.(maps.Params)
if !ok {
// E.g. a string, not a map that we can store values in.
return "", nil
}
} }
return parts[len(parts)-1], current return parts[len(parts)-1], current
} }

135
hugolib/config_test.go
View file

@ -576,9 +576,10 @@ anchor = "smart"
quality = 75 quality = 75
` `
b := newTestSitesBuilder(t).WithConfigFile("toml", baseConfig) newB := func(t testing.TB) *sitesBuilder {
b := newTestSitesBuilder(t).WithConfigFile("toml", baseConfig)
b.WithSourceFile("themes/mytheme/config.toml", ` b.WithSourceFile("themes/mytheme/config.toml", `
[outputFormats] [outputFormats]
[outputFormats.oftheme] [outputFormats.oftheme]
@ -595,64 +596,90 @@ theme_param="themevalue2"
`) `)
b.WithEnviron( return b
"HUGO_ENVIRONMENT", "test", }
"HUGO_NEW", "new", // key not in config.toml
"HUGO_ENABLEGITINFO", "false",
"HUGO_IMAGING_ANCHOR", "top",
"HUGO_IMAGING_RESAMPLEFILTER", "CatmullRom",
"HUGO_STRINGSLICE", `["c", "d"]`,
"HUGO_INTSLICE", `[5, 8, 9]`,
"HUGO_FLOATSLICE", `[5.32]`,
// Issue #7829
"HUGOxPARAMSxAPI_CONFIGxAPI_KEY", "new_key",
// Delimiters are case sensitive.
"HUGOxPARAMSxAPI_CONFIGXANOTHER_KEY", "another_key",
// Issue #8346
"HUGOxPARAMSxMYTHEME_SECTIONxTHEME_PARAM", "themevalue_changed",
"HUGOxPARAMSxMYTHEME_SECTION2xTHEME_PARAM", "themevalue2_changed",
"HUGO_PARAMS_EMPTY", ``,
"HUGO_PARAMS_HTML", `<a target="_blank" />`,
// Issue #8618
"HUGO_SERVICES_GOOGLEANALYTICS_ID", `gaid`,
"HUGO_PARAMS_A_B_C", "abc",
)
b.Build(BuildCfg{}) c.Run("Variations", func(c *qt.C) {
cfg := b.H.Cfg b := newB(c)
s := b.H.Sites[0]
scfg := s.siteConfigConfig.Services
c.Assert(cfg.Get("environment"), qt.Equals, "test") b.WithEnviron(
c.Assert(cfg.GetBool("enablegitinfo"), qt.Equals, false) "HUGO_ENVIRONMENT", "test",
c.Assert(cfg.Get("new"), qt.Equals, "new") "HUGO_NEW", "new", // key not in config.toml
c.Assert(cfg.Get("imaging.anchor"), qt.Equals, "top") "HUGO_ENABLEGITINFO", "false",
c.Assert(cfg.Get("imaging.quality"), qt.Equals, int64(75)) "HUGO_IMAGING_ANCHOR", "top",
c.Assert(cfg.Get("imaging.resamplefilter"), qt.Equals, "CatmullRom") "HUGO_IMAGING_RESAMPLEFILTER", "CatmullRom",
c.Assert(cfg.Get("stringSlice"), qt.DeepEquals, []interface{}{"c", "d"}) "HUGO_STRINGSLICE", `["c", "d"]`,
c.Assert(cfg.Get("floatSlice"), qt.DeepEquals, []interface{}{5.32}) "HUGO_INTSLICE", `[5, 8, 9]`,
c.Assert(cfg.Get("intSlice"), qt.DeepEquals, []interface{}{5, 8, 9}) "HUGO_FLOATSLICE", `[5.32]`,
c.Assert(cfg.Get("params.api_config.api_key"), qt.Equals, "new_key") // Issue #7829
c.Assert(cfg.Get("params.api_config.another_key"), qt.Equals, "default another_key") "HUGOxPARAMSxAPI_CONFIGxAPI_KEY", "new_key",
c.Assert(cfg.Get("params.mytheme_section.theme_param"), qt.Equals, "themevalue_changed") // Delimiters are case sensitive.
c.Assert(cfg.Get("params.mytheme_section.theme_param_nooverride"), qt.Equals, "nooverride") "HUGOxPARAMSxAPI_CONFIGXANOTHER_KEY", "another_key",
c.Assert(cfg.Get("params.mytheme_section2.theme_param"), qt.Equals, "themevalue2_changed") // Issue #8346
c.Assert(cfg.Get("params.empty"), qt.Equals, ``) "HUGOxPARAMSxMYTHEME_SECTIONxTHEME_PARAM", "themevalue_changed",
c.Assert(cfg.Get("params.html"), qt.Equals, `<a target="_blank" />`) "HUGOxPARAMSxMYTHEME_SECTION2xTHEME_PARAM", "themevalue2_changed",
"HUGO_PARAMS_EMPTY", ``,
"HUGO_PARAMS_HTML", `<a target="_blank" />`,
// Issue #8618
"HUGO_SERVICES_GOOGLEANALYTICS_ID", `gaid`,
"HUGO_PARAMS_A_B_C", "abc",
)
b.Build(BuildCfg{})
cfg := b.H.Cfg
s := b.H.Sites[0]
scfg := s.siteConfigConfig.Services
c.Assert(cfg.Get("environment"), qt.Equals, "test")
c.Assert(cfg.GetBool("enablegitinfo"), qt.Equals, false)
c.Assert(cfg.Get("new"), qt.Equals, "new")
c.Assert(cfg.Get("imaging.anchor"), qt.Equals, "top")
c.Assert(cfg.Get("imaging.quality"), qt.Equals, int64(75))
c.Assert(cfg.Get("imaging.resamplefilter"), qt.Equals, "CatmullRom")
c.Assert(cfg.Get("stringSlice"), qt.DeepEquals, []interface{}{"c", "d"})
c.Assert(cfg.Get("floatSlice"), qt.DeepEquals, []interface{}{5.32})
c.Assert(cfg.Get("intSlice"), qt.DeepEquals, []interface{}{5, 8, 9})
c.Assert(cfg.Get("params.api_config.api_key"), qt.Equals, "new_key")
c.Assert(cfg.Get("params.api_config.another_key"), qt.Equals, "default another_key")
c.Assert(cfg.Get("params.mytheme_section.theme_param"), qt.Equals, "themevalue_changed")
c.Assert(cfg.Get("params.mytheme_section.theme_param_nooverride"), qt.Equals, "nooverride")
c.Assert(cfg.Get("params.mytheme_section2.theme_param"), qt.Equals, "themevalue2_changed")
c.Assert(cfg.Get("params.empty"), qt.Equals, ``)
c.Assert(cfg.Get("params.html"), qt.Equals, `<a target="_blank" />`)
params := cfg.Get("params").(maps.Params)
c.Assert(params["paramwithnoenvoverride"], qt.Equals, "nooverride")
c.Assert(cfg.Get("params.paramwithnoenvoverride"), qt.Equals, "nooverride")
c.Assert(scfg.GoogleAnalytics.ID, qt.Equals, "gaid")
c.Assert(cfg.Get("params.a.b"), qt.DeepEquals, maps.Params{
"c": "abc",
})
ofBase, _ := s.outputFormatsConfig.GetByName("ofbase")
ofTheme, _ := s.outputFormatsConfig.GetByName("oftheme")
c.Assert(ofBase.MediaType, qt.Equals, media.TextType)
c.Assert(ofTheme.MediaType, qt.Equals, media.TextType)
params := cfg.Get("params").(maps.Params)
c.Assert(params["paramwithnoenvoverride"], qt.Equals, "nooverride")
c.Assert(cfg.Get("params.paramwithnoenvoverride"), qt.Equals, "nooverride")
c.Assert(scfg.GoogleAnalytics.ID, qt.Equals, "gaid")
c.Assert(cfg.Get("params.a.b"), qt.DeepEquals, maps.Params{
"c": "abc",
}) })
ofBase, _ := s.outputFormatsConfig.GetByName("ofbase") // Issue #8709
ofTheme, _ := s.outputFormatsConfig.GetByName("oftheme") c.Run("Set in string", func(c *qt.C) {
b := newB(c)
c.Assert(ofBase.MediaType, qt.Equals, media.TextType) b.WithEnviron(
c.Assert(ofTheme.MediaType, qt.Equals, media.TextType) // imaging.anchor is a string, and it's not possible
// to set a child attribute.
"HUGO_IMAGING_ANCHOR_FOO", "top",
)
b.Build(BuildCfg{})
cfg := b.H.Cfg
c.Assert(cfg.Get("imaging.anchor"), qt.Equals, "smart")
})
} }