// 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 page import ( "fmt" "regexp" "strings" "sync" "testing" "time" qt "github.com/frankban/quicktest" "github.com/gohugoio/hugo/source" ) // testdataPermalinks is used by a couple of tests; the expandsTo content is // subject to the data in simplePageJSON. var testdataPermalinks = []struct { spec string valid bool withPage func(p *testPage) expandsTo string }{ {":title", true, nil, "spf13-vim-3.0-release-and-new-website"}, {"/:year-:month-:title", true, nil, "/2012-04-spf13-vim-3.0-release-and-new-website"}, {"/:year/:yearday/:month/:monthname/:day/:weekday/:weekdayname/", true, nil, "/2012/97/04/April/06/5/Friday/"}, // Dates {"/:section/", true, nil, "/blue/"}, // Section {"/:title/", true, nil, "/spf13-vim-3.0-release-and-new-website/"}, // Title {"/:slug/", true, nil, "/the-slug/"}, // Slug {"/:slugorfilename/", true, nil, "/the-slug/"}, // Slug or filename {"/:filename/", true, nil, "/test-page/"}, // Filename {"/:06-:1-:2-:Monday", true, nil, "/12-4-6-Friday"}, // Dates with Go formatting {"/:2006_01_02_15_04_05.000", true, nil, "/2012_04_06_03_01_59.000"}, // Complicated custom date format {"/:sections/", true, nil, "/a/b/c/"}, // Sections {"/:sections[last]/", true, nil, "/c/"}, // Sections {"/:sections[0]/:sections[last]/", true, nil, "/a/c/"}, // Sections {"/\\:filename", true, nil, "/:filename"}, // Escape sequence {"/special\\::slug/", true, nil, "/special:the-slug/"}, // contentbasename. // Escape sequence {"/:contentbasename/", true, nil, "/test-page/"}, // slug, contentbasename. // Content base name {"/:slugorcontentbasename/", true, func(p *testPage) { p.slug = "" }, "/test-page/"}, {"/:slugorcontentbasename/", true, func(p *testPage) { p.slug = "myslug" }, "/myslug/"}, {"/:slugorcontentbasename/", true, func(p *testPage) { p.slug = "" p.title = "mytitle" p.file = source.NewContentFileInfoFrom("/", "_index.md") }, "/test-page/"}, // Failures {"/blog/:fred", false, nil, ""}, {"/:year//:title", false, nil, ""}, {"/:TITLE", false, nil, ""}, // case is not normalized {"/:2017", false, nil, ""}, // invalid date format {"/:2006-01-02", false, nil, ""}, // valid date format but invalid attribute name } func urlize(uri string) string { // This is just an approximation of the real urlize function. return strings.ToLower(strings.ReplaceAll(uri, " ", "-")) } func TestPermalinkExpansion(t *testing.T) { t.Parallel() c := qt.New(t) newPage := func() *testPage { page := newTestPageWithFile("/test-page/index.md") page.title = "Spf13 Vim 3.0 Release and new website" d, _ := time.Parse("2006-01-02 15:04:05", "2012-04-06 03:01:59") page.date = d page.section = "blue" page.slug = "The Slug" page.kind = "page" // page.pathInfo return page } for i, item := range testdataPermalinks { if !item.valid { continue } page := newPage() if item.withPage != nil { item.withPage(page) } specNameCleaner := regexp.MustCompile(`[\:\/\[\]]`) name := fmt.Sprintf("[%d] %s", i, specNameCleaner.ReplaceAllString(item.spec, "_")) c.Run(name, func(c *qt.C) { patterns := map[string]map[string]string{ "page": { "posts": item.spec, }, } expander, err := NewPermalinkExpander(urlize, patterns) c.Assert(err, qt.IsNil) expanded, err := expander.Expand("posts", page) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, item.expandsTo) expanded, err = expander.ExpandPattern(item.spec, page) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, item.expandsTo) }) } } func TestPermalinkExpansionMultiSection(t *testing.T) { t.Parallel() c := qt.New(t) page := newTestPage() page.title = "Page Title" d, _ := time.Parse("2006-01-02", "2012-04-06") page.date = d page.section = "blue" page.slug = "The Slug" page.kind = "page" page_slug_fallback := newTestPageWithFile("/page-filename/index.md") page_slug_fallback.title = "Page Title" page_slug_fallback.kind = "page" permalinksConfig := map[string]map[string]string{ "page": { "posts": "/:slug", "blog": "/:section/:year", "recipes": "/:slugorfilename", "special": "/special\\::slug", }, } expander, err := NewPermalinkExpander(urlize, permalinksConfig) c.Assert(err, qt.IsNil) expanded, err := expander.Expand("posts", page) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, "/the-slug") expanded, err = expander.Expand("blog", page) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, "/blue/2012") expanded, err = expander.Expand("posts", page_slug_fallback) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, "/page-title") expanded, err = expander.Expand("recipes", page_slug_fallback) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, "/page-filename") expanded, err = expander.Expand("special", page) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, "/special:the-slug") } func TestPermalinkExpansionConcurrent(t *testing.T) { t.Parallel() c := qt.New(t) permalinksConfig := map[string]map[string]string{ "page": { "posts": "/:slug/", }, } expander, err := NewPermalinkExpander(urlize, permalinksConfig) c.Assert(err, qt.IsNil) var wg sync.WaitGroup for i := 1; i < 20; i++ { wg.Add(1) go func(i int) { defer wg.Done() page := newTestPage() page.kind = "page" for j := 1; j < 20; j++ { page.slug = fmt.Sprintf("slug%d", i+j) expanded, err := expander.Expand("posts", page) c.Assert(err, qt.IsNil) c.Assert(expanded, qt.Equals, fmt.Sprintf("/%s/", page.slug)) } }(i) } wg.Wait() } func TestPermalinkExpansionSliceSyntax(t *testing.T) { t.Parallel() c := qt.New(t) exp, err := NewPermalinkExpander(urlize, nil) c.Assert(err, qt.IsNil) slice4 := []string{"a", "b", "c", "d"} fn4 := func(s string) []string { return exp.toSliceFunc(s)(slice4) } slice1 := []string{"a"} fn1 := func(s string) []string { return exp.toSliceFunc(s)(slice1) } c.Run("Basic", func(c *qt.C) { c.Assert(fn4("[1:3]"), qt.DeepEquals, []string{"b", "c"}) c.Assert(fn4("[1:]"), qt.DeepEquals, []string{"b", "c", "d"}) c.Assert(fn4("[:2]"), qt.DeepEquals, []string{"a", "b"}) c.Assert(fn4("[0:2]"), qt.DeepEquals, []string{"a", "b"}) c.Assert(fn4("[:]"), qt.DeepEquals, []string{"a", "b", "c", "d"}) c.Assert(fn4(""), qt.DeepEquals, []string{"a", "b", "c", "d"}) c.Assert(fn4("[last]"), qt.DeepEquals, []string{"d"}) c.Assert(fn4("[:last]"), qt.DeepEquals, []string{"a", "b", "c"}) c.Assert(fn1("[last]"), qt.DeepEquals, []string{"a"}) c.Assert(fn1("[:last]"), qt.DeepEquals, []string{}) c.Assert(fn1("[1:last]"), qt.DeepEquals, []string{}) c.Assert(fn1("[1]"), qt.DeepEquals, []string{}) }) c.Run("Out of bounds", func(c *qt.C) { c.Assert(fn4("[1:5]"), qt.DeepEquals, []string{"b", "c", "d"}) c.Assert(fn4("[-1:5]"), qt.DeepEquals, []string{"a", "b", "c", "d"}) c.Assert(fn4("[5:]"), qt.DeepEquals, []string{}) c.Assert(fn4("[5:]"), qt.DeepEquals, []string{}) c.Assert(fn4("[5:32]"), qt.DeepEquals, []string{}) c.Assert(exp.toSliceFunc("[:1]")(nil), qt.DeepEquals, []string(nil)) c.Assert(exp.toSliceFunc("[:1]")([]string{}), qt.DeepEquals, []string(nil)) // These all return nil c.Assert(fn4("[]"), qt.IsNil) c.Assert(fn4("[1:}"), qt.IsNil) c.Assert(fn4("foo"), qt.IsNil) }) } func BenchmarkPermalinkExpand(b *testing.B) { page := newTestPage() page.title = "Hugo Rocks" d, _ := time.Parse("2006-01-02", "2019-02-28") page.date = d page.kind = "page" permalinksConfig := map[string]map[string]string{ "page": { "posts": "/:year-:month-:title", }, } expander, err := NewPermalinkExpander(urlize, permalinksConfig) if err != nil { b.Fatal(err) } b.ResetTimer() for i := 0; i < b.N; i++ { s, err := expander.Expand("posts", page) if err != nil { b.Fatal(err) } if s != "/2019-02-hugo-rocks" { b.Fatal(s) } } }