// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package hugolib import ( "fmt" "path/filepath" "strings" "testing" "github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/identity" qt "github.com/frankban/quicktest" "github.com/gohugoio/hugo/deps" "github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/tpl" ) func TestTemplateLookupOrder(t *testing.T) { var ( fs *hugofs.Fs cfg config.Provider th testHelper ) // Variants base templates: // 1. /-baseof., e.g. list-baseof.. // 2. /baseof. // 3. _default/-baseof., e.g. list-baseof.. // 4. _default/baseof. for _, this := range []struct { name string setup func(t *testing.T) assert func(t *testing.T) }{ { "Variant 1", func(t *testing.T) { writeSource(t, fs, filepath.Join("layouts", "section", "sect1-baseof.html"), `Base: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "section", "sect1.html"), `{{define "main"}}sect{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: sect") }, }, { "Variant 2", func(t *testing.T) { writeSource(t, fs, filepath.Join("layouts", "baseof.html"), `Base: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "index.html"), `{{define "main"}}index{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "index.html"), "Base: index") }, }, { "Variant 3", func(t *testing.T) { writeSource(t, fs, filepath.Join("layouts", "_default", "list-baseof.html"), `Base: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "_default", "list.html"), `{{define "main"}}list{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: list") }, }, { "Variant 4", func(t *testing.T) { writeSource(t, fs, filepath.Join("layouts", "_default", "baseof.html"), `Base: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "_default", "list.html"), `{{define "main"}}list{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: list") }, }, { "Variant 1, theme, use site base", func(t *testing.T) { cfg.Set("theme", "mytheme") writeSource(t, fs, filepath.Join("layouts", "section", "sect1-baseof.html"), `Base: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect-baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "section", "sect1.html"), `{{define "main"}}sect{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: sect") }, }, { "Variant 1, theme, use theme base", func(t *testing.T) { cfg.Set("theme", "mytheme") writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect1-baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "section", "sect1.html"), `{{define "main"}}sect{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base Theme: sect") }, }, { "Variant 4, theme, use site base", func(t *testing.T) { cfg.Set("theme", "mytheme") writeSource(t, fs, filepath.Join("layouts", "_default", "baseof.html"), `Base: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "list.html"), `{{define "main"}}list{{ end }}`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "index.html"), `{{define "main"}}index{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: list") th.assertFileContent(filepath.Join("public", "index.html"), "Base: index") // Issue #3505 }, }, { "Variant 4, theme, use themes base", func(t *testing.T) { cfg.Set("theme", "mytheme") writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "list.html"), `{{define "main"}}list{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base Theme: list") }, }, { // Issue #3116 "Test section list and single template selection", func(t *testing.T) { cfg.Set("theme", "mytheme") writeSource(t, fs, filepath.Join("layouts", "_default", "baseof.html"), `Base: {{block "main" .}}block{{end}}`) // Both single and list template in /SECTION/ writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "sect1", "list.html"), `sect list`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "list.html"), `default list`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "sect1", "single.html"), `sect single`) writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "single.html"), `default single`) // sect2 with list template in /section writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect2.html"), `sect2 list`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "sect list") th.assertFileContent(filepath.Join("public", "sect1", "page1", "index.html"), "sect single") th.assertFileContent(filepath.Join("public", "sect2", "index.html"), "sect2 list") }, }, { // Issue #2995 "Test section list and single template selection with base template", func(t *testing.T) { writeSource(t, fs, filepath.Join("layouts", "_default", "baseof.html"), `Base Default: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "sect1", "baseof.html"), `Base Sect1: {{block "main" .}}block{{end}}`) writeSource(t, fs, filepath.Join("layouts", "section", "sect2-baseof.html"), `Base Sect2: {{block "main" .}}block{{end}}`) // Both single and list + base template in /SECTION/ writeSource(t, fs, filepath.Join("layouts", "sect1", "list.html"), `{{define "main"}}sect1 list{{ end }}`) writeSource(t, fs, filepath.Join("layouts", "_default", "list.html"), `{{define "main"}}default list{{ end }}`) writeSource(t, fs, filepath.Join("layouts", "sect1", "single.html"), `{{define "main"}}sect single{{ end }}`) writeSource(t, fs, filepath.Join("layouts", "_default", "single.html"), `{{define "main"}}default single{{ end }}`) // sect2 with list template in /section writeSource(t, fs, filepath.Join("layouts", "section", "sect2.html"), `{{define "main"}}sect2 list{{ end }}`) }, func(t *testing.T) { th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base Sect1", "sect1 list") th.assertFileContent(filepath.Join("public", "sect1", "page1", "index.html"), "Base Sect1", "sect single") th.assertFileContent(filepath.Join("public", "sect2", "index.html"), "Base Sect2", "sect2 list") // Note that this will get the default base template and not the one in /sect2 -- because there are no // single template defined in /sect2. th.assertFileContent(filepath.Join("public", "sect2", "page2", "index.html"), "Base Default", "default single") }, }, } { this := this t.Run(this.name, func(t *testing.T) { // TODO(bep) there are some function vars need to pull down here to enable => t.Parallel() cfg, fs = newTestCfg() th = newTestHelper(cfg, fs, t) for i := 1; i <= 3; i++ { writeSource(t, fs, filepath.Join("content", fmt.Sprintf("sect%d", i), fmt.Sprintf("page%d.md", i)), `--- title: Template test --- Some content `) } this.setup(t) buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{}) // helpers.PrintFs(s.BaseFs.Layouts.Fs, "", os.Stdout) this.assert(t) }) } } // https://github.com/gohugoio/hugo/issues/4895 func TestTemplateBOM(t *testing.T) { b := newTestSitesBuilder(t).WithSimpleConfigFile() bom := "\ufeff" b.WithTemplatesAdded( "_default/baseof.html", bom+` Base: {{ block "main" . }}base main{{ end }}`, "_default/single.html", bom+`{{ define "main" }}Hi!?{{ end }}`) b.WithContent("page.md", `--- title: "Page" --- Page Content `) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/page/index.html", "Base: Hi!?") } func TestTemplateManyBaseTemplates(t *testing.T) { t.Parallel() b := newTestSitesBuilder(t).WithSimpleConfigFile() numPages := 100 // To get some parallelism pageTemplate := `--- title: "Page %d" layout: "layout%d" --- Content. ` singleTemplate := ` {{ define "main" }}%d{{ end }} ` baseTemplate := ` Base %d: {{ block "main" . }}FOO{{ end }} ` for i := 0; i < numPages; i++ { id := i + 1 b.WithContent(fmt.Sprintf("page%d.md", id), fmt.Sprintf(pageTemplate, id, id)) b.WithTemplates(fmt.Sprintf("_default/layout%d.html", id), fmt.Sprintf(singleTemplate, id)) b.WithTemplates(fmt.Sprintf("_default/layout%d-baseof.html", id), fmt.Sprintf(baseTemplate, id)) } b.Build(BuildCfg{}) for i := 0; i < numPages; i++ { id := i + 1 b.AssertFileContent(fmt.Sprintf("public/page%d/index.html", id), fmt.Sprintf(`Base %d: %d`, id, id)) } } // https://github.com/gohugoio/hugo/issues/6790 func TestTemplateNoBasePlease(t *testing.T) { t.Parallel() b := newTestSitesBuilder(t).WithSimpleConfigFile() b.WithTemplates("_default/list.html", ` {{ define "main" }} Bonjour {{ end }} {{ printf "list" }} `) b.WithTemplates( "_default/single.html", ` {{ printf "single" }} {{ define "main" }} Bonjour {{ end }} `) b.WithContent("blog/p1.md", `--- title: The Page --- `) b.Build(BuildCfg{}) b.AssertFileContent("public/blog/p1/index.html", `single`) b.AssertFileContent("public/blog/index.html", `list`) } // https://github.com/gohugoio/hugo/issues/6816 func TestTemplateBaseWithComment(t *testing.T) { t.Parallel() b := newTestSitesBuilder(t).WithSimpleConfigFile() b.WithTemplatesAdded( "baseof.html", `Base: {{ block "main" . }}{{ end }}`, "index.html", ` {{/* A comment */}} {{ define "main" }} Bonjour {{ end }} `) b.Build(BuildCfg{}) b.AssertFileContent("public/index.html", `Base: Bonjour`) } func TestTemplateLookupSite(t *testing.T) { t.Run("basic", func(t *testing.T) { t.Parallel() b := newTestSitesBuilder(t).WithSimpleConfigFile() b.WithTemplates( "_default/single.html", `Single: {{ .Title }}`, "_default/list.html", `List: {{ .Title }}`, ) createContent := func(title string) string { return fmt.Sprintf(`--- title: %s ---`, title) } b.WithContent( "_index.md", createContent("Home Sweet Home"), "p1.md", createContent("P1")) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/index.html", `List: Home Sweet Home`) b.AssertFileContent("public/p1/index.html", `Single: P1`) }) t.Run("baseof", func(t *testing.T) { t.Parallel() b := newTestSitesBuilder(t).WithDefaultMultiSiteConfig() b.WithTemplatesAdded( "index.html", `{{ define "main" }}Main Home En{{ end }}`, "index.fr.html", `{{ define "main" }}Main Home Fr{{ end }}`, "baseof.html", `Baseof en: {{ block "main" . }}main block{{ end }}`, "baseof.fr.html", `Baseof fr: {{ block "main" . }}main block{{ end }}`, "mysection/baseof.html", `Baseof mysection: {{ block "main" . }}mysection block{{ end }}`, "_default/single.html", `{{ define "main" }}Main Default Single{{ end }}`, "_default/list.html", `{{ define "main" }}Main Default List{{ end }}`, ) b.WithContent("mysection/p1.md", `--- title: My Page --- `) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/en/index.html", `Baseof en: Main Home En`) b.AssertFileContent("public/fr/index.html", `Baseof fr: Main Home Fr`) b.AssertFileContent("public/en/mysection/index.html", `Baseof mysection: Main Default List`) b.AssertFileContent("public/en/mysection/p1/index.html", `Baseof mysection: Main Default Single`) }) } func TestTemplateFuncs(t *testing.T) { b := newTestSitesBuilder(t).WithDefaultMultiSiteConfig() homeTpl := `Site: {{ site.Language.Lang }} / {{ .Site.Language.Lang }} / {{ site.BaseURL }} Sites: {{ site.Sites.First.Home.Language.Lang }} Hugo: {{ hugo.Generator }} ` b.WithTemplatesAdded( "index.html", homeTpl, "index.fr.html", homeTpl, ) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/en/index.html", "Site: en / en / http://example.com/blog", "Sites: en", "Hugo: {"@type":"WebPage","headline":"{{$title}}"} {{/* Action/commands newlines, from Go 1.16, see https://github.com/golang/go/issues/29770 */}} {{ $norway := dict "country" "Norway" "population" "5 millions" "language" "Norwegian" "language_code" "nb" "weather" "freezing cold" "capitol" "Oslo" "largest_city" "Oslo" "currency" "Norwegian krone" "dialing_code" "+47" }} Population in Norway is {{ $norway.population | lower | upper }} `, ) b.Build(BuildCfg{}) b.AssertFileContent("public/index.html", ` Population in Norway is 5 MILLIONS `) } func collectIdentities(set map[identity.Identity]bool, provider identity.Provider) { if ids, ok := provider.(identity.IdentitiesProvider); ok { for _, id := range ids.GetIdentities() { collectIdentities(set, id) } } else { set[provider.GetIdentity()] = true } } func ident(level int) string { return strings.Repeat(" ", level) } func TestPartialInline(t *testing.T) { b := newTestSitesBuilder(t) b.WithContent("p1.md", "") b.WithTemplates( "index.html", ` {{ $p1 := partial "p1" . }} {{ $p2 := partial "p2" . }} P1: {{ $p1 }} P2: {{ $p2 }} {{ define "partials/p1" }}Inline: p1{{ end }} {{ define "partials/p2" }} {{ $value := 32 }} {{ return $value }} {{ end }} `, ) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/index.html", ` P1: Inline: p1 P2: 32`, ) } func TestPartialInlineBase(t *testing.T) { b := newTestSitesBuilder(t) b.WithContent("p1.md", "") b.WithTemplates( "baseof.html", `{{ $p3 := partial "p3" . }}P3: {{ $p3 }} {{ block "main" . }}{{ end }}{{ define "partials/p3" }}Inline: p3{{ end }}`, "index.html", ` {{ define "main" }} {{ $p1 := partial "p1" . }} {{ $p2 := partial "p2" . }} P1: {{ $p1 }} P2: {{ $p2 }} {{ end }} {{ define "partials/p1" }}Inline: p1{{ end }} {{ define "partials/p2" }} {{ $value := 32 }} {{ return $value }} {{ end }} `, ) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/index.html", ` P1: Inline: p1 P2: 32 P3: Inline: p3 `, ) } // https://github.com/gohugoio/hugo/issues/7478 func TestBaseWithAndWithoutDefine(t *testing.T) { b := newTestSitesBuilder(t) b.WithContent("p1.md", "---\ntitle: P\n---\nContent") b.WithTemplates( "_default/baseof.html", ` ::Header Start:{{ block "header" . }}{{ end }}:Header End: ::{{ block "main" . }}Main{{ end }}:: `, "index.html", ` {{ define "header" }} Home Header {{ end }} {{ define "main" }} This is home main {{ end }} `, "_default/single.html", ` {{ define "main" }} This is single main {{ end }} `, ) b.CreateSites().Build(BuildCfg{}) b.AssertFileContent("public/index.html", ` Home Header This is home main `, ) b.AssertFileContent("public/p1/index.html", ` ::Header Start::Header End: This is single main `, ) }