mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-25 14:30:49 +00:00
a3701e0931
We have been using `go-toml` for language files only. This commit makes it the only TOML library. It's spec compliant and very fast. A benchark building a site with 200 pages with TOML front matter: ```bash name old time/op new time/op delta SiteNew/Regular_TOML_front_matter-16 48.5ms ± 1% 47.1ms ± 1% -2.85% (p=0.029 n=4+4) name old alloc/op new alloc/op delta SiteNew/Regular_TOML_front_matter-16 16.9MB ± 0% 16.7MB ± 0% -1.56% (p=0.029 n=4+4) name old allocs/op new allocs/op delta SiteNew/Regular_TOML_front_matter-16 302k ± 0% 296k ± 0% -2.20% (p=0.029 n=4+4) ``` Note that the front matter unmarshaling is only a small part of building a site, so the above is very good. Fixes #8801
152 lines
3.9 KiB
Go
152 lines
3.9 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package hugolib
|
|
|
|
import (
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/common/herrors"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
"github.com/gohugoio/hugo/htesting"
|
|
"github.com/spf13/afero"
|
|
)
|
|
|
|
func TestLoadConfigDir(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
c := qt.New(t)
|
|
|
|
configContent := `
|
|
baseURL = "https://example.org"
|
|
paginagePath = "pag_root"
|
|
|
|
[languages.en]
|
|
weight = 0
|
|
languageName = "English"
|
|
|
|
[languages.no]
|
|
weight = 10
|
|
languageName = "FOO"
|
|
|
|
[params]
|
|
p1 = "p1_base"
|
|
|
|
`
|
|
|
|
mm := afero.NewMemMapFs()
|
|
|
|
writeToFs(t, mm, "hugo.toml", configContent)
|
|
|
|
fb := htesting.NewTestdataBuilder(mm, "config/_default", t)
|
|
|
|
fb.Add("config.toml", `paginatePath = "pag_default"`)
|
|
|
|
fb.Add("params.yaml", `
|
|
p2: "p2params_default"
|
|
p3: "p3params_default"
|
|
p4: "p4params_default"
|
|
`)
|
|
fb.Add("menus.toml", `
|
|
[[docs]]
|
|
name = "About Hugo"
|
|
weight = 1
|
|
[[docs]]
|
|
name = "Home"
|
|
weight = 2
|
|
`)
|
|
|
|
fb.Add("menus.no.toml", `
|
|
[[docs]]
|
|
name = "Om Hugo"
|
|
weight = 1
|
|
`)
|
|
|
|
fb.Add("params.no.toml",
|
|
`
|
|
p3 = "p3params_no_default"
|
|
p4 = "p4params_no_default"`,
|
|
)
|
|
fb.Add("languages.no.toml", `languageName = "Norsk_no_default"`)
|
|
|
|
fb.Build()
|
|
|
|
fb = fb.WithWorkingDir("config/production")
|
|
|
|
fb.Add("config.toml", `paginatePath = "pag_production"`)
|
|
|
|
fb.Add("params.no.toml", `
|
|
p2 = "p2params_no_production"
|
|
p3 = "p3params_no_production"
|
|
`)
|
|
|
|
fb.Build()
|
|
|
|
fb = fb.WithWorkingDir("config/development")
|
|
|
|
// This is set in all the config.toml variants above, but this will win.
|
|
fb.Add("config.TOML", `paginatePath = "pag_development"`)
|
|
// Issue #5646
|
|
fb.Add("config.toml.swp", `p3 = "paginatePath = "nono"`)
|
|
|
|
fb.Add("params.no.toml", `p3 = "p3params_no_development"`)
|
|
fb.Add("params.toml", `p3 = "p3params_development"`)
|
|
|
|
fb.Build()
|
|
|
|
cfg, _, err := LoadConfig(ConfigSourceDescriptor{Fs: mm, Environment: "development", Filename: "hugo.toml", AbsConfigDir: "config"})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
c.Assert(cfg.GetString("paginatePath"), qt.Equals, "pag_development") // /config/development/config.toml
|
|
|
|
c.Assert(cfg.GetInt("languages.no.weight"), qt.Equals, 10) // /config.toml
|
|
c.Assert(cfg.GetString("languages.no.languageName"), qt.Equals, "Norsk_no_default") // /config/_default/languages.no.toml
|
|
|
|
c.Assert(cfg.GetString("params.p1"), qt.Equals, "p1_base")
|
|
c.Assert(cfg.GetString("params.p2"), qt.Equals, "p2params_default") // Is in both _default and production
|
|
c.Assert(cfg.GetString("params.p3"), qt.Equals, "p3params_development")
|
|
c.Assert(cfg.GetString("languages.no.params.p3"), qt.Equals, "p3params_no_development")
|
|
|
|
c.Assert(len(cfg.Get("menus.docs").([]interface{})), qt.Equals, 2)
|
|
noMenus := cfg.Get("languages.no.menus.docs")
|
|
c.Assert(noMenus, qt.Not(qt.IsNil))
|
|
c.Assert(len(noMenus.([]interface{})), qt.Equals, 1)
|
|
}
|
|
|
|
func TestLoadConfigDirError(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
c := qt.New(t)
|
|
|
|
configContent := `
|
|
baseURL = "https://example.org"
|
|
|
|
`
|
|
|
|
mm := afero.NewMemMapFs()
|
|
|
|
writeToFs(t, mm, "hugo.toml", configContent)
|
|
|
|
fb := htesting.NewTestdataBuilder(mm, "config/development", t)
|
|
|
|
fb.Add("config.toml", `invalid & syntax`).Build()
|
|
|
|
_, _, err := LoadConfig(ConfigSourceDescriptor{Fs: mm, Environment: "development", Filename: "hugo.toml", AbsConfigDir: "config"})
|
|
c.Assert(err, qt.Not(qt.IsNil))
|
|
|
|
fe := herrors.UnwrapErrorWithFileContext(err)
|
|
c.Assert(fe, qt.Not(qt.IsNil))
|
|
c.Assert(fe.Position().Filename, qt.Equals, filepath.FromSlash("config/development/config.toml"))
|
|
}
|