From: Bjørn Erik Pedersen Date: Sat, 8 Nov 2025 10:22:56 +0000 (+0100) Subject: testing: Rewrite all the old style integration tests to txtar style tests X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=a2469d504efd34a5507aadfa40778d1de0ebd976;p=brevno-suite%2Fhugo testing: Rewrite all the old style integration tests to txtar style tests And remove some not worth keeping (or too much work to convert). --- diff --git a/config/configLoader.go b/config/configLoader.go index dd103f27b..7b8633492 100644 --- a/config/configLoader.go +++ b/config/configLoader.go @@ -1,4 +1,4 @@ -// Copyright 2018 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -20,6 +20,7 @@ import ( "strings" "github.com/gohugoio/hugo/common/herrors" + "github.com/gohugoio/hugo/parser" "github.com/gohugoio/hugo/common/paths" @@ -57,6 +58,7 @@ func IsValidConfigFilename(filename string) bool { return validConfigFileExtensionsMap[ext] } +// FromTOMLConfigString creates a config from the given TOML config. This is useful in tests. func FromTOMLConfigString(config string) Provider { cfg, err := FromConfigString(config, "toml") if err != nil { @@ -65,6 +67,16 @@ func FromTOMLConfigString(config string) Provider { return cfg } +// FromMapToTOMLString converts the given map to a TOML string. This is useful in tests. +func FromMapToTOMLString(v map[string]any) string { + var sb strings.Builder + err := parser.InterfaceToConfig(v, metadecoders.TOML, &sb) + if err != nil { + panic(err) + } + return sb.String() +} + // FromConfigString creates a config from the given YAML, JSON or TOML config. This is useful in tests. func FromConfigString(config, configType string) (Provider, error) { m, err := readConfig(metadecoders.FormatFromString(configType), []byte(config)) @@ -218,7 +230,6 @@ func init() { // Before 0.53 we used singular for "menu". "{menu,languages/*/menu}", "menus", ) - if err != nil { panic(err) } diff --git a/go.mod b/go.mod index 8adf07fba..870c34037 100644 --- a/go.mod +++ b/go.mod @@ -44,7 +44,6 @@ require ( github.com/gohugoio/hugo-goldmark-extensions/passthrough v0.3.1 github.com/gohugoio/locales v0.14.0 github.com/gohugoio/localescompressed v1.0.1 - github.com/gohugoio/testmodBuilder/mods v0.0.0-20190520184928-c56af20f2e95 github.com/google/go-cmp v0.7.0 github.com/gorilla/websocket v1.5.3 github.com/hairyhenderson/go-codeowners v0.7.0 diff --git a/hugolib/404_test.go b/hugolib/404_test.go index ed953339c..36738e428 100644 --- a/hugolib/404_test.go +++ b/hugolib/404_test.go @@ -1,4 +1,4 @@ -// Copyright 2017 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -41,12 +41,7 @@ Page: {{ .Page.RelPermalink }}| Data: {{ len .Data }}| ` - b := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).Build() + b := Test(t, files) b.AssertFileContent("public/index.html", "All. home. |") @@ -68,25 +63,6 @@ Data: 1| `) } -func Test404WithBase(t *testing.T) { - t.Parallel() - - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile().WithTemplates("404.html", `{{ define "main" }} -Page not found -{{ end }}`, - "baseof.html", `Base: {{ block "main" . }}{{ end }}`).WithContent("page.md", ``) - - b.Build(BuildCfg{}) - - // Note: We currently have only 1 404 page. One might think that we should have - // multiple, to follow the Custom Output scheme, but I don't see how that would work - // right now. - b.AssertFileContent("public/404.html", ` -Base: -Page not found`) -} - func Test404EditTemplate(t *testing.T) { t.Parallel() diff --git a/hugolib/alias_test.go b/hugolib/alias_test.go index 10ea41048..32a95d608 100644 --- a/hugolib/alias_test.go +++ b/hugolib/alias_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -14,37 +14,17 @@ package hugolib import ( - "os" "path/filepath" "runtime" + "strings" "testing" - qt "github.com/frankban/quicktest" "github.com/gohugoio/hugo/common/loggers" -) - -const pageWithAlias = `--- -title: Has Alias -aliases: ["/foo/bar/", "rel"] ---- -For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke. -` - -const pageWithAliasMultipleOutputs = `--- -title: Has Alias for HTML and AMP -aliases: ["/foo/bar/"] -outputs: ["HTML", "AMP", "JSON"] ---- -For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke. -` - -const ( - basicTemplate = "{{.Content}}" + "github.com/gohugoio/hugo/config" ) func TestAlias(t *testing.T) { t.Parallel() - c := qt.New(t) tests := []struct { fileSuffix string @@ -60,15 +40,26 @@ func TestAlias(t *testing.T) { } for _, test := range tests { - b := newTestSitesBuilder(t) - b.WithSimpleConfigFileAndSettings(test.settings).WithContent("blog/page.md", pageWithAlias) - b.CreateSites().Build(BuildCfg{}) + files := ` +-- hugo.toml -- +disableKinds = ["rss", "sitemap", "taxonomy", "term"] +CONFIG +-- content/blog/page.md -- +--- +title: Has Alias +aliases: ["/foo/bar/", "rel"] +--- +For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke. +-- layouts/all.html -- +Title: {{ .Title }}|Content: {{ .Content }}| +` + files = strings.Replace(files, "CONFIG", config.FromMapToTOMLString(test.settings), 1) - c.Assert(len(b.H.Sites), qt.Equals, 1) - c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 1) + b := Test(t, files) // the real page b.AssertFileContent("public/blog/page"+test.fileSuffix, "For some moments the old man") + // the alias redirectors b.AssertFileContent("public/foo/bar"+test.fileSuffix, "") b.AssertFileContent("public/blog/rel"+test.fileSuffix, "") @@ -78,19 +69,25 @@ func TestAlias(t *testing.T) { func TestAliasMultipleOutputFormats(t *testing.T) { t.Parallel() - c := qt.New(t) - - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile().WithContent("blog/page.md", pageWithAliasMultipleOutputs) - - b.WithTemplates( - "_default/single.html", basicTemplate, - "_default/single.amp.html", basicTemplate, - "_default/single.json", basicTemplate) - - b.CreateSites().Build(BuildCfg{}) + files := ` +-- hugo.toml -- +baseURL = "http://example.com" +-- layouts/_default/single.html -- +{{ .Content }} +-- layouts/_default/single.amp.html -- +{{ .Content }} +-- layouts/_default/single.json -- +{{ .Content }} +-- content/blog/page.md -- +--- +title: Has Alias for HTML and AMP +aliases: ["/foo/bar/"] +outputs: ["html", "amp", "json"] +--- +For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke. +` - b.H.Sites[0].pageMap.debugPrint("", 999, os.Stdout) + b := Test(t, files) // the real pages b.AssertFileContent("public/blog/page/index.html", "For some moments the old man") @@ -100,7 +97,7 @@ func TestAliasMultipleOutputFormats(t *testing.T) { // the alias redirectors b.AssertFileContent("public/foo/bar/index.html", "https://example.org/sect4/index.xml`) - b.AssertFileContent("public/sect4/p1/index.xml", `https://example.org/sect4/p1/index.xml`) - b.C.Assert(b.CheckExists("public/sect2/index.xml"), qt.Equals, false) - - // Check cascade into bundled page - b.AssertFileContent("public/bundle1/index.html", `Resources: bp1.md|home.png|`) - }) -} - -func TestCascadeEdit(t *testing.T) { - p1Content := `--- -title: P1 ---- -` - - indexContentNoCascade := ` ---- -title: Home ---- -` - - indexContentCascade := ` ---- -title: Section -cascade: - banner: post.jpg - layout: postlayout - type: posttype ---- -` - - layout := `Banner: {{ .Params.banner }}|Layout: {{ .Layout }}|Type: {{ .Type }}|Content: {{ .Content }}` - - newSite := func(t *testing.T, cascade bool) *sitesBuilder { - b := newTestSitesBuilder(t).Running() - b.WithTemplates("_default/single.html", layout) - b.WithTemplates("_default/list.html", layout) - if cascade { - b.WithContent("post/_index.md", indexContentCascade) - } else { - b.WithContent("post/_index.md", indexContentNoCascade) - } - b.WithContent("post/dir/p1.md", p1Content) - - return b - } - - /*t.Run("Edit descendant", func(t *testing.T) { - t.Parallel() - - b := newSite(t, true) - b.Build(BuildCfg{}) - - assert := func() { - b.Helper() - b.AssertFileContent("public/post/dir/p1/index.html", - `Banner: post.jpg|`, - `Layout: postlayout`, - `Type: posttype`, - ) - } - - assert() - - b.EditFiles("content/post/dir/p1.md", p1Content+"\ncontent edit") - b.Build(BuildCfg{}) - - assert() - b.AssertFileContent("public/post/dir/p1/index.html", - `content edit - Banner: post.jpg`, - ) - }) - - t.Run("Edit ancestor", func(t *testing.T) { - t.Parallel() - - b := newSite(t, true) - b.Build(BuildCfg{}) - - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg|Layout: postlayout|Type: posttype|Content:`) - - b.EditFiles("content/post/_index.md", strings.Replace(indexContentCascade, "post.jpg", "edit.jpg", 1)) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/post/index.html", `Banner: edit.jpg|Layout: postlayout|Type: posttype|`) - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: edit.jpg|Layout: postlayout|Type: posttype|`) - }) - - t.Run("Edit ancestor, add cascade", func(t *testing.T) { - t.Parallel() - - b := newSite(t, true) - b.Build(BuildCfg{}) - - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg`) - - b.EditFiles("content/post/_index.md", indexContentCascade) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/post/index.html", `Banner: post.jpg|Layout: postlayout|Type: posttype|`) - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg|Layout: postlayout|`) - }) - - t.Run("Edit ancestor, remove cascade", func(t *testing.T) { - t.Parallel() - - b := newSite(t, false) - b.Build(BuildCfg{}) - - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: |Layout: |`) - - b.EditFiles("content/post/_index.md", indexContentNoCascade) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/post/index.html", `Banner: |Layout: |Type: post|`) - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: |Layout: |`) - }) - */ - - t.Run("Edit ancestor, content only", func(t *testing.T) { - t.Parallel() - - b := newSite(t, true) - b.Build(BuildCfg{}) - - b.EditFiles("content/post/_index.md", indexContentCascade+"\ncontent edit") - - counters := &buildCounters{} - b.Build(BuildCfg{testCounters: counters}) - b.Assert(int(counters.contentRenderCounter.Load()), qt.Equals, 1) - - b.AssertFileContent("public/post/index.html", `Banner: post.jpg|Layout: postlayout|Type: posttype|Content:

content edit

