// Copyright 2024 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 paths import ( "path/filepath" "reflect" "testing" "github.com/gohugoio/hugo/hugofs/files" "github.com/gohugoio/hugo/hugolib/sitesmatrix" "github.com/gohugoio/hugo/resources/kinds" qt "github.com/frankban/quicktest" ) func newTestParser() *PathParser { dims := sitesmatrix.NewTestingDimensions([]string{"en", "no", "fr"}, []string{"v1", "v2", "v3", "v1.0.0"}, []string{"admin", "editor", "viewer", "guest"}) return &PathParser{ LanguageIndex: map[string]int{ "no": 0, "en": 1, "fr": 2, }, IsContentExt: func(ext string) bool { return ext == "md" }, IsOutputFormat: func(name, ext string) bool { switch name { case "html", "amp", "csv", "rss": return true } return false }, ConfiguredDimensions: dims, } } func TestParse(t *testing.T) { c := qt.New(t) tests := []struct { name string path string assert func(c *qt.C, p *Path) }{ { "Basic text file", "/a/b.txt", func(c *qt.C, p *Path) { c.Assert(p.Name(), qt.Equals, "b.txt") c.Assert(p.Base(), qt.Equals, "/a/b.txt") c.Assert(p.Container(), qt.Equals, "a") c.Assert(p.Dir(), qt.Equals, "/a") c.Assert(p.Ext(), qt.Equals, "txt") c.Assert(p.IsContent(), qt.IsFalse) }, }, { "Basic text file, upper case", "/A/B.txt", func(c *qt.C, p *Path) { c.Assert(p.Name(), qt.Equals, "b.txt") c.Assert(p.NameNoExt(), qt.Equals, "b") c.Assert(p.NameNoIdentifier(), qt.Equals, "b") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "b") c.Assert(p.Base(), qt.Equals, "/a/b.txt") c.Assert(p.Ext(), qt.Equals, "txt") }, }, { "Basic text file, 1 space in dir", "/a b/c.txt", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a-b/c.txt") }, }, { "Basic text file, 2 spaces in dir", "/a b/c.txt", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a--b/c.txt") }, }, { "Basic text file, 1 space in filename", "/a/b c.txt", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b-c.txt") }, }, { "Basic text file, 2 spaces in filename", "/a/b c.txt", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b--c.txt") }, }, { "Basic text file, mixed case and spaces, unnormalized", "/a/Foo BAR.txt", func(c *qt.C, p *Path) { pp := p.Unnormalized() c.Assert(pp, qt.IsNotNil) c.Assert(pp.BaseNameNoIdentifier(), qt.Equals, "Foo BAR") }, }, { "Basic Markdown file", "/a/b/c.md", func(c *qt.C, p *Path) { c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Type(), qt.Equals, TypeContentSingle) c.Assert(p.IsContent(), qt.IsTrue) c.Assert(p.IsLeafBundle(), qt.IsFalse) c.Assert(p.Name(), qt.Equals, "c.md") c.Assert(p.Base(), qt.Equals, "/a/b/c") c.Assert(p.BaseReTyped("foo"), qt.Equals, "/foo/b/c") c.Assert(p.Section(), qt.Equals, "a") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "c") c.Assert(p.Path(), qt.Equals, "/a/b/c.md") c.Assert(p.Dir(), qt.Equals, "/a/b") c.Assert(p.Container(), qt.Equals, "b") c.Assert(p.ContainerDir(), qt.Equals, "/a/b") }, }, { "Content resource", "/a/b.md", func(c *qt.C, p *Path) { c.Assert(p.Name(), qt.Equals, "b.md") c.Assert(p.Base(), qt.Equals, "/a/b") c.Assert(p.Section(), qt.Equals, "a") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "b") // Reclassify it as a content resource. ModifyPathBundleTypeResource(p) c.Assert(p.Type(), qt.Equals, TypeContentResource) c.Assert(p.IsContent(), qt.IsTrue) c.Assert(p.Name(), qt.Equals, "b.md") c.Assert(p.Base(), qt.Equals, "/a/b.md") }, }, { "No ext", "/a/b", func(c *qt.C, p *Path) { c.Assert(p.Name(), qt.Equals, "b") c.Assert(p.NameNoExt(), qt.Equals, "b") c.Assert(p.Base(), qt.Equals, "/a/b") c.Assert(p.Ext(), qt.Equals, "") }, }, { "No ext, trailing slash", "/a/b/", func(c *qt.C, p *Path) { c.Assert(p.Name(), qt.Equals, "b") c.Assert(p.Base(), qt.Equals, "/a/b") c.Assert(p.Ext(), qt.Equals, "") }, }, { "Identifiers", "/a/b.a.b.no.txt", func(c *qt.C, p *Path) { c.Assert(p.Name(), qt.Equals, "b.a.b.no.txt") c.Assert(p.NameNoIdentifier(), qt.Equals, "b.a.b") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"txt", "no"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{"b", "a", "b"}) c.Assert(p.Base(), qt.Equals, "/a/b.a.b.txt") c.Assert(p.Path(), qt.Equals, "/a/b.a.b.no.txt") c.Assert(p.PathNoLang(), qt.Equals, "/a/b.a.b.txt") c.Assert(p.Ext(), qt.Equals, "txt") c.Assert(p.PathNoIdentifier(), qt.Equals, "/a/b.a.b") }, }, { "Home branch cundle", "/_index.md", func(c *qt.C, p *Path) { c.Assert(p.Identifiers(), qt.DeepEquals, []string{"md"}) c.Assert(p.IsBranchBundle(), qt.IsTrue) c.Assert(p.IsBundle(), qt.IsTrue) c.Assert(p.Base(), qt.Equals, "") c.Assert(p.BaseReTyped("foo"), qt.Equals, "/foo") c.Assert(p.Path(), qt.Equals, "/_index.md") c.Assert(p.Container(), qt.Equals, "") c.Assert(p.ContainerDir(), qt.Equals, "/") }, }, { "Index content file in root", "/a/index.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a") c.Assert(p.BaseReTyped("foo"), qt.Equals, "/foo/a") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "a") c.Assert(p.Container(), qt.Equals, "a") c.Assert(p.Container(), qt.Equals, "a") c.Assert(p.ContainerDir(), qt.Equals, "") c.Assert(p.Dir(), qt.Equals, "/a") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{"index"}) c.Assert(p.Identifiers(), qt.DeepEquals, []string{"md"}) c.Assert(p.IsBranchBundle(), qt.IsFalse) c.Assert(p.IsBundle(), qt.IsTrue) c.Assert(p.IsLeafBundle(), qt.IsTrue) c.Assert(p.Lang(), qt.Equals, "") c.Assert(p.NameNoExt(), qt.Equals, "index") c.Assert(p.NameNoIdentifier(), qt.Equals, "index") c.Assert(p.Section(), qt.Equals, "") }, }, { "Index content file with lang", "/a/b/index.no.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "b") c.Assert(p.BaseReTyped("foo"), qt.Equals, "/foo/b") c.Assert(p.Container(), qt.Equals, "b") c.Assert(p.ContainerDir(), qt.Equals, "/a") c.Assert(p.Dir(), qt.Equals, "/a/b") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"md", "no"}) c.Assert(p.IsBranchBundle(), qt.IsFalse) c.Assert(p.IsBundle(), qt.IsTrue) c.Assert(p.IsLeafBundle(), qt.IsTrue) c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.NameNoExt(), qt.Equals, "index.no") c.Assert(p.NameNoIdentifier(), qt.Equals, "index") c.Assert(p.Path(), qt.Equals, "/a/b/index.no.md") c.Assert(p.PathNoLang(), qt.Equals, "/a/b/index.md") c.Assert(p.Section(), qt.Equals, "a") }, }, { "Index branch content file", "/a/b/_index.no.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "b") c.Assert(p.Container(), qt.Equals, "b") c.Assert(p.ContainerDir(), qt.Equals, "/a") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"md", "no"}) c.Assert(p.IsBranchBundle(), qt.IsTrue) c.Assert(p.IsBundle(), qt.IsTrue) c.Assert(p.IsLeafBundle(), qt.IsFalse) c.Assert(p.NameNoExt(), qt.Equals, "_index.no") }, }, { "Index root no slash", "_index.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Name(), qt.Equals, "_index.md") }, }, { "Index root", "/_index.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Name(), qt.Equals, "_index.md") }, }, { "Index first", "/a/_index.md", func(c *qt.C, p *Path) { c.Assert(p.Section(), qt.Equals, "a") }, }, { "Index text file", "/a/b/index.no.txt", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/index.txt") c.Assert(p.Ext(), qt.Equals, "txt") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"txt", "no"}) c.Assert(p.IsLeafBundle(), qt.IsFalse) c.Assert(p.PathNoIdentifier(), qt.Equals, "/a/b/index") }, }, { "Empty", "", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/") c.Assert(p.Ext(), qt.Equals, "") c.Assert(p.Name(), qt.Equals, "") c.Assert(p.Path(), qt.Equals, "/") }, }, { "Slash", "/", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/") c.Assert(p.Ext(), qt.Equals, "") c.Assert(p.Name(), qt.Equals, "") }, }, { "Trim Leading Slash bundle", "foo/bar/index.no.md", func(c *qt.C, p *Path) { c.Assert(p.Path(), qt.Equals, "/foo/bar/index.no.md") pp := p.TrimLeadingSlash() c.Assert(pp.Path(), qt.Equals, "foo/bar/index.no.md") c.Assert(pp.PathNoLang(), qt.Equals, "foo/bar/index.md") c.Assert(pp.Base(), qt.Equals, "foo/bar") c.Assert(pp.Dir(), qt.Equals, "foo/bar") c.Assert(pp.ContainerDir(), qt.Equals, "foo") c.Assert(pp.Container(), qt.Equals, "bar") c.Assert(pp.BaseNameNoIdentifier(), qt.Equals, "bar") }, }, { "Trim Leading Slash file", "foo/bar.txt", func(c *qt.C, p *Path) { c.Assert(p.Path(), qt.Equals, "/foo/bar.txt") pp := p.TrimLeadingSlash() c.Assert(pp.Path(), qt.Equals, "foo/bar.txt") c.Assert(pp.PathNoLang(), qt.Equals, "foo/bar.txt") c.Assert(pp.Base(), qt.Equals, "foo/bar.txt") c.Assert(pp.Dir(), qt.Equals, "foo") c.Assert(pp.ContainerDir(), qt.Equals, "foo") c.Assert(pp.Container(), qt.Equals, "foo") c.Assert(pp.BaseNameNoIdentifier(), qt.Equals, "bar") }, }, { "File separator", filepath.FromSlash("/a/b/c.txt"), func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/c.txt") c.Assert(p.Ext(), qt.Equals, "txt") c.Assert(p.Name(), qt.Equals, "c.txt") c.Assert(p.Path(), qt.Equals, "/a/b/c.txt") }, }, { "Content data file gotmpl", "/a/b/_content.gotmpl", func(c *qt.C, p *Path) { c.Assert(p.Path(), qt.Equals, "/a/b/_content.gotmpl") c.Assert(p.Ext(), qt.Equals, "gotmpl") c.Assert(p.IsContentData(), qt.IsTrue) }, }, { "Content data file yaml", "/a/b/_content.yaml", func(c *qt.C, p *Path) { c.Assert(p.IsContentData(), qt.IsFalse) }, }, { "Custom identifier", "/a/b/p1._myid_.no.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Custom(), qt.Equals, "myid") }, }, { "Prefix language", "/a/b/p1._language_no_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"md", "no"}) }, }, { "Prefix version", "/a/b/p1._version_v1_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Versions(), qt.DeepEquals, []string{"v1"}) c.Assert(p.Ext(), qt.Equals, "md") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"md", "v1"}) }, }, { "Prefix version with dots", "/a/b/p1._version_v1.0.0_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Versions(), qt.DeepEquals, []string{"v1.0.0"}) c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Prefix role", "/a/b/p1._role_admin_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Roles(), qt.DeepEquals, []string{"admin"}) c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Multiple prefixes", "/a/b/p1._language_no_._role_admin_._version_v2_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Roles(), qt.DeepEquals, []string{"admin"}) c.Assert(p.Versions(), qt.DeepEquals, []string{"v2"}) c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Prefix version with dots and role", "/a/b/p1._version_v1.0.0_._role_editor_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Versions(), qt.DeepEquals, []string{"v1.0.0"}) c.Assert(p.Roles(), qt.DeepEquals, []string{"editor"}) c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Prefix with dot-based lang", "/a/b/p1._version_v1_.no.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Versions(), qt.DeepEquals, []string{"v1"}) c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Prefix leaf bundle with version", "/a/b/index._version_v1_.md", func(c *qt.C, p *Path) { c.Assert(p.IsLeafBundle(), qt.IsTrue) c.Assert(p.Versions(), qt.DeepEquals, []string{"v1"}) c.Assert(p.Base(), qt.Equals, "/a/b") c.Assert(p.BaseNameNoIdentifier(), qt.Equals, "b") }, }, { "Prefix branch bundle with role", "/a/b/_index._role_admin_.md", func(c *qt.C, p *Path) { c.Assert(p.IsBranchBundle(), qt.IsTrue) c.Assert(p.Roles(), qt.DeepEquals, []string{"admin"}) c.Assert(p.Base(), qt.Equals, "/a/b") }, }, { "Prefix with mixed case, unnormalized", "/a/b/My Page._Version_V1_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/my-page") c.Assert(p.Versions(), qt.DeepEquals, []string{"v1"}) pp := p.Unnormalized() c.Assert(pp.BaseNameNoIdentifier(), qt.Equals, "My Page") }, }, { "Multiple languages", "/a/b/p1._language_en_._language_fr_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") // Right-to-left parse order. c.Assert(p.Lang(), qt.Equals, "fr") c.Assert(p.Langs(), qt.DeepEquals, []string{"fr", "en"}) c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Multiple roles", "/a/b/p1._role_guest_._role_admin_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Roles(), qt.DeepEquals, []string{"admin", "guest"}) c.Assert(p.Ext(), qt.Equals, "md") }, }, { "Multiple versions", "/a/b/p1._version_v1_._version_v2_.md", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/a/b/p1") c.Assert(p.Versions(), qt.DeepEquals, []string{"v2", "v1"}) }, }, { "Unknown prefix not extracted", "/a/b/p1._unknown_foo_.md", func(c *qt.C, p *Path) { // Unknown prefix should be left in path and treated as custom wrapper. c.Assert(p.Custom(), qt.Equals, "unknown_foo") c.Assert(p.Versions(), qt.IsNil) c.Assert(p.Roles(), qt.IsNil) }, }, } parser := newTestParser() for _, test := range tests { c.Run(test.name, func(c *qt.C) { if test.name != "Caret up identifier" { // return } test.assert(c, parser.Parse(files.ComponentFolderContent, test.path)) }) } } func TestParseLayouts(t *testing.T) { c := qt.New(t) tests := []struct { name string path string assert func(c *qt.C, p *Path) }{ { "Basic", "/list.html", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/list.html") c.Assert(p.OutputFormat(), qt.Equals, "html") }, }, { "Lang", "/list.no.html", func(c *qt.C, p *Path) { c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "no", "list"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{}) c.Assert(p.Base(), qt.Equals, "/list.html") c.Assert(p.Lang(), qt.Equals, "no") }, }, { "Kind", "/section.no.html", func(c *qt.C, p *Path) { c.Assert(p.Kind(), qt.Equals, kinds.KindSection) c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "no", "section"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{}) c.Assert(p.Base(), qt.Equals, "/section.html") c.Assert(p.Lang(), qt.Equals, "no") }, }, { "Layout", "/list.section.no.html", func(c *qt.C, p *Path) { c.Assert(p.Layout(), qt.Equals, "list") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "no", "section", "list"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{}) c.Assert(p.Base(), qt.Equals, "/list.html") c.Assert(p.Lang(), qt.Equals, "no") }, }, { "Layout multiple", "/mylayout.list.section.no.html", func(c *qt.C, p *Path) { c.Assert(p.Layout(), qt.Equals, "mylayout") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "no", "section", "mylayout"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{"list"}) c.Assert(p.Base(), qt.Equals, "/mylayout.html") c.Assert(p.Lang(), qt.Equals, "no") }, }, { "Layout shortcode", "/_shortcodes/myshort.list.no.html", func(c *qt.C, p *Path) { c.Assert(p.Layout(), qt.Equals, "list") }, }, { "Layout baseof", "/baseof.list.no.html", func(c *qt.C, p *Path) { c.Assert(p.Layout(), qt.Equals, "list") }, }, { "Lang and output format", "/list.no.amp.not.html", func(c *qt.C, p *Path) { c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "list", "amp", "no"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{"not"}) c.Assert(p.OutputFormat(), qt.Equals, "amp") c.Assert(p.Ext(), qt.Equals, "html") c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Base(), qt.Equals, "/list.html") }, }, { "Term", "/term.html", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/term.html") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "term"}) c.Assert(p.PathNoIdentifier(), qt.Equals, "/term") c.Assert(p.PathBeforeLangAndOutputFormatAndExt(), qt.Equals, "/term") c.Assert(p.Lang(), qt.Equals, "") c.Assert(p.Kind(), qt.Equals, "term") c.Assert(p.OutputFormat(), qt.Equals, "html") }, }, { "Shortcode with layout", "/_shortcodes/myshortcode.list.html", func(c *qt.C, p *Path) { c.Assert(p.Base(), qt.Equals, "/_shortcodes/myshortcode.html") c.Assert(p.Type(), qt.Equals, TypeShortcode) c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "list"}) c.Assert(p.Layout(), qt.Equals, "list") c.Assert(p.PathNoIdentifier(), qt.Equals, "/_shortcodes/myshortcode") c.Assert(p.PathBeforeLangAndOutputFormatAndExt(), qt.Equals, "/_shortcodes/myshortcode.list") c.Assert(p.Lang(), qt.Equals, "") c.Assert(p.Kind(), qt.Equals, "") c.Assert(p.OutputFormat(), qt.Equals, "html") }, }, { "Sub dir", "/pages/home.html", func(c *qt.C, p *Path) { c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "home"}) c.Assert(p.Lang(), qt.Equals, "") c.Assert(p.Kind(), qt.Equals, "home") c.Assert(p.OutputFormat(), qt.Equals, "html") c.Assert(p.Dir(), qt.Equals, "/pages") }, }, { "Baseof", "/pages/baseof.list.section.fr.amp.html", func(c *qt.C, p *Path) { c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "amp", "fr", "section", "list", "baseof"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{}) c.Assert(p.Kind(), qt.Equals, kinds.KindSection) c.Assert(p.Lang(), qt.Equals, "fr") c.Assert(p.OutputFormat(), qt.Equals, "amp") c.Assert(p.Dir(), qt.Equals, "/pages") c.Assert(p.NameNoIdentifier(), qt.Equals, "baseof") c.Assert(p.Type(), qt.Equals, TypeBaseof) c.Assert(p.IdentifierBase(), qt.Equals, "/pages/baseof.list.section.fr.amp.html") }, }, { "Markup", "/_markup/render-link.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeMarkup) }, }, { "Markup nested", "/foo/_markup/render-link.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeMarkup) }, }, { "Shortcode", "/_shortcodes/myshortcode.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeShortcode) }, }, { "Shortcode nested", "/foo/_shortcodes/myshortcode.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeShortcode) }, }, { "Shortcode nested sub", "/foo/_shortcodes/foo/myshortcode.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeShortcode) }, }, { "Partials", "/_partials/foo.bar", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypePartial) }, }, { "Shortcode lang in root", "/_shortcodes/no.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeShortcode) c.Assert(p.Lang(), qt.Equals, "") c.Assert(p.NameNoIdentifier(), qt.Equals, "no") }, }, { "Shortcode lang layout", "/_shortcodes/myshortcode.no.html", func(c *qt.C, p *Path) { c.Assert(p.Type(), qt.Equals, TypeShortcode) c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Layout(), qt.Equals, "") c.Assert(p.NameNoIdentifier(), qt.Equals, "myshortcode") }, }, { "Not lang", "/foo/index.xy.html", func(c *qt.C, p *Path) { c.Assert(p.Lang(), qt.Equals, "") c.Assert(p.Layout(), qt.Equals, "index") c.Assert(p.PathNoLang(), qt.Equals, "/foo/index.xy.html") c.Assert(p.Identifiers(), qt.DeepEquals, []string{"html", "index"}) c.Assert(p.IdentifiersUnknown(), qt.DeepEquals, []string{"xy"}) }, }, { "Prefix language layout", "/page._language_no_.html", func(c *qt.C, p *Path) { c.Assert(p.Lang(), qt.Equals, "no") c.Assert(p.Ext(), qt.Equals, "html") c.Assert(p.OutputFormat(), qt.Equals, "html") c.Assert(p.Base(), qt.Equals, "/page.html") }, }, { "Prefix outputformat layout", "/page._outputformat_amp_.html", func(c *qt.C, p *Path) { c.Assert(p.OutputFormat(), qt.Equals, "amp") c.Assert(p.Ext(), qt.Equals, "html") c.Assert(p.Base(), qt.Equals, "/page.html") }, }, { "Prefix kind layout", "/page._kind_section_.html", func(c *qt.C, p *Path) { c.Assert(p.Kind(), qt.Equals, kinds.KindSection) c.Assert(p.Ext(), qt.Equals, "html") c.Assert(p.Base(), qt.Equals, "/page.html") }, }, { "Prefix layout layout", "/page._layout_list_.html", func(c *qt.C, p *Path) { c.Assert(p.Layout(), qt.Equals, "list") c.Assert(p.Ext(), qt.Equals, "html") c.Assert(p.Base(), qt.Equals, "/page.html") }, }, { "All prefix identifiers in layout", "/page._language_fr_._kind_section_._outputformat_amp_._layout_list_.html", func(c *qt.C, p *Path) { c.Assert(p.Lang(), qt.Equals, "fr") c.Assert(p.Kind(), qt.Equals, kinds.KindSection) c.Assert(p.OutputFormat(), qt.Equals, "amp") c.Assert(p.Layout(), qt.Equals, "list") c.Assert(p.Ext(), qt.Equals, "html") c.Assert(p.Base(), qt.Equals, "/page.html") }, }, { "Prefix version in layout", "/page._version_v2_.html", func(c *qt.C, p *Path) { c.Assert(p.Versions(), qt.DeepEquals, []string{"v2"}) c.Assert(p.Base(), qt.Equals, "/page.html") }, }, { "Prefix role in layout", "/page._role_guest_.html", func(c *qt.C, p *Path) { c.Assert(p.Roles(), qt.DeepEquals, []string{"guest"}) c.Assert(p.Base(), qt.Equals, "/page.html") }, }, } parser := newTestParser() for _, test := range tests { c.Run(test.name, func(c *qt.C) { test.assert(c, parser.Parse(files.ComponentFolderLayouts, test.path)) }) } } func TestHasExt(t *testing.T) { c := qt.New(t) c.Assert(HasExt("/a/b/c.txt"), qt.IsTrue) c.Assert(HasExt("/a/b.c/d.txt"), qt.IsTrue) c.Assert(HasExt("/a/b/c"), qt.IsFalse) c.Assert(HasExt("/a/b.c/d"), qt.IsFalse) } func TestSitesMatrixFromPath(t *testing.T) { c := qt.New(t) parser := newTestParser() p := parser.Parse(files.ComponentFolderContent, "/a/b/c.fr.md") v := parser.SitesMatrixFromPath(p) c.Assert(v.HasLanguage(2), qt.IsTrue) c.Assert(v.LenVectors(), qt.Equals, 1) c.Assert(v.VectorSample(), qt.Equals, sitesmatrix.Vector{2, 0, 0}) // With version prefix. p = parser.Parse(files.ComponentFolderContent, "/a/b/c._version_v2_.fr.md") v = parser.SitesMatrixFromPath(p) c.Assert(v.HasLanguage(2), qt.IsTrue) c.Assert(v.HasVersion(1), qt.IsTrue) // v2 is index 1 c.Assert(v.LenVectors(), qt.Equals, 1) c.Assert(v.VectorSample(), qt.Equals, sitesmatrix.Vector{2, 1, 0}) // With version and role prefixes. p = parser.Parse(files.ComponentFolderContent, "/a/b/c._version_v1_._role_editor_.fr.md") v = parser.SitesMatrixFromPath(p) c.Assert(v.HasLanguage(2), qt.IsTrue) c.Assert(v.HasVersion(0), qt.IsTrue) // v1 is index 0 c.Assert(v.HasRole(1), qt.IsTrue) // editor is index 1 c.Assert(v.LenVectors(), qt.Equals, 1) c.Assert(v.VectorSample(), qt.Equals, sitesmatrix.Vector{2, 0, 1}) // With multiple roles. p = parser.Parse(files.ComponentFolderContent, "/a/b/c._role_guest_._role_admin_.fr.md") v = parser.SitesMatrixFromPath(p) c.Assert(v.HasLanguage(2), qt.IsTrue) c.Assert(v.HasRole(0), qt.IsTrue) // admin is index 0 c.Assert(v.HasRole(3), qt.IsTrue) // guest is index 3 c.Assert(v.LenVectors(), qt.Equals, 2) // With multiple languages via prefix. p = parser.Parse(files.ComponentFolderContent, "/a/b/c._language_en_._language_fr_.md") v = parser.SitesMatrixFromPath(p) c.Assert(v.HasLanguage(0), qt.IsFalse) // no is index 0, not included c.Assert(v.HasLanguage(1), qt.IsTrue) // en is index 1 c.Assert(v.HasLanguage(2), qt.IsTrue) // fr is index 2 c.Assert(v.LenVectors(), qt.Equals, 2) } func FuzzParsePath(f *testing.F) { componentPaths := []struct { component string path string }{ {files.ComponentFolderContent, "/a/b/c.fr.md"}, {files.ComponentFolderContent, "/a/b/c._version_v2_.fr.md"}, {files.ComponentFolderContent, "/a/b/c._version_v1_._role_editor_.fr.md"}, {files.ComponentFolderContent, "/a/b/c._role_guest_._role_admin_.fr.md"}, {files.ComponentFolderContent, "/a/b/c._language_en_._language_fr_.md"}, {files.ComponentFolderLayouts, "/list.no.html"}, {files.ComponentFolderLayouts, "/page._language_fr_._kind_section_._outputformat_amp_._layout_list_.html"}, } for _, cp := range componentPaths { f.Add(cp.component, cp.path) } parser := newTestParser() f.Fuzz(func(t *testing.T, c, s string) { p := parser.Parse(c, s) if p == nil { t.Fatalf("Parse returned nil for path: %q", s) } // Execute all the methods using reflection to ensure they don't panic. v := reflect.ValueOf(p) for i := 0; i < v.NumMethod(); i++ { method := v.Type().Method(i) if method.Type.NumIn() == 1 { method.Func.Call([]reflect.Value{v}) } } }) } func BenchmarkSitesMatrixFromPath(b *testing.B) { parser := newTestParser() p := parser.Parse(files.ComponentFolderContent, "/a/b/c.fr.md") for b.Loop() { parser.SitesMatrixFromPath(p) } }