summaryrefslogtreecommitdiffstats
path: root/hugolib/template_test.go
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-01-15 15:59:56 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-01-22 09:39:49 +0100
commitc6d650c8c8b22fdc7ddedc1e42a3ca698e1390d6 (patch)
tree5a189224439d654a9ef7517b0c702e781874b45a /hugolib/template_test.go
parent8585b388d27abde1ab6b6c63ad6addf4066ec8dd (diff)
tpl/tplimpl: Rework template management to get rid of concurrency issues
This more or less completes the simplification of the template handling code in Hugo started in v0.62. The main motivation was to fix a long lasting issue about a crash in HTML content files without front matter. But this commit also comes with a big functional improvement. As we now have moved the base template evaluation to the build stage we now use the same lookup rules for `baseof` as for `list` etc. type of templates. This means that in this simple example you can have a `baseof` template for the `blog` section without having to duplicate the others: ``` layouts ├── _default │   ├── baseof.html │   ├── list.html │   └── single.html └── blog └── baseof.html ``` Also, when simplifying code, you often get rid of some double work, as shown in the "site building" benchmarks below. These benchmarks looks suspiciously good, but I have repeated the below with ca. the same result. Compared to master: ``` name old time/op new time/op delta SiteNew/Bundle_with_image-16 13.1ms ± 1% 10.5ms ± 1% -19.34% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 13.0ms ± 0% 10.7ms ± 1% -18.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 46.4ms ± 2% 43.1ms ± 1% -7.15% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 52.2ms ± 2% 47.8ms ± 1% -8.30% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 77.9ms ± 1% 70.9ms ± 1% -9.01% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 43.0ms ± 0% 37.2ms ± 1% -13.54% (p=0.029 n=4+4) SiteNew/Page_collections-16 58.2ms ± 1% 52.4ms ± 1% -9.95% (p=0.029 n=4+4) name old alloc/op new alloc/op delta SiteNew/Bundle_with_image-16 3.81MB ± 0% 2.22MB ± 0% -41.70% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 3.60MB ± 0% 2.01MB ± 0% -44.20% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 19.3MB ± 1% 14.1MB ± 0% -26.91% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 70.7MB ± 0% 69.0MB ± 0% -2.40% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 37.1MB ± 0% 31.2MB ± 0% -15.94% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 17.6MB ± 0% 10.6MB ± 0% -39.92% (p=0.029 n=4+4) SiteNew/Page_collections-16 25.9MB ± 0% 21.2MB ± 0% -17.99% (p=0.029 n=4+4) name old allocs/op new allocs/op delta SiteNew/Bundle_with_image-16 52.3k ± 0% 26.1k ± 0% -50.18% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 52.3k ± 0% 26.1k ± 0% -50.16% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 336k ± 1% 269k ± 0% -19.90% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 422k ± 0% 395k ± 0% -6.43% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 401k ± 0% 313k ± 0% -21.79% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 247k ± 0% 143k ± 0% -42.17% (p=0.029 n=4+4) SiteNew/Page_collections-16 282k ± 0% 207k ± 0% -26.55% (p=0.029 n=4+4) ``` Fixes #6716 Fixes #6760 Fixes #6768 Fixes #6778
Diffstat (limited to 'hugolib/template_test.go')
-rw-r--r--hugolib/template_test.go172
1 files changed, 172 insertions, 0 deletions
diff --git a/hugolib/template_test.go b/hugolib/template_test.go
index 80a703801..e75bda790 100644
--- a/hugolib/template_test.go
+++ b/hugolib/template_test.go
@@ -244,6 +244,178 @@ Page Content
}
+func TestTemplateLateTemplates(t *testing.T) {
+ t.Parallel()
+ b := newTestSitesBuilder(t).WithSimpleConfigFile().Running()
+
+ numPages := 500 // To get some parallelism
+ homeTempl := `
+Len RegularPages: {{ len site.RegularPages }}
+{{ range site.RegularPages }}
+Link: {{ .RelPermalink }} Len Content: {{ len .Content }}
+{{ end }}
+`
+ pageTemplate := `<!doctype html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>{{ .RelPermalink }}</title>
+ <meta name="description" content="The HTML5 Herald">
+ <meta name="author" content="SitePoint">
+ <link rel="stylesheet" href="css/styles.css?v=1.0">
+</head>
+<body>
+ <h1>{{ .RelPermalink }}</h1>
+ <p>Shortcode: {{< shortcode >}}</p>
+ <p>Partial: {{ partial "mypartial.html" . }}</p>
+ <script src="js/scripts.js"></script>
+</body>
+</html>
+`
+
+ b.WithTemplatesAdded(
+ "index.html", homeTempl,
+ "partials/mypartial.html", `this my partial`,
+ )
+
+ // Make sure we get some parallelism.
+ for i := 0; i < numPages; i++ {
+ b.WithContent(fmt.Sprintf("page%d.html", i+1), pageTemplate)
+ }
+
+ b.Build(BuildCfg{})
+
+ b.AssertFileContent("public/index.html", fmt.Sprintf(`
+Len RegularPages: %d
+Link: /page3/ Len Content: 0
+Link: /page22/ Len Content: 0
+`, numPages))
+
+ for i := 0; i < numPages; i++ {
+ b.AssertFileContent(fmt.Sprintf("public/page%d/index.html", i+1),
+ fmt.Sprintf(`<title>/page%d/</title>`, i+1),
+ `<p>Shortcode: Shortcode: Hello</p>`,
+ "<p>Partial: this my partial</p>",
+ )
+ }
+
+ b.EditFiles(
+ "layouts/partials/mypartial.html", `this my changed partial`,
+ "layouts/index.html", (homeTempl + "CHANGED"),
+ )
+ for i := 0; i < 5; i++ {
+ b.EditFiles(fmt.Sprintf("content/page%d.html", i+1), pageTemplate+"CHANGED")
+ }
+
+ b.Build(BuildCfg{})
+ b.AssertFileContent("public/index.html", fmt.Sprintf(`
+Len RegularPages: %d
+Link: /page3/ Len Content: 0
+Link: /page2/ Len Content: 0
+CHANGED
+`, numPages))
+ for i := 0; i < 5; i++ {
+ b.AssertFileContent(fmt.Sprintf("public/page%d/index.html", i+1),
+ fmt.Sprintf(`<title>/page%d/</title>`, i+1),
+ `<p>Shortcode: Shortcode: Hello</p>`,
+ "<p>Partial: this my changed partial</p>",
+ "CHANGED",
+ )
+ }
+
+}
+
+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))
+ }
+
+}
+
+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()
generated by cgit v1.2.3 (git 2.25.1) at 2024-08-11 06:33:46 +0000