// 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 hugolib import ( "io/ioutil" "os" "runtime" "strings" "testing" "github.com/spf13/afero" "github.com/gohugoio/hugo/media" "path/filepath" "fmt" "github.com/gohugoio/hugo/deps" "github.com/gohugoio/hugo/hugofs" "github.com/gohugoio/hugo/resource" "github.com/spf13/viper" "github.com/stretchr/testify/require" ) func TestPageBundlerSite(t *testing.T) { t.Parallel() for _, ugly := range []bool{false, true} { t.Run(fmt.Sprintf("ugly=%t", ugly), func(t *testing.T) { assert := require.New(t) cfg, fs := newTestBundleSources(t) cfg.Set("permalinks", map[string]string{ "a": ":sections/:filename", "b": ":year/:slug/", }) cfg.Set("outputFormats", map[string]interface{}{ "CUSTOMO": map[string]interface{}{ "mediaType": media.HTMLType, "baseName": "cindex", "path": "cpath", }, }) cfg.Set("outputs", map[string]interface{}{ "home": []string{"HTML", "CUSTOMO"}, "page": []string{"HTML", "CUSTOMO"}, "section": []string{"HTML", "CUSTOMO"}, }) cfg.Set("uglyURLs", ugly) s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{}) th := testHelper{s.Cfg, s.Fs, t} // Singles (2), Below home (1), Bundle (1) assert.Len(s.RegularPages, 6) singlePage := s.getPage(KindPage, "a/1.md") assert.NotNil(singlePage) assert.Contains(singlePage.Content, "TheContent") if ugly { assert.Equal("/a/1.html", singlePage.RelPermalink()) th.assertFileContent(filepath.FromSlash("/work/public/a/1.html"), "TheContent") } else { assert.Equal("/a/1/", singlePage.RelPermalink()) th.assertFileContent(filepath.FromSlash("/work/public/a/1/index.html"), "TheContent") } th.assertFileContent(filepath.FromSlash("/work/public/images/hugo-logo.png"), "content") // This should be just copied to destination. th.assertFileContent(filepath.FromSlash("/work/public/assets/pic1.png"), "content") leafBundle1 := s.getPage(KindPage, "b/index.md") assert.NotNil(leafBundle1) leafBundle2 := s.getPage(KindPage, "a/b/index.md") assert.NotNil(leafBundle2) pageResources := leafBundle1.Resources.ByType(pageResourceType) assert.Len(pageResources, 2) firstPage := pageResources[0].(*Page) secondPage := pageResources[1].(*Page) assert.Equal(filepath.FromSlash("b/1.md"), firstPage.pathOrTitle(), secondPage.pathOrTitle()) assert.Contains(firstPage.Content, "TheContent") assert.Len(leafBundle1.Resources, 4) // 2 pages 1 image 1 custom mime type imageResources := leafBundle1.Resources.ByType("image") assert.Len(imageResources, 1) image := imageResources[0] altFormat := leafBundle1.OutputFormats().Get("CUSTOMO") assert.NotNil(altFormat) assert.Equal(filepath.FromSlash("/work/base/b/c/logo.png"), image.(resource.Source).AbsSourceFilename()) assert.Equal("https://example.com/2017/pageslug/c/logo.png", image.Permalink()) th.assertFileContent(filepath.FromSlash("/work/public/2017/pageslug/c/logo.png"), "content") th.assertFileContent(filepath.FromSlash("/work/public/cpath/2017/pageslug/c/logo.png"), "content") // Custom media type defined in site config. assert.Len(leafBundle1.Resources.ByType("bepsays"), 1) if ugly { assert.Equal("/2017/pageslug.html", leafBundle1.RelPermalink()) th.assertFileContent(filepath.FromSlash("/work/public/2017/pageslug.html"), "TheContent") th.assertFileContent(filepath.FromSlash("/work/public/cpath/2017/pageslug.html"), "TheContent") assert.Equal("/a/b.html", leafBundle2.RelPermalink()) } else { assert.Equal("/2017/pageslug/", leafBundle1.RelPermalink()) th.assertFileContent(filepath.FromSlash("/work/public/2017/pageslug/index.html"), "TheContent") th.assertFileContent(filepath.FromSlash("/work/public/cpath/2017/pageslug/cindex.html"), "TheContent") assert.Equal("/a/b/", leafBundle2.RelPermalink()) } }) } } func TestPageBundlerSiteWitSymbolicLinksInContent(t *testing.T) { assert := require.New(t) cfg, fs, workDir := newTestBundleSymbolicSources(t) s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg, Logger: newWarningLogger()}, BuildCfg{}) th := testHelper{s.Cfg, s.Fs, t} assert.Equal(7, len(s.RegularPages)) a1Bundle := s.getPage(KindPage, "symbolic2/a1/index.md") assert.NotNil(a1Bundle) assert.Equal(2, len(a1Bundle.Resources)) assert.Equal(1, len(a1Bundle.Resources.ByType(pageResourceType))) th.assertFileContent(filepath.FromSlash(workDir+"/public/a/page/index.html"), "TheContent") th.assertFileContent(filepath.FromSlash(workDir+"/public/symbolic1/s1/index.html"), "TheContent") th.assertFileContent(filepath.FromSlash(workDir+"/public/symbolic2/a1/index.html"), "TheContent") } func newTestBundleSources(t *testing.T) (*viper.Viper, *hugofs.Fs) { cfg, fs := newTestCfg() workDir := "/work" cfg.Set("workingDir", workDir) cfg.Set("contentDir", "base") cfg.Set("baseURL", "https://example.com") cfg.Set("mediaTypes", map[string]interface{}{ "text/bepsays": map[string]interface{}{ "suffix": "bep", }, }) pageContent := `--- title: "Bundle Galore" slug: pageslug date: 2017-10-09 --- TheContent. ` pageContentNoSlug := `--- title: "Bundle Galore #2" date: 2017-10-09 --- TheContent. ` layout := `{{ .Title }}|{{ .Content }}` writeSource(t, fs, filepath.Join(workDir, "layouts", "_default", "single.html"), layout) writeSource(t, fs, filepath.Join(workDir, "layouts", "_default", "list.html"), layout) writeSource(t, fs, filepath.Join(workDir, "base", "_index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "_1.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "_1.png"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "images", "hugo-logo.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "a", "2.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "a", "1.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "a", "b", "index.md"), pageContentNoSlug) writeSource(t, fs, filepath.Join(workDir, "base", "a", "b", "ab1.md"), pageContentNoSlug) // Mostly plain static assets in a folder with a page in a sub folder thrown in. writeSource(t, fs, filepath.Join(workDir, "base", "assets", "pic1.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "assets", "pic2.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "assets", "pages", "mypage.md"), pageContent) // Bundle writeSource(t, fs, filepath.Join(workDir, "base", "b", "index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "b", "1.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "b", "2.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "b", "custom-mime.bep"), "bepsays") writeSource(t, fs, filepath.Join(workDir, "base", "b", "c", "logo.png"), "content") return cfg, fs } func newTestBundleSourcesMultilingual(t *testing.T) (*viper.Viper, *hugofs.Fs) { cfg, fs := newTestCfg() workDir := "/work" cfg.Set("workingDir", workDir) cfg.Set("contentDir", "base") cfg.Set("baseURL", "https://example.com") cfg.Set("defaultContentLanguage", "en") langConfig := map[string]interface{}{ "en": map[string]interface{}{ "weight": 1, "languageName": "English", }, "nn": map[string]interface{}{ "weight": 2, "languageName": "Nynorsk", }, } cfg.Set("languages", langConfig) pageContent := `--- slug: pageslug date: 2017-10-09 --- TheContent. ` layout := `{{ .Title }}|{{ .Content }}|Lang: {{ .Site.Language.Lang }}` writeSource(t, fs, filepath.Join(workDir, "layouts", "_default", "single.html"), layout) writeSource(t, fs, filepath.Join(workDir, "layouts", "_default", "list.html"), layout) writeSource(t, fs, filepath.Join(workDir, "base", "1s", "mypage.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "1s", "mylogo.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "bb", "_index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bb", "_index.nn.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bb", "en.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bb", "_1.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bb", "_1.nn.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bb", "a.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "bb", "b.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "bb", "b.nn.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "bb", "c.nn.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "bb", "b", "d.nn.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "bc", "_index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bc", "page.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bc", "logo-bc.png"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bc", "page.nn.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bd", "index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bd", "page.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "bd", "page.nn.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "be", "_index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "be", "page.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "be", "page.nn.md"), pageContent) // Bundle leaf, multilingual writeSource(t, fs, filepath.Join(workDir, "base", "lb", "index.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "lb", "index.nn.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "lb", "1.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "lb", "2.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "lb", "2.nn.md"), pageContent) writeSource(t, fs, filepath.Join(workDir, "base", "lb", "c", "logo.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "lb", "c", "logo.nn.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "lb", "c", "one.png"), "content") writeSource(t, fs, filepath.Join(workDir, "base", "lb", "c", "d", "deep.png"), "content") return cfg, fs } func newTestBundleSymbolicSources(t *testing.T) (*viper.Viper, *hugofs.Fs, string) { assert := require.New(t) // We need to use the OS fs for this. cfg := viper.New() fs := hugofs.NewFrom(hugofs.Os, cfg) fs.Destination = &afero.MemMapFs{} loadDefaultSettingsFor(cfg) workDir, err := ioutil.TempDir("", "hugosym") if runtime.GOOS == "darwin" && !strings.HasPrefix(workDir, "/private") { // To get the entry folder in line with the rest. This its a little bit // mysterious, but so be it. workDir = "/private" + workDir } contentDir := "base" cfg.Set("workingDir", workDir) cfg.Set("contentDir", contentDir) cfg.Set("baseURL", "https://example.com") layout := `{{ .Title }}|{{ .Content }}` pageContent := `--- slug: %s date: 2017-10-09 --- TheContent. ` fs.Source.MkdirAll(filepath.Join(workDir, "layouts", "_default"), 0777) fs.Source.MkdirAll(filepath.Join(workDir, contentDir), 0777) fs.Source.MkdirAll(filepath.Join(workDir, contentDir, "a"), 0777) for i := 1; i <= 3; i++ { fs.Source.MkdirAll(filepath.Join(workDir, fmt.Sprintf("symcontent%d", i)), 0777) } fs.Source.MkdirAll(filepath.Join(workDir, "symcontent2", "a1"), 0777) writeSource(t, fs, filepath.Join(workDir, "layouts", "_default", "single.html"), layout) writeSource(t, fs, filepath.Join(workDir, "layouts", "_default", "list.html"), layout) writeSource(t, fs, filepath.Join(workDir, contentDir, "a", "regular.md"), fmt.Sprintf(pageContent, "a1")) // Regular files inside symlinked folder. writeSource(t, fs, filepath.Join(workDir, "symcontent1", "s1.md"), fmt.Sprintf(pageContent, "s1")) writeSource(t, fs, filepath.Join(workDir, "symcontent1", "s2.md"), fmt.Sprintf(pageContent, "s2")) // A bundle writeSource(t, fs, filepath.Join(workDir, "symcontent2", "a1", "index.md"), fmt.Sprintf(pageContent, "")) writeSource(t, fs, filepath.Join(workDir, "symcontent2", "a1", "page.md"), fmt.Sprintf(pageContent, "page")) writeSource(t, fs, filepath.Join(workDir, "symcontent2", "a1", "logo.png"), "image") // Assets writeSource(t, fs, filepath.Join(workDir, "symcontent3", "s1.png"), "image") writeSource(t, fs, filepath.Join(workDir, "symcontent3", "s2.png"), "image") // Symlinked sections inside content. os.Chdir(filepath.Join(workDir, contentDir)) for i := 1; i <= 3; i++ { assert.NoError(os.Symlink(filepath.FromSlash(fmt.Sprintf(("../symcontent%d"), i)), fmt.Sprintf("symbolic%d", i))) } os.Chdir(filepath.Join(workDir, contentDir, "a")) // Create a symlink to one single content file assert.NoError(os.Symlink(filepath.FromSlash("../../symcontent2/a1/page.md"), "page_s.md")) os.Chdir(filepath.FromSlash("../../symcontent3")) // Create a circular symlink. Will print some warnings. assert.NoError(os.Symlink(filepath.Join("..", contentDir), filepath.FromSlash("circus"))) os.Chdir(workDir) assert.NoError(err) return cfg, fs, workDir }