Files
hugo/hugolib/cascade_test.go
T
Joe Mooring 5559263326 common/hmaps: Merge slice-valued module config into site config
When a module provides a config key whose value is a slice (e.g.
cascade or permalinks), and the site config declares the same key as a
map with only a merge strategy marker (_merge = 'deep'), the types do
not match and Params.merge silently dropped the module's value, leaving
the site with no effective cascade or permalink config from the module.

Fix Params.merge so that when the destination value is an empty Params
(IsZero — only the _merge key is present) and the source value is a
non-Params type, the source value is used provided the user-declared
merge strategy is not 'none'. This honours the explicit _merge
directive regardless of the surrounding shallow-merge context.

Closes #13869

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-15 19:50:42 +02:00

601 lines
12 KiB
Go

// 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.
// 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"
"strings"
"testing"
"github.com/gohugoio/hugo/hugolib/sitesmatrix"
qt "github.com/frankban/quicktest"
)
func BenchmarkCascadeTarget(b *testing.B) {
var files strings.Builder
files.WriteString(`
-- content/_index.md --
background = 'yosemite.jpg'
[cascade.target]
kind = '{section,term}'
-- content/posts/_index.md --
-- content/posts/funny/_index.md --
`)
for i := 1; i < 100; i++ {
files.WriteString(fmt.Sprintf("\n-- content/posts/p%d.md --\n", i+1))
}
for i := 1; i < 100; i++ {
files.WriteString(fmt.Sprintf("\n-- content/posts/funny/pf%d.md --\n", i+1))
}
b.Run("Kind", func(b *testing.B) {
cfg := IntegrationTestConfig{
T: b,
TxtarString: files.String(),
}
b.ResetTimer()
for b.Loop() {
b.StopTimer()
builder := NewIntegrationTestBuilder(cfg)
b.StartTimer()
builder.Build()
}
})
}
func TestCascadeBuildOptionsTaxonomies(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
baseURL="https://example.org"
[taxonomies]
tag = "tags"
[[cascade]]
[cascade.build]
render = "never"
list = "never"
publishResources = false
[cascade.target]
path = '/hidden/**'
-- content/p1.md --
---
title: P1
---
-- content/hidden/p2.md --
---
title: P2
tags: [t1, t2]
---
-- layouts/list.html --
List: {{ len .Pages }}|
-- layouts/single.html --
Single: Tags: {{ site.Taxonomies.tags }}|
`
b := Test(t, files)
b.AssertFileContent("public/p1/index.html", "Single: Tags: map[]|")
b.AssertFileContent("public/tags/index.html", "List: 0|")
b.AssertFileExists("public/hidden/p2/index.html", false)
b.AssertFileExists("public/tags/t2/index.html", false)
}
func TestCascadeEditIssue12449(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
baseURL = "https://example.com"
disableKinds = ['sitemap','rss', 'home', 'taxonomy','term']
disableLiveReload = true
-- layouts/list.html --
Title: {{ .Title }}|{{ .Content }}|cascadeparam: {{ .Params.cascadeparam }}|
-- layouts/single.html --
Title: {{ .Title }}|{{ .Content }}|cascadeparam: {{ .Params.cascadeparam }}|
-- content/mysect/_index.md --
---
title: mysect
cascade:
description: descriptionvalue
params:
cascadeparam: cascadeparamvalue
---
mysect-content|
-- content/mysect/p1/index.md --
---
slug: p1
---
p1-content|
-- content/mysect/subsect/_index.md --
---
slug: subsect
---
subsect-content|
`
b := TestRunning(t, files)
// Make the cascade set the title.
b.EditFileReplaceAll("content/mysect/_index.md", "description: descriptionvalue", "title: cascadetitle").Build()
b.AssertFileContent("public/mysect/subsect/index.html", "Title: cascadetitle|")
// Edit cascade title.
b.EditFileReplaceAll("content/mysect/_index.md", "title: cascadetitle", "title: cascadetitle-edit").Build()
b.AssertFileContent("public/mysect/subsect/index.html", "Title: cascadetitle-edit|")
// Revert title change.
// The step below failed in #12449.
b.EditFileReplaceAll("content/mysect/_index.md", "title: cascadetitle-edit", "description: descriptionvalue").Build()
b.AssertFileContent("public/mysect/subsect/index.html", "Title: |")
}
func TestCascadeIssue12172(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['rss','sitemap','taxonomy','term']
[[cascade]]
headless = true
[cascade.target]
path = '/s1**'
-- content/s1/p1.md --
---
title: p1
---
-- layouts/single.html --
{{ .Title }}|
-- layouts/list.html --
{{ .Title }}|
`
b := Test(t, files)
b.AssertFileExists("public/index.html", true)
b.AssertFileExists("public/s1/index.html", false)
b.AssertFileExists("public/s1/p1/index.html", false)
}
// Issue 12594.
func TestCascadeOrder(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['rss','sitemap','taxonomy','term', 'home']
-- content/_index.md --
---
title: Home
cascade:
- target:
path: "**"
params:
background: yosemite.jpg
- target:
params:
background: goldenbridge.jpg
---
-- content/p1.md --
---
title: p1
---
-- layouts/single.html --
Background: {{ .Params.background }}|
-- layouts/list.html --
{{ .Title }}|
`
for range 10 {
b := Test(t, files)
b.AssertFileContent("public/p1/index.html", "Background: yosemite.jpg")
}
}
// Issue #12465.
func TestCascadeOverlap(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['home','rss','sitemap','taxonomy','term']
-- layouts/list.html --
{{ .Title }}
-- layouts/single.html --
{{ .Title }}
-- content/s/_index.md --
---
title: s
cascade:
build:
render: never
---
-- content/s/p1.md --
---
title: p1
---
-- content/sx/_index.md --
---
title: sx
---
-- content/sx/p2.md --
---
title: p2
---
`
b := Test(t, files)
b.AssertFileExists("public/s/index.html", false)
b.AssertFileExists("public/s/p1/index.html", false)
b.AssertFileExists("public/sx/index.html", true) // failing
b.AssertFileExists("public/sx/p2/index.html", true) // failing
}
func TestCascadeGotmplIssue13743(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['home','rss','section','sitemap','taxonomy','term']
[cascade.params]
foo = 'bar'
[cascade.target]
path = '/p1'
-- content/_content.gotmpl --
{{ .AddPage (dict "title" "p1" "path" "p1") }}
-- layouts/all.html --
{{ .Title }}|{{ .Params.foo }}
`
b := Test(t, files)
b.AssertFileContent("public/p1/index.html", "p1|bar") // actual content is "p1|"
}
func TestSitesMatrixCascadeConfig(t *testing.T) {
files := `
-- hugo.toml --
disableKinds = ["taxonomy", "term", "rss", "sitemap"]
[languages]
[languages.en]
weight = 1
[languages.nn]
weight = 2
[languages.sv]
weight = 3
[versions]
[versions."v1.0.0"]
[versions."v2.0.0"]
[versions."v2.1.0"]
[roles]
[roles.guest]
[roles.member]
[cascade]
[cascade.sites.matrix]
languages = ["en"]
versions = ["v2**"]
roles = ["member"]
[cascade.sites.complements]
languages = ["nn"]
versions = ["v1.0.*"]
roles = ["guest"]
-- content/_index.md --
---
title: "Home"
sites:
matrix:
roles: ["guest"]
---
-- layouts/all.html --
All.
`
b := Test(t, files)
s0 := b.H.sitesVersionsRolesMap[sitesmatrix.Vector{0, 0, 0}] // en, v2.1.0, guest
b.Assert(s0.home, qt.IsNotNil)
b.Assert(s0.home.File(), qt.IsNotNil)
b.Assert(s0.language.Name(), qt.Equals, "en")
b.Assert(s0.version.Name(), qt.Equals, "v2.1.0")
b.Assert(s0.role.Name(), qt.Equals, "guest")
s0Pconfig := s0.Home().(*pageState).m.pageConfigSource
b.Assert(s0Pconfig.SitesMatrix.Vectors(), qt.DeepEquals, []sitesmatrix.Vector{{0, 0, 0}, {0, 1, 0}}) // en, v2.1.0, guest + en, v2.0.0, guest
s1 := b.H.sitesVersionsRolesMap[sitesmatrix.Vector{1, 2, 0}]
b.Assert(s1.home, qt.IsNotNil)
b.Assert(s1.home.File(), qt.IsNil)
b.Assert(s1.language.Name(), qt.Equals, "nn")
b.Assert(s1.version.Name(), qt.Equals, "v1.0.0")
b.Assert(s1.role.Name(), qt.Equals, "guest")
s1Pconfig := s1.Home().(*pageState).m.pageConfigSource
b.Assert(s1Pconfig.SitesMatrix.HasVector(sitesmatrix.Vector{1, 2, 0}), qt.IsTrue) // nn, v1.0.0, guest
// Every site needs a home page. This matrix adds the missing ones, (3 * 3 * 2) - 2 = 16
b.Assert(s1Pconfig.SitesMatrix.LenVectors(), qt.Equals, 16)
}
func TestCascadeBundledPage(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
baseURL = "https://example.org"
-- content/_index.md --
---
title: Home
cascade:
params:
p1: v1
---
-- content/b1/index.md --
---
title: b1
---
-- content/b1/p2.md --
---
title: p2
---
-- layouts/all.html --
Title: {{ .Title }}|p1: {{ .Params.p1 }}|
{{ range .Resources }}
Resource: {{ .Name }}|p1: {{ .Params.p1 }}|
{{ end }}
`
b := Test(t, files)
b.AssertFileContent("public/b1/index.html", "Title: b1|p1: v1|", "Resource: p2.md|p1: v1|")
}
// Issue 14310
// Issue 14321
func TestCascadeIssue14310(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['home', 'rss', 'sitemap', 'taxonomy', 'term']
defaultContentLanguage = 'en'
defaultContentLanguageInSubdir = true
[languages.en]
weight = 1
[languages.de]
weight = 2
[[cascade]]
[cascade.params]
size = 'medium'
[cascade.target]
kind = 'page'
-- layouts/all.html --
|color: {{ .Params.color }}|size: {{ .Params.size }}|
-- content/s1/_index.de.md --
---
title: s1 (de)
cascade:
params:
color: red (de)
---
-- content/s1/_index.en.md --
---
title: s1 (en)
cascade:
params:
color: red (en)
---
-- content/s1/p1.de.md --
---
title: p1 (de)
---
-- content/s1/p1.en.md --
---
title: p1 (en)
---
`
b := Test(t, files)
b.AssertFileContent("public/en/s1/p1/index.html", "|color: red (en)|size: medium|") // fails: file contains "|color: red (en)|size: |"
b.AssertFileContent("public/de/s1/p1/index.html", "|color: red (de)|size: medium|")
}
// Issue 14409
func TestCascadeDraftTrue14409(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['rss','taxonomy','term']
defaultContentLanguage = 'en'
defaultContentLanguageInSubdir = true
[languages.en]
weight = 1
[languages.de]
weight = 2
[[cascade]]
draft = true
[cascade.target.sites.matrix]
languages = ['en']
-- content/_index.en.md --
---
title: home en
draft: false
---
-- content/_index.de.md --
---
title: home de
draft: false
---
-- content/s1/_index.en.md --
---
title: s1 en
draft: false
---
-- content/s1/_index.de.md --
---
title: s1 de
draft: false
---
-- content/s1/p1.en.md --
---
title: p1 en
---
-- content/s1/p1.de.md --
---
title: p1 de
---
-- layouts/all.html --
{{ .Title }}
`
b := Test(t, files)
b.AssertFileExists("public/de/index.html", true)
b.AssertFileExists("public/en/index.html", true)
b.AssertFileExists("public/de/s1/index.html", true)
b.AssertFileExists("public/en/s1/index.html", true)
b.AssertFileExists("public/de/s1/p1/index.html", true)
b.AssertFileExists("public/en/s1/p1/index.html", false)
}
// Issue 14627
func TestRegularPageCascadeToSelf(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['home','rss','sitemap','taxonomy','term']
environment = 'pubweb'
-- content/s1/_index.md --
---
title: s1
cascade:
target:
environment: pubweb
build:
list: never
render: never
publishResources: false
---
-- content/s1/p1.md --
---
title: p1
---
-- content/s2/_index.md --
---
title: s2
---
-- content/s2/p2.md --
---
title: p2
cascade:
target:
environment: pubweb
build:
list: never
render: never
publishResources: false
---
-- content/s2/p3/index.md --
---
title: p3
cascade:
target:
environment: pubweb
build:
list: never
render: never
publishResources: false
---
-- layouts/all.html --
{{ .Title }}|
`
b := Test(t, files)
b.AssertFileExists("public/s1/index.html", false)
b.AssertFileExists("public/s1/p1/index.html", false)
b.AssertFileExists("public/s2/index.html", true)
b.AssertFileExists("public/s2/p2/index.html", false)
b.AssertFileExists("public/s2/p3/index.html", false)
}
// Issue 13869
func TestCascadeSliceFromModule13869(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
disableKinds = ['page','rss','section','sitemap','taxonomy','term']
theme = 'foo'
[cascade]
_merge = 'deep'
-- content/_index.md --
---
title: home
---
-- layouts/home.html --
color: {{ .Params.color }}
-- themes/foo/hugo.toml --
[[cascade]]
[cascade.params]
color = 'red'
`
b := Test(t, files)
b.AssertFileContent("public/index.html", "color: red")
}
// Issue 14848
func TestCascadeParamsLangIssue14848(t *testing.T) {
t.Parallel()
files := `
-- hugo.toml --
baseURL = "https://example.org"
disableKinds = ['rss','sitemap','taxonomy','term']
-- content/_index.md --
---
title: Home
cascade:
params:
lang: en
---
-- content/p1.md --
---
title: p1
---
-- layouts/all.html --
{{ .Title }}|lang: {{ .Params.lang }}|
`
b := Test(t, files)
b.AssertFileContent("public/p1/index.html", "p1|lang: en|")
}