`) - b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg|Layout: postlayout|`) - }) -} - func TestCascadeBuildOptionsTaxonomies(t *testing.T) { t.Parallel() @@ -371,301 +97,6 @@ Single: Tags: {{ site.Taxonomies.tags }}| b.AssertFileExists("public/tags/t2/index.html", false) } -func newCascadeTestBuilder(t testing.TB, langs []string) *sitesBuilder { - p := func(m map[string]any) string { - var yamlStr string - - if len(m) > 0 { - var b bytes.Buffer - - parser.InterfaceToConfig(m, metadecoders.YAML, &b) - yamlStr = b.String() - } - - metaStr := "---\n" + yamlStr + "\n---" - - return metaStr - } - - createLangConfig := func(lang string) string { - const langEntry = ` -[languages.%s] -` - return fmt.Sprintf(langEntry, lang) - } - - createMount := func(lang string) string { - const mountsTempl = ` -[[module.mounts]] -source="content/%s" -target="content" -lang="%s" -` - return fmt.Sprintf(mountsTempl, lang, lang) - } - - config := ` -baseURL = "https://example.org" -defaultContentLanguage = "en" -defaultContentLanguageInSubDir = false - -[languages]` - for _, lang := range langs { - config += createLangConfig(lang) - } - - config += "\n\n[module]\n" - for _, lang := range langs { - config += createMount(lang) - } - - b := newTestSitesBuilder(t).WithConfigFile("toml", config) - - createContentFiles := func(lang string) { - withContent := func(filenameContent ...string) { - for i := 0; i < len(filenameContent); i += 2 { - b.WithContent(path.Join(lang, filenameContent[i]), filenameContent[i+1]) - } - } - - withContent( - "_index.md", p(map[string]any{ - "title": "Home", - "cascade": map[string]any{ - "title": "Cascade Home", - "ICoN": "home.png", - "outputs": []string{"HTML"}, - "weight": 42, - }, - }), - "p1.md", p(map[string]any{ - "title": "p1", - }), - "p2.md", p(map[string]any{}), - "sect1/_index.md", p(map[string]any{ - "title": "Sect1", - "type": "stype", - "cascade": map[string]any{ - "title": "Cascade Sect1", - "icon": "sect1.png", - "type": "stype", - "categories": []string{"catsect1"}, - }, - }), - "sect1/s1_2/_index.md", p(map[string]any{ - "title": "Sect1_2", - }), - "sect1/s1_2/p1.md", p(map[string]any{ - "title": "Sect1_2_p1", - }), - "sect1/s1_2/p2.md", p(map[string]any{ - "title": "Sect1_2_p2", - }), - "sect2/_index.md", p(map[string]any{ - "title": "Sect2", - }), - "sect2/p1.md", p(map[string]any{ - "title": "Sect2_p1", - "categories": []string{"cool", "funny", "sad"}, - "tags": []string{"blue", "green"}, - }), - "sect2/p2.md", p(map[string]any{}), - "sect3/p1.md", p(map[string]any{}), - - // No front matter, see #6855 - "sect3/nofrontmatter.md", `**Hello**`, - "sectnocontent/p1.md", `**Hello**`, - "sectnofrontmatter/_index.md", `**Hello**`, - - "sect4/_index.md", p(map[string]any{ - "title": "Sect4", - "cascade": map[string]any{ - "weight": 52, - "outputs": []string{"RSS"}, - }, - }), - "sect4/p1.md", p(map[string]any{}), - "p2.md", p(map[string]any{}), - "bundle1/index.md", p(map[string]any{}), - "bundle1/bp1.md", p(map[string]any{}), - "categories/_index.md", p(map[string]any{ - "title": "My Categories", - "cascade": map[string]any{ - "title": "Cascade Category", - "icoN": "cat.png", - "weight": 12, - }, - }), - "categories/cool/_index.md", p(map[string]any{}), - "categories/sad/_index.md", p(map[string]any{ - "cascade": map[string]any{ - "icon": "sad.png", - "weight": 32, - }, - }), - ) - } - - createContentFiles("en") - - b.WithTemplates("index.html", ` - -{{ range .Site.Pages }} -{{- .Weight }}|{{ .Kind }}|{{ .Path }}|{{ .Title }}|{{ .Params.icon }}|{{ .Type }}|{{ range .OutputFormats }}{{ .Name }}-{{ end }}| -{{ end }} -`, - - "_default/single.html", "default single: {{ .Title }}|{{ .RelPermalink }}|{{ .Content }}|Resources: {{ range .Resources }}{{ .Name }}|{{ .Params.icon }}|{{ .Content }}{{ end }}", - "_default/list.html", "default list: {{ .Title }}", - "stype/single.html", "stype single: {{ .Title }}|{{ .RelPermalink }}|{{ .Content }}", - "stype/list.html", "stype list: {{ .Title }}", - ) - - return b -} - -func TestCascadeTarget(t *testing.T) { - t.Parallel() - - c := qt.New(t) - - newBuilder := func(c *qt.C) *sitesBuilder { - b := newTestSitesBuilder(c) - - b.WithTemplates("index.html", ` -{{ $p1 := site.GetPage "s1/p1" }} -{{ $s1 := site.GetPage "s1" }} - -P1|p1:{{ $p1.Params.p1 }}|p2:{{ $p1.Params.p2 }}| -S1|p1:{{ $s1.Params.p1 }}|p2:{{ $s1.Params.p2 }}| -`) - b.WithContent("s1/_index.md", "---\ntitle: s1 section\n---") - b.WithContent("s1/p1/index.md", "---\ntitle: p1\n---") - b.WithContent("s1/p2/index.md", "---\ntitle: p2\n---") - b.WithContent("s2/p1/index.md", "---\ntitle: p1_2\n---") - - return b - } - - c.Run("slice", func(c *qt.C) { - b := newBuilder(c) - b.WithContent("_index.md", `+++ -title = "Home" -[[cascade]] -p1 = "p1" -[[cascade]] -p2 = "p2" -+++ -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", "P1|p1:p1|p2:p2") - }) - - c.Run("slice with _target", func(c *qt.C) { - b := newBuilder(c) - - b.WithContent("_index.md", `+++ -title = "Home" -[[cascade]] -p1 = "p1" -[cascade._target] -path="**p1**" -[[cascade]] -p2 = "p2" -[cascade._target] -kind="section" -+++ -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", ` -P1|p1:p1|p2:| -S1|p1:|p2:p2| -`) - }) - - c.Run("slice with environment _target", func(c *qt.C) { - b := newBuilder(c) - - b.WithContent("_index.md", `+++ -title = "Home" -[[cascade]] -p1 = "p1" -[cascade._target] -path="**p1**" -environment="testing" -[[cascade]] -p2 = "p2" -[cascade._target] -kind="section" -environment="production" -+++ -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", ` -P1|p1:|p2:| -S1|p1:|p2:p2| -`) - }) - - c.Run("slice with yaml _target", func(c *qt.C) { - b := newBuilder(c) - - b.WithContent("_index.md", `--- -title: "Home" -cascade: -- p1: p1 - _target: - path: "**p1**" -- p2: p2 - _target: - kind: "section" ---- -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", ` -P1|p1:p1|p2:| -S1|p1:|p2:p2| -`) - }) - - c.Run("slice with json _target", func(c *qt.C) { - b := newBuilder(c) - - b.WithContent("_index.md", `{ -"title": "Home", -"cascade": [ - { - "p1": "p1", - "_target": { - "path": "**p1**" - } - },{ - "p2": "p2", - "_target": { - "kind": "section" - } - } -] -} -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", ` - P1|p1:p1|p2:| - S1|p1:|p2:p2| - `) - }) -} - func TestCascadeEditIssue12449(t *testing.T) { t.Parallel() diff --git a/hugolib/collections_test.go b/hugolib/collections_test.go deleted file mode 100644 index f62d4c604..000000000 --- a/hugolib/collections_test.go +++ /dev/null @@ -1,219 +0,0 @@ -// 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" - "testing" - - qt "github.com/frankban/quicktest" -) - -func TestGroupFunc(t *testing.T) { - c := qt.New(t) - - pageContent := ` ---- -title: "Page" ---- - -` - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile(). - WithContent("page1.md", pageContent, "page2.md", pageContent). - WithTemplatesAdded("index.html", ` -{{ $cool := .Site.RegularPages | group "cool" }} -{{ $cool.Key }}: {{ len $cool.Pages }} - -`) - b.CreateSites().Build(BuildCfg{}) - - // b.H.TemplateStore.PrintDebug("", tplimpl.CategoryLayout, os.Stdout) - - c.Assert(len(b.H.Sites), qt.Equals, 1) - c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 2) - - b.AssertFileContent("public/index.html", "cool: 2") -} - -func TestSliceFunc(t *testing.T) { - c := qt.New(t) - - pageContent := ` ---- -title: "Page" -tags: ["blue", "green"] -tags_weight: %d ---- - -` - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile(). - WithContent("page1.md", fmt.Sprintf(pageContent, 10), "page2.md", fmt.Sprintf(pageContent, 20)). - WithTemplatesAdded("index.html", ` -{{ $cool := first 1 .Site.RegularPages | group "cool" }} -{{ $blue := after 1 .Site.RegularPages | group "blue" }} -{{ $weightedPages := index (index .Site.Taxonomies "tags") "blue" }} - -{{ $p1 := index .Site.RegularPages 0 }}{{ $p2 := index .Site.RegularPages 1 }} -{{ $wp1 := index $weightedPages 0 }}{{ $wp2 := index $weightedPages 1 }} - -{{ $pages := slice $p1 $p2 }} -{{ $pageGroups := slice $cool $blue }} -{{ $weighted := slice $wp1 $wp2 }} - -{{ printf "pages:%d:%T:%s|%s" (len $pages) $pages (index $pages 0).Path (index $pages 1).Path }} -{{ printf "pageGroups:%d:%T:%s|%s" (len $pageGroups) $pageGroups (index (index $pageGroups 0).Pages 0).Path (index (index $pageGroups 1).Pages 0).Path}} -{{ printf "weightedPages:%d:%T" (len $weighted) $weighted | safeHTML }} - -`) - b.CreateSites().Build(BuildCfg{}) - - c.Assert(len(b.H.Sites), qt.Equals, 1) - c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 2) - - b.AssertFileContent("public/index.html", - "pages:2:page.Pages:/page1|/page2", - "pageGroups:2:page.PagesGroup:/page1|/page2", - `weightedPages:2:page.WeightedPages`) -} - -func TestUnionFunc(t *testing.T) { - c := qt.New(t) - - pageContent := ` ---- -title: "Page" -tags: ["blue", "green"] -tags_weight: %d ---- - -` - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile(). - WithContent("page1.md", fmt.Sprintf(pageContent, 10), "page2.md", fmt.Sprintf(pageContent, 20), - "page3.md", fmt.Sprintf(pageContent, 30)). - WithTemplatesAdded("index.html", ` -{{ $unionPages := first 2 .Site.RegularPages | union .Site.RegularPages }} -{{ $unionWeightedPages := .Site.Taxonomies.tags.blue | union .Site.Taxonomies.tags.green }} -{{ printf "unionPages: %T %d" $unionPages (len $unionPages) }} -{{ printf "unionWeightedPages: %T %d" $unionWeightedPages (len $unionWeightedPages) }} -`) - b.CreateSites().Build(BuildCfg{}) - - c.Assert(len(b.H.Sites), qt.Equals, 1) - c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 3) - - b.AssertFileContent("public/index.html", - "unionPages: page.Pages 3", - "unionWeightedPages: page.WeightedPages 6") -} - -func TestCollectionsFuncs(t *testing.T) { - c := qt.New(t) - - pageContent := ` ---- -title: "Page %d" -tags: ["blue", "green"] -tags_weight: %d ---- - -` - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile(). - WithContent("page1.md", fmt.Sprintf(pageContent, 10, 10), "page2.md", fmt.Sprintf(pageContent, 20, 20), - "page3.md", fmt.Sprintf(pageContent, 30, 30)). - WithTemplatesAdded("index.html", ` -{{ $uniqPages := first 2 .Site.RegularPages | append .Site.RegularPages | uniq }} -{{ $inTrue := in .Site.RegularPages (index .Site.RegularPages 1) }} -{{ $inFalse := in .Site.RegularPages (.Site.Home) }} - -{{ printf "uniqPages: %T %d" $uniqPages (len $uniqPages) }} -{{ printf "inTrue: %t" $inTrue }} -{{ printf "inFalse: %t" $inFalse }} -`) - - b.WithTemplatesAdded("_default/single.html", ` -{{ $related := .Site.RegularPages.Related . }} -{{ $symdiff := $related | symdiff .Site.RegularPages }} -Related: {{ range $related }}{{ .RelPermalink }}|{{ end }} -Symdiff: {{ range $symdiff }}{{ .RelPermalink }}|{{ end }} -`) - b.CreateSites().Build(BuildCfg{}) - - c.Assert(len(b.H.Sites), qt.Equals, 1) - c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 3) - - b.AssertFileContent("public/index.html", - "uniqPages: page.Pages 3", - "inTrue: true", - "inFalse: false", - ) - - b.AssertFileContent("public/page1/index.html", `Related: /page2/|/page3/|`, `Symdiff: /page1/|`) -} - -func TestAppendFunc(t *testing.T) { - c := qt.New(t) - - pageContent := ` ---- -title: "Page" -tags: ["blue", "green"] -tags_weight: %d ---- - -` - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile(). - WithContent("page1.md", fmt.Sprintf(pageContent, 10), "page2.md", fmt.Sprintf(pageContent, 20)). - WithTemplatesAdded("index.html", ` -{{ $p1 := index .Site.RegularPages 0 }}{{ $p2 := index .Site.RegularPages 1 }} - -{{ $pages := slice }} - -{{ if true }} - {{ $pages = $pages | append $p2 $p1 }} -{{ end }} -{{ $appendPages := .Site.Pages | append .Site.RegularPages }} -{{ $appendStrings := slice "a" "b" | append "c" "d" "e" }} -{{ $appendStringsSlice := slice "a" "b" "c" | append (slice "c" "d") }} - -{{ printf "pages:%d:%T:%s|%s" (len $pages) $pages (index $pages 0).Path (index $pages 1).Path }} -{{ printf "appendPages:%d:%T:%v/%v" (len $appendPages) $appendPages (index $appendPages 0).Kind (index $appendPages 8).Kind }} -{{ printf "appendStrings:%T:%v" $appendStrings $appendStrings }} -{{ printf "appendStringsSlice:%T:%v" $appendStringsSlice $appendStringsSlice }} - -{{/* add some slightly related funcs to check what types we get */}} -{{ $u := $appendStrings | union $appendStringsSlice }} -{{ $i := $appendStrings | intersect $appendStringsSlice }} -{{ printf "union:%T:%v" $u $u }} -{{ printf "intersect:%T:%v" $i $i }} - -`) - b.CreateSites().Build(BuildCfg{}) - - c.Assert(len(b.H.Sites), qt.Equals, 1) - c.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 2) - - b.AssertFileContent("public/index.html", - "pages:2:page.Pages:/page2|/page1", - "appendPages:9:page.Pages:home/page", - "appendStrings:[]string:[a b c d e]", - "appendStringsSlice:[]string:[a b c c d]", - "union:[]string:[a b c d e]", - "intersect:[]string:[a b c d]", - ) -} diff --git a/hugolib/config_test.go b/hugolib/config_test.go index c7c093594..70b49f806 100644 --- a/hugolib/config_test.go +++ b/hugolib/config_test.go @@ -1,4 +1,4 @@ -// Copyright 2016-present The Hugo Authors. All rights reserved. +// Copyright 2025-present 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. @@ -16,7 +16,6 @@ package hugolib import ( "bytes" "fmt" - "path/filepath" "strings" "testing" @@ -410,14 +409,12 @@ name = "menu-main-theme" name = "menu-theme" ` - - buildForConfig := func(t testing.TB, mainConfig, themeConfig string) *sitesBuilder { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", mainConfig).WithThemeConfigFile("toml", themeConfig) - return b.Build(BuildCfg{}) + buildForConfig := func(t testing.TB, mainConfig, themeConfig string) *IntegrationTestBuilder { + files := "-- hugo.toml --\n" + mainConfig + "\n-- themes/test-theme/hugo.toml --\n" + themeConfig + return Test(t, files) } - buildForStrategy := func(t testing.TB, s string) *sitesBuilder { + buildForStrategy := func(t testing.TB, s string) *IntegrationTestBuilder { mainConfig := strings.ReplaceAll(mainConfigTemplate, "MERGE_PARAMS", s) return buildForConfig(t, mainConfig, themeConfig) } @@ -425,7 +422,7 @@ name = "menu-theme" c.Run("Merge default", func(c *qt.C) { b := buildForStrategy(c, "") - got := b.Configs.Base + got := b.H.Configs.Base b.Assert(got.Params, qt.DeepEquals, maps.Params{ "b": maps.Params{ @@ -447,7 +444,7 @@ name = "menu-theme" c.Run("Merge shallow", func(c *qt.C) { b := buildForStrategy(c, fmt.Sprintf("_merge=%q", "shallow")) - got := b.Configs.Base.Params + got := b.H.Configs.Base.Params // Shallow merge, only add new keys to params. b.Assert(got, qt.DeepEquals, maps.Params{ @@ -469,7 +466,7 @@ name = "menu-theme" "[params]\np1 = \"p1 theme\"\n", ) - got := b.Configs.Base.Params + got := b.H.Configs.Base.Params b.Assert(got, qt.DeepEquals, maps.Params{ "p1": "p1 theme", @@ -490,7 +487,7 @@ name = "menu-theme" "baseURL=\"http://example.com\"\n"+fmt.Sprintf(smapConfigTempl, "monthly"), ) - got := b.Configs.Base + got := b.H.Configs.Base if mergeStrategy == "none" { b.Assert(got.Sitemap, qt.DeepEquals, config.SitemapConfig{ChangeFreq: "", Disable: false, Priority: -1, Filename: "sitemap.xml"}) @@ -506,101 +503,75 @@ name = "menu-theme" func TestLoadConfigFromThemeDir(t *testing.T) { t.Parallel() - mainConfig := ` + files := ` +-- hugo.toml -- theme = "test-theme" - [params] m1 = "mv1" -` - - themeConfig := ` +-- themes/test-theme/hugo.toml -- [params] t1 = "tv1" t2 = "tv2" -` - - themeConfigDir := filepath.Join("themes", "test-theme", "config") - themeConfigDirDefault := filepath.Join(themeConfigDir, "_default") - themeConfigDirProduction := filepath.Join(themeConfigDir, "production") - - projectConfigDir := "config" - - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", mainConfig).WithThemeConfigFile("toml", themeConfig) - b.Assert(b.Fs.Source.MkdirAll(themeConfigDirDefault, 0o777), qt.IsNil) - b.Assert(b.Fs.Source.MkdirAll(themeConfigDirProduction, 0o777), qt.IsNil) - b.Assert(b.Fs.Source.MkdirAll(projectConfigDir, 0o777), qt.IsNil) - - b.WithSourceFile(filepath.Join(projectConfigDir, "config.toml"), `[params] +-- config/_default/config.toml -- +[params] m2 = "mv2" -`) - b.WithSourceFile(filepath.Join(themeConfigDirDefault, "config.toml"), `[params] +-- themes/test-theme/config/_default/config.toml -- +[params] t2 = "tv2d" t3 = "tv3d" -`) - - b.WithSourceFile(filepath.Join(themeConfigDirProduction, "config.toml"), `[params] +-- themes/test-theme/config/production/config.toml -- +[params] t3 = "tv3p" -`) +-- layouts/index.html -- +m1: {{ .Site.Params.m1 }} +m2: {{ .Site.Params.m2 }} +t1: {{ .Site.Params.t1 }} +t2: {{ .Site.Params.t2 }} +t3: {{ .Site.Params.t3 }} +` - b.Build(BuildCfg{}) + b := Test(t, files) - got := b.Configs.Base.Params + got := b.H.Configs.Base.Params b.Assert(got, qt.DeepEquals, maps.Params{ - "t3": "tv3p", "m1": "mv1", + "m2": "mv2", "t1": "tv1", "t2": "tv2d", + "t3": "tv3p", }) } func TestPrivacyConfig(t *testing.T) { t.Parallel() - c := qt.New(t) - - tomlConfig := ` - + files := ` +-- hugo.toml -- someOtherValue = "foo" - -[privacy] [privacy.youtube] privacyEnhanced = true +-- layouts/index.html -- +Privacy Enhanced: {{ .Site.Config.Privacy.YouTube.PrivacyEnhanced }} ` - - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", tomlConfig) - b.Build(BuildCfg{SkipRender: true}) - - c.Assert(b.H.Sites[0].Config().Privacy.YouTube.PrivacyEnhanced, qt.Equals, true) + b := Test(t, files) + b.AssertFileContent("public/index.html", "Privacy Enhanced: true") } func TestLoadConfigModules(t *testing.T) { t.Parallel() - c := qt.New(t) - - // https://github.com/gohugoio/hugoThemes#themetoml - const ( - // Before Hugo 0.56 each theme/component could have its own theme.toml - // with some settings, mostly used on the Hugo themes site. - // To preserve combability we read these files into the new "modules" - // section in config.toml. o1t = ` name = "Component o1" license = "MIT" min_version = 0.38 ` - // This is the component's config.toml, using the old theme syntax. o1c = ` theme = ["n2"] ` - n1 = ` title = "Component n1" - [module] description = "Component n1 description" [module.hugoVersion] @@ -611,64 +582,58 @@ extended = true path="o1" [[module.imports]] path="n3" - - ` - n2 = ` title = "Component n2" ` - n3 = ` title = "Component n3" ` - n4 = ` title = "Component n4" ` ) - b := newTestSitesBuilder(t) - - writeThemeFiles := func(name, configTOML, themeTOML string) { - b.WithSourceFile(filepath.Join("themes", name, "data", "module.toml"), fmt.Sprintf("name=%q", name)) - if configTOML != "" { - b.WithSourceFile(filepath.Join("themes", name, "config.toml"), configTOML) - } - if themeTOML != "" { - b.WithSourceFile(filepath.Join("themes", name, "theme.toml"), themeTOML) - } - } - - writeThemeFiles("n1", n1, "") - writeThemeFiles("n2", n2, "") - writeThemeFiles("n3", n3, "") - writeThemeFiles("n4", n4, "") - writeThemeFiles("o1", o1c, o1t) - - b.WithConfigFile("toml", ` + files := ` +-- hugo.toml -- [module] [[module.imports]] path="n1" [[module.imports]] path="n4" +-- themes/n1/hugo.toml -- +` + n1 + ` +-- themes/n2/hugo.toml -- +` + n2 + ` +-- themes/n3/hugo.toml -- +` + n3 + ` +-- themes/n4/hugo.toml -- +` + n4 + ` +-- themes/o1/hugo.toml -- +` + o1c + ` +-- themes/o1/theme.toml -- +` + o1t + ` +-- themes/n1/data/module.toml -- +name="n1" +-- themes/n2/data/module.toml -- +name="n2" +-- themes/n3/data/module.toml -- +name="n3" +-- themes/n4/data/module.toml -- +name="n4" +-- themes/o1/data/module.toml -- +name="o1" +` -`) - - b.Build(BuildCfg{}) + b := Test(t, files) modulesClient := b.H.Configs.ModulesClient var graphb bytes.Buffer modulesClient.Graph(&graphb) - expected := `project n1 -n1 o1 -o1 n2 -n1 n3 -project n4 -` + expected := "project n1\nn1 o1\no1 n2\nn1 n3\nproject n4\n" - c.Assert(graphb.String(), qt.Equals, expected) + b.Assert(graphb.String(), qt.Equals, expected) } func TestInvalidDefaultMarkdownHandler(t *testing.T) { diff --git a/hugolib/content_factory_test.go b/hugolib/content_factory_test.go deleted file mode 100644 index 9181cda68..000000000 --- a/hugolib/content_factory_test.go +++ /dev/null @@ -1,79 +0,0 @@ -package hugolib - -import ( - "bytes" - "path/filepath" - "testing" - - qt "github.com/frankban/quicktest" - "github.com/gohugoio/hugo/hugofs" -) - -func TestContentFactory(t *testing.T) { - t.Parallel() - - c := qt.New(t) - - c.Run("Simple", func(c *qt.C) { - workingDir := "/my/work" - b := newTestSitesBuilder(c) - b.WithWorkingDir(workingDir).WithConfigFile("toml", ` - -workingDir="/my/work" - -[module] -[[module.mounts]] -source = 'mcontent/en' -target = 'content' -lang = 'en' -[[module.mounts]] -source = 'archetypes' -target = 'archetypes' - -`) - - b.WithSourceFile(filepath.Join("mcontent/en/bundle", "index.md"), "") - - b.WithSourceFile(filepath.Join("archetypes", "post.md"), `--- -title: "{{ replace .Name "-" " " | title }}" -date: {{ .Date }} -draft: true ---- - -Hello World. -`) - b.CreateSites() - cf := NewContentFactory(b.H) - abs, err := cf.CreateContentPlaceHolder(filepath.FromSlash("mcontent/en/blog/mypage.md"), false) - b.Assert(err, qt.IsNil) - b.Assert(abs, qt.Equals, filepath.FromSlash("/my/work/mcontent/en/blog/mypage.md")) - b.Build(BuildCfg{SkipRender: true}) - - p := b.H.GetContentPage(abs) - b.Assert(p, qt.Not(qt.IsNil)) - - var buf bytes.Buffer - fi, err := b.H.BaseFs.Archetypes.Fs.Stat("post.md") - b.Assert(err, qt.IsNil) - b.Assert(cf.ApplyArchetypeFi(&buf, p, "", fi.(hugofs.FileMetaInfo)), qt.IsNil) - - b.Assert(buf.String(), qt.Contains, `title: "Mypage"`) - }) - - // Issue #9129 - c.Run("Content in both project and theme", func(c *qt.C) { - b := newTestSitesBuilder(c) - b.WithConfigFile("toml", ` -theme = 'ipsum' -`) - - themeDir := filepath.Join("themes", "ipsum") - b.WithSourceFile("content/posts/foo.txt", `Hello.`) - b.WithSourceFile(filepath.Join(themeDir, "content/posts/foo.txt"), `Hello.`) - b.CreateSites() - cf := NewContentFactory(b.H) - abs, err := cf.CreateContentPlaceHolder(filepath.FromSlash("posts/test.md"), false) - b.Assert(err, qt.IsNil) - b.Assert(abs, qt.Equals, filepath.FromSlash("content/posts/test.md")) - }) -} diff --git a/hugolib/content_map_test.go b/hugolib/content_map_test.go index 6882711fe..2be88a78e 100644 --- a/hugolib/content_map_test.go +++ b/hugolib/content_map_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -24,7 +24,7 @@ import ( ) func TestContentMapSite(t *testing.T) { - b := newTestSitesBuilder(t) + t.Parallel() pageTempl := ` --- @@ -51,39 +51,10 @@ draft: true ` - b.WithContent("_index.md", ` ---- -title: "Hugo Home" -cascade: - description: "Common Description" ---- - -Home Content. -`) - - b.WithContent("blog/page1.md", createPage(1)) - b.WithContent("blog/page2.md", createPage(2)) - b.WithContent("blog/page3.md", createPage(3)) - b.WithContent("blog/bundle/index.md", createPage(4)) - b.WithContent("blog/bundle/data.json", "data") - b.WithContent("blog/bundle/page.md", createPage(5)) - b.WithContent("blog/subsection/_index.md", createPage(6)) - b.WithContent("blog/subsection/subdata.json", "data") - b.WithContent("blog/subsection/page4.md", createPage(7)) - b.WithContent("blog/subsection/page5.md", createPage(8)) - b.WithContent("blog/subsection/draft/index.md", draftTemplate) - b.WithContent("blog/subsection/draft/data.json", "data") - b.WithContent("blog/draftsection/_index.md", draftTemplate) - b.WithContent("blog/draftsection/page/index.md", createPage(9)) - b.WithContent("blog/draftsection/page/folder/data.json", "data") - b.WithContent("blog/draftsection/sub/_index.md", createPage(10)) - b.WithContent("blog/draftsection/sub/page.md", createPage(11)) - b.WithContent("docs/page6.md", createPage(12)) - b.WithContent("tags/_index.md", createPageInCategory(13, "sad")) - b.WithContent("overlap/_index.md", createPageInCategory(14, "sad")) - b.WithContent("overlap2/_index.md", createPage(15)) - - b.WithTemplatesAdded("layouts/index.html", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com" +-- layouts/index.html -- Num Regular: {{ len .Site.RegularPages }}|{{ range .Site.RegularPages }}{{ .RelPermalink }}|{{ end }}$ Main Sections: {{ .Site.Params.mainSections }} Pag Num Pages: {{ len .Paginator.Pages }} @@ -131,9 +102,59 @@ Draft4: {{ if (.Site.GetPage "blog/draftsection/sub") }}FOUND{{ end }}| Draft5: {{ if (.Site.GetPage "blog/draftsection/sub/page") }}FOUND{{ end }}| {{ define "print-page" }}{{ .Title }}|{{ .RelPermalink }}|{{ .Date.Format "2006-01-02" }}|Current Section: {{ with .CurrentSection }}{{ .Path }}{{ else }}NIL{{ end }}|Resources: {{ range .Resources }}{{ .ResourceType }}: {{ .RelPermalink }}|{{ end }}{{ end }} -`) +-- content/_index.md -- +--- +title: "Hugo Home" +cascade: + description: "Common Description" +--- + +Home Content. +-- content/blog/page1.md -- +` + createPage(1) + ` +-- content/blog/page2.md -- +` + createPage(2) + ` +-- content/blog/page3.md -- +` + createPage(3) + ` +-- content/blog/bundle/index.md -- +` + createPage(4) + ` +-- content/blog/bundle/data.json -- +data +-- content/blog/bundle/page.md -- +` + createPage(5) + ` +-- content/blog/subsection/_index.md -- +` + createPage(6) + ` +-- content/blog/subsection/subdata.json -- +data +-- content/blog/subsection/page4.md -- +` + createPage(7) + ` +-- content/blog/subsection/page5.md -- +` + createPage(8) + ` +-- content/blog/subsection/draft/index.md -- +` + draftTemplate + ` +-- content/blog/subsection/draft/data.json -- +data +-- content/blog/draftsection/_index.md -- +` + draftTemplate + ` +-- content/blog/draftsection/page/index.md -- +` + createPage(9) + ` +-- content/blog/draftsection/page/folder/data.json -- +data +-- content/blog/draftsection/sub/_index.md -- +` + createPage(10) + ` +-- content/blog/draftsection/sub/page.md -- +` + createPage(11) + ` +-- content/docs/page6.md -- +` + createPage(12) + ` +-- content/tags/_index.md -- +` + createPageInCategory(13, "sad") + ` +-- content/overlap/_index.md -- +` + createPageInCategory(14, "sad") + ` +-- content/overlap2/_index.md -- +` + createPage(15) + ` +` - b.Build(BuildCfg{}) + b := Test(t, files) b.AssertFileContent("public/index.html", diff --git a/hugolib/content_render_hooks_test.go b/hugolib/content_render_hooks_test.go index 31ce545b5..063d695da 100644 --- a/hugolib/content_render_hooks_test.go +++ b/hugolib/content_render_hooks_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -141,28 +141,24 @@ xml-heading: Heading in p2| // https://github.com/gohugoio/hugo/issues/6629 func TestRenderLinkWithMarkupInText(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", ` + t.Parallel() + files := ` +-- hugo.toml -- baseURL="https://example.org" - [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true - -`) - - b.WithTemplates("index.html", ` +-- layouts/index.html -- {{ $p := site.GetPage "p1.md" }} P1: {{ $p.Content }} - - `, - "_default/_markup/render-link.html", `html-link: {{ .Destination | safeURL }}|Text: {{ .Text }}|Plain: {{ .PlainText | safeHTML }}`, - "_default/_markup/render-image.html", `html-image: {{ .Destination | safeURL }}|Text: {{ .Text }}|Plain: {{ .PlainText | safeHTML }}`, - ) - - b.WithContent("p1.md", `--- +-- layouts/_default/_markup/render-link.html -- +html-link: {{ .Destination | safeURL }}|Text: {{ .Text }}|Plain: {{ .PlainText | safeHTML }} +-- layouts/_default/_markup/render-image.html -- +html-image: {{ .Destination | safeURL }}|Text: {{ .Text }}|Plain: {{ .PlainText | safeHTML }} +-- content/p1.md -- +--- title: "p1" --- @@ -173,10 +169,9 @@ Some regular **markup**. Image: ![Hello
Goodbye](image.jpg)END +` -`) - - b.Build(BuildCfg{}) + b := Test(t, files) b.AssertFileContent("public/index.html", ` P1:

START: html-link: https://gohugo.io|Text: should be bold|Plain: should be boldEND

diff --git a/hugolib/dates_test.go b/hugolib/dates_test.go index 2bdc47892..c99545e8a 100644 --- a/hugolib/dates_test.go +++ b/hugolib/dates_test.go @@ -1,4 +1,4 @@ -// Copyright 2021 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -22,59 +22,40 @@ import ( ) func TestDateFormatMultilingual(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", ` -baseURL = "https://example.org" + t.Parallel() + files := ` +-- hugo.toml -- +baseURL = "https://example.org" defaultContentLanguage = "en" defaultContentLanguageInSubDir = true - [languages] [languages.en] weight=10 [languages.nn] weight=20 - -`) - - pageWithDate := `--- +-- content/_index.en.md -- +--- title: Page date: 2021-07-18 ---- -` - - b.WithContent( - "_index.en.md", pageWithDate, - "_index.nn.md", pageWithDate, - ) - - b.WithTemplatesAdded("index.html", ` +--- +-- content/_index.nn.md -- +--- +title: Page +date: 2021-07-18 +--- +-- layouts/index.html -- Date: {{ .Date | time.Format ":date_long" }} - `) +` - b.Build(BuildCfg{}) + b := Test(t, files) b.AssertFileContent("public/en/index.html", `Date: July 18, 2021`) b.AssertFileContent("public/nn/index.html", `Date: 18. juli 2021`) } func TestTimeZones(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", ` -baseURL = "https://example.org" - -defaultContentLanguage = "en" -defaultContentLanguageInSubDir = true - -[languages] -[languages.en] -timeZone="UTC" -weight=10 -[languages.nn] -timeZone="America/Antigua" -weight=20 - -`) + t.Parallel() const ( pageTemplYaml = `--- @@ -83,7 +64,7 @@ date: %s lastMod: %s publishDate: %s expiryDate: %s ---- +--- ` pageTemplTOML = `+++ @@ -118,34 +99,46 @@ expiryDate=%s ) } - b.WithContent( - // YAML - "short-date-yaml-unqouted.en.md", createPageContent(pageTemplYaml, shortDateTempl, false), - "short-date-yaml-unqouted.nn.md", createPageContent(pageTemplYaml, shortDateTempl, false), - "short-date-yaml-qouted.en.md", createPageContent(pageTemplYaml, shortDateTempl, true), - "short-date-yaml-qouted.nn.md", createPageContent(pageTemplYaml, shortDateTempl, true), - "long-date-yaml-unqouted.en.md", createPageContent(pageTemplYaml, longDateTempl, false), - "long-date-yaml-unqouted.nn.md", createPageContent(pageTemplYaml, longDateTempl, false), - // TOML - "short-date-toml-unqouted.en.md", createPageContent(pageTemplTOML, shortDateTempl, false), - "short-date-toml-unqouted.nn.md", createPageContent(pageTemplTOML, shortDateTempl, false), - "short-date-toml-qouted.en.md", createPageContent(pageTemplTOML, shortDateTempl, true), - "short-date-toml-qouted.nn.md", createPageContent(pageTemplTOML, shortDateTempl, true), - ) - - const datesTempl = ` + files := ` +-- hugo.toml -- +baseURL = "https://example.org" +defaultContentLanguage = "en" +defaultContentLanguageInSubDir = true +[languages] +[languages.en] +timeZone="UTC" +weight=10 +[languages.nn] +timeZone="America/Antigua" +weight=20 +-- layouts/_default/single.html -- Date: {{ .Date | safeHTML }} Lastmod: {{ .Lastmod | safeHTML }} PublishDate: {{ .PublishDate | safeHTML }} ExpiryDate: {{ .ExpiryDate | safeHTML }} +-- content/short-date-yaml-unqouted.en.md -- +` + createPageContent(pageTemplYaml, shortDateTempl, false) + ` +-- content/short-date-yaml-unqouted.nn.md -- +` + createPageContent(pageTemplYaml, shortDateTempl, false) + ` +-- content/short-date-yaml-qouted.en.md -- +` + createPageContent(pageTemplYaml, shortDateTempl, true) + ` +-- content/short-date-yaml-qouted.nn.md -- +` + createPageContent(pageTemplYaml, shortDateTempl, true) + ` +-- content/long-date-yaml-unqouted.en.md -- +` + createPageContent(pageTemplYaml, longDateTempl, false) + ` +-- content/long-date-yaml-unqouted.nn.md -- +` + createPageContent(pageTemplYaml, longDateTempl, false) + ` +-- content/short-date-toml-unqouted.en.md -- +` + createPageContent(pageTemplTOML, shortDateTempl, false) + ` +-- content/short-date-toml-unqouted.nn.md -- +` + createPageContent(pageTemplTOML, shortDateTempl, false) + ` +-- content/short-date-toml-qouted.en.md -- +` + createPageContent(pageTemplTOML, shortDateTempl, true) + ` +-- content/short-date-toml-qouted.nn.md -- +` + createPageContent(pageTemplTOML, shortDateTempl, true) + ` +` - ` - - b.WithTemplatesAdded( - "_default/single.html", datesTempl, - ) - - b.Build(BuildCfg{}) + b := Test(t, files) expectShortDateEn := ` Date: 2021-07-10 00:00:00 +0000 UTC @@ -163,13 +156,7 @@ ExpiryDate: 2099-07-13 15:28:01 +0000 UTC` expectLongDateNn := strings.ReplaceAll(expectLongDateEn, "+0000 UTC", "-0400 AST") - // TODO(bep) create a common proposal for go-yaml, go-toml - // for a custom date parser hook to handle these time zones. - // JSON is omitted from this test as JSON does no (to my knowledge) - // have date literals. - // YAML - // Note: This is with go-yaml v2, I suspect v3 will fail with the unquoted values. b.AssertFileContent("public/en/short-date-yaml-unqouted/index.html", expectShortDateEn) b.AssertFileContent("public/nn/short-date-yaml-unqouted/index.html", expectShortDateNn) b.AssertFileContent("public/en/short-date-yaml-qouted/index.html", expectShortDateEn) @@ -179,8 +166,6 @@ ExpiryDate: 2099-07-13 15:28:01 +0000 UTC` b.AssertFileContent("public/nn/long-date-yaml-unqouted/index.html", expectLongDateNn) // TOML - // These fails: TOML (Burnt Sushi) defaults to local timezone. - // TODO(bep) check go-toml b.AssertFileContent("public/en/short-date-toml-unqouted/index.html", expectShortDateEn) b.AssertFileContent("public/nn/short-date-toml-unqouted/index.html", expectShortDateNn) b.AssertFileContent("public/en/short-date-toml-qouted/index.html", expectShortDateEn) @@ -189,26 +174,31 @@ ExpiryDate: 2099-07-13 15:28:01 +0000 UTC` // Issue 8832 func TestTimeZoneInvalid(t *testing.T) { - b := newTestSitesBuilder(t) + t.Parallel() - b.WithConfigFile("toml", ` - + files := ` +-- hugo.toml -- timeZone = "America/LosAngeles" # Should be America/Los_Angeles -`) +` + b, err := TestE(t, files) - err := b.CreateSitesE() b.Assert(err, qt.Not(qt.IsNil)) b.Assert(err.Error(), qt.Contains, `invalid timeZone for language "en": unknown time zone America/LosAngeles`) } // Issue 8835 func TestTimeOnError(t *testing.T) { - b := newTestSitesBuilder(t) + t.Parallel() - b.WithTemplates("index.html", `time: {{ time "2020-10-20" "invalid-timezone" }}`) - b.WithContent("p1.md", "") + files := ` +-- hugo.toml -- +-- layouts/index.html -- +time: {{ time "2020-10-20" "invalid-timezone" }} +-- content/p1.md -- +` + b, err := TestE(t, files) - b.Assert(b.BuildE(BuildCfg{}), qt.Not(qt.IsNil)) + b.Assert(err, qt.Not(qt.IsNil)) } func TestTOMLDates(t *testing.T) { diff --git a/hugolib/disableKinds_test.go b/hugolib/disableKinds_test.go index 4dc476fc9..1ee312347 100644 --- a/hugolib/disableKinds_test.go +++ b/hugolib/disableKinds_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -18,66 +18,55 @@ import ( qt "github.com/frankban/quicktest" "github.com/gohugoio/hugo/resources/kinds" - "github.com/gohugoio/hugo/resources/page" ) -func TestDisable(t *testing.T) { - c := qt.New(t) - - newSitesBuilder := func(c *qt.C, disableKind string) *sitesBuilder { - config := fmt.Sprintf(` +func TestDisableKinds(t *testing.T) { + filesForDisabledKind := func(disableKind string) string { + return fmt.Sprintf(` +-- hugo.toml -- baseURL = "http://example.com/blog" enableRobotsTXT = true ignoreErrors = ["error-disable-taxonomy"] -disableKinds = [%q] -`, disableKind) - - b := newTestSitesBuilder(c) - b.WithTemplatesAdded("_default/single.html", `single`) - b.WithConfigFile("toml", config).WithContent("sect/page.md", ` +disableKinds = ["%s"] +-- layouts/_default/single.html -- +single +-- content/sect/page.md -- --- title: Page categories: ["mycat"] tags: ["mytag"] --- - -`, "sect/no-list.md", ` +-- content/sect/no-list.md -- --- title: No List build: list: false --- - -`, "sect/no-render.md", ` +-- content/sect/no-render.md -- --- title: No List build: render: false --- -`, - "sect/no-render-link.md", ` +-- content/sect/no-render-link.md -- --- title: No Render Link aliases: ["/link-alias"] build: render: link --- -`, - "sect/no-publishresources/index.md", ` +-- content/sect/no-publishresources/index.md -- --- title: No Publish Resources build: publishResources: false --- - -`, "sect/headlessbundle/index.md", ` +-- content/sect/headlessbundle/index.md -- --- title: Headless headless: true --- - - -`, "headless-local/_index.md", ` +-- content/headless-local/_index.md -- --- title: Headless Local Lists cascade: @@ -86,335 +75,217 @@ cascade: list: local publishResources: false --- - -`, "headless-local/headless-local-page.md", "---\ntitle: Headless Local Page\n---", - "headless-local/sub/_index.md", ` +-- content/headless-local/headless-local-page.md -- +--- +title: Headless Local Page +--- +-- content/headless-local/sub/_index.md -- --- title: Headless Local Lists Sub --- - -`, "headless-local/sub/headless-local-sub-page.md", "---\ntitle: Headless Local Sub Page\n---", - ) - - b.WithSourceFile("content/sect/headlessbundle/data.json", "DATA") - b.WithSourceFile("content/sect/no-publishresources/data.json", "DATA") - - return b - } - - getPage := func(b *sitesBuilder, ref string) page.Page { - b.Helper() - p, err := b.H.Sites[0].getPage(nil, ref) - b.Assert(err, qt.IsNil) - return p - } - - getPageInSitePages := func(b *sitesBuilder, ref string) page.Page { - b.Helper() - for _, pages := range []page.Pages{b.H.Sites[0].Pages(), b.H.Sites[0].RegularPages()} { - for _, p := range pages { - if ref == p.Path() { - return p - } - } - } - return nil - } - - getPageInPagePages := func(p page.Page, ref string, pageCollections ...page.Pages) page.Page { - if len(pageCollections) == 0 { - pageCollections = []page.Pages{p.Pages(), p.RegularPages(), p.RegularPagesRecursive(), p.Sections()} - } - for _, pages := range pageCollections { - for _, p := range pages { - if ref == p.Path() { - return p - } - } - } - return nil +-- content/headless-local/sub/headless-local-sub-page.md -- +--- +title: Headless Local Sub Page +--- +-- content/sect/headlessbundle/data.json -- +DATA +-- content/sect/no-publishresources/data.json -- +DATA +`, disableKind) } - - disableKind := kinds.KindPage - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) + t.Run("Disable "+kinds.KindPage, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindPage) + b := Test(t, files) s := b.H.Sites[0] - b.Assert(getPage(b, "/sect/page.md"), qt.IsNil) - b.Assert(b.CheckExists("public/sect/page/index.html"), qt.Equals, false) - b.Assert(getPageInSitePages(b, "/sect/page.md"), qt.IsNil) - b.Assert(getPageInPagePages(getPage(b, "/"), "/sect/page.md"), qt.IsNil) - - // Also check the side effects - b.Assert(b.CheckExists("public/categories/mycat/index.html"), qt.Equals, false) + b.AssertFileExists("public/sect/page/index.html", false) + b.AssertFileExists("public/categories/mycat/index.html", false) b.Assert(len(s.Taxonomies()["categories"]), qt.Equals, 0) }) - disableKind = kinds.KindTerm - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) + t.Run("Disable "+kinds.KindTerm, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindTerm) + b := Test(t, files) s := b.H.Sites[0] - b.Assert(b.CheckExists("public/categories/index.html"), qt.Equals, true) - b.Assert(b.CheckExists("public/categories/mycat/index.html"), qt.Equals, false) + b.AssertFileExists("public/categories/index.html", false) + b.AssertFileExists("public/categories/mycat/index.html", false) b.Assert(len(s.Taxonomies()["categories"]), qt.Equals, 0) - b.Assert(getPage(b, "/categories"), qt.Not(qt.IsNil)) - b.Assert(getPage(b, "/categories/mycat"), qt.IsNil) }) - disableKind = kinds.KindTaxonomy - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) + t.Run("Disable "+kinds.KindTaxonomy, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindTaxonomy) + b := Test(t, files) s := b.H.Sites[0] - b.Assert(b.CheckExists("public/categories/mycat/index.html"), qt.Equals, true) - b.Assert(b.CheckExists("public/categories/index.html"), qt.Equals, false) + b.AssertFileExists("public/categories/mycat/index.html", false) + b.AssertFileExists("public/categories/index.html", false) b.Assert(len(s.Taxonomies()["categories"]), qt.Equals, 1) - b.Assert(getPage(b, "/categories/mycat"), qt.Not(qt.IsNil)) - categories := getPage(b, "/categories") - b.Assert(categories, qt.Not(qt.IsNil)) - b.Assert(categories.RelPermalink(), qt.Equals, "") - b.Assert(getPageInSitePages(b, "/categories"), qt.IsNil) - b.Assert(getPageInPagePages(getPage(b, "/"), "/categories"), qt.IsNil) }) - disableKind = kinds.KindHome - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/index.html"), qt.Equals, false) - home := getPage(b, "/") - b.Assert(home, qt.Not(qt.IsNil)) - b.Assert(home.RelPermalink(), qt.Equals, "") - b.Assert(getPageInSitePages(b, "/"), qt.IsNil) - b.Assert(getPageInPagePages(home, "/"), qt.IsNil) - b.Assert(getPage(b, "/sect/page.md"), qt.Not(qt.IsNil)) + t.Run("Disable "+kinds.KindHome, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindHome) + b := Test(t, files) + b.AssertFileExists("public/index.html", false) }) - disableKind = kinds.KindSection - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/sect/index.html"), qt.Equals, false) - sect := getPage(b, "/sect") - b.Assert(sect, qt.Not(qt.IsNil)) - b.Assert(sect.RelPermalink(), qt.Equals, "") - b.Assert(getPageInSitePages(b, "/sect"), qt.IsNil) - home := getPage(b, "/") - b.Assert(getPageInPagePages(home, "/sect"), qt.IsNil) - b.Assert(home.OutputFormats(), qt.HasLen, 2) - page := getPage(b, "/sect/page.md") - b.Assert(page, qt.Not(qt.IsNil)) - b.Assert(page.CurrentSection(), qt.Equals, sect) - b.Assert(getPageInPagePages(sect, "/sect/page"), qt.Not(qt.IsNil)) + t.Run("Disable "+kinds.KindSection, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindSection) + b := Test(t, files) + b.AssertFileExists("public/sect/index.html", false) b.AssertFileContent("public/sitemap.xml", "sitemap") b.AssertFileContent("public/index.xml", "rss") }) - disableKind = kinds.KindRSS - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/index.xml"), qt.Equals, false) - home := getPage(b, "/") - b.Assert(home.OutputFormats(), qt.HasLen, 1) + t.Run("Disable "+kinds.KindRSS, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindRSS) + b := Test(t, files) + b.AssertFileExists("public/index.xml", false) }) - disableKind = kinds.KindSitemap - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/sitemap.xml"), qt.Equals, false) + t.Run("Disable "+kinds.KindSitemap, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindSitemap) + b := Test(t, files) + b.AssertFileExists("public/sitemap.xml", false) }) - disableKind = kinds.KindStatus404 - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/404.html"), qt.Equals, false) + t.Run("Disable "+kinds.KindStatus404, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindStatus404) + b := Test(t, files) + b.AssertFileExists("public/404.html", false) }) - disableKind = kinds.KindRobotsTXT - c.Run("Disable "+disableKind, func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.WithTemplatesAdded("robots.txt", "myrobots") - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/robots.txt"), qt.Equals, false) + t.Run("Disable "+kinds.KindRobotsTXT, func(t *testing.T) { + files := filesForDisabledKind(kinds.KindRobotsTXT) + b := Test(t, files) + b.AssertFileExists("public/robots.txt", false) }) - c.Run("Headless bundle", func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/sect/headlessbundle/index.html"), qt.Equals, false) - b.Assert(b.CheckExists("public/sect/headlessbundle/data.json"), qt.Equals, true) - bundle := getPage(b, "/sect/headlessbundle/index.md") - b.Assert(bundle, qt.Not(qt.IsNil)) - b.Assert(bundle.RelPermalink(), qt.Equals, "") - resource := bundle.Resources()[0] - b.Assert(resource.RelPermalink(), qt.Equals, "/blog/sect/headlessbundle/data.json") - b.Assert(bundle.OutputFormats(), qt.HasLen, 0) - b.Assert(bundle.AlternativeOutputFormats(), qt.HasLen, 0) + t.Run("Headless bundle", func(t *testing.T) { + files := filesForDisabledKind("") + b := Test(t, files) + b.AssertFileExists("public/sect/headlessbundle/index.html", false) + b.AssertFileExists("public/sect/headlessbundle/data.json", true) }) - c.Run("Build config, no list", func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - ref := "/sect/no-list.md" - b.Assert(b.CheckExists("public/sect/no-list/index.html"), qt.Equals, true) - p := getPage(b, ref) - b.Assert(p, qt.Not(qt.IsNil)) - b.Assert(p.RelPermalink(), qt.Equals, "/blog/sect/no-list/") - b.Assert(getPageInSitePages(b, ref), qt.IsNil) - sect := getPage(b, "/sect") - b.Assert(getPageInPagePages(sect, ref), qt.IsNil) + t.Run("Build config, no list", func(t *testing.T) { + files := filesForDisabledKind("") + b := Test(t, files) + b.AssertFileExists("public/sect/no-list/index.html", true) }) - c.Run("Build config, local list", func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - ref := "/headless-local" - sect := getPage(b, ref) - b.Assert(sect, qt.Not(qt.IsNil)) - b.Assert(getPageInSitePages(b, ref), qt.IsNil) - - b.Assert(getPageInSitePages(b, "/headless-local"), qt.IsNil) - b.Assert(getPageInSitePages(b, "/headless-local/headless-local-page"), qt.IsNil) - - localPageRef := ref + "/headless-local-page" - - b.Assert(getPageInPagePages(sect, localPageRef, sect.RegularPages()), qt.Not(qt.IsNil)) - b.Assert(getPageInPagePages(sect, localPageRef, sect.RegularPagesRecursive()), qt.Not(qt.IsNil)) - b.Assert(getPageInPagePages(sect, localPageRef, sect.Pages()), qt.Not(qt.IsNil)) - - ref = "/headless-local/sub" - - sect = getPage(b, ref) - b.Assert(sect, qt.Not(qt.IsNil)) - - localPageRef = ref + "/headless-local-sub-page" - b.Assert(getPageInPagePages(sect, localPageRef), qt.Not(qt.IsNil)) + t.Run("Build config, local list", func(t *testing.T) { + files := filesForDisabledKind("") + b := Test(t, files) + // Assert that the pages are not rendered to disk, as list:local implies. + b.AssertFileExists("public/headless-local/index.html", false) + b.AssertFileExists("public/headless-local/headless-local-page/index.html", false) + b.AssertFileExists("public/headless-local/sub/index.html", false) + b.AssertFileExists("public/headless-local/sub/headless-local-sub-page/index.html", false) }) - c.Run("Build config, no render", func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - ref := "/sect/no-render" - b.Assert(b.CheckExists("public/sect/no-render/index.html"), qt.Equals, false) - p := getPage(b, ref) - b.Assert(p, qt.Not(qt.IsNil)) - b.Assert(p.RelPermalink(), qt.Equals, "") - b.Assert(p.OutputFormats(), qt.HasLen, 0) - b.Assert(getPageInSitePages(b, ref), qt.Not(qt.IsNil)) - sect := getPage(b, "/sect") - b.Assert(getPageInPagePages(sect, ref), qt.Not(qt.IsNil)) + t.Run("Build config, no render", func(t *testing.T) { + files := filesForDisabledKind("") + b := Test(t, files) + b.AssertFileExists("public/sect/no-render/index.html", false) }) - c.Run("Build config, no render link", func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - ref := "/sect/no-render-link" - b.Assert(b.CheckExists("public/sect/no-render/index.html"), qt.Equals, false) - p := getPage(b, ref) - b.Assert(p, qt.Not(qt.IsNil)) - b.Assert(p.RelPermalink(), qt.Equals, "/blog/sect/no-render-link/") - b.Assert(p.OutputFormats(), qt.HasLen, 1) - b.Assert(getPageInSitePages(b, ref), qt.Not(qt.IsNil)) - sect := getPage(b, "/sect") - b.Assert(getPageInPagePages(sect, ref), qt.Not(qt.IsNil)) - - // https://github.com/gohugoio/hugo/issues/7832 - // It should still render any aliases. + t.Run("Build config, no render link", func(t *testing.T) { + files := filesForDisabledKind("") + b := Test(t, files) + b.AssertFileExists("public/sect/no-render/index.html", false) b.AssertFileContent("public/link-alias/index.html", "refresh") }) - c.Run("Build config, no publish resources", func(c *qt.C) { - b := newSitesBuilder(c, disableKind) - b.Build(BuildCfg{}) - b.Assert(b.CheckExists("public/sect/no-publishresources/index.html"), qt.Equals, true) - b.Assert(b.CheckExists("public/sect/no-publishresources/data.json"), qt.Equals, false) - bundle := getPage(b, "/sect/no-publishresources/index.md") - b.Assert(bundle, qt.Not(qt.IsNil)) - b.Assert(bundle.RelPermalink(), qt.Equals, "/blog/sect/no-publishresources/") - b.Assert(bundle.Resources(), qt.HasLen, 1) - resource := bundle.Resources()[0] - b.Assert(resource.RelPermalink(), qt.Equals, "/blog/sect/no-publishresources/data.json") + t.Run("Build config, no publish resources", func(t *testing.T) { + files := filesForDisabledKind("") + b := Test(t, files) + b.AssertFileExists("public/sect/no-publishresources/index.html", true) + b.AssertFileExists("public/sect/no-publishresources/data.json", false) }) } // https://github.com/gohugoio/hugo/issues/6897#issuecomment-587947078 func TestDisableRSSWithRSSInCustomOutputs(t *testing.T) { - b := newTestSitesBuilder(t).WithConfigFile("toml", ` + files := ` +-- hugo.toml -- disableKinds = ["term", "taxonomy", "RSS"] [outputs] home = [ "HTML", "RSS" ] -`).Build(BuildCfg{}) +-- layouts/index.html -- +Home +` + b := Test(t, files) // The config above is a little conflicting, but it exists in the real world. // In Hugo 0.65 we consolidated the code paths and made RSS a pure output format, // but we should make sure to not break existing sites. - b.Assert(b.CheckExists("public/index.xml"), qt.Equals, false) + b.AssertFileExists("public/index.xml", false) } func TestBundleNoPublishResources(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithTemplates("index.html", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com" +-- layouts/index.html -- {{ $bundle := site.GetPage "section/bundle-false" }} {{ $data1 := $bundle.Resources.GetMatch "data1*" }} Data1: {{ $data1.RelPermalink }} - -`) - - b.WithContent("section/bundle-false/index.md", `---\ntitle: BundleFalse +-- content/section/bundle-false/index.md -- +--- +title: BundleFalse build: publishResources: false ----`, - "section/bundle-false/data1.json", "Some data1", - "section/bundle-false/data2.json", "Some data2", - ) - - b.WithContent("section/bundle-true/index.md", `---\ntitle: BundleTrue ----`, - "section/bundle-true/data3.json", "Some data 3", - ) - - b.Build(BuildCfg{}) +--- +-- content/section/bundle-false/data1.json -- +Some data1 +-- content/section/bundle-false/data2.json -- +Some data2 +-- content/section/bundle-true/index.md -- +--- +title: BundleTrue +--- +-- content/section/bundle-true/data3.json -- +Some data 3 +` + b := Test(t, files) b.AssertFileContent("public/index.html", `Data1: /section/bundle-false/data1.json`) b.AssertFileContent("public/section/bundle-false/data1.json", `Some data1`) - b.Assert(b.CheckExists("public/section/bundle-false/data2.json"), qt.Equals, false) + b.AssertFileExists("public/section/bundle-false/data2.json", false) b.AssertFileContent("public/section/bundle-true/data3.json", `Some data 3`) } func TestNoRenderAndNoPublishResources(t *testing.T) { - noRenderPage := ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com" +-- layouts/index.html -- +{{ $page := site.GetPage "sect/no-render" }} +{{ $sect := site.GetPage "sect-no-render" }} + +Page: {{ $page.Title }}|RelPermalink: {{ $page.RelPermalink }}|Outputs: {{ len $page.OutputFormats }} +Section: {{ $sect.Title }}|RelPermalink: {{ $sect.RelPermalink }}|Outputs: {{ len $sect.OutputFormats }} +-- content/sect-no-render/_index.md -- --- -title: %s +title: MySection +build: + render: false + publishResources: false +--- +-- content/sect/no-render.md -- +--- +title: MyPage build: render: false publishResources: false --- ` - b := newTestSitesBuilder(t) - b.WithTemplatesAdded("index.html", ` -{{ $page := site.GetPage "sect/no-render" }} -{{ $sect := site.GetPage "sect-no-render" }} - -Page: {{ $page.Title }}|RelPermalink: {{ $page.RelPermalink }}|Outputs: {{ len $page.OutputFormats }} -Section: {{ $sect.Title }}|RelPermalink: {{ $sect.RelPermalink }}|Outputs: {{ len $sect.OutputFormats }} - - -`) - b.WithContent("sect-no-render/_index.md", fmt.Sprintf(noRenderPage, "MySection")) - b.WithContent("sect/no-render.md", fmt.Sprintf(noRenderPage, "MyPage")) - - b.Build(BuildCfg{}) + b := Test(t, files) b.AssertFileContent("public/index.html", ` Page: MyPage|RelPermalink: |Outputs: 0 Section: MySection|RelPermalink: |Outputs: 0 `) - b.Assert(b.CheckExists("public/sect/no-render/index.html"), qt.Equals, false) - b.Assert(b.CheckExists("public/sect-no-render/index.html"), qt.Equals, false) + b.AssertFileExists("public/sect/no-render/index.html", false) + b.AssertFileExists("public/sect-no-render/index.html", false) } func TestDisableOneOfThreeLanguages(t *testing.T) { diff --git a/hugolib/embedded_templates_test.go b/hugolib/embedded_templates_test.go index ec59751f3..80f773099 100644 --- a/hugolib/embedded_templates_test.go +++ b/hugolib/embedded_templates_test.go @@ -1,4 +1,4 @@ -// Copyright 2018 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -18,46 +18,42 @@ import ( ) func TestInternalTemplatesImage(t *testing.T) { - config := ` + files := ` +-- hugo.toml -- baseURL = "https://example.org" [params] images=["siteimg1.jpg", "siteimg2.jpg"] - -` - b := newTestSitesBuilder(t).WithConfigFile("toml", config) - - b.WithContent("mybundle/index.md", `--- +-- content/mybundle/index.md -- +--- title: My Bundle date: 2021-02-26T18:02:00-01:00 lastmod: 2021-05-22T19:25:00-01:00 --- -`) - - b.WithContent("mypage/index.md", `--- +-- content/mypage/index.md -- +--- title: My Page images: ["pageimg1.jpg", "pageimg2.jpg", "https://example.local/logo.png", "sample.jpg"] date: 2021-02-26T18:02:00+01:00 lastmod: 2021-05-22T19:25:00+01:00 --- -`) - - b.WithContent("mysite.md", `--- +-- content/mysite.md -- +--- title: My Site --- -`) - - b.WithTemplatesAdded("_default/single.html", ` +-- layouts/_default/single.html -- {{ template "_internal/twitter_cards.html" . }} {{ template "_internal/opengraph.html" . }} {{ template "_internal/schema.html" . }} -`) +-- content/mybundle/featured-sunset.jpg -- +/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAD/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEBAAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AAT8AAAAA//Z +-- content/mypage/sample.jpg -- +/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAD/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEBAAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AAT8AAAAA//Z +` - b.WithSunset("content/mybundle/featured-sunset.jpg") - b.WithSunset("content/mypage/sample.jpg") - b.Build(BuildCfg{}) + b := Test(t, files) b.AssertFileContent("public/mybundle/index.html", ` @@ -99,22 +95,53 @@ func TestEmbeddedPaginationTemplate(t *testing.T) { t.Parallel() test := func(variant string, expectedOutput string) { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", `pagination.pagerSize = 1`) - b.WithContent( - "s1/p01.md", "---\ntitle: p01\n---", - "s1/p02.md", "---\ntitle: p02\n---", - "s1/p03.md", "---\ntitle: p03\n---", - "s1/p04.md", "---\ntitle: p04\n---", - "s1/p05.md", "---\ntitle: p05\n---", - "s1/p06.md", "---\ntitle: p06\n---", - "s1/p07.md", "---\ntitle: p07\n---", - "s1/p08.md", "---\ntitle: p08\n---", - "s1/p09.md", "---\ntitle: p09\n---", - "s1/p10.md", "---\ntitle: p10\n---", - ) - b.WithTemplates("index.html", `{{ .Paginate (where site.RegularPages "Section" "s1") }}`+variant) - b.Build(BuildCfg{}) + files := ` +-- hugo.toml -- +pagination.pagerSize = 1 +-- content/s1/p01.md -- +--- +title: p01 +--- +-- content/s1/p02.md -- +--- +title: p02 +--- +-- content/s1/p03.md -- +--- +title: p03 +--- +-- content/s1/p04.md -- +--- +title: p04 +--- +-- content/s1/p05.md -- +--- +title: p05 +--- +-- content/s1/p06.md -- +--- +title: p06 +--- +-- content/s1/p07.md -- +--- +title: p07 +--- +-- content/s1/p08.md -- +--- +title: p08 +--- +-- content/s1/p09.md -- +--- +title: p09 +--- +-- content/s1/p10.md -- +--- +title: p10 +--- +-- layouts/index.html -- +{{ .Paginate (where site.RegularPages "Section" "s1") }}` + variant + ` +` + b := Test(t, files) b.AssertFileContent("public/index.html", expectedOutput) } diff --git a/hugolib/hugo_modules_test.go b/hugolib/hugo_modules_test.go index 895973b0f..03c70239d 100644 --- a/hugolib/hugo_modules_test.go +++ b/hugolib/hugo_modules_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -15,411 +15,34 @@ package hugolib import ( "fmt" - "math/rand" - "os" - "path/filepath" - "strings" "testing" - "time" - - "github.com/bep/logg" - "github.com/gohugoio/hugo/config" - "github.com/gohugoio/hugo/modules/npm" - - "github.com/spf13/afero" - - "github.com/gohugoio/hugo/common/loggers" - "github.com/gohugoio/hugo/common/version" - - "github.com/gohugoio/hugo/htesting" - "github.com/gohugoio/hugo/hugofs" qt "github.com/frankban/quicktest" - "github.com/gohugoio/testmodBuilder/mods" ) -func TestHugoModulesVariants(t *testing.T) { - if !htesting.IsCI() { - t.Skip("skip (relative) long running modules test when running locally") - } - - tomlConfig := ` -baseURL="https://example.org" -workingDir = %q - -[module] -[[module.imports]] -path="github.com/gohugoio/hugoTestModule2" -%s -` - - createConfig := func(workingDir, moduleOpts string) string { - return fmt.Sprintf(tomlConfig, workingDir, moduleOpts) - } - - newTestBuilder := func(t testing.TB, moduleOpts string) *sitesBuilder { - b := newTestSitesBuilder(t) - tempDir := t.TempDir() - workingDir := filepath.Join(tempDir, "myhugosite") - b.Assert(os.MkdirAll(workingDir, 0o777), qt.IsNil) - cfg := config.New() - cfg.Set("workingDir", workingDir) - cfg.Set("publishDir", "public") - b.Fs = hugofs.NewDefault(cfg) - b.WithWorkingDir(workingDir).WithConfigFile("toml", createConfig(workingDir, moduleOpts)) - b.WithTemplates( - "index.html", ` -Param from module: {{ site.Params.Hugo }}| -{{ $js := resources.Get "jslibs/alpinejs/alpine.js" }} -JS imported in module: {{ with $js }}{{ .RelPermalink }}{{ end }}| -`, - "_default/single.html", `{{ .Content }}`) - b.WithContent("p1.md", `--- -title: "Page" ---- - -[A link](https://bep.is) - -`) - b.WithSourceFile("go.mod", ` -module github.com/gohugoio/tests/testHugoModules - - -`) - - b.WithSourceFile("go.sum", ` -github.com/gohugoio/hugoTestModule2 v0.0.0-20200131160637-9657d7697877 h1:WLM2bQCKIWo04T6NsIWsX/Vtirhf0TnpY66xyqGlgVY= -github.com/gohugoio/hugoTestModule2 v0.0.0-20200131160637-9657d7697877/go.mod h1:CBFZS3khIAXKxReMwq0le8sEl/D8hcXmixlOHVv+Gd0= -`) - - return b - } - - t.Run("Target in subfolder", func(t *testing.T) { - b := newTestBuilder(t, "ignoreImports=true") - b.Build(BuildCfg{}) - - b.AssertFileContent("public/p1/index.html", `

Page|https://bep.is|Title: |Text: A link|END

`) - }) - - t.Run("Ignore config", func(t *testing.T) { - b := newTestBuilder(t, "ignoreConfig=true") - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", ` -Param from module: | -JS imported in module: | -`) - }) - - t.Run("Ignore imports", func(t *testing.T) { - b := newTestBuilder(t, "ignoreImports=true") - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", ` -Param from module: Rocks| -JS imported in module: | -`) - }) - - t.Run("Create package.json", func(t *testing.T) { - b := newTestBuilder(t, "") - - b.WithSourceFile("package.json", `{ - "name": "mypack", - "version": "1.2.3", - "scripts": { - "client": "wait-on http://localhost:1313 && open http://localhost:1313", - "start": "run-p client server", - "test": "echo 'hoge' > hoge" - }, - "dependencies": { - "nonon": "error" - } -}`) - - b.WithSourceFile("package.hugo.json", `{ - "name": "mypack", - "version": "1.2.3", - "scripts": { - "client": "wait-on http://localhost:1313 && open http://localhost:1313", - "start": "run-p client server", - "test": "echo 'hoge' > hoge" - }, - "dependencies": { - "foo": "1.2.3" - }, - "devDependencies": { - "postcss-cli": "7.8.0", - "tailwindcss": "1.8.0" - - } -}`) - - b.Build(BuildCfg{}) - b.Assert(npm.Pack(b.H.BaseFs.ProjectSourceFs, b.H.BaseFs.AssetsWithDuplicatesPreserved.Fs), qt.IsNil) - - b.AssertFileContentFn("package.json", func(s string) bool { - return s == `{ - "comments": { - "dependencies": { - "foo": "project", - "react-dom": "github.com/gohugoio/hugoTestModule2" - }, - "devDependencies": { - "@babel/cli": "github.com/gohugoio/hugoTestModule2", - "@babel/core": "github.com/gohugoio/hugoTestModule2", - "@babel/preset-env": "github.com/gohugoio/hugoTestModule2", - "postcss-cli": "project", - "tailwindcss": "project" - } - }, - "dependencies": { - "foo": "1.2.3", - "react-dom": "^16.13.1" - }, - "devDependencies": { - "@babel/cli": "7.8.4", - "@babel/core": "7.9.0", - "@babel/preset-env": "7.9.5", - "postcss-cli": "7.8.0", - "tailwindcss": "1.8.0" - }, - "name": "mypack", - "scripts": { - "client": "wait-on http://localhost:1313 && open http://localhost:1313", - "start": "run-p client server", - "test": "echo 'hoge' > hoge" - }, - "version": "1.2.3" -} -` - }) - }) - - t.Run("Create package.json, no default", func(t *testing.T) { - b := newTestBuilder(t, "") - - const origPackageJSON = `{ - "name": "mypack", - "version": "1.2.3", - "scripts": { - "client": "wait-on http://localhost:1313 && open http://localhost:1313", - "start": "run-p client server", - "test": "echo 'hoge' > hoge" - }, - "dependencies": { - "moo": "1.2.3" - } -}` - - b.WithSourceFile("package.json", origPackageJSON) - - b.Build(BuildCfg{}) - b.Assert(npm.Pack(b.H.BaseFs.ProjectSourceFs, b.H.BaseFs.AssetsWithDuplicatesPreserved.Fs), qt.IsNil) - - b.AssertFileContentFn("package.json", func(s string) bool { - return s == `{ - "comments": { - "dependencies": { - "moo": "project", - "react-dom": "github.com/gohugoio/hugoTestModule2" - }, - "devDependencies": { - "@babel/cli": "github.com/gohugoio/hugoTestModule2", - "@babel/core": "github.com/gohugoio/hugoTestModule2", - "@babel/preset-env": "github.com/gohugoio/hugoTestModule2", - "postcss-cli": "github.com/gohugoio/hugoTestModule2", - "tailwindcss": "github.com/gohugoio/hugoTestModule2" - } - }, - "dependencies": { - "moo": "1.2.3", - "react-dom": "^16.13.1" - }, - "devDependencies": { - "@babel/cli": "7.8.4", - "@babel/core": "7.9.0", - "@babel/preset-env": "7.9.5", - "postcss-cli": "7.1.0", - "tailwindcss": "1.2.0" - }, - "name": "mypack", - "scripts": { - "client": "wait-on http://localhost:1313 && open http://localhost:1313", - "start": "run-p client server", - "test": "echo 'hoge' > hoge" - }, - "version": "1.2.3" -} -` - }) - - // https://github.com/gohugoio/hugo/issues/7690 - b.AssertFileContent("package.hugo.json", origPackageJSON) - }) - - t.Run("Create package.json, no default, no package.json", func(t *testing.T) { - b := newTestBuilder(t, "") - - b.Build(BuildCfg{}) - b.Assert(npm.Pack(b.H.BaseFs.ProjectSourceFs, b.H.BaseFs.AssetsWithDuplicatesPreserved.Fs), qt.IsNil) - - b.AssertFileContentFn("package.json", func(s string) bool { - return s == `{ - "comments": { - "dependencies": { - "react-dom": "github.com/gohugoio/hugoTestModule2" - }, - "devDependencies": { - "@babel/cli": "github.com/gohugoio/hugoTestModule2", - "@babel/core": "github.com/gohugoio/hugoTestModule2", - "@babel/preset-env": "github.com/gohugoio/hugoTestModule2", - "postcss-cli": "github.com/gohugoio/hugoTestModule2", - "tailwindcss": "github.com/gohugoio/hugoTestModule2" - } - }, - "dependencies": { - "react-dom": "^16.13.1" - }, - "devDependencies": { - "@babel/cli": "7.8.4", - "@babel/core": "7.9.0", - "@babel/preset-env": "7.9.5", - "postcss-cli": "7.1.0", - "tailwindcss": "1.2.0" - }, - "name": "myhugosite", - "version": "0.1.0" -} -` - }) - }) -} - -// TODO(bep) this fails when testmodBuilder is also building ... -func TestHugoModulesMatrix(t *testing.T) { - if !htesting.IsCI() { - t.Skip("skip (relative) long running modules test when running locally") - } +func TestModulesWithContent(t *testing.T) { t.Parallel() - if !htesting.IsCI() || version.GoMinorVersion() < 12 { - // https://github.com/golang/go/issues/26794 - // There were some concurrent issues with Go modules in < Go 12. - t.Skip("skip this on local host and for Go <= 1.11 due to a bug in Go's stdlib") - } - - if testing.Short() { - t.Skip() - } - - rnd := rand.New(rand.NewSource(time.Now().UnixNano())) - gooss := []string{"linux", "darwin", "windows"} - goos := gooss[rnd.Intn(len(gooss))] - ignoreVendor := rnd.Intn(2) == 0 - testmods := mods.CreateModules(goos).Collect() - rnd.Shuffle(len(testmods), func(i, j int) { testmods[i], testmods[j] = testmods[j], testmods[i] }) - - for _, m := range testmods[:2] { - c := qt.New(t) - - workingDir, clean, err := htesting.CreateTempDir(hugofs.Os, "hugo-modules-test") - c.Assert(err, qt.IsNil) - defer clean() - - v := config.New() - v.Set("workingDir", workingDir) - v.Set("publishDir", "public") - - configTemplate := ` -baseURL = "https://example.com" -title = "My Modular Site" -workingDir = %q -theme = %q -ignoreVendorPaths = %q - -` - - ignoreVendorPaths := "" - if ignoreVendor { - ignoreVendorPaths = "github.com/**" - } - config := fmt.Sprintf(configTemplate, workingDir, m.Path(), ignoreVendorPaths) - - b := newTestSitesBuilder(t) - - // Need to use OS fs for this. - b.Fs = hugofs.NewDefault(v) - - b.WithWorkingDir(workingDir).WithConfigFile("toml", config) - b.WithContent("page.md", ` ---- -title: "Foo" + content := func(id string) string { + return fmt.Sprintf(`--- +title: Title %s --- -`) - b.WithTemplates("home.html", ` - -{{ $mod := .Site.Data.modinfo.module }} -Mod Name: {{ $mod.name }} -Mod Version: {{ $mod.version }} ----- -{{ range $k, $v := .Site.Data.modinfo }} -- {{ $k }}: {{ range $kk, $vv := $v }}{{ $kk }}: {{ $vv }}|{{ end -}} -{{ end }} - - -`) - b.WithSourceFile("go.mod", ` -module github.com/gohugoio/tests/testHugoModules - - -`) - - b.Build(BuildCfg{}) - - // Verify that go.mod is autopopulated with all the modules in config.toml. - b.AssertFileContent("go.mod", m.Path()) - - b.AssertFileContent("public/index.html", - "Mod Name: "+m.Name(), - "Mod Version: v1.4.0") - - b.AssertFileContent("public/index.html", createChildModMatchers(m, ignoreVendor, m.Vendor)...) - - } -} - -func createChildModMatchers(m *mods.Md, ignoreVendor, vendored bool) []string { - // Child dependencies are one behind. - expectMinorVersion := 3 +Content %s - if !ignoreVendor && vendored { - // Vendored modules are stuck at v1.1.0. - expectMinorVersion = 1 +`, id, id) } - expectVersion := fmt.Sprintf("v1.%d.0", expectMinorVersion) - - var matchers []string - - for _, mm := range m.Children { - matchers = append( - matchers, - fmt.Sprintf("%s: name: %s|version: %s", mm.Name(), mm.Name(), expectVersion)) - matchers = append(matchers, createChildModMatchers(mm, ignoreVendor, vendored || mm.Vendor)...) + i18nContent := func(id, value string) string { + return fmt.Sprintf(` +[%s] +other = %q +`, id, value) } - return matchers -} -func TestModulesWithContent(t *testing.T) { - t.Parallel() - - b := newTestSitesBuilder(t).WithWorkingDir("/site").WithConfigFile("toml", ` + files := ` +-- hugo.toml -- baseURL="https://example.org" -workingDir="/site" - defaultContentLanguage = "en" [module] @@ -459,10 +82,7 @@ languageName = "French" weight = 4 title = "French Title" - -`) - - b.WithTemplatesAdded("index.html", ` +-- layouts/index.html -- {{ range .Site.RegularPages }} |{{ .Title }}|{{ .RelPermalink }}|{{ .Plain }} {{ end }} @@ -475,51 +95,37 @@ All Data: {{ $data }} i18n hello1: {{ i18n "hello1" . }} i18n theme: {{ i18n "theme" . }} i18n theme2: {{ i18n "theme2" . }} -`) - - content := func(id string) string { - return fmt.Sprintf(`--- -title: Title %s ---- -Content %s - -`, id, id) - } - - i18nContent := func(id, value string) string { - return fmt.Sprintf(` -[%s] -other = %q -`, id, value) - } - - // Content files - b.WithSourceFile("themes/a/myacontent/page.md", content("theme-a-en")) - b.WithSourceFile("themes/b/mybcontent/page.md", content("theme-b-nn")) - b.WithSourceFile("themes/c/content/blog/c.md", content("theme-c-nn")) - - // Data files - b.WithSourceFile("data/common.toml", `value="Project"`) - b.WithSourceFile("themes/c/data/common.toml", `value="Theme C"`) - b.WithSourceFile("themes/c/data/c.toml", `value="Hugo Rocks!"`) - b.WithSourceFile("themes/d/data/c.toml", `value="Hugo Rodcks!"`) - b.WithSourceFile("themes/d/data/d.toml", `value="Hugo Rodks!"`) - - // i18n files - b.WithSourceFile("i18n/en.toml", i18nContent("hello1", "Project")) - b.WithSourceFile("themes/c/i18n/en.toml", ` +-- themes/a/myacontent/page.md -- +` + content("theme-a-en") + ` +-- themes/b/mybcontent/page.md -- +` + content("theme-b-nn") + ` +-- themes/c/content/blog/c.md -- +` + content("theme-c-nn") + ` +-- data/common.toml -- +value="Project" +-- themes/c/data/common.toml -- +value="Theme C" +-- themes/c/data/c.toml -- +value="Hugo Rocks!" +-- themes/d/data/c.toml -- +value="Hugo Rodcks!" +-- themes/d/data/d.toml -- +value="Hugo Rodks!" +-- i18n/en.toml -- +` + i18nContent("hello1", "Project") + ` +-- themes/c/i18n/en.toml -- [hello1] other="Theme C Hello" [theme] other="Theme C" -`) - b.WithSourceFile("themes/d/i18n/en.toml", i18nContent("theme", "Theme D")) - b.WithSourceFile("themes/d/i18n/en.toml", i18nContent("theme2", "Theme2 D")) - - // Static files - b.WithSourceFile("themes/c/static/hello.txt", `Hugo Rocks!"`) - - b.Build(BuildCfg{}) +-- themes/d/i18n/en.toml -- +` + i18nContent("theme", "Theme D") + ` +-- themes/d/i18n/en.toml -- +` + i18nContent("theme2", "Theme2 D") + ` +-- themes/c/static/hello.txt -- +Hugo Rocks!" +` + b := Test(t, files) b.AssertFileContent("public/index.html", "|Title theme-a-en|/blog/page/|Content theme-a-en") b.AssertFileContent("public/nn/index.html", "|Title theme-b-nn|/nn/blog/page/|Content theme-b-nn") @@ -540,38 +146,29 @@ other="Theme C" } func TestModulesIgnoreConfig(t *testing.T) { - b := newTestSitesBuilder(t).WithWorkingDir("/site").WithConfigFile("toml", ` + files := ` +-- hugo.toml -- baseURL="https://example.org" -workingDir="/site" - [module] [[module.imports]] path="a" ignoreConfig=true -`) - - b.WithSourceFile("themes/a/config.toml", ` +-- themes/a/config.toml -- [params] a = "Should Be Ignored!" -`) - - b.WithTemplatesAdded("index.html", `Params: {{ .Site.Params }}`) - - b.Build(BuildCfg{}) - - b.AssertFileContentFn("public/index.html", func(s string) bool { - return !strings.Contains(s, "Ignored") - }) +-- layouts/index.html -- +Params: {{ .Site.Params }} +` + Test(t, files).AssertFileContent("public/index.html", "! Ignored") } func TestModulesDisabled(t *testing.T) { - b := newTestSitesBuilder(t).WithWorkingDir("/site").WithConfigFile("toml", ` + files := ` +-- hugo.toml -- baseURL="https://example.org" -workingDir="/site" - [module] [[module.imports]] path="a" @@ -579,36 +176,25 @@ path="a" path="b" disable=true - -`) - - b.WithSourceFile("themes/a/config.toml", ` +-- themes/a/config.toml -- [params] a = "A param" -`) - - b.WithSourceFile("themes/b/config.toml", ` +-- themes/b/config.toml -- [params] b = "B param" -`) - - b.WithTemplatesAdded("index.html", `Params: {{ .Site.Params }}`) - - b.Build(BuildCfg{}) - - b.AssertFileContentFn("public/index.html", func(s string) bool { - return strings.Contains(s, "A param") && !strings.Contains(s, "B param") - }) +-- layouts/index.html -- +Params: {{ .Site.Params }} +` + Test(t, files).AssertFileContent("public/index.html", "A param", "! B param") } func TestModulesIncompatible(t *testing.T) { t.Parallel() - b := newTestSitesBuilder(t).WithWorkingDir("/site").WithConfigFile("toml", ` + files := ` +-- hugo.toml -- baseURL="https://example.org" -workingDir="/site" - [module] [[module.imports]] path="ok" @@ -619,39 +205,24 @@ path="incompat2" [[module.imports]] path="incompat3" -`) - - b.WithSourceFile("themes/ok/data/ok.toml", `title = "OK"`) - - b.WithSourceFile("themes/incompat1/config.toml", ` +-- themes/ok/data/ok.toml -- +title = "OK" +-- themes/incompat1/config.toml -- [module] [module.hugoVersion] min = "0.33.2" max = "0.45.0" -`) - - // Old setup. - b.WithSourceFile("themes/incompat2/theme.toml", ` +-- themes/incompat2/theme.toml -- min_version = "5.0.0" -`) - - // Issue 6162 - b.WithSourceFile("themes/incompat3/theme.toml", ` +-- themes/incompat3/theme.toml -- min_version = 0.55.0 -`) - - logger := loggers.NewDefault() - b.WithLogger(logger) - - b.Build(BuildCfg{}) - - c := qt.New(t) - - c.Assert(logger.LoggCount(logg.LevelWarn), qt.Equals, 3) +` + b := Test(t, files, TestOptWarn()) + b.AssertLogContains("is not compatible with this Hugo version") } func TestMountsProject(t *testing.T) { @@ -700,8 +271,6 @@ Home: {{ .Title }}|{{ .Content }}| func TestSiteWithGoModButNoModules(t *testing.T) { t.Parallel() - tempDir := t.TempDir() - files := ` -- hugo.toml -- baseURL = "https://example.org" @@ -709,63 +278,8 @@ baseURL = "https://example.org" ` - Test(t, files, TestOptWithConfig(func(cfg *IntegrationTestConfig) { - cfg.WorkingDir = tempDir - })) -} - -// https://github.com/gohugoio/hugo/issues/6622 -func TestModuleAbsMount(t *testing.T) { - t.Parallel() - - c := qt.New(t) - // We need to use the OS fs for this. - workDir, clean1, err := htesting.CreateTempDir(hugofs.Os, "hugo-project") - c.Assert(err, qt.IsNil) - absContentDir, clean2, err := htesting.CreateTempDir(hugofs.Os, "hugo-content") - c.Assert(err, qt.IsNil) - - cfg := config.New() - cfg.Set("workingDir", workDir) - cfg.Set("publishDir", "public") - fs := hugofs.NewFromOld(hugofs.Os, cfg) - - config := fmt.Sprintf(` -workingDir=%q - -[module] - [[module.mounts]] - source = %q - target = "content" - -`, workDir, absContentDir) - - defer clean1() - defer clean2() - - b := newTestSitesBuilder(t) - b.Fs = fs - - contentFilename := filepath.Join(absContentDir, "p1.md") - afero.WriteFile(hugofs.Os, contentFilename, []byte(` ---- -title: Abs ---- - -Content. -`), 0o777) - - b.WithWorkingDir(workDir).WithConfigFile("toml", config) - b.WithContent("dummy.md", "") - - b.WithTemplatesAdded("index.html", ` -{{ $p1 := site.GetPage "p1" }} -P1: {{ $p1.Title }}|{{ $p1.RelPermalink }}|Filename: {{ $p1.File.Filename }} -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", "P1: Abs|/p1/", "Filename: "+contentFilename) + b, err := TestE(t, files, TestOptOsFs()) + b.Assert(err, qt.IsNil) } // Issue 9426 diff --git a/hugolib/hugo_sites_build_errors_test.go b/hugolib/hugo_sites_build_errors_test.go index 35d467268..709f1c34d 100644 --- a/hugolib/hugo_sites_build_errors_test.go +++ b/hugolib/hugo_sites_build_errors_test.go @@ -2,7 +2,6 @@ package hugolib import ( "fmt" - "os" "path/filepath" "strings" "testing" @@ -45,24 +44,95 @@ func TestSiteBuildErrors(t *testing.T) { single = "single" ) - // TODO(bep) add content tests after https://github.com/gohugoio/hugo/issues/5324 - // is implemented. + type testCase struct { + name string + fileType string + fileFixer func(content string) string + assertErr func(a testSiteBuildErrorAsserter, err error) + } + + createTestFiles := func(tc testCase) string { + f := func(ftype, content string) string { + if ftype != tc.fileType { + return content + } + return tc.fileFixer(content) + } + + return ` +-- hugo.toml -- +baseURL = "https://example.com" +-- layouts/shortcodes/sc.html -- +` + f(shortcode, `SHORTCODE L1 +SHORTCODE L2 +SHORTCODE L3: +SHORTCODE L4: {{ .Page.Title }} +`) + ` +-- layouts/_default/baseof.html -- +` + f(base, `BASEOF L1 +BASEOF L2 +BASEOF L3 +BASEOF L4{{ if .Title }}{{ end }} +{{block "main" .}}This is the main content.{{end}} +BASEOF L6 +`) + ` +-- layouts/_default/single.html -- +` + f(single, `{{ define "main" }} +SINGLE L2: +SINGLE L3: +SINGLE L4: +SINGLE L5: {{ .Title }} {{ .Content }} +{{ end }} +`) + ` +-- layouts/foo/single.html -- +` + f(single, ` +SINGLE L2: +SINGLE L3: +SINGLE L4: +SINGLE L5: {{ .Title }} {{ .Content }} +`) + ` +-- content/myyaml.md -- +` + f(yamlcontent, `--- +title: "The YAML" +--- - tests := []struct { - name string - fileType string - fileFixer func(content string) string - assertCreateError func(a testSiteBuildErrorAsserter, err error) - assertBuildError func(a testSiteBuildErrorAsserter, err error) - }{ +Some content. + + {{< sc >}} + +Some more text. + +The end. +`) + ` +-- content/mytoml.md -- +` + f(tomlcontent, `+++ +title = "The TOML" +p1 = "v" +p2 = "v" +p3 = "v" +description = "Descriptioon" ++++ + +Some content. +`) + ` +-- content/myjson.md -- +` + f(jsoncontent, `{ + "title": "This is a title", + "description": "This is a description." +} + +Some content. +`) + } + + tests := []testCase{ { name: "Base template parse failed", fileType: base, fileFixer: func(content string) string { return strings.Replace(content, ".Title }}", ".Title }", 1) }, - // Base templates gets parsed at build time. - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { a.assertLineNumber(4, err) }, }, @@ -72,7 +142,7 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, ".Title", ".Titles", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { a.assertLineNumber(4, err) }, }, @@ -82,11 +152,11 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, ".Title }}", ".Title }", 1) }, - assertCreateError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 5) a.c.Assert(fe.Position().ColumnNumber, qt.Equals, 1) - a.assertErrorMessage("\"layouts/foo/single.html:5:1\": parse failed: template: foo/single.html:5: unexpected \"}\" in operand", fe.Error()) + a.assertErrorMessage("\"/layouts/foo/single.html:5:1\": parse of template failed: template: foo/single.html:5: unexpected \"}\" in operand", fe.Error()) }, }, { @@ -95,7 +165,7 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, ".Title", ".Titles", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 5) a.c.Assert(fe.Position().ColumnNumber, qt.Equals, 14) @@ -108,7 +178,7 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, ".Title", ".ThisIsAVeryLongTitle", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 5) a.c.Assert(fe.Position().ColumnNumber, qt.Equals, 14) @@ -121,7 +191,7 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, ".Title }}", ".Title }", 1) }, - assertCreateError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { a.assertLineNumber(4, err) }, }, @@ -131,7 +201,7 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, ".Title", ".Titles", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) // Make sure that it contains both the content file and template a.assertErrorMessage(`"content/myyaml.md:7:10": failed to render shortcode "sc": failed to process shortcode: "layouts/shortcodes/sc.html:4:22": execute of template failed: template: shortcodes/sc.html:4:22: executing "shortcodes/sc.html" at <.Page.Titles>: can't evaluate field Titles in type page.Page`, fe.Error()) @@ -144,7 +214,7 @@ func TestSiteBuildErrors(t *testing.T) { fileFixer: func(content string) string { return strings.Replace(content, "{{< sc >}}", "{{< nono >}}", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 7) a.c.Assert(fe.Position().ColumnNumber, qt.Equals, 10) @@ -161,7 +231,7 @@ foo bar --- ` }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { a.assertLineNumber(3, err) }, }, @@ -171,7 +241,7 @@ foo bar fileFixer: func(content string) string { return strings.Replace(content, "description = ", "description &", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 6) }, @@ -182,7 +252,7 @@ foo bar fileFixer: func(content string) string { return strings.Replace(content, "\"description\":", "\"description\"", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 3) }, @@ -195,7 +265,7 @@ foo bar return strings.Replace(content, ".Title", ".Parent.Parent.Parent", 1) }, - assertBuildError: func(a testSiteBuildErrorAsserter, err error) { + assertErr: func(a testSiteBuildErrorAsserter, err error) { a.c.Assert(err, qt.Not(qt.IsNil)) fe := a.getFileError(err) a.c.Assert(fe.Position().LineNumber, qt.Equals, 5) @@ -205,10 +275,10 @@ foo bar } for _, test := range tests { - if test.name != "Invalid JSON front matter" { + test := test + if test.name != "Base template parse failed" { continue } - test := test t.Run(test.name, func(t *testing.T) { t.Parallel() c := qt.New(t) @@ -217,94 +287,14 @@ foo bar name: test.name, } - b := newTestSitesBuilder(t).WithSimpleConfigFile() + files := createTestFiles(test) - f := func(fileType, content string) string { - if fileType != test.fileType { - return content - } - return test.fileFixer(content) - } + _, err := TestE(t, files) - b.WithTemplatesAdded("layouts/shortcodes/sc.html", f(shortcode, `SHORTCODE L1 -SHORTCODE L2 -SHORTCODE L3: -SHORTCODE L4: {{ .Page.Title }} -`)) - b.WithTemplatesAdded("layouts/_default/baseof.html", f(base, `BASEOF L1 -BASEOF L2 -BASEOF L3 -BASEOF L4{{ if .Title }}{{ end }} -{{block "main" .}}This is the main content.{{end}} -BASEOF L6 -`)) - - b.WithTemplatesAdded("layouts/_default/single.html", f(single, `{{ define "main" }} -SINGLE L2: -SINGLE L3: -SINGLE L4: -SINGLE L5: {{ .Title }} {{ .Content }} -{{ end }} -`)) - - b.WithTemplatesAdded("layouts/foo/single.html", f(single, ` -SINGLE L2: -SINGLE L3: -SINGLE L4: -SINGLE L5: {{ .Title }} {{ .Content }} -`)) - - b.WithContent("myyaml.md", f(yamlcontent, `--- -title: "The YAML" ---- - -Some content. - - {{< sc >}} - -Some more text. - -The end. - -`)) - - b.WithContent("mytoml.md", f(tomlcontent, `+++ -title = "The TOML" -p1 = "v" -p2 = "v" -p3 = "v" -description = "Descriptioon" -+++ - -Some content. - - -`)) - - b.WithContent("myjson.md", f(jsoncontent, `{ - "title": "This is a title", - "description": "This is a description." -} - -Some content. - - -`)) - - createErr := b.CreateSitesE() - if test.assertCreateError != nil { - test.assertCreateError(errorAsserter, createErr) + if test.assertErr != nil { + test.assertErr(errorAsserter, err) } else { - c.Assert(createErr, qt.IsNil) - } - - if createErr == nil { - buildErr := b.BuildE(BuildCfg{}) - if test.assertBuildError != nil { - test.assertBuildError(errorAsserter, buildErr) - } else { - c.Assert(buildErr, qt.IsNil) - } + c.Assert(err, qt.IsNil) } }) } @@ -315,8 +305,9 @@ func TestErrorMinify(t *testing.T) { t.Parallel() files := ` --- config.toml -- -minify = true +-- hugo.toml -- +[minify] +minifyOutput = true -- layouts/index.html -- @@ -325,12 +316,7 @@ minify = true ` - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) fe := herrors.UnwrapFileError(err) @@ -339,14 +325,15 @@ minify = true b.Assert(fe.Position().ColumnNumber, qt.Equals, 9) b.Assert(fe.Error(), qt.Contains, "unexpected = in expression on line 2 and column 9") b.Assert(filepath.ToSlash(fe.Position().Filename), qt.Contains, "hugo-transform-error") - b.Assert(os.Remove(fe.Position().Filename), qt.IsNil) + // os.Remove is not needed in txtar tests as the filesystem is ephemeral. + // b.Assert(os.Remove(fe.Position().Filename), qt.IsNil) } func TestErrorNestedRender(t *testing.T) { t.Parallel() files := ` --- config.toml -- +-- hugo.toml -- -- content/_index.md -- --- title: "Home" @@ -367,12 +354,7 @@ line 2 line 4 ` - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) errors := herrors.UnwrapFileErrorsWithErrorContext(err) @@ -394,7 +376,7 @@ func TestErrorNestedShortcode(t *testing.T) { t.Parallel() files := ` --- config.toml -- +-- hugo.toml -- -- content/_index.md -- --- title: "Home" @@ -420,12 +402,7 @@ line 2 line 4 ` - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) errors := herrors.UnwrapFileErrorsWithErrorContext(err) @@ -438,6 +415,8 @@ line 4 b.Assert(errors[1].Error(), qt.Contains, filepath.FromSlash(`"/content/_index.md:6:1": failed to render shortcode "hello": failed to process shortcode: "/layouts/shortcodes/hello.html:2:5":`)) b.Assert(errors[1].ErrorContext().Lines, qt.DeepEquals, []string{"", "## Hello", "{{< hello >}}", ""}) b.Assert(errors[2].ErrorContext().Lines, qt.DeepEquals, []string{"line 1", "12{{ partial \"foo.html\" . }}", "line 4", "line 5"}) + b.Assert(errors[3].Position().LineNumber, qt.Equals, 3) + b.Assert(errors[3].Position().ColumnNumber, qt.Equals, 6) b.Assert(errors[3].ErrorContext().Lines, qt.DeepEquals, []string{"line 1", "line 2", "123{{ .ThisDoesNotExist }}", "line 4"}) } @@ -445,7 +424,7 @@ func TestErrorRenderHookHeading(t *testing.T) { t.Parallel() files := ` --- config.toml -- +-- hugo.toml -- -- content/_index.md -- --- title: "Home" @@ -465,12 +444,7 @@ line 4 line 5 ` - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) errors := herrors.UnwrapFileErrorsWithErrorContext(err) @@ -483,7 +457,7 @@ func TestErrorRenderHookCodeblock(t *testing.T) { t.Parallel() files := ` --- config.toml -- +-- hugo.toml -- -- content/_index.md -- --- title: "Home" @@ -508,12 +482,7 @@ line 4 line 5 ` - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) errors := herrors.UnwrapFileErrorsWithErrorContext(err) @@ -527,7 +496,7 @@ func TestErrorInBaseTemplate(t *testing.T) { t.Parallel() filesTemplate := ` --- config.toml -- +-- hugo.toml -- -- content/_index.md -- --- title: "Home" @@ -559,12 +528,7 @@ toc line 4 t.Run("base template", func(t *testing.T) { files := strings.Replace(filesTemplate, "line 4 base", "123{{ .ThisDoesNotExist \"abc\" }}", 1) - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) b.Assert(err.Error(), qt.Contains, `baseof.html:4:6`) @@ -573,12 +537,7 @@ toc line 4 t.Run("index template", func(t *testing.T) { files := strings.Replace(filesTemplate, "line 3 index", "1234{{ .ThisDoesNotExist \"abc\" }}", 1) - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) b.Assert(err.Error(), qt.Contains, `index.html:3:7"`) @@ -587,12 +546,7 @@ toc line 4 t.Run("partial from define", func(t *testing.T) { files := strings.Replace(filesTemplate, "toc line 2", "12345{{ .ThisDoesNotExist \"abc\" }}", 1) - b, err := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).BuildE() + b, err := TestE(t, files) b.Assert(err, qt.IsNotNil) b.Assert(err.Error(), qt.Contains, `toc.html:2:8"`) @@ -601,29 +555,35 @@ toc line 4 // https://github.com/gohugoio/hugo/issues/5375 func TestSiteBuildTimeout(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", ` -timeout = 5 -`) + t.Parallel() - b.WithTemplatesAdded("_default/single.html", ` + var filesBuilder strings.Builder + filesBuilder.WriteString(` +-- hugo.toml -- +timeout = 5 +-- layouts/_default/single.html -- {{ .WordCount }} -`, "shortcodes/c.html", ` +-- layouts/shortcodes/c.html -- {{ range .Page.Site.RegularPages }} {{ .WordCount }} {{ end }} - `) for i := 1; i < 100; i++ { - b.WithContent(fmt.Sprintf("page%d.md", i), `--- + filesBuilder.WriteString(fmt.Sprintf(` +-- content/page%d.md -- +--- title: "A page" --- -{{< c >}}`) +{{< c >}} +`, i)) } - b.CreateSites().BuildFail(BuildCfg{}) + _, err := TestE(t, filesBuilder.String()) + + qt.Assert(t, err, qt.Not(qt.IsNil)) + qt.Assert(t, err.Error(), qt.Contains, "timed out rendering the page content") } func TestErrorTemplateRuntime(t *testing.T) { diff --git a/hugolib/hugo_sites_build_test.go b/hugolib/hugo_sites_build_test.go index 4d13e3617..1a20532e1 100644 --- a/hugolib/hugo_sites_build_test.go +++ b/hugolib/hugo_sites_build_test.go @@ -1,18 +1,12 @@ package hugolib import ( - "fmt" "path/filepath" - "strings" "testing" qt "github.com/frankban/quicktest" - "github.com/gohugoio/hugo/common/loggers" - "github.com/gohugoio/hugo/htesting" "github.com/gohugoio/hugo/resources/kinds" - "github.com/gohugoio/hugo/helpers" - "github.com/gohugoio/hugo/hugofs" "github.com/spf13/afero" ) @@ -48,9 +42,8 @@ Single: {{ .Title }}|{{ .Lang }}|{{ .RelPermalink }}| func TestMultiSitesWithTwoLanguages(t *testing.T) { t.Parallel() - c := qt.New(t) - b := newTestSitesBuilder(t).WithConfigFile("toml", ` - + files := ` +-- hugo.toml -- defaultContentLanguage = "nn" [languages] @@ -67,12 +60,11 @@ languageName = "English" weight = 2 [languages.en.params] p1 = "p1en" -`) - - b.CreateSites() - b.Build(BuildCfg{SkipRender: true}) +` + b := Test(t, files, TestOptSkipRender()) sites := b.H.Sites + c := qt.New(t) c.Assert(len(sites), qt.Equals, 2) nnSite := sites[0] @@ -92,198 +84,9 @@ p1 = "p1en" c.Assert(p1, qt.Equals, "p1nn") } -// https://github.com/gohugoio/hugo/issues/4706 -func TestContentStressTest(t *testing.T) { - b := newTestSitesBuilder(t) - - numPages := 500 - - contentTempl := ` ---- -%s -title: %q -weight: %d -multioutput: %t ---- - -# Header - -CONTENT - -The End. -` - - contentTempl = strings.Replace(contentTempl, "CONTENT", strings.Repeat(` - -## Another header - -Some text. Some more text. - -`, 100), -1) - - var content []string - defaultOutputs := `outputs: ["html", "json", "rss" ]` - - for i := 1; i <= numPages; i++ { - outputs := defaultOutputs - multioutput := true - if i%3 == 0 { - outputs = `outputs: ["json"]` - multioutput = false - } - section := "s1" - if i%10 == 0 { - section = "s2" - } - content = append(content, []string{fmt.Sprintf("%s/page%d.md", section, i), fmt.Sprintf(contentTempl, outputs, fmt.Sprintf("Title %d", i), i, multioutput)}...) - } - - content = append(content, []string{"_index.md", fmt.Sprintf(contentTempl, defaultOutputs, fmt.Sprintf("Home %d", 0), 0, true)}...) - content = append(content, []string{"s1/_index.md", fmt.Sprintf(contentTempl, defaultOutputs, fmt.Sprintf("S %d", 1), 1, true)}...) - content = append(content, []string{"s2/_index.md", fmt.Sprintf(contentTempl, defaultOutputs, fmt.Sprintf("S %d", 2), 2, true)}...) - - b.WithSimpleConfigFile() - b.WithTemplates("layouts/_default/single.html", `Single: {{ .Content }}|RelPermalink: {{ .RelPermalink }}|Permalink: {{ .Permalink }}`) - b.WithTemplates("layouts/_default/myview.html", `View: {{ len .Content }}`) - b.WithTemplates("layouts/_default/single.json", `Single JSON: {{ .Content }}|RelPermalink: {{ .RelPermalink }}|Permalink: {{ .Permalink }}`) - b.WithTemplates("layouts/_default/list.html", ` -Page: {{ .Paginator.PageNumber }} -P: {{ with .File }}{{ path.Join .Path }}{{ end }} -List: {{ len .Paginator.Pages }}|List Content: {{ len .Content }} -{{ $shuffled := where .Site.RegularPages "Params.multioutput" true | shuffle }} -{{ $first5 := $shuffled | first 5 }} -L1: {{ len .Site.RegularPages }} L2: {{ len $first5 }} -{{ range $i, $e := $first5 }} -Render {{ $i }}: {{ .Render "myview" }} -{{ end }} -END -`) - - b.WithContent(content...) - - b.CreateSites().Build(BuildCfg{}) - - contentMatchers := []string{"

Another header

", "

Another header

", "

The End.

"} - - for i := 1; i <= numPages; i++ { - if i%3 != 0 { - section := "s1" - if i%10 == 0 { - section = "s2" - } - checkContent(b, fmt.Sprintf("public/%s/page%d/index.html", section, i), contentMatchers...) - } - } - - for i := 1; i <= numPages; i++ { - section := "s1" - if i%10 == 0 { - section = "s2" - } - checkContent(b, fmt.Sprintf("public/%s/page%d/index.json", section, i), contentMatchers...) - } - - checkContent(b, "public/s1/index.html", "P: s1/_index.md\nList: 10|List Content: 8132\n\n\nL1: 500 L2: 5\n\nRender 0: View: 8132\n\nRender 1: View: 8132\n\nRender 2: View: 8132\n\nRender 3: View: 8132\n\nRender 4: View: 8132\n\nEND\n") - checkContent(b, "public/s2/index.html", "P: s2/_index.md\nList: 10|List Content: 8132", "Render 4: View: 8132\n\nEND") - checkContent(b, "public/index.html", "P: _index.md\nList: 10|List Content: 8132", "4: View: 8132\n\nEND") - - // Check paginated pages - for i := 2; i <= 9; i++ { - checkContent(b, fmt.Sprintf("public/page/%d/index.html", i), fmt.Sprintf("Page: %d", i), "Content: 8132\n\n\nL1: 500 L2: 5\n\nRender 0: View: 8132", "Render 4: View: 8132\n\nEND") - } -} - -func checkContent(s *sitesBuilder, filename string, matches ...string) { - s.T.Helper() - content := readWorkingDir(s.T, s.Fs, filename) - for _, match := range matches { - if !strings.Contains(content, match) { - s.Fatalf("No match for\n%q\nin content for %s\n%q\nDiff:\n%s", match, filename, content, htesting.DiffStrings(content, match)) - } - } -} - -func writeSource(t testing.TB, fs *hugofs.Fs, filename, content string) { - t.Helper() - writeToFs(t, fs.Source, filename, content) -} - func writeToFs(t testing.TB, fs afero.Fs, filename, content string) { t.Helper() if err := afero.WriteFile(fs, filepath.FromSlash(filename), []byte(content), 0o755); err != nil { t.Fatalf("Failed to write file: %s", err) } } - -func readWorkingDir(t testing.TB, fs *hugofs.Fs, filename string) string { - t.Helper() - return readFileFromFs(t, fs.WorkingDirReadOnly, filename) -} - -func workingDirExists(fs *hugofs.Fs, filename string) bool { - b, err := helpers.Exists(filename, fs.WorkingDirReadOnly) - if err != nil { - panic(err) - } - return b -} - -func readFileFromFs(t testing.TB, fs afero.Fs, filename string) string { - t.Helper() - filename = filepath.Clean(filename) - b, err := afero.ReadFile(fs, filename) - if err != nil { - // Print some debug info - hadSlash := strings.HasPrefix(filename, helpers.FilePathSeparator) - start := 0 - if hadSlash { - start = 1 - } - end := start + 1 - - parts := strings.Split(filename, helpers.FilePathSeparator) - if parts[start] == "work" { - end++ - } - - /* - root := filepath.Join(parts[start:end]...) - if hadSlash { - root = helpers.FilePathSeparator + root - } - - helpers.PrintFs(fs, root, os.Stdout) - */ - - t.Fatalf("Failed to read file: %s", err) - } - return string(b) -} - -const testPageTemplate = `--- -title: "%s" -publishdate: "%s" -weight: %d ---- -# Doc %s -` - -func newTestPage(title, date string, weight int) string { - return fmt.Sprintf(testPageTemplate, title, date, weight, title) -} - -func TestRebuildOnAssetChange(t *testing.T) { - b := newTestSitesBuilder(t).Running().WithLogger(loggers.NewDefault()) - b.WithTemplatesAdded("index.html", ` -{{ (resources.Get "data.json").Content }} -`) - b.WithSourceFile("assets/data.json", "orig data") - - b.Build(BuildCfg{}) - b.AssertFileContent("public/index.html", `orig data`) - - b.EditFiles("assets/data.json", "changed data") - - b.Build(BuildCfg{}) - b.AssertFileContent("public/index.html", `changed data`) -} diff --git a/hugolib/hugo_smoke_test.go b/hugolib/hugo_smoke_test.go index a32d01d44..f8ae8a80a 100644 --- a/hugolib/hugo_smoke_test.go +++ b/hugolib/hugo_smoke_test.go @@ -1,4 +1,4 @@ -// Copyright 2024 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -16,6 +16,7 @@ package hugolib import ( "fmt" "math/rand" + "strings" "testing" "github.com/bep/logg" @@ -688,39 +689,64 @@ title: "Heim" // https://github.com/golang/go/issues/30286 func TestDataRace(t *testing.T) { - const page = ` ---- -title: "The Page" -outputs: ["HTML", "JSON"] ---- + var filesBuilder strings.Builder -The content. + filesBuilder.WriteString(` +-- hugo.toml -- +baseURL = "https://example.org" +defaultContentLanguage = "en" +[outputs] +home = ["HTML", "JSON", "CSV", "RSS"] +page = ["HTML", "JSON"] - ` +[mediaTypes] +[mediaTypes."application/json"] +suffixes = ["json"] +[mediaTypes."text/csv"] +suffixes = ["csv"] - b := newTestSitesBuilder(t).WithSimpleConfigFile() - for i := 1; i <= 50; i++ { - b.WithContent(fmt.Sprintf("blog/page%d.md", i), page) - } +[outputFormats.JSON] +mediaType = "application/json" +isPlainText = true +isHTML = false - b.WithContent("_index.md", ` +[outputFormats.CSV] +mediaType = "text/csv" +isPlainText = true +isHTML = false + +-- layouts/_default/single.html -- +HTML Single: {{ .Data.Pages }} +-- layouts/_default/list.html -- +HTML List: {{ .Data.Pages }} +-- content/_index.md -- --- title: "The Home" outputs: ["HTML", "JSON", "CSV", "RSS"] --- - The content. +`) + const pageContent = ` +--- +title: "The Page" +outputs: ["HTML", "JSON"] +--- +The content. +` -`) + for i := 1; i <= 50; i++ { + filesBuilder.WriteString(fmt.Sprintf("\n-- content/blog/page%d.md --\n%s", i, pageContent)) + } - commonTemplate := `{{ .Data.Pages }}` + files := filesBuilder.String() - b.WithTemplatesAdded("_default/single.html", "HTML Single: "+commonTemplate) - b.WithTemplatesAdded("_default/list.html", "HTML List: "+commonTemplate) + _ = Test(t, files) - b.CreateSites().Build(BuildCfg{}) + // Assertions can be added here if needed, but the original test only builds. + // The primary purpose of TestDataRace is to check for race conditions during the build process. + // If the build completes without race detector errors, the test passes. } // This is just a test to verify that BenchmarkBaseline is working as intended. diff --git a/hugolib/image_test.go b/hugolib/image_test.go deleted file mode 100644 index 09a5b841e..000000000 --- a/hugolib/image_test.go +++ /dev/null @@ -1,92 +0,0 @@ -// 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 ( - "testing" -) - -func TestImageResizeMultilingual(t *testing.T) { - b := newTestSitesBuilder(t).WithConfigFile("toml", ` -baseURL="https://example.org" -defaultContentLanguage = "en" - -[languages] -[languages.en] -title = "Title in English" -languageName = "English" -weight = 1 -[languages.nn] -languageName = "Nynorsk" -weight = 2 -title = "Tittel på nynorsk" -[languages.nb] -languageName = "Bokmål" -weight = 3 -title = "Tittel på bokmål" -[languages.fr] -languageName = "French" -weight = 4 -title = "French Title" - -`) - - pageContent := `--- -title: "Page" ---- -` - - b.WithContent("bundle/index.md", pageContent) - b.WithContent("bundle/index.nn.md", pageContent) - b.WithContent("bundle/index.fr.md", pageContent) - b.WithSunset("content/bundle/sunset.jpg") - b.WithSunset("assets/images/sunset.jpg") - b.WithTemplates("index.html", ` -{{ with (.Site.GetPage "bundle" ) }} -{{ $sunset := .Resources.GetMatch "sunset*" }} -{{ if $sunset }} -{{ $resized := $sunset.Resize "200x200" }} -SUNSET FOR: {{ $.Site.Language.Lang }}: {{ $resized.RelPermalink }}/{{ $resized.Width }}/Lat: {{ $resized.Exif.Lat }} -{{ end }} -{{ else }} -No bundle for {{ $.Site.Language.Lang }} -{{ end }} - -{{ $sunset2 := resources.Get "images/sunset.jpg" }} -{{ $resized2 := $sunset2.Resize "123x234" }} -SUNSET2: {{ $resized2.RelPermalink }}/{{ $resized2.Width }}/Lat: {{ $resized2.Exif.Lat }} - - -`) - - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", "SUNSET FOR: en: /bundle/sunset_hu_77061c65c31d2244.jpg/200/Lat: 36.59744166666667") - b.AssertFileContent("public/fr/index.html", "SUNSET FOR: fr: /bundle/sunset_hu_77061c65c31d2244.jpg/200/Lat: 36.59744166666667") - b.AssertFileContent("public/index.html", " SUNSET2: /images/sunset_hu_b52e3343ea6a8764.jpg/123/Lat: 36.59744166666667") - b.AssertFileContent("public/nn/index.html", " SUNSET2: /images/sunset_hu_b52e3343ea6a8764.jpg/123/Lat: 36.59744166666667") - - b.AssertImage(200, 200, "public/bundle/sunset_hu_77061c65c31d2244.jpg") - - // Check the file cache - b.AssertImage(200, 200, "resources/_gen/images/bundle/sunset_hu_77061c65c31d2244.jpg") - - b.AssertFileContent("resources/_gen/images/bundle/sunset_d209dcdc6b875e26.json", - "FocalLengthIn35mmFormat|uint16", "PENTAX") - - b.AssertFileContent("resources/_gen/images/images/sunset_d209dcdc6b875e26.json", - "FocalLengthIn35mmFormat|uint16", "PENTAX") - - b.AssertNoDuplicateWrites() -} diff --git a/hugolib/integrationtest_builder.go b/hugolib/integrationtest_builder.go index d1d787797..c9d7beea9 100644 --- a/hugolib/integrationtest_builder.go +++ b/hugolib/integrationtest_builder.go @@ -86,6 +86,15 @@ func TestOptWarn() TestOpt { } } +// TestOptSkipRender will skip the render phase in integration tests. +func TestOptSkipRender() TestOpt { + return func(c *IntegrationTestConfig) { + c.BuildCfg = BuildCfg{ + SkipRender: true, + } + } +} + // TestOptOsFs will enable the real file system in integration tests. func TestOptOsFs() TestOpt { return func(c *IntegrationTestConfig) { diff --git a/hugolib/language_content_dir_test.go b/hugolib/language_content_dir_test.go index acc0d60ae..c79ab99b0 100644 --- a/hugolib/language_content_dir_test.go +++ b/hugolib/language_content_dir_test.go @@ -164,12 +164,7 @@ title: "p4 theme (nl)" --- ` - b := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - }, - ).Build() + b := Test(t, files) b.AssertFileContent("public/nl/index.html", `home (nl): nl: p1 (nl)|p2 (en)|p3 (nl)|p4 theme (nl)|:END`) b.AssertFileContent("public/de/index.html", `home (de): de: p1 (de)|p2 (en)|p3 (en)|:END`) diff --git a/hugolib/language_test.go b/hugolib/language_test.go index f7dd5b79d..ac07d9b66 100644 --- a/hugolib/language_test.go +++ b/hugolib/language_test.go @@ -1,4 +1,4 @@ -// Copyright 2020 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -15,44 +15,50 @@ package hugolib import ( "fmt" - "strings" "testing" - "github.com/gohugoio/hugo/htesting" - qt "github.com/frankban/quicktest" ) func TestI18n(t *testing.T) { c := qt.New(t) - // https://github.com/gohugoio/hugo/issues/7804 - c.Run("pt-br should be case insensitive", func(c *qt.C) { - b := newTestSitesBuilder(c) - langCode := func() string { - c := "pt-br" - if htesting.RandBool() { - c = strings.ToUpper(c) - } - return c - } - - b.WithConfigFile(`toml`, fmt.Sprintf(` + testCases := []struct { + name string + langCode string + }{ + { + name: "pt-br lowercase", + langCode: "pt-br", + }, + { + name: "pt-br uppercase", + langCode: "PT-BR", + }, + } + + for _, tc := range testCases { + tc := tc + c.Run(tc.name, func(c *qt.C) { + files := fmt.Sprintf(` +-- hugo.toml -- baseURL = "https://example.com" defaultContentLanguage = "%s" [languages] [languages.%s] weight = 1 -`, langCode(), langCode())) - - b.WithI18n(fmt.Sprintf("i18n/%s.toml", langCode()), `hello.one = "Hello"`) - b.WithTemplates("index.html", `Hello: {{ i18n "hello" 1 }}`) - b.WithContent("p1.md", "") - b.Build(BuildCfg{}) - - b.AssertFileContent("public/index.html", "Hello: Hello") - }) +-- i18n/%s.toml -- +hello.one = "Hello" +-- layouts/index.html -- +Hello: {{ i18n "hello" 1 }} +-- content/p1.md -- +`, tc.langCode, tc.langCode, tc.langCode) + + b := Test(c, files) + b.AssertFileContent("public/index.html", "Hello: Hello") + }) + } } func TestLanguageBugs(t *testing.T) { @@ -60,19 +66,16 @@ func TestLanguageBugs(t *testing.T) { // Issue #8672 c.Run("Config with language, menu in root only", func(c *qt.C) { - b := newTestSitesBuilder(c) - b.WithConfigFile("toml", ` + files := ` +-- hugo.toml -- theme = "test-theme" [[menus.foo]] name = "foo-a" [languages.en] - -`, - ) - - b.WithThemeConfigFile("toml", `[languages.en]`) - - b.Build(BuildCfg{}) +-- themes/test-theme/hugo.toml -- +[languages.en] +` + b := Test(c, files) menus := b.H.Sites[0].Menus() c.Assert(menus, qt.HasLen, 1) @@ -80,8 +83,8 @@ name = "foo-a" } func TestLanguageNumberFormatting(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithConfigFile("toml", ` + files := ` +-- hugo.toml -- baseURL = "https://example.org" defaultContentLanguage = "en" @@ -93,24 +96,17 @@ timeZone="UTC" weight=10 [languages.nn] weight=20 - -`) - - b.WithTemplates("index.html", ` +-- layouts/index.html -- FormatNumber: {{ 512.5032 | lang.FormatNumber 2 }} FormatPercent: {{ 512.5032 | lang.FormatPercent 2 }} FormatCurrency: {{ 512.5032 | lang.FormatCurrency 2 "USD" }} FormatAccounting: {{ 512.5032 | lang.FormatAccounting 2 "NOK" }} FormatNumberCustom: {{ lang.FormatNumberCustom 2 12345.6789 }} +-- content/p1.md -- +` - - - -`) - b.WithContent("p1.md", "") - - b.Build(BuildCfg{}) + b := Test(t, files) b.AssertFileContent("public/en/index.html", ` FormatNumber: 512.50 @@ -118,7 +114,6 @@ FormatPercent: 512.50% FormatCurrency: $512.50 FormatAccounting: NOK512.50 FormatNumberCustom: 12,345.68 - `, ) @@ -135,7 +130,7 @@ FormatNumberCustom: 12,345.68 // Issue 11993. func TestI18nDotFile(t *testing.T) { files := ` --- hugo.toml --{} +-- hugo.toml -- baseURL = "https://example.com" -- i18n/.keep -- -- data/.keep -- diff --git a/hugolib/menu_test.go b/hugolib/menu_test.go index 3be999c31..c241c9299 100644 --- a/hugolib/menu_test.go +++ b/hugolib/menu_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -14,64 +14,98 @@ package hugolib import ( - "fmt" "testing" qt "github.com/frankban/quicktest" ) -const ( - menuPageTemplate = `--- -title: %q -weight: %d -menu: - %s: - title: %s - weight: %d ---- -# Doc Menu -` -) - func TestMenusSectionPagesMenu(t *testing.T) { t.Parallel() - siteConfig := ` + files := ` +-- hugo.toml -- baseurl = "http://example.com/" title = "Section Menu" sectionPagesMenu = "sect" -` - - b := newTestSitesBuilder(t).WithConfigFile("toml", siteConfig) - - b.WithTemplates( - "partials/menu.html", - `{{- $p := .page -}} +-- layouts/partials/menu.html -- +{{- $p := .page -}} {{- $m := .menu -}} {{ range (index $p.Site.Menus $m) -}} {{- .URL }}|{{ .Name }}|{{ .Title }}|{{ .Weight -}}| {{- if $p.IsMenuCurrent $m . }}IsMenuCurrent{{ else }}-{{ end -}}| {{- if $p.HasMenuCurrent $m . }}HasMenuCurrent{{ else }}-{{ end -}}| {{- end -}} -`, - "_default/single.html", - `Single|{{ .Title }} +-- layouts/_default/single.html -- +Single|{{ .Title }} Menu Sect: {{ partial "menu.html" (dict "page" . "menu" "sect") }} -Menu Main: {{ partial "menu.html" (dict "page" . "menu" "main") }}`, - "_default/list.html", "List|{{ .Title }}|{{ .Content }}", - ) - - b.WithContent( - "sect1/p1.md", fmt.Sprintf(menuPageTemplate, "p1", 1, "main", "atitle1", 40), - "sect1/p2.md", fmt.Sprintf(menuPageTemplate, "p2", 2, "main", "atitle2", 30), - "sect2/p3.md", fmt.Sprintf(menuPageTemplate, "p3", 3, "main", "atitle3", 20), - "sect2/p4.md", fmt.Sprintf(menuPageTemplate, "p4", 4, "main", "atitle4", 10), - "sect3/p5.md", fmt.Sprintf(menuPageTemplate, "p5", 5, "main", "atitle5", 5), - "sect1/_index.md", newTestPage("Section One", "2017-01-01", 100), - "sect5/_index.md", newTestPage("Section Five", "2017-01-01", 10), - ) +Menu Main: {{ partial "menu.html" (dict "page" . "menu" "main") }} +-- layouts/_default/list.html -- +List|{{ .Title }}|{{ .Content }} +-- content/sect1/p1.md -- +--- +title: "p1" +weight: 1 +menu: + main: + title: "atitle1" + weight: 40 +--- +# Doc Menu +-- content/sect1/p2.md -- +--- +title: "p2" +weight: 2 +menu: + main: + title: "atitle2" + weight: 30 +--- +# Doc Menu +-- content/sect2/p3.md -- +--- +title: "p3" +weight: 3 +menu: + main: + title: "atitle3" + weight: 20 +--- +# Doc Menu +-- content/sect2/p4.md -- +--- +title: "p4" +weight: 4 +menu: + main: + title: "atitle4" + weight: 10 +--- +# Doc Menu +-- content/sect3/p5.md -- +--- +title: "p5" +weight: 5 +menu: + main: + title: "atitle5" + weight: 5 +--- +# Doc Menu +-- content/sect1/_index.md -- +--- +title: "Section One" +date: "2017-01-01" +weight: 100 +--- +-- content/sect5/_index.md -- +--- +title: "Section Five" +date: "2017-01-01" +weight: 10 +--- +` - b.Build(BuildCfg{}) + b := Test(t, files) h := b.H s := h.Sites[0] @@ -106,9 +140,10 @@ Menu Main: {{ partial "menu.html" (dict "page" . "menu" "main") }}`, } func TestMenusFrontMatter(t *testing.T) { - b := newTestSitesBuilder(t).WithSimpleConfigFile() - - b.WithTemplatesAdded("index.html", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- layouts/index.html -- Main: {{ len .Site.Menus.main }} Other: {{ len .Site.Menus.other }} {{ range .Site.Menus.main }} @@ -117,35 +152,27 @@ Other: {{ len .Site.Menus.other }} {{ range .Site.Menus.other }} * Other|{{ .Name }}: {{ .URL }} {{ end }} -`) - - // Issue #5828 - b.WithContent("blog/page1.md", ` +-- content/blog/page1.md -- --- title: "P1" menu: main --- -`) - - b.WithContent("blog/page2.md", ` +-- content/blog/page2.md -- --- title: "P2" menu: [main,other] --- -`) - - b.WithContent("blog/page3.md", ` +-- content/blog/page3.md -- --- title: "P3" menu: main: weight: 30 --- -`) - - b.Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/index.html", "Main: 3", "Other: 1", @@ -156,7 +183,8 @@ menu: // https://github.com/gohugoio/hugo/issues/5849 func TestMenusPageMultipleOutputFormats(t *testing.T) { - config := ` + files := ` +-- hugo.toml -- baseURL = "https://example.com" # DAMP is similar to AMP, but not permalinkable. @@ -165,48 +193,38 @@ baseURL = "https://example.com" mediaType = "text/html" path = "damp" -` - - b := newTestSitesBuilder(t).WithConfigFile("toml", config) - b.WithContent("_index.md", ` +-- layouts/index.html -- +{{ range .Site.Menus.main }}{{ .Title }}|{{ .URL }}|{{ end }} +-- content/_index.md -- --- Title: Home Sweet Home outputs: [ "html", "amp" ] menu: "main" --- -`) - - b.WithContent("blog/html-amp.md", ` +-- content/blog/html-amp.md -- --- Title: AMP and HTML outputs: [ "html", "amp" ] menu: "main" --- -`) - - b.WithContent("blog/html.md", ` +-- content/blog/html.md -- --- Title: HTML only outputs: [ "html" ] menu: "main" --- -`) - - b.WithContent("blog/amp.md", ` +-- content/blog/amp.md -- --- Title: AMP only outputs: [ "amp" ] menu: "main" --- -`) - - b.WithTemplatesAdded("index.html", `{{ range .Site.Menus.main }}{{ .Title }}|{{ .URL }}|{{ end }}`) - - b.Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/index.html", "AMP and HTML|/blog/html-amp/|AMP only|/amp/blog/amp/|Home Sweet Home|/|HTML only|/blog/html/|") b.AssertFileContent("public/amp/index.html", "AMP and HTML|/amp/blog/html-amp/|AMP only|/amp/blog/amp/|Home Sweet Home|/amp/|HTML only|/blog/html/|") @@ -214,9 +232,14 @@ menu: "main" // https://github.com/gohugoio/hugo/issues/5989 func TestMenusPageSortByDate(t *testing.T) { - b := newTestSitesBuilder(t).WithSimpleConfigFile() + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- layouts/index.html -- +{{ range .Site.Menus.main }}{{ .Title }}|Children: +{{- $children := sort .Children ".Page.Date" "desc" }}{{ range $children }}{{ .Title }}|{{ end }}{{ end }} - b.WithContent("blog/a.md", ` +-- content/blog/a.md -- --- Title: A date: 2019-01-01 @@ -226,9 +249,7 @@ menu: weight: 1 --- -`) - - b.WithContent("blog/b.md", ` +-- content/blog/b.md -- --- Title: B date: 2018-01-02 @@ -238,9 +259,7 @@ menu: weight: 100 --- -`) - - b.WithContent("blog/c.md", ` +-- content/blog/c.md -- --- Title: C date: 2019-01-03 @@ -250,39 +269,16 @@ menu: weight: 10 --- -`) - - b.WithTemplatesAdded("index.html", `{{ range .Site.Menus.main }}{{ .Title }}|Children: -{{- $children := sort .Children ".Page.Date" "desc" }}{{ range $children }}{{ .Title }}|{{ end }}{{ end }} - -`) - - b.Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/index.html", "A|Children:C|B|") } -// Issue #8825 -func TestMenuParamsEmptyYaml(t *testing.T) { - b := newTestSitesBuilder(t).WithConfigFile("yaml", ` - -`) - - b.WithTemplates("index.html", `{{ site.Menus }}`) - - b.WithContent("p1.md", `--- -menus: - main: - identity: journal - weight: 2 - params: ---- -`) - b.Build(BuildCfg{}) -} - func TestMenuParams(t *testing.T) { - b := newTestSitesBuilder(t).WithConfigFile("toml", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" [[menus.main]] identifier = "contact" title = "Contact Us" @@ -292,18 +288,14 @@ weight = 300 foo = "foo_config" key2 = "key2_config" camelCase = "camelCase_config" -`) - - b.WithTemplatesAdded("index.html", ` +-- layouts/index.html -- Main: {{ len .Site.Menus.main }} {{ range .Site.Menus.main }} foo: {{ .Params.foo }} key2: {{ .Params.KEy2 }} camelCase: {{ .Params.camelcase }} {{ end }} -`) - - b.WithContent("_index.md", ` +-- content/_index.md -- --- title: "Home" menu: @@ -314,9 +306,8 @@ menu: key2: "key2_content" camelCase: "camelCase_content" --- -`) - - b.Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/index.html", ` Main: 2 @@ -332,7 +323,9 @@ camelCase: camelCase_config } func TestMenusShadowMembers(t *testing.T) { - b := newTestSitesBuilder(t).WithConfigFile("toml", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" [[menus.main]] identifier = "contact" pageRef = "contact" @@ -344,65 +337,53 @@ pageRef = "/blog/post3" title = "My Post 3" url = "/blog/post3" -`) - - commonTempl := ` +-- layouts/index.html -- Main: {{ len .Site.Menus.main }} {{ range .Site.Menus.main }} {{ .Title }}|HasMenuCurrent: {{ $.HasMenuCurrent "main" . }}|Page: {{ .Page.Path }} {{ .Title }}|IsMenuCurrent: {{ $.IsMenuCurrent "main" . }}|Page: {{ .Page.Path }} {{ end }} -` - - b.WithTemplatesAdded("index.html", commonTempl) - b.WithTemplatesAdded("_default/single.html", commonTempl) - - b.WithContent("_index.md", ` +-- layouts/_default/single.html -- +Main: {{ len .Site.Menus.main }} +{{ range .Site.Menus.main }} +{{ .Title }}|HasMenuCurrent: {{ $.HasMenuCurrent "main" . }}|Page: {{ .Page.Path }} +{{ .Title }}|IsMenuCurrent: {{ $.IsMenuCurrent "main" . }}|Page: {{ .Page.Path }} +{{ end }} +-- content/_index.md -- --- title: "Home" menu: main: weight: 10 --- -`) - - b.WithContent("blog/_index.md", ` +-- content/blog/_index.md -- --- title: "Blog" menu: main: weight: 20 --- -`) - - b.WithContent("blog/post1.md", ` +-- content/blog/post1.md -- --- title: "My Post 1: With No Menu Defined" --- -`) - - b.WithContent("blog/post2.md", ` +-- content/blog/post2.md -- --- title: "My Post 2: With Menu Defined" menu: main: weight: 30 --- -`) - - b.WithContent("blog/post3.md", ` +-- content/blog/post3.md -- --- title: "My Post 2: With No Menu Defined" --- -`) - - b.WithContent("contact.md", ` +-- content/contact.md -- --- title: "Contact: With No Menu Defined" --- -`) - - b.Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/index.html", ` Main: 5 diff --git a/hugolib/minify_publisher_test.go b/hugolib/minify_publisher_test.go index ef460efa2..eea267eaf 100644 --- a/hugolib/minify_publisher_test.go +++ b/hugolib/minify_publisher_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -15,18 +15,17 @@ package hugolib import ( "testing" - - "github.com/gohugoio/hugo/config" ) func TestMinifyPublisher(t *testing.T) { t.Parallel() - v := config.New() - v.Set("minify", true) - v.Set("baseURL", "https://example.org/") - - htmlTemplate := ` + files := ` +-- hugo.toml -- +baseURL = "https://example.org/" +[minify] +minifyOutput = true +-- layouts/index.html -- @@ -46,10 +45,7 @@ func TestMinifyPublisher(t *testing.T) { ` - - b := newTestSitesBuilder(t) - b.WithViper(v).WithTemplatesAdded("layouts/index.html", htmlTemplate) - b.CreateSites().Build(BuildCfg{}) + b := Test(t, files) // Check minification // HTML diff --git a/hugolib/mount_filters_test.go b/hugolib/mount_filters_test.go index 16b062ec6..8f785aa4e 100644 --- a/hugolib/mount_filters_test.go +++ b/hugolib/mount_filters_test.go @@ -1,4 +1,4 @@ -// Copyright 2021 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -14,34 +14,15 @@ package hugolib import ( - "fmt" - "os" - "path/filepath" "testing" - - "github.com/gohugoio/hugo/common/loggers" - "github.com/gohugoio/hugo/hugofs/files" - - "github.com/gohugoio/hugo/htesting" - "github.com/gohugoio/hugo/hugofs" - - qt "github.com/frankban/quicktest" ) func TestMountFilters(t *testing.T) { t.Parallel() - b := newTestSitesBuilder(t) - workingDir, clean, err := htesting.CreateTempDir(hugofs.Os, "hugo-test-mountfilters") - b.Assert(err, qt.IsNil) - defer clean() - - for _, component := range files.ComponentFolders { - b.Assert(os.MkdirAll(filepath.Join(workingDir, component), 0o777), qt.IsNil) - } - b.WithWorkingDir(workingDir).WithLogger(loggers.NewDefault()) - b.WithConfigFile("toml", fmt.Sprintf(` -workingDir = %q + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" [module] [[module.mounts]] source = 'content' @@ -68,25 +49,29 @@ target = 'i18n' [[module.mounts]] source = 'archetypes' target = 'archetypes' - - -`, workingDir)) - - b.WithContent("/a/b/p1.md", "---\ntitle: Include\n---") - b.WithContent("/a/c/p2.md", "---\ntitle: Exclude\n---") - - b.WithSourceFile( - "data/mydata/b.toml", `b1='bval'`, - "data/nodata/c.toml", `c1='bval'`, - "layouts/partials/foo.html", `foo`, - "assets/exclude.txt", `foo`, - "assets/js/exclude.js", `foo`, - "assets/js/include.js", `foo`, - "assets/js/exclude.js", `foo`, - ) - - b.WithTemplatesAdded("index.html", ` - +-- layouts/_default/single.html -- +Single page. +-- content/a/b/p1.md -- +--- +title: Include +--- +-- content/a/c/p2.md -- +--- +title: Exclude +--- +-- data/mydata/b.toml -- +b1='bval' +-- data/nodata/c.toml -- +c1='bval' +-- layouts/partials/foo.html -- +foo +-- assets/exclude.txt -- +foo +-- assets/js/exclude.js -- +foo +-- assets/js/include.js -- +foo +-- layouts/index.html -- Data: {{ site.Data }}:END Template: {{ templates.Exists "partials/foo.html" }}:END @@ -94,20 +79,14 @@ Resource1: {{ resources.Get "js/include.js" }}:END Resource2: {{ resources.Get "js/exclude.js" }}:END Resource3: {{ resources.Get "exclude.txt" }}:END Resources: {{ resources.Match "**.js" }} -`) - - b.Build(BuildCfg{}) - - assertExists := func(name string, shouldExist bool) { - b.Helper() - b.Assert(b.CheckExists(name), qt.Equals, shouldExist) - } +` + b := Test(t, files) - assertExists("public/a/b/p1/index.html", true) - assertExists("public/a/c/p2/index.html", false) + b.AssertFileExists("public/a/b/p1/index.html", true) + b.AssertFileExists("public/a/c/p2/index.html", false) - b.AssertFileContent(filepath.Join("public", "index.html"), ` -Data: map[mydata:map[b:map[b1:bval]]]:END + b.AssertFileContent("public/index.html", ` +Data: map[mydata:map[b:map[b1:bval]]]:END Template: false Resource1: /js/include.js:END Resource2: :END diff --git a/hugolib/page_permalink_test.go b/hugolib/page_permalink_test.go index 52d1c9931..edb03f4ee 100644 --- a/hugolib/page_permalink_test.go +++ b/hugolib/page_permalink_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -19,8 +19,6 @@ import ( "testing" qt "github.com/frankban/quicktest" - - "github.com/gohugoio/hugo/config" ) func TestPermalink(t *testing.T) { @@ -67,13 +65,12 @@ func TestPermalink(t *testing.T) { t.Run(fmt.Sprintf("%s-%d", test.file, i), func(t *testing.T) { t.Parallel() c := qt.New(t) - cfg := config.New() - cfg.Set("uglyURLs", test.uglyURLs) - cfg.Set("canonifyURLs", test.canonifyURLs) files := fmt.Sprintf(` -- hugo.toml -- baseURL = %q +uglyURLs = %t +canonifyURLs = %t -- content/%s -- --- title: Page @@ -81,21 +78,9 @@ slug: %q url: %q output: ["HTML"] --- -`, test.base, test.file, test.slug, test.url) - - if i > 0 { - t.Skip() - } - - b := NewIntegrationTestBuilder( - IntegrationTestConfig{ - T: t, - TxtarString: files, - BaseCfg: cfg, - }, - ) +`, test.base, test.uglyURLs, test.canonifyURLs, test.file, test.slug, test.url) - b.Build() + b := Test(t, files) s := b.H.Sites[0] c.Assert(len(s.RegularPages()), qt.Equals, 1) p := s.RegularPages()[0] @@ -117,7 +102,10 @@ output: ["HTML"] } func TestRelativeURLInFrontMatter(t *testing.T) { - config := ` + t.Parallel() + + files := ` +-- hugo.toml -- baseURL = "https://example.com" defaultContentLanguage = "en" defaultContentLanguageInSubdir = false @@ -129,26 +117,54 @@ contentDir = "content/en" [Languages.nn] weight = 20 contentDir = "content/nn" +-- layouts/_default/single.html -- +Single: {{ .Title }}|Hello|{{ .Lang }}|RelPermalink: {{ .RelPermalink }}|Permalink: {{ .Permalink }}| +-- layouts/_default/list.html -- +List Page 1|{{ .Title }}|Hello|{{ .Permalink }}| +-- content/en/blog/page1.md -- +--- +title: "A page" +url: "myblog/p1/" +--- -` +Some content. +-- content/en/blog/page2.md -- +--- +title: "A page" +url: "../../../../../myblog/p2/" +--- + +Some content. +-- content/en/blog/page3.md -- +--- +title: "A page" +url: "../myblog/../myblog/p3/" +--- - pageTempl := `--- +Some content. +-- content/en/blog/_index.md -- +--- title: "A page" -url: %q +url: "this-is-my-english-blog" --- Some content. -` +-- content/nn/blog/page1.md -- +--- +title: "A page" +url: "myblog/p1/" +--- - b := newTestSitesBuilder(t).WithConfigFile("toml", config) - b.WithContent("content/en/blog/page1.md", fmt.Sprintf(pageTempl, "myblog/p1/")) - b.WithContent("content/en/blog/page2.md", fmt.Sprintf(pageTempl, "../../../../../myblog/p2/")) - b.WithContent("content/en/blog/page3.md", fmt.Sprintf(pageTempl, "../myblog/../myblog/p3/")) - b.WithContent("content/en/blog/_index.md", fmt.Sprintf(pageTempl, "this-is-my-english-blog")) - b.WithContent("content/nn/blog/page1.md", fmt.Sprintf(pageTempl, "myblog/p1/")) - b.WithContent("content/nn/blog/_index.md", fmt.Sprintf(pageTempl, "this-is-my-blog")) +Some content. +-- content/nn/blog/_index.md -- +--- +title: "A page" +url: "this-is-my-blog" +--- - b.Build(BuildCfg{}) +Some content. +` + b := Test(t, files) b.AssertFileContent("public/nn/myblog/p1/index.html", "Single: A page|Hello|nn|RelPermalink: /nn/myblog/p1/|") b.AssertFileContent("public/nn/this-is-my-blog/index.html", "List Page 1|A page|Hello|https://example.com/nn/this-is-my-blog/|") diff --git a/hugolib/page_test.go b/hugolib/page_test.go index b8d56f758..88308120c 100644 --- a/hugolib/page_test.go +++ b/hugolib/page_test.go @@ -1,4 +1,4 @@ -// Copyright 2019 The Hugo Authors. All rights reserved. +// Copyright 2025 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. @@ -27,18 +27,17 @@ import ( "github.com/gohugoio/hugo/markup/asciidocext" "github.com/gohugoio/hugo/markup/rst" "github.com/gohugoio/hugo/tpl" + "github.com/spf13/cast" "github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/common/hashing" "github.com/gohugoio/hugo/common/htime" - "github.com/gohugoio/hugo/common/loggers" "github.com/gohugoio/hugo/resources/page" "github.com/gohugoio/hugo/resources/resource" qt "github.com/frankban/quicktest" - "github.com/gohugoio/hugo/deps" ) const ( @@ -405,29 +404,30 @@ allow = ['^python$', '^rst2html.*', '^asciidoctor$'] // Issue #1076 func TestPageWithDelimiterForMarkdownThatCrossesBorder(t *testing.T) { t.Parallel() - cfg, fs := newTestCfg() - c := qt.New(t) - configs, err := loadTestConfigFromProvider(cfg) - c.Assert(err, qt.IsNil) - - writeSource(t, fs, filepath.Join("content", "simple.md"), simplePageWithSummaryDelimiterAndMarkdownThatCrossesBorder) - - s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Configs: configs}, BuildCfg{SkipRender: true}) + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/simple.md -- +` + simplePageWithSummaryDelimiterAndMarkdownThatCrossesBorder + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{SkipRender: true}, + }, + ).Build() - c.Assert(len(s.RegularPages()), qt.Equals, 1) + b.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 1) - p := s.RegularPages()[0] + p := b.H.Sites[0].RegularPages()[0] - if p.Summary(context.Background()) != template.HTML( - "

The best static site generator.1

") { - t.Fatalf("Got summary:\n%q", p.Summary(context.Background())) - } + b.Assert(p.Summary(context.Background()), qt.Equals, template.HTML( + "

The best static site generator.1

")) cnt := content(p) - if cnt != "

The best static site generator.1

\n
\n
\n
    \n
  1. \n

    Many people say so. ↩︎

    \n
    2. \n
\n
" { - t.Fatalf("Got content:\n%q", cnt) - } + b.Assert(cnt, qt.Equals, "

The best static site generator.1

\n
\n
\n
    \n
  1. \n

    Many people say so. ↩︎

    \n
    2. \n
\n
") } func TestPageDatesTerms(t *testing.T) { @@ -480,11 +480,16 @@ categories: ["cool stuff"] --- ` - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile().WithContent("page.md", pageContent) - b.WithContent("blog/page.md", pageContent) + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/page.md -- +` + pageContent + ` +-- content/blog/page.md -- +` + pageContent + ` +` - b.CreateSites().Build(BuildCfg{}) + b := Test(t, files) b.Assert(len(b.H.Sites), qt.Equals, 1) s := b.H.Sites[0] @@ -508,45 +513,45 @@ categories: ["cool stuff"] func TestPageDatesSections(t *testing.T) { t.Parallel() - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile().WithContent("no-index/page.md", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/no-index/page.md -- --- title: Page date: 2017-01-15 --- -`, "with-index-no-date/_index.md", `--- +-- content/with-index-no-date/_index.md -- +--- title: No Date --- - -`, - // https://github.com/gohugoio/hugo/issues/5854 - "with-index-date/_index.md", `--- +-- content/with-index-date/_index.md -- +--- title: Date date: 2018-01-15 --- - -`, "with-index-date/p1.md", `--- +-- content/with-index-date/p1.md -- +--- title: Date date: 2018-01-15 --- - -`, "with-index-date/p1.md", `--- +-- content/with-index-date/p2.md -- +--- title: Date date: 2018-01-15 --- - -`) - +` for i := 1; i <= 20; i++ { - b.WithContent(fmt.Sprintf("main-section/p%d.md", i), `--- + files += fmt.Sprintf(` +-- content/main-section/p%d.md -- +--- title: Date date: 2012-01-12 --- - -`) +`, i) } - b.CreateSites().Build(BuildCfg{}) + b := Test(t, files) b.Assert(len(b.H.Sites), qt.Equals, 1) s := b.H.Sites[0] @@ -668,18 +673,25 @@ title: "empty" } func TestTableOfContents(t *testing.T) { - c := qt.New(t) - cfg, fs := newTestCfg() - configs, err := loadTestConfigFromProvider(cfg) - c.Assert(err, qt.IsNil) - - writeSource(t, fs, filepath.Join("content", "tocpage.md"), pageWithToC) + t.Parallel() - s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Configs: configs}, BuildCfg{SkipRender: true}) + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/tocpage.md -- +` + pageWithToC + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{SkipRender: true}, + }, + ).Build() - c.Assert(len(s.RegularPages()), qt.Equals, 1) + b.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 1) - p := s.RegularPages()[0] + p := b.H.Sites[0].RegularPages()[0] checkPageContent(t, p, "

For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.

AA

I have no idea, of course, how long it took me to reach the limit of the plain, but at last I entered the foothills, following a pretty little canyon upward toward the mountains. Beside me frolicked a laughing brooklet, hurrying upon its noisy way down to the silent sea. In its quieter pools I discovered many small fish, of four-or five-pound weight I should imagine. In appearance, except as to size and color, they were not unlike the whale of our own seas. As I watched them playing about I discovered, not only that they suckled their young, but that at intervals they rose to the surface to breathe as well as to feed upon certain grasses and a strange, scarlet lichen which grew upon the rocks just above the water line.

AAA

I remember I felt an extraordinary persuasion that I was being played with, that presently, when I was upon the very verge of safety, this mysterious death–as swift as the passage of light–would leap after me from the pit about the cylinder and strike me down. ## BB

BBB

“You’re a great Granser,” he cried delightedly, “always making believe them little marks mean something.”

") checkPageTOC(t, p, "") @@ -809,12 +821,11 @@ Here is the last report for commits in the year 2016. It covers hrev50718-hrev50 // Issue 9383 func TestRenderStringForRegularPageTranslations(t *testing.T) { - c := qt.New(t) - b := newTestSitesBuilder(t) - b.WithLogger(loggers.NewDefault()) + t.Parallel() - b.WithConfigFile("toml", - `baseurl = "https://example.org/" + files := ` +-- hugo.toml -- +baseurl = "https://example.org/" title = "My Site" defaultContentLanguage = "ru" @@ -829,30 +840,22 @@ weight = 2 contentDir = 'content/en' [outputs] -home = ["HTML", "JSON"]`) - - b.WithTemplates("index.html", ` +home = ["HTML", "JSON"] +-- layouts/index.html -- {{- range .Site.Home.Translations -}}

{{- .RenderString "foo" -}}

{{- end -}} {{- range .Site.Home.AllTranslations -}}

{{- .RenderString "bar" -}}

{{- end -}} -`, "_default/single.html", - `{{ .Content }}`, - "index.json", - `{"Title": "My Site"}`, - ) - - b.WithContent( - "ru/a.md", - "", - "en/a.md", - "", - ) - - err := b.BuildE(BuildCfg{}) - c.Assert(err, qt.Equals, nil) +-- layouts/_default/single.html -- +{{ .Content }} +-- layouts/index.json -- +{"Title": "My Site"} +-- content/ru/a.md -- +-- content/en/a.md -- +` + b := Test(t, files) b.AssertFileContent("public/ru/index.html", `

foo

@@ -871,9 +874,11 @@ home = ["HTML", "JSON"]`) // Issue 8919 func TestContentProviderWithCustomOutputFormat(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithLogger(loggers.NewDefault()) - b.WithConfigFile("toml", `baseURL = 'http://example.org/' + t.Parallel() + + files := ` +-- hugo.toml -- +baseURL = 'http://example.org/' title = 'My New Hugo Site' timeout = 600000 # ten minutes in case we want to pause and debug @@ -899,9 +904,9 @@ defaultContentLanguage = "en" notAlternative = true [outputs] - home = ["HTML", "metadata"]`) - - b.WithTemplates("home.metadata.html", `

Translations metadata

+ home = ["HTML", "metadata"] +-- layouts/home.metadata.html -- +

Translations metadata

`) - - b.WithTemplates("_default/baseof.html", ` + +-- layouts/_default/baseof.html -- + {{ block "main" . }}{{ end }} -`) - - b.WithTemplates("_default/home.html", `{{ define "main" }} + +-- layouts/_default/home.html -- +{{ define "main" }}

Translations

-{{ end }}`) - - b.WithContent("en/_index.md", `--- +{{ end }} +-- content/en/_index.md -- +--- title: Title (en) summary: Summary (en) --- Here is some content. -`) - - b.WithContent("zh_CN/_index.md", `--- +-- content/zh_CN/_index.md -- +--- title: Title (zh) summary: Summary (zh) --- 这是一些内容 -`) - - b.Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/index.html", ` @@ -1049,18 +1052,24 @@ summary: Summary (zh) func TestPageWithDate(t *testing.T) { t.Parallel() - c := qt.New(t) - cfg, fs := newTestCfg() - configs, err := loadTestConfigFromProvider(cfg) - c.Assert(err, qt.IsNil) - writeSource(t, fs, filepath.Join("content", "simple.md"), simplePageRFC3339Date) - - s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Configs: configs}, BuildCfg{SkipRender: true}) + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/simple.md -- +` + simplePageRFC3339Date + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{SkipRender: true}, + }, + ).Build() - c.Assert(len(s.RegularPages()), qt.Equals, 1) + b.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 1) - p := s.RegularPages()[0] + p := b.H.Sites[0].RegularPages()[0] d, _ := time.Parse(time.RFC3339, "2013-05-17T16:59:30Z") checkPageDate(t, p, d) @@ -1070,8 +1079,6 @@ func TestPageWithFrontMatterConfig(t *testing.T) { for _, dateHandler := range []string{":filename", ":fileModTime"} { t.Run(fmt.Sprintf("dateHandler=%q", dateHandler), func(t *testing.T) { t.Parallel() - c := qt.New(t) - cfg, fs := newTestCfg() pageTemplate := ` --- @@ -1082,51 +1089,59 @@ lastMod: 2018-02-28 --- Content ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +[frontmatter] +date = ["` + dateHandler + `", "date"] +-- content/section/2012-02-21-noslug.md -- +` + fmt.Sprintf(pageTemplate, 1, "") + ` +-- content/section/2012-02-22-slug.md -- +` + fmt.Sprintf(pageTemplate, 2, "slug: aslug") + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + NeedsOsFS: true, // Needed for fileModTime + }, + ).Build() - cfg.Set("frontmatter", map[string]any{ - "date": []string{dateHandler, "date"}, - }) - configs, err := loadTestConfigFromProvider(cfg) - c.Assert(err, qt.IsNil) - - c1 := filepath.Join("content", "section", "2012-02-21-noslug.md") - c2 := filepath.Join("content", "section", "2012-02-22-slug.md") - - writeSource(t, fs, c1, fmt.Sprintf(pageTemplate, 1, "")) - writeSource(t, fs, c2, fmt.Sprintf(pageTemplate, 2, "slug: aslug")) - - c1fi, err := fs.Source.Stat(c1) - c.Assert(err, qt.IsNil) - c2fi, err := fs.Source.Stat(c2) - c.Assert(err, qt.IsNil) - - b := newTestSitesBuilderFromDepsCfg(t, deps.DepsCfg{Fs: fs, Configs: configs}).WithNothingAdded() - b.Build(BuildCfg{SkipRender: true}) - - c.Assert(len(b.H.Sites), qt.Equals, 1) s := b.H.Sites[0] - c.Assert(len(s.RegularPages()), qt.Equals, 2) + b.Assert(len(s.RegularPages()), qt.Equals, 2) noSlug := s.RegularPages()[0] slug := s.RegularPages()[1] - c.Assert(noSlug.Lastmod().Day(), qt.Equals, 28) + b.Assert(noSlug.Lastmod().Day(), qt.Equals, 28) switch strings.ToLower(dateHandler) { case ":filename": - c.Assert(noSlug.Date().IsZero(), qt.Equals, false) - c.Assert(slug.Date().IsZero(), qt.Equals, false) - c.Assert(noSlug.Date().Year(), qt.Equals, 2012) - c.Assert(slug.Date().Year(), qt.Equals, 2012) - c.Assert(noSlug.Slug(), qt.Equals, "noslug") - c.Assert(slug.Slug(), qt.Equals, "aslug") + b.Assert(noSlug.Date().IsZero(), qt.Equals, false) + b.Assert(slug.Date().IsZero(), qt.Equals, false) + b.Assert(noSlug.Date().Year(), qt.Equals, 2012) + b.Assert(slug.Date().Year(), qt.Equals, 2012) + b.Assert(noSlug.Slug(), qt.Equals, "noslug") + b.Assert(slug.Slug(), qt.Equals, "aslug") case ":filemodtime": - c.Assert(noSlug.Date().Year(), qt.Equals, c1fi.ModTime().Year()) - c.Assert(slug.Date().Year(), qt.Equals, c2fi.ModTime().Year()) + // For fileModTime, we need to get the actual file mod time. + // The IntegrationTestBuilder creates a temporary directory. + // We need to get the path to the created files. + // The `b.Fs` field gives access to the file system. + c1Path := filepath.Join(b.Cfg.WorkingDir, "content", "section", "2012-02-21-noslug.md") + c2Path := filepath.Join(b.Cfg.WorkingDir, "content", "section", "2012-02-22-slug.md") + + c1fi, err := b.fs.Source.Stat(c1Path) + b.Assert(err, qt.IsNil) + c2fi, err := b.fs.Source.Stat(c2Path) + b.Assert(err, qt.IsNil) + + b.Assert(noSlug.Date().Year(), qt.Equals, c1fi.ModTime().Year()) + b.Assert(slug.Date().Year(), qt.Equals, c2fi.ModTime().Year()) fallthrough default: - c.Assert(noSlug.Slug(), qt.Equals, "") - c.Assert(slug.Slug(), qt.Equals, "aslug") + b.Assert(noSlug.Slug(), qt.Equals, "") + b.Assert(slug.Slug(), qt.Equals, "aslug") } }) @@ -1210,11 +1225,11 @@ func TestWordCount(t *testing.T) { func TestPagePaths(t *testing.T) { t.Parallel() - c := qt.New(t) - siteParmalinksSetting := map[string]string{ - "post": ":year/:month/:day/:title/", - } + siteParmalinksSetting := ` +[permalinks] +post = ":year/:month/:day/:title/" +` tests := []struct { content string @@ -1222,30 +1237,45 @@ func TestPagePaths(t *testing.T) { hasPermalink bool expected string }{ - {simplePage, "post/x.md", false, "post/x.html"}, - {simplePageWithURL, "post/x.md", false, "simple/url/index.html"}, - {simplePageWithSlug, "post/x.md", false, "post/simple-slug.html"}, - {simplePageWithDate, "post/x.md", true, "2013/10/15/simple/index.html"}, - {UTF8Page, "post/x.md", false, "post/x.html"}, - {UTF8PageWithURL, "post/x.md", false, "ラーメン/url/index.html"}, - {UTF8PageWithSlug, "post/x.md", false, "post/ラーメン-slug.html"}, - {UTF8PageWithDate, "post/x.md", true, "2013/10/15/ラーメン/index.html"}, + {simplePage, "post/x.md", false, "/post/x/"}, + {simplePageWithURL, "post/x.md", false, "/simple/url/"}, + {simplePageWithSlug, "post/x.md", false, "/post/simple-slug/"}, + {simplePageWithDate, "post/x.md", true, "/2013/10/15/simple/"}, + {UTF8Page, "post/x.md", false, "/post/x/"}, + {UTF8PageWithURL, "post/x.md", false, "/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3/url/"}, + {UTF8PageWithSlug, "post/x.md", false, "/post/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3-slug/"}, + {UTF8PageWithDate, "post/x.md", true, "/2013/10/15/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3/"}, } - for _, test := range tests { - cfg, fs := newTestCfg() - configs, err := loadTestConfigFromProvider(cfg) - c.Assert(err, qt.IsNil) - - if test.hasPermalink { - cfg.Set("permalinks", siteParmalinksSetting) - } + for i, test := range tests { + test := test + t.Run(fmt.Sprintf("Test%d", i), func(t *testing.T) { + t.Parallel() - writeSource(t, fs, filepath.Join("content", filepath.FromSlash(test.path)), test.content) + configContent := `baseURL = "http://example.com/"` + if test.hasPermalink { + configContent += siteParmalinksSetting + } - s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Configs: configs}, BuildCfg{SkipRender: true}) - c.Assert(len(s.RegularPages()), qt.Equals, 1) + files := ` +-- hugo.toml -- +` + configContent + ` +-- content/` + test.path + ` -- +` + test.content + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{SkipRender: true}, + }, + ).Build() + s := b.H.Sites[0] + b.Assert(len(s.RegularPages()), qt.Equals, 1) + p := s.RegularPages()[0] + b.Assert(p.RelPermalink(), qt.Equals, test.expected) + }) } } @@ -1417,82 +1447,82 @@ Rotate(language): {{ with .Rotate "language" }}{{ range . }}{{ template "printp" func TestChompBOM(t *testing.T) { t.Parallel() - c := qt.New(t) const utf8BOM = "\xef\xbb\xbf" - cfg, fs := newTestCfg() - configs, err := loadTestConfigFromProvider(cfg) - c.Assert(err, qt.IsNil) - - writeSource(t, fs, filepath.Join("content", "simple.md"), utf8BOM+simplePage) - - s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Configs: configs}, BuildCfg{SkipRender: true}) + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/simple.md -- +` + utf8BOM + simplePage + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{SkipRender: true}, + }, + ).Build() - c.Assert(len(s.RegularPages()), qt.Equals, 1) + b.Assert(len(b.H.Sites[0].RegularPages()), qt.Equals, 1) - p := s.RegularPages()[0] + p := b.H.Sites[0].RegularPages()[0] checkPageTitle(t, p, "Simple") } // https://github.com/gohugoio/hugo/issues/5381 func TestPageManualSummary(t *testing.T) { - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile() + t.Parallel() - b.WithContent("page-md-shortcode.md", `--- + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- content/page-md-shortcode.md -- +--- title: "Hugo" --- This is a {{< sc >}}. Content. -`) - - // https://github.com/gohugoio/hugo/issues/5464 - b.WithContent("page-md-only-shortcode.md", `--- +-- content/page-md-only-shortcode.md -- +--- title: "Hugo" --- {{< sc >}} {{< sc >}} -`) - - b.WithContent("page-md-shortcode-same-line.md", `--- +-- content/page-md-shortcode-same-line.md -- +--- title: "Hugo" --- This is a {{< sc >}}Same line. -`) - - b.WithContent("page-md-shortcode-same-line-after.md", `--- +-- content/page-md-shortcode-same-line-after.md -- +--- title: "Hugo" --- Summary{{< sc >}} -`) - - b.WithContent("page-org-shortcode.org", `#+TITLE: T1 +-- content/page-org-shortcode.org -- +#+TITLE: T1 #+AUTHOR: A1 #+DESCRIPTION: D1 This is a {{< sc >}}. # more Content. -`) - - b.WithContent("page-org-variant1.org", `#+TITLE: T1 +-- content/page-org-variant1.org -- +#+TITLE: T1 Summary. # more Content. -`) - - b.WithTemplatesAdded("layouts/shortcodes/sc.html", "a shortcode") - b.WithTemplatesAdded("layouts/_default/single.html", ` +-- layouts/shortcodes/sc.html -- +a shortcode +-- layouts/_default/single.html -- SUMMARY:{{ .Summary }}:END -------------------------- CONTENT:{{ .Content }} -`) - - b.CreateSites().Build(BuildCfg{}) +` + b := Test(t, files) b.AssertFileContent("public/page-md-shortcode/index.html", "SUMMARY:

