// Copyright 2017-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. // 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 output import ( "testing" "github.com/gohugoio/hugo/media" "github.com/stretchr/testify/require" ) func TestLayout(t *testing.T) { noExtNoDelimMediaType := media.TextType noExtNoDelimMediaType.Suffix = "" noExtNoDelimMediaType.Delimiter = "" noExtMediaType := media.TextType noExtMediaType.Suffix = "" var ( ampType = Format{ Name: "AMP", MediaType: media.HTMLType, BaseName: "index", } noExtDelimFormat = Format{ Name: "NEM", MediaType: noExtNoDelimMediaType, BaseName: "_redirects", } noExt = Format{ Name: "NEX", MediaType: noExtMediaType, BaseName: "next", } ) for _, this := range []struct { name string d LayoutDescriptor hasTheme bool layoutOverride string tp Format expect []string }{ {"Home", LayoutDescriptor{Kind: "home"}, true, "", ampType, []string{"index.amp.html", "index.html", "_default/list.amp.html", "_default/list.html", "theme/index.amp.html", "theme/index.html"}}, {"Home, french language", LayoutDescriptor{Kind: "home", Lang: "fr"}, true, "", ampType, []string{"index.fr.amp.html", "index.amp.html", "index.fr.html", "index.html", "_default/list.fr.amp.html", "_default/list.amp.html", "_default/list.fr.html", "_default/list.html", "theme/index.fr.amp.html", "theme/index.amp.html", "theme/index.fr.html"}}, {"Home, no ext or delim", LayoutDescriptor{Kind: "home"}, true, "", noExtDelimFormat, []string{"index.nem", "_default/list.nem"}}, {"Home, no ext", LayoutDescriptor{Kind: "home"}, true, "", noExt, []string{"index.nex", "_default/list.nex"}}, {"Page, no ext or delim", LayoutDescriptor{Kind: "page"}, true, "", noExtDelimFormat, []string{"_default/single.nem", "theme/_default/single.nem"}}, {"Section", LayoutDescriptor{Kind: "section", Section: "sect1"}, false, "", ampType, []string{"section/sect1.amp.html", "section/sect1.html"}}, {"Taxonomy", LayoutDescriptor{Kind: "taxonomy", Section: "tag"}, false, "", ampType, []string{"taxonomy/tag.amp.html", "taxonomy/tag.html"}}, {"Taxonomy term", LayoutDescriptor{Kind: "taxonomyTerm", Section: "categories"}, false, "", ampType, []string{"taxonomy/categories.terms.amp.html", "taxonomy/categories.terms.html", "_default/terms.amp.html"}}, {"Page", LayoutDescriptor{Kind: "page"}, true, "", ampType, []string{"_default/single.amp.html", "_default/single.html", "theme/_default/single.amp.html"}}, {"Page with layout", LayoutDescriptor{Kind: "page", Layout: "mylayout"}, false, "", ampType, []string{"_default/mylayout.amp.html", "_default/mylayout.html"}}, {"Page with layout and type", LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype"}, false, "", ampType, []string{"myttype/mylayout.amp.html", "myttype/mylayout.html", "_default/mylayout.amp.html"}}, {"Page with layout and type with subtype", LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype/mysubtype"}, false, "", ampType, []string{"myttype/mysubtype/mylayout.amp.html", "myttype/mysubtype/mylayout.html", "myttype/mylayout.amp.html"}}, {"Page with overridden layout", LayoutDescriptor{Kind: "page", Layout: "mylayout", Type: "myttype"}, false, "myotherlayout", ampType, []string{"myttype/myotherlayout.amp.html", "myttype/myotherlayout.html"}}, // RSS {"RSS Home with theme", LayoutDescriptor{Kind: "home"}, true, "", RSSFormat, []string{"rss.xml", "_default/rss.xml", "theme/rss.xml", "theme/_default/rss.xml", "_internal/_default/rss.xml"}}, {"RSS Section", LayoutDescriptor{Kind: "section", Section: "sect1"}, false, "", RSSFormat, []string{"section/sect1.rss.xml", "_default/rss.xml", "rss.xml", "_internal/_default/rss.xml"}}, {"RSS Taxonomy", LayoutDescriptor{Kind: "taxonomy", Section: "tag"}, false, "", RSSFormat, []string{"taxonomy/tag.rss.xml", "_default/rss.xml", "rss.xml", "_internal/_default/rss.xml"}}, {"RSS Taxonomy term", LayoutDescriptor{Kind: "taxonomyTerm", Section: "tag"}, false, "", RSSFormat, []string{"taxonomy/tag.terms.rss.xml", "_default/rss.xml", "rss.xml", "_internal/_default/rss.xml"}}, {"Home plain text", LayoutDescriptor{Kind: "home"}, true, "", JSONFormat, []string{"_text/index.json.json", "_text/index.json", "_text/_default/list.json.json", "_text/_default/list.json", "_text/theme/index.json.json", "_text/theme/index.json"}}, {"Page plain text", LayoutDescriptor{Kind: "page"}, true, "", JSONFormat, []string{"_text/_default/single.json.json", "_text/_default/single.json", "_text/theme/_default/single.json.json"}}, } { t.Run(this.name, func(t *testing.T) { l := NewLayoutHandler(this.hasTheme) layouts, err := l.For(this.d, this.layoutOverride, this.tp) require.NoError(t, err) require.NotNil(t, layouts) require.True(t, len(layouts) >= len(this.expect)) // Not checking the complete list for now ... require.Equal(t, this.expect, layouts[:len(this.expect)]) if !this.hasTheme { for _, layout := range layouts { require.NotContains(t, layout, "theme") } } }) } l := NewLayoutHandler(false) _, err := l.For(LayoutDescriptor{Kind: "taxonomyTerm", Section: "tag"}, "override", RSSFormat) require.Error(t, err) } func BenchmarkLayout(b *testing.B) { descriptor := LayoutDescriptor{Kind: "taxonomyTerm", Section: "categories"} l := NewLayoutHandler(false) for i := 0; i < b.N; i++ { layouts, err := l.For(descriptor, "", HTMLFormat) require.NoError(b, err) require.NotEmpty(b, layouts) } }