mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-23 19:32:10 +00:00
412 lines
12 KiB
Go
412 lines
12 KiB
Go
// Copyright 2019 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 (
|
|
"fmt"
|
|
"path/filepath"
|
|
"reflect"
|
|
"runtime"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
"github.com/gohugoio/hugo/deps"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
func TestDataDir(t *testing.T) {
|
|
t.Parallel()
|
|
equivDataDirs := make([]dataDir, 3)
|
|
equivDataDirs[0].addSource("data/test/a.json", `{ "b" : { "c1": "red" , "c2": "blue" } }`)
|
|
equivDataDirs[1].addSource("data/test/a.yaml", "b:\n c1: red\n c2: blue")
|
|
equivDataDirs[2].addSource("data/test/a.toml", "[b]\nc1 = \"red\"\nc2 = \"blue\"\n")
|
|
expected := map[string]any{
|
|
"test": map[string]any{
|
|
"a": map[string]any{
|
|
"b": map[string]any{
|
|
"c1": "red",
|
|
"c2": "blue",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
doTestEquivalentDataDirs(t, equivDataDirs, expected)
|
|
}
|
|
|
|
// Unable to enforce equivalency for int values as
|
|
// the JSON, YAML and TOML parsers return
|
|
// float64, int, int64 respectively. They all return
|
|
// float64 for float values though:
|
|
func TestDataDirNumeric(t *testing.T) {
|
|
t.Parallel()
|
|
equivDataDirs := make([]dataDir, 3)
|
|
equivDataDirs[0].addSource("data/test/a.json", `{ "b" : { "c1": 1.7 , "c2": 2.9 } }`)
|
|
equivDataDirs[1].addSource("data/test/a.yaml", "b:\n c1: 1.7\n c2: 2.9")
|
|
equivDataDirs[2].addSource("data/test/a.toml", "[b]\nc1 = 1.7\nc2 = 2.9\n")
|
|
expected := map[string]any{
|
|
"test": map[string]any{
|
|
"a": map[string]any{
|
|
"b": map[string]any{
|
|
"c1": 1.7,
|
|
"c2": 2.9,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
doTestEquivalentDataDirs(t, equivDataDirs, expected)
|
|
}
|
|
|
|
func TestDataDirBoolean(t *testing.T) {
|
|
t.Parallel()
|
|
equivDataDirs := make([]dataDir, 3)
|
|
equivDataDirs[0].addSource("data/test/a.json", `{ "b" : { "c1": true , "c2": false } }`)
|
|
equivDataDirs[1].addSource("data/test/a.yaml", "b:\n c1: true\n c2: false")
|
|
equivDataDirs[2].addSource("data/test/a.toml", "[b]\nc1 = true\nc2 = false\n")
|
|
expected := map[string]any{
|
|
"test": map[string]any{
|
|
"a": map[string]any{
|
|
"b": map[string]any{
|
|
"c1": true,
|
|
"c2": false,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
doTestEquivalentDataDirs(t, equivDataDirs, expected)
|
|
}
|
|
|
|
func TestDataDirTwoFiles(t *testing.T) {
|
|
t.Parallel()
|
|
equivDataDirs := make([]dataDir, 3)
|
|
|
|
equivDataDirs[0].addSource("data/test/foo.json", `{ "bar": "foofoo" }`)
|
|
equivDataDirs[0].addSource("data/test.json", `{ "hello": [ "world", "foo" ] }`)
|
|
|
|
equivDataDirs[1].addSource("data/test/foo.yaml", "bar: foofoo")
|
|
equivDataDirs[1].addSource("data/test.yaml", "hello:\n- world\n- foo")
|
|
|
|
equivDataDirs[2].addSource("data/test/foo.toml", "bar = \"foofoo\"")
|
|
equivDataDirs[2].addSource("data/test.toml", "hello = [\"world\", \"foo\"]")
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"test": map[string]any{
|
|
"hello": []any{
|
|
"world",
|
|
"foo",
|
|
},
|
|
"foo": map[string]any{
|
|
"bar": "foofoo",
|
|
},
|
|
},
|
|
}
|
|
|
|
doTestEquivalentDataDirs(t, equivDataDirs, expected)
|
|
}
|
|
|
|
func TestDataDirOverriddenValue(t *testing.T) {
|
|
t.Parallel()
|
|
equivDataDirs := make([]dataDir, 3)
|
|
|
|
// filepath.Walk walks the files in lexical order, '/' comes before '.'. Simulate this:
|
|
equivDataDirs[0].addSource("data/a.json", `{"a": "1"}`)
|
|
equivDataDirs[0].addSource("data/test/v1.json", `{"v1-2": "2"}`)
|
|
equivDataDirs[0].addSource("data/test/v2.json", `{"v2": ["2", "3"]}`)
|
|
equivDataDirs[0].addSource("data/test.json", `{"v1": "1"}`)
|
|
|
|
equivDataDirs[1].addSource("data/a.yaml", "a: \"1\"")
|
|
equivDataDirs[1].addSource("data/test/v1.yaml", "v1-2: \"2\"")
|
|
equivDataDirs[1].addSource("data/test/v2.yaml", "v2:\n- \"2\"\n- \"3\"")
|
|
equivDataDirs[1].addSource("data/test.yaml", "v1: \"1\"")
|
|
|
|
equivDataDirs[2].addSource("data/a.toml", "a = \"1\"")
|
|
equivDataDirs[2].addSource("data/test/v1.toml", "v1-2 = \"2\"")
|
|
equivDataDirs[2].addSource("data/test/v2.toml", "v2 = [\"2\", \"3\"]")
|
|
equivDataDirs[2].addSource("data/test.toml", "v1 = \"1\"")
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"a": map[string]any{"a": "1"},
|
|
"test": map[string]any{
|
|
"v1": map[string]any{"v1-2": "2"},
|
|
"v2": map[string]any{"v2": []any{"2", "3"}},
|
|
},
|
|
}
|
|
|
|
doTestEquivalentDataDirs(t, equivDataDirs, expected)
|
|
}
|
|
|
|
// Issue #4361, #3890
|
|
func TestDataDirArrayAtTopLevelOfFile(t *testing.T) {
|
|
t.Parallel()
|
|
equivDataDirs := make([]dataDir, 2)
|
|
|
|
equivDataDirs[0].addSource("data/test.json", `[ { "hello": "world" }, { "what": "time" }, { "is": "lunch?" } ]`)
|
|
equivDataDirs[1].addSource("data/test.yaml", `
|
|
- hello: world
|
|
- what: time
|
|
- is: lunch?
|
|
`)
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"test": []any{
|
|
map[string]any{"hello": "world"},
|
|
map[string]any{"what": "time"},
|
|
map[string]any{"is": "lunch?"},
|
|
},
|
|
}
|
|
|
|
doTestEquivalentDataDirs(t, equivDataDirs, expected)
|
|
}
|
|
|
|
// Issue #892
|
|
func TestDataDirMultipleSources(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var dd dataDir
|
|
dd.addSource("data/test/first.yaml", "bar: 1")
|
|
dd.addSource("themes/mytheme/data/test/first.yaml", "bar: 2")
|
|
dd.addSource("data/test/second.yaml", "tender: 2")
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"test": map[string]any{
|
|
"first": map[string]any{
|
|
"bar": 1,
|
|
},
|
|
"second": map[string]any{
|
|
"tender": 2,
|
|
},
|
|
},
|
|
}
|
|
|
|
doTestDataDir(t, dd, expected,
|
|
"theme", "mytheme")
|
|
}
|
|
|
|
// test (and show) the way values from four different sources,
|
|
// including theme data, commingle and override
|
|
func TestDataDirMultipleSourcesCommingled(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var dd dataDir
|
|
dd.addSource("data/a.json", `{ "b1" : { "c1": "data/a" }, "b2": "data/a", "b3": ["x", "y", "z"] }`)
|
|
dd.addSource("themes/mytheme/data/a.json", `{ "b1": "mytheme/data/a", "b2": "mytheme/data/a", "b3": "mytheme/data/a" }`)
|
|
dd.addSource("themes/mytheme/data/a/b1.json", `{ "c1": "mytheme/data/a/b1", "c2": "mytheme/data/a/b1" }`)
|
|
dd.addSource("data/a/b1.json", `{ "c1": "data/a/b1" }`)
|
|
|
|
// Per handleDataFile() comment:
|
|
// 1. A theme uses the same key; the main data folder wins
|
|
// 2. A sub folder uses the same key: the sub folder wins
|
|
expected :=
|
|
map[string]any{
|
|
"a": map[string]any{
|
|
"b1": map[string]any{
|
|
"c1": "data/a/b1",
|
|
"c2": "mytheme/data/a/b1",
|
|
},
|
|
"b2": "data/a",
|
|
"b3": []any{"x", "y", "z"},
|
|
},
|
|
}
|
|
|
|
doTestDataDir(t, dd, expected, "theme", "mytheme")
|
|
}
|
|
|
|
func TestDataDirCollidingChildArrays(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var dd dataDir
|
|
dd.addSource("themes/mytheme/data/a/b2.json", `["Q", "R", "S"]`)
|
|
dd.addSource("data/a.json", `{ "b1" : "data/a", "b2" : ["x", "y", "z"] }`)
|
|
dd.addSource("data/a/b2.json", `["1", "2", "3"]`)
|
|
|
|
// Per handleDataFile() comment:
|
|
// 1. A theme uses the same key; the main data folder wins
|
|
// 2. A sub folder uses the same key: the sub folder wins
|
|
expected :=
|
|
map[string]any{
|
|
"a": map[string]any{
|
|
"b1": "data/a",
|
|
"b2": []any{"1", "2", "3"},
|
|
},
|
|
}
|
|
|
|
doTestDataDir(t, dd, expected, "theme", "mytheme")
|
|
}
|
|
|
|
func TestDataDirCollidingTopLevelArrays(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var dd dataDir
|
|
dd.addSource("themes/mytheme/data/a/b1.json", `["x", "y", "z"]`)
|
|
dd.addSource("data/a/b1.json", `["1", "2", "3"]`)
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"a": map[string]any{
|
|
"b1": []any{"1", "2", "3"},
|
|
},
|
|
}
|
|
|
|
doTestDataDir(t, dd, expected, "theme", "mytheme")
|
|
}
|
|
|
|
func TestDataDirCollidingMapsAndArrays(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var dd dataDir
|
|
// on
|
|
dd.addSource("themes/mytheme/data/a.json", `["1", "2", "3"]`)
|
|
dd.addSource("themes/mytheme/data/b.json", `{ "film" : "Logan Lucky" }`)
|
|
dd.addSource("data/a.json", `{ "music" : "Queen's Rebuke" }`)
|
|
dd.addSource("data/b.json", `["x", "y", "z"]`)
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"a": map[string]any{
|
|
"music": "Queen's Rebuke",
|
|
},
|
|
"b": []any{"x", "y", "z"},
|
|
}
|
|
|
|
doTestDataDir(t, dd, expected, "theme", "mytheme")
|
|
}
|
|
|
|
// https://discourse.gohugo.io/t/recursive-data-file-parsing/26192
|
|
func TestDataDirNestedDirectories(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var dd dataDir
|
|
dd.addSource("themes/mytheme/data/a.json", `["1", "2", "3"]`)
|
|
dd.addSource("data/test1/20/06/a.json", `{ "artist" : "Michael Brecker" }`)
|
|
dd.addSource("data/test1/20/05/b.json", `{ "artist" : "Charlie Parker" }`)
|
|
|
|
expected :=
|
|
map[string]any{
|
|
"a": []any{"1", "2", "3"},
|
|
"test1": map[string]any{"20": map[string]any{"05": map[string]any{"b": map[string]any{"artist": "Charlie Parker"}}, "06": map[string]any{"a": map[string]any{"artist": "Michael Brecker"}}}},
|
|
}
|
|
|
|
doTestDataDir(t, dd, expected, "theme", "mytheme")
|
|
}
|
|
|
|
type dataDir struct {
|
|
sources [][2]string
|
|
}
|
|
|
|
func (d *dataDir) addSource(path, content string) {
|
|
d.sources = append(d.sources, [2]string{path, content})
|
|
}
|
|
|
|
func doTestEquivalentDataDirs(t *testing.T, equivDataDirs []dataDir, expected any, configKeyValues ...any) {
|
|
for i, dd := range equivDataDirs {
|
|
err := doTestDataDirImpl(t, dd, expected, configKeyValues...)
|
|
if err != "" {
|
|
t.Errorf("equivDataDirs[%d]: %s", i, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func doTestDataDir(t *testing.T, dd dataDir, expected any, configKeyValues ...any) {
|
|
err := doTestDataDirImpl(t, dd, expected, configKeyValues...)
|
|
if err != "" {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func doTestDataDirImpl(t *testing.T, dd dataDir, expected any, configKeyValues ...any) (err string) {
|
|
cfg, fs := newTestCfg()
|
|
|
|
for i := 0; i < len(configKeyValues); i += 2 {
|
|
cfg.Set(configKeyValues[i].(string), configKeyValues[i+1])
|
|
}
|
|
|
|
var (
|
|
logger = loggers.NewErrorLogger()
|
|
depsCfg = deps.DepsCfg{Fs: fs, Cfg: cfg, Logger: logger}
|
|
)
|
|
|
|
writeSource(t, fs, filepath.Join("content", "dummy.md"), "content")
|
|
writeSourcesToSource(t, "", fs, dd.sources...)
|
|
|
|
expectBuildError := false
|
|
|
|
if ok, shouldFail := expected.(bool); ok && shouldFail {
|
|
expectBuildError = true
|
|
}
|
|
|
|
// trap and report panics as unmarshaling errors so that test suit can complete
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
// Capture the stack trace
|
|
buf := make([]byte, 10000)
|
|
runtime.Stack(buf, false)
|
|
t.Errorf("PANIC: %s\n\nStack Trace : %s", r, string(buf))
|
|
}
|
|
}()
|
|
|
|
s := buildSingleSiteExpected(t, false, expectBuildError, depsCfg, BuildCfg{SkipRender: true})
|
|
|
|
if !expectBuildError && !reflect.DeepEqual(expected, s.h.Data()) {
|
|
// This disabled code detects the situation described in the WARNING message below.
|
|
// The situation seems to only occur for TOML data with integer values.
|
|
// Perhaps the TOML parser returns ints in another type.
|
|
// Re-enable temporarily to debug fails that should be passing.
|
|
// Re-enable permanently if reflect.DeepEqual is simply too strict.
|
|
/*
|
|
exp := fmt.Sprintf("%#v", expected)
|
|
got := fmt.Sprintf("%#v", s.Data)
|
|
if exp == got {
|
|
t.Logf("WARNING: reflect.DeepEqual returned FALSE for values that appear equal.\n"+
|
|
"Treating as equal for the purpose of the test, but this maybe should be investigated.\n"+
|
|
"Expected data:\n%v got\n%v\n\nExpected type structure:\n%#[1]v got\n%#[2]v", expected, s.Data)
|
|
return
|
|
}
|
|
*/
|
|
|
|
return fmt.Sprintf("Expected data:\n%v got\n%v\n\nExpected type structure:\n%#[1]v got\n%#[2]v", expected, s.h.Data())
|
|
}
|
|
|
|
return
|
|
}
|
|
|
|
func TestDataFromShortcode(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var (
|
|
cfg, fs = newTestCfg()
|
|
c = qt.New(t)
|
|
)
|
|
|
|
writeSource(t, fs, "data/hugo.toml", "slogan = \"Hugo Rocks!\"")
|
|
writeSource(t, fs, "layouts/_default/single.html", `
|
|
* Slogan from template: {{ .Site.Data.hugo.slogan }}
|
|
* {{ .Content }}`)
|
|
writeSource(t, fs, "layouts/shortcodes/d.html", `{{ .Page.Site.Data.hugo.slogan }}`)
|
|
writeSource(t, fs, "content/c.md", `---
|
|
---
|
|
Slogan from shortcode: {{< d >}}
|
|
`)
|
|
|
|
buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{})
|
|
|
|
content := readSource(t, fs, "public/c/index.html")
|
|
|
|
c.Assert(content, qt.Contains, "Slogan from template: Hugo Rocks!")
|
|
c.Assert(content, qt.Contains, "Slogan from shortcode: Hugo Rocks!")
|
|
}
|