This is a a shortcode.

:END", @@ -1525,18 +1555,23 @@ CONTENT:{{ .Content }} } func TestHomePageWithNoTitle(t *testing.T) { - b := newTestSitesBuilder(t).WithConfigFile("toml", ` + t.Parallel() + + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" title = "Site Title" -`) - b.WithTemplatesAdded("index.html", "Title|{{ with .Title }}{{ . }}{{ end }}|") - b.WithContent("_index.md", `--- +-- layouts/index.html -- +Title|{{ with .Title }}{{ . }}{{ end }}| +-- content/_index.md -- +--- description: "No title for you!" --- Content. -`) +` + b := Test(t, files) - b.Build(BuildCfg{}) b.AssertFileContent("public/index.html", "Title||") } @@ -1678,25 +1713,33 @@ Single: {{ .Title}}|{{ .RelPermalink }}|{{ .Path }}| func TestScratch(t *testing.T) { t.Parallel() - b := newTestSitesBuilder(t) - b.WithSimpleConfigFile().WithTemplatesAdded("index.html", ` + files := ` +-- hugo.toml -- +baseURL = "http://example.com/" +-- layouts/index.html -- {{ .Scratch.Set "b" "bv" }} B: {{ .Scratch.Get "b" }} -`, - "shortcodes/scratch.html", ` +-- layouts/shortcodes/scratch.html -- {{ .Scratch.Set "c" "cv" }} C: {{ .Scratch.Get "c" }} -`, - ) - - b.WithContentAdded("scratchme.md", ` +-- layouts/_default/single.html -- +{{ .Content }} +-- content/scratchme.md -- --- title: Scratch Me! --- {{< scratch >}} -`) - b.Build(BuildCfg{}) +` + b, err := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{}, + }, + ).BuildE() + + b.Assert(err, qt.IsNil) b.AssertFileContent("public/index.html", "B: bv") b.AssertFileContent("public/scratchme/index.html", "C: cv") @@ -1731,16 +1774,14 @@ c: {{ .Scratch.Get "c" }} func TestPageParam(t *testing.T) { t.Parallel() - b := newTestSitesBuilder(t).WithConfigFile("toml", ` - + files := ` +-- hugo.toml -- baseURL = "https://example.org" [params] [params.author] name = "Kurt Vonnegut" - -`) - b.WithTemplatesAdded("index.html", ` +-- layouts/index.html -- {{ $withParam := .Site.GetPage "withparam" }} {{ $noParam := .Site.GetPage "noparam" }} @@ -1751,32 +1792,31 @@ Author name page string: {{ $withStringParam.Param "author.name" }}| Author page string: {{ $withStringParam.Param "author" }}| Author site config: {{ $noParam.Param "author.name" }} -`, - ) - - b.WithContent("withparam.md", ` +-- content/withparam.md -- +++ title = "With Param!" [author] name = "Ernest Miller Hemingway" +++ - -`, - - "noparam.md", ` +-- content/noparam.md -- --- title: "No Param!" --- -`, "withstringparam.md", ` +-- content/withstringparam.md -- +++ title = "With string Param!" author = "Jo Nesbø" +++ - -`) - b.Build(BuildCfg{}) +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{}, + }, + ).Build() b.AssertFileContent("public/index.html", "Author page: Ernest Miller Hemingway", @@ -1788,28 +1828,6 @@ author = "Jo Nesbø" func TestGoldmark(t *testing.T) { t.Parallel() - b := newTestSitesBuilder(t).WithConfigFile("toml", ` -baseURL = "https://example.org" - -[markup] -defaultMarkdownHandler="goldmark" -[markup.goldmark] -[markup.goldmark.renderer] -unsafe = false -[markup.highlight] -noClasses=false - - -`) - b.WithTemplatesAdded("_default/single.html", ` -Title: {{ .Title }} -ToC: {{ .TableOfContents }} -Content: {{ .Content }} - -`, "shortcodes/t.html", `T-SHORT`, "shortcodes/s.html", `## Code -{{ .Inner }} -`) - content := ` +++ title = "A Page!" @@ -1839,9 +1857,36 @@ Link with URL as text ` content = strings.ReplaceAll(content, "$$$", "```") - b.WithContent("page.md", content) + files := ` +-- hugo.toml -- +baseURL = "https://example.org" - b.Build(BuildCfg{}) +[markup] +defaultMarkdownHandler="goldmark" +[markup.goldmark] +[markup.goldmark.renderer] +unsafe = false +[markup.highlight] +noClasses=false +-- layouts/_default/single.html -- +Title: {{ .Title }} +ToC: {{ .TableOfContents }} +Content: {{ .Content }} +-- layouts/shortcodes/t.html -- +T-SHORT +-- layouts/shortcodes/s.html -- +## Code +{{ .Inner }} +-- content/page.md -- +` + content + ` +` + b := NewIntegrationTestBuilder( + IntegrationTestConfig{ + T: t, + TxtarString: files, + BuildCfg: BuildCfg{}, + }, + ).Build() b.AssertFileContent("public/page/index.html", `