some content") - require.Len(t, enSite.RegularPages, 5) - require.Len(t, frSite.RegularPages, 4) + enSite := sites[0] + frSite := sites[1] + + assert.Len(enSite.RegularPages, 5) + assert.Len(frSite.RegularPages, 4) // Verify translations - th.assertFileContent("public/en/sect/doc1-slug/index.html", "Hello") - th.assertFileContent("public/fr/sect/doc1/index.html", "Bonjour") + b.AssertFileContent("public/en/sect/doc1-slug/index.html", "Hello") + b.AssertFileContent("public/fr/sect/doc1/index.html", "Bonjour") // check single page content - th.assertFileContent("public/fr/sect/doc1/index.html", "Single", "Shortcode: Bonjour") - th.assertFileContent("public/en/sect/doc1-slug/index.html", "Single", "Shortcode: Hello") + b.AssertFileContent("public/fr/sect/doc1/index.html", "Single", "Shortcode: Bonjour") + b.AssertFileContent("public/en/sect/doc1-slug/index.html", "Single", "Shortcode: Hello") for i, this := range []struct { preFunc func(t *testing.T) @@ -499,7 +477,7 @@ func TestMultiSitesRebuild(t *testing.T) { }, []fsnotify.Event{{Name: filepath.FromSlash("content/sect/doc2.en.md"), Op: fsnotify.Remove}}, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 4, "1 en removed") + assert.Len(enSite.RegularPages, 4, "1 en removed") // Check build stats require.Equal(t, 1, enSite.draftCount, "Draft") @@ -522,9 +500,9 @@ func TestMultiSitesRebuild(t *testing.T) { {Name: filepath.FromSlash("content/new1.fr.md"), Op: fsnotify.Create}, }, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 6) - require.Len(t, enSite.AllPages, 34) - require.Len(t, frSite.RegularPages, 5) + assert.Len(enSite.RegularPages, 6) + assert.Len(enSite.AllPages, 34) + assert.Len(frSite.RegularPages, 5) require.Equal(t, "new_fr_1", frSite.RegularPages[3].title) require.Equal(t, "new_en_2", enSite.RegularPages[0].title) require.Equal(t, "new_en_1", enSite.RegularPages[1].title) @@ -542,7 +520,7 @@ func TestMultiSitesRebuild(t *testing.T) { }, []fsnotify.Event{{Name: filepath.FromSlash("content/sect/doc1.en.md"), Op: fsnotify.Write}}, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 6) + assert.Len(enSite.RegularPages, 6) doc1 := readDestination(t, fs, "public/en/sect/doc1-slug/index.html") require.True(t, strings.Contains(doc1, "CHANGED"), doc1) @@ -560,7 +538,7 @@ func TestMultiSitesRebuild(t *testing.T) { {Name: filepath.FromSlash("content/new1.en.md"), Op: fsnotify.Rename}, }, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 6, "Rename") + assert.Len(enSite.RegularPages, 6, "Rename") require.Equal(t, "new_en_1", enSite.RegularPages[1].title) rendered := readDestination(t, fs, "public/en/new1renamed/index.html") require.True(t, strings.Contains(rendered, "new_en_1"), rendered) @@ -575,9 +553,9 @@ func TestMultiSitesRebuild(t *testing.T) { }, []fsnotify.Event{{Name: filepath.FromSlash("layouts/_default/single.html"), Op: fsnotify.Write}}, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 6) - require.Len(t, enSite.AllPages, 34) - require.Len(t, frSite.RegularPages, 5) + assert.Len(enSite.RegularPages, 6) + assert.Len(enSite.AllPages, 34) + assert.Len(frSite.RegularPages, 5) doc1 := readDestination(t, fs, "public/en/sect/doc1-slug/index.html") require.True(t, strings.Contains(doc1, "Template Changed"), doc1) }, @@ -592,9 +570,9 @@ func TestMultiSitesRebuild(t *testing.T) { }, []fsnotify.Event{{Name: filepath.FromSlash("i18n/fr.yaml"), Op: fsnotify.Write}}, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 6) - require.Len(t, enSite.AllPages, 34) - require.Len(t, frSite.RegularPages, 5) + assert.Len(enSite.RegularPages, 6) + assert.Len(enSite.AllPages, 34) + assert.Len(frSite.RegularPages, 5) docEn := readDestination(t, fs, "public/en/sect/doc1-slug/index.html") require.True(t, strings.Contains(docEn, "Hello"), "No Hello") docFr := readDestination(t, fs, "public/fr/sect/doc1/index.html") @@ -602,7 +580,7 @@ func TestMultiSitesRebuild(t *testing.T) { homeEn := enSite.getPage(KindHome) require.NotNil(t, homeEn) - require.Len(t, homeEn.Translations(), 3) + assert.Len(homeEn.Translations(), 3) require.Equal(t, "fr", homeEn.Translations()[0].Lang()) }, @@ -616,11 +594,11 @@ func TestMultiSitesRebuild(t *testing.T) { {Name: filepath.FromSlash("layouts/shortcodes/shortcode.html"), Op: fsnotify.Write}, }, func(t *testing.T) { - require.Len(t, enSite.RegularPages, 6) - require.Len(t, enSite.AllPages, 34) - require.Len(t, frSite.RegularPages, 5) - th.assertFileContent("public/fr/sect/doc1/index.html", "Single", "Modified Shortcode: Salut") - th.assertFileContent("public/en/sect/doc1-slug/index.html", "Single", "Modified Shortcode: Hello") + assert.Len(enSite.RegularPages, 6) + assert.Len(enSite.AllPages, 34) + assert.Len(frSite.RegularPages, 5) + b.AssertFileContent("public/fr/sect/doc1/index.html", "Single", "Modified Shortcode: Salut") + b.AssertFileContent("public/en/sect/doc1-slug/index.html", "Single", "Modified Shortcode: Hello") }, }, } { @@ -629,7 +607,7 @@ func TestMultiSitesRebuild(t *testing.T) { this.preFunc(t) } - err = sites.Build(cfg, this.events...) + err := b.H.Build(BuildCfg{}, this.events...) if err != nil { t.Fatalf("[%d] Failed to rebuild sites: %s", i, err) @@ -639,7 +617,7 @@ func TestMultiSitesRebuild(t *testing.T) { } // Check that the drafts etc. are not built/processed/rendered. - assertShouldNotBuild(t, sites) + assertShouldNotBuild(t, b.H) } @@ -658,18 +636,12 @@ func assertShouldNotBuild(t *testing.T, sites *HugoSites) { func TestAddNewLanguage(t *testing.T) { t.Parallel() - siteConfig := testSiteConfig{Fs: afero.NewMemMapFs(), DefaultContentLanguage: "fr", DefaultContentLanguageInSubdir: true} + assert := require.New(t) - sites := createMultiTestSites(t, siteConfig, multiSiteTOMLConfigTemplate) - cfg := BuildCfg{} + b := newMultiSiteTestDefaultBuilder(t) + b.CreateSites().Build(BuildCfg{}) - err := sites.Build(cfg) - - if err != nil { - t.Fatalf("Failed to build sites: %s", err) - } - - fs := sites.Fs + fs := b.Fs newConfig := multiSiteTOMLConfigTemplate + ` @@ -678,15 +650,15 @@ weight = 15 title = "Svenska" ` - newConfig = createConfig(t, siteConfig, newConfig) - writeNewContentFile(t, fs, "Swedish Contentfile", "2016-01-01", "content/sect/doc1.sv.md", 10) // replace the config - writeSource(t, fs, "multilangconfig.toml", newConfig) + b.WithNewConfig(newConfig) + + sites := b.H // Watching does not work with in-memory fs, so we trigger a reload manually - require.NoError(t, sites.Cfg.(*helpers.Language).Cfg.(*viper.Viper).ReadInConfig()) - err = sites.Build(BuildCfg{CreateSitesFromConfig: true}) + assert.NoError(sites.Cfg.(*helpers.Language).Cfg.(*viper.Viper).ReadInConfig()) + err := b.H.Build(BuildCfg{CreateSitesFromConfig: true}) if err != nil { t.Fatalf("Failed to rebuild sites: %s", err) @@ -728,67 +700,50 @@ title = "Svenska" func TestChangeDefaultLanguage(t *testing.T) { t.Parallel() - mf := afero.NewMemMapFs() - sites := createMultiTestSites(t, testSiteConfig{Fs: mf, DefaultContentLanguage: "fr", DefaultContentLanguageInSubdir: false}, multiSiteTOMLConfigTemplate) + assert := require.New(t) - require.Equal(t, mf, sites.Fs.Source) + b := newMultiSiteTestBuilder(t, "", "", map[string]interface{}{ + "DefaultContentLanguage": "fr", + "DefaultContentLanguageInSubdir": false, + }) + b.CreateSites().Build(BuildCfg{}) - cfg := BuildCfg{} - fs := sites.Fs - th := testHelper{sites.Cfg, fs, t} + b.AssertFileContent("public/sect/doc1/index.html", "Single", "Bonjour") + b.AssertFileContent("public/en/sect/doc2/index.html", "Single", "Hello") - err := sites.Build(cfg) - - if err != nil { - t.Fatalf("Failed to build sites: %s", err) - } - - th.assertFileContent("public/sect/doc1/index.html", "Single", "Bonjour") - th.assertFileContent("public/en/sect/doc2/index.html", "Single", "Hello") - - newConfig := createConfig(t, testSiteConfig{Fs: mf, DefaultContentLanguage: "en", DefaultContentLanguageInSubdir: false}, multiSiteTOMLConfigTemplate) - - // replace the config - writeSource(t, fs, "multilangconfig.toml", newConfig) + // Switch language + b.WithNewConfigData(map[string]interface{}{ + "DefaultContentLanguage": "en", + "DefaultContentLanguageInSubdir": false, + }) // Watching does not work with in-memory fs, so we trigger a reload manually // This does not look pretty, so we should think of something else. - require.NoError(t, th.Cfg.(*helpers.Language).Cfg.(*viper.Viper).ReadInConfig()) - err = sites.Build(BuildCfg{CreateSitesFromConfig: true}) - + assert.NoError(b.H.Cfg.(*helpers.Language).Cfg.(*viper.Viper).ReadInConfig()) + err := b.H.Build(BuildCfg{CreateSitesFromConfig: true}) if err != nil { t.Fatalf("Failed to rebuild sites: %s", err) } // Default language is now en, so that should now be the "root" language - th.assertFileContent("public/fr/sect/doc1/index.html", "Single", "Bonjour") - th.assertFileContent("public/sect/doc2/index.html", "Single", "Hello") + b.AssertFileContent("public/fr/sect/doc1/index.html", "Single", "Bonjour") + b.AssertFileContent("public/sect/doc2/index.html", "Single", "Hello") } func TestTableOfContentsInShortcodes(t *testing.T) { t.Parallel() - mf := afero.NewMemMapFs() - writeToFs(t, mf, "layouts/shortcodes/toc.html", tocShortcode) - writeToFs(t, mf, "content/post/simple.en.md", tocPageSimple) - writeToFs(t, mf, "content/post/withSCInHeading.en.md", tocPageWithShortcodesInHeadings) + b := newMultiSiteTestDefaultBuilder(t) - sites := createMultiTestSites(t, testSiteConfig{Fs: mf, DefaultContentLanguage: "en", DefaultContentLanguageInSubdir: true}, multiSiteTOMLConfigTemplate) + b.WithTemplatesAdded("layouts/shortcodes/toc.html", tocShortcode) + b.WithContent("post/simple.en.md", tocPageSimple) + b.WithContent("post/withSCInHeading.en.md", tocPageWithShortcodesInHeadings) - cfg := BuildCfg{} + b.CreateSites().Build(BuildCfg{}) - err := sites.Build(cfg) - - if err != nil { - t.Fatalf("Failed to build sites: %s", err) - } - - fs := sites.Fs - th := testHelper{sites.Cfg, fs, t} - - th.assertFileContent("public/en/post/simple/index.html", tocPageSimpleExpected) - th.assertFileContent("public/en/post/withSCInHeading/index.html", tocPageWithShortcodesInHeadingsExpected) + b.AssertFileContent("public/en/post/simple/index.html", tocPageSimpleExpected) + b.AssertFileContent("public/en/post/withSCInHeading/index.html", tocPageWithShortcodesInHeadingsExpected) } var tocShortcode = ` @@ -799,23 +754,14 @@ var tocPageSimple = `--- title: tocTest publishdate: "2000-01-01" --- - {{< toc >}} - # Heading 1 {#1} - Some text. - ## Subheading 1.1 {#1-1} - Some more text. - # Heading 2 {#2} - Even more text. - ## Subheading 2.1 {#2-1} - Lorem ipsum... ` @@ -985,6 +931,7 @@ Languages: ` +// TODO(bep) clean move var multiSiteJSONConfigTemplate = ` { "baseURL": "http://example.com/blog", @@ -1059,289 +1006,6 @@ var multiSiteJSONConfigTemplate = ` } ` -func createMultiTestSites(t *testing.T, siteConfig testSiteConfig, tomlConfigTemplate string) *HugoSites { - return createMultiTestSitesForConfig(t, siteConfig, tomlConfigTemplate, "toml") -} - -func createMultiTestSitesForConfig(t *testing.T, siteConfig testSiteConfig, configTemplate, configSuffix string) *HugoSites { - - configContent := createConfig(t, siteConfig, configTemplate) - - mf := siteConfig.Fs - - // TODO(bep) cleanup/remove duplication, use the new testBuilder in testhelpers_test - // Add some layouts - if err := afero.WriteFile(mf, - filepath.Join("layouts", "_default/single.html"), - []byte("Single: {{ .Title }}|{{ i18n \"hello\" }}|{{.Lang}}|{{ .Content }}"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - if err := afero.WriteFile(mf, - filepath.Join("layouts", "_default/list.html"), - []byte("{{ $p := .Paginator }}List Page {{ $p.PageNumber }}: {{ .Title }}|{{ i18n \"hello\" }}|{{ .Permalink }}|Pager: {{ template \"_internal/pagination.html\" . }}"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - if err := afero.WriteFile(mf, - filepath.Join("layouts", "index.html"), - []byte("{{ $p := .Paginator }}Default Home Page {{ $p.PageNumber }}: {{ .Title }}|{{ .IsHome }}|{{ i18n \"hello\" }}|{{ .Permalink }}|{{ .Site.Data.hugo.slogan }}"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - if err := afero.WriteFile(mf, - filepath.Join("layouts", "index.fr.html"), - []byte("{{ $p := .Paginator }}French Home Page {{ $p.PageNumber }}: {{ .Title }}|{{ .IsHome }}|{{ i18n \"hello\" }}|{{ .Permalink }}|{{ .Site.Data.hugo.slogan }}"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - // Add a shortcode - if err := afero.WriteFile(mf, - filepath.Join("layouts", "shortcodes", "shortcode.html"), - []byte("Shortcode: {{ i18n \"hello\" }}"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - // A shortcode in multiple languages - if err := afero.WriteFile(mf, - filepath.Join("layouts", "shortcodes", "lingo.html"), - []byte("LingoDefault"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - if err := afero.WriteFile(mf, - filepath.Join("layouts", "shortcodes", "lingo.fr.html"), - []byte("LingoFrench"), - 0755); err != nil { - t.Fatalf("Failed to write layout file: %s", err) - } - - // Add some language files - if err := afero.WriteFile(mf, - filepath.Join("i18n", "en.yaml"), - []byte(` -hello: - other: "Hello" -`), - 0755); err != nil { - t.Fatalf("Failed to write language file: %s", err) - } - if err := afero.WriteFile(mf, - filepath.Join("i18n", "fr.yaml"), - []byte(` -hello: - other: "Bonjour" -`), - 0755); err != nil { - t.Fatalf("Failed to write language file: %s", err) - } - - // Sources - sources := [][2]string{ - {filepath.FromSlash("root.en.md"), `--- -title: root -weight: 10000 -slug: root -publishdate: "2000-01-01" ---- -# root -`}, - {filepath.FromSlash("sect/doc1.en.md"), `--- -title: doc1 -weight: 1 -slug: doc1-slug -tags: - - tag1 -publishdate: "2000-01-01" ---- -# doc1 -*some "content"* - -{{< shortcode >}} - -{{< lingo >}} - -NOTE: slug should be used as URL -`}, - {filepath.FromSlash("sect/doc1.fr.md"), `--- -title: doc1 -weight: 1 -plaques: - - frtag1 - - frtag2 -publishdate: "2000-01-04" ---- -# doc1 -*quelque "contenu"* - -{{< shortcode >}} - -{{< lingo >}} - -NOTE: should be in the 'en' Page's 'Translations' field. -NOTE: date is after "doc3" -`}, - {filepath.FromSlash("sect/doc2.en.md"), `--- -title: doc2 -weight: 2 -publishdate: "2000-01-02" ---- -# doc2 -*some content* -NOTE: without slug, "doc2" should be used, without ".en" as URL -`}, - {filepath.FromSlash("sect/doc3.en.md"), `--- -title: doc3 -weight: 3 -publishdate: "2000-01-03" -aliases: [/en/al/alias1,/al/alias2/] -tags: - - tag2 - - tag1 -url: /superbob ---- -# doc3 -*some content* -NOTE: third 'en' doc, should trigger pagination on home page. -`}, - {filepath.FromSlash("sect/doc4.md"), `--- -title: doc4 -weight: 4 -plaques: - - frtag1 -publishdate: "2000-01-05" ---- -# doc4 -*du contenu francophone* -NOTE: should use the defaultContentLanguage and mark this doc as 'fr'. -NOTE: doesn't have any corresponding translation in 'en' -`}, - {filepath.FromSlash("other/doc5.fr.md"), `--- -title: doc5 -weight: 5 -publishdate: "2000-01-06" ---- -# doc5 -*autre contenu francophone* -NOTE: should use the "permalinks" configuration with :filename -`}, - // Add some for the stats - {filepath.FromSlash("stats/expired.fr.md"), `--- -title: expired -publishdate: "2000-01-06" -expiryDate: "2001-01-06" ---- -# Expired -`}, - {filepath.FromSlash("stats/future.fr.md"), `--- -title: future -weight: 6 -publishdate: "2100-01-06" ---- -# Future -`}, - {filepath.FromSlash("stats/expired.en.md"), `--- -title: expired -weight: 7 -publishdate: "2000-01-06" -expiryDate: "2001-01-06" ---- -# Expired -`}, - {filepath.FromSlash("stats/future.en.md"), `--- -title: future -weight: 6 -publishdate: "2100-01-06" ---- -# Future -`}, - {filepath.FromSlash("stats/draft.en.md"), `--- -title: expired -publishdate: "2000-01-06" -draft: true ---- -# Draft -`}, - {filepath.FromSlash("stats/tax.nn.md"), `--- -title: Tax NN -weight: 8 -publishdate: "2000-01-06" -weight: 1001 -lag: -- Sogndal ---- -# Tax NN -`}, - {filepath.FromSlash("stats/tax.nb.md"), `--- -title: Tax NB -weight: 8 -publishdate: "2000-01-06" -weight: 1002 -lag: -- Sogndal ---- -# Tax NB -`}, - // Bundle - {filepath.FromSlash("bundles/b1/index.en.md"), `--- -title: Bundle EN -publishdate: "2000-01-06" -weight: 2001 ---- -# Bundle Content EN -`}, - {filepath.FromSlash("bundles/b1/index.md"), `--- -title: Bundle Default -publishdate: "2000-01-06" -weight: 2002 ---- -# Bundle Content Default -`}, - {filepath.FromSlash("bundles/b1/logo.png"), ` -PNG Data -`}, - } - - configFile := "multilangconfig." + configSuffix - writeToFs(t, mf, configFile, configContent) - - cfg, err := LoadConfig(mf, "", configFile) - require.NoError(t, err) - - fs := hugofs.NewFrom(mf, cfg) - - for _, s := range sources { - if err := afero.WriteFile(mf, filepath.Join("content", s[0]), []byte(s[1]), 0755); err != nil { - t.Fatalf("Failed to write file: %s", err) - } - } - - // Add some data - writeSource(t, fs, "data/hugo.toml", "slogan = \"Hugo Rocks!\"") - - sites, err := NewHugoSites(deps.DepsCfg{Fs: fs, Cfg: cfg, Running: siteConfig.Running}) //, Logger: newDebugLogger()}) - - if err != nil { - t.Fatalf("Failed to create sites: %s", err) - } - - if len(sites.Sites) == 0 { - t.Fatalf("Got %d sites", len(sites.Sites)) - } - - if sites.Fs.Source != mf { - t.Fatal("FS mismatch") - } - - return sites -} - func writeSource(t testing.TB, fs *hugofs.Fs, filename, content string) { writeToFs(t, fs.Source, filename, content) } @@ -1373,7 +1037,7 @@ func readFileFromFs(t testing.TB, fs afero.Fs, filename string) string { b, err := afero.ReadFile(fs, filename) if err != nil { // Print some debug info - root := "" //strings.Split(filename, helpers.FilePathSeparator)[0] + root := strings.Split(filename, helpers.FilePathSeparator)[0] afero.Walk(fs, root, func(path string, info os.FileInfo, err error) error { if info != nil && !info.IsDir() { fmt.Println(" ", path) @@ -1381,7 +1045,7 @@ func readFileFromFs(t testing.TB, fs afero.Fs, filename string) string { return nil }) - t.Fatalf("Failed to read file: %s", err) + Fatalf(t, "Failed to read file: %s", err) } return string(b) } @@ -1403,12 +1067,207 @@ func writeNewContentFile(t *testing.T, fs *hugofs.Fs, title, date, filename stri writeSource(t, fs, filename, content) } -func createConfig(t *testing.T, config testSiteConfig, configTemplate string) string { - templ, err := template.New("test").Parse(configTemplate) - if err != nil { - t.Fatal("Template parse failed:", err) - } - var b bytes.Buffer - templ.Execute(&b, config) - return b.String() +type multiSiteTestBuilder struct { + configData interface{} + config string + configFormat string + + *sitesBuilder +} + +func newMultiSiteTestDefaultBuilder(t testing.TB) *multiSiteTestBuilder { + return newMultiSiteTestBuilder(t, "", "", nil) +} + +func (b *multiSiteTestBuilder) WithNewConfig(config string) *multiSiteTestBuilder { + b.WithConfigTemplate(b.configData, b.configFormat, config) + return b +} + +func (b *multiSiteTestBuilder) WithNewConfigData(data interface{}) *multiSiteTestBuilder { + b.WithConfigTemplate(data, b.configFormat, b.config) + return b +} + +func newMultiSiteTestBuilder(t testing.TB, configFormat, config string, configData interface{}) *multiSiteTestBuilder { + if configData == nil { + configData = map[string]interface{}{ + "DefaultContentLanguage": "fr", + "DefaultContentLanguageInSubdir": true, + } + } + + if config == "" { + config = multiSiteTOMLConfigTemplate + } + + if configFormat == "" { + configFormat = "toml" + } + + b := newTestSitesBuilder(t).WithConfigTemplate(configData, configFormat, config) + b.WithContent("root.en.md", `--- +title: root +weight: 10000 +slug: root +publishdate: "2000-01-01" +--- +# root +`, + "sect/doc1.en.md", `--- +title: doc1 +weight: 1 +slug: doc1-slug +tags: + - tag1 +publishdate: "2000-01-01" +--- +# doc1 +*some "content"* + +{{< shortcode >}} + +{{< lingo >}} + +NOTE: slug should be used as URL +`, + "sect/doc1.fr.md", `--- +title: doc1 +weight: 1 +plaques: + - frtag1 + - frtag2 +publishdate: "2000-01-04" +--- +# doc1 +*quelque "contenu"* + +{{< shortcode >}} + +{{< lingo >}} + +NOTE: should be in the 'en' Page's 'Translations' field. +NOTE: date is after "doc3" +`, + "sect/doc2.en.md", `--- +title: doc2 +weight: 2 +publishdate: "2000-01-02" +--- +# doc2 +*some content* +NOTE: without slug, "doc2" should be used, without ".en" as URL +`, + "sect/doc3.en.md", `--- +title: doc3 +weight: 3 +publishdate: "2000-01-03" +aliases: [/en/al/alias1,/al/alias2/] +tags: + - tag2 + - tag1 +url: /superbob +--- +# doc3 +*some content* +NOTE: third 'en' doc, should trigger pagination on home page. +`, + "sect/doc4.md", `--- +title: doc4 +weight: 4 +plaques: + - frtag1 +publishdate: "2000-01-05" +--- +# doc4 +*du contenu francophone* +NOTE: should use the defaultContentLanguage and mark this doc as 'fr'. +NOTE: doesn't have any corresponding translation in 'en' +`, + "other/doc5.fr.md", `--- +title: doc5 +weight: 5 +publishdate: "2000-01-06" +--- +# doc5 +*autre contenu francophone* +NOTE: should use the "permalinks" configuration with :filename +`, + // Add some for the stats + "stats/expired.fr.md", `--- +title: expired +publishdate: "2000-01-06" +expiryDate: "2001-01-06" +--- +# Expired +`, + "stats/future.fr.md", `--- +title: future +weight: 6 +publishdate: "2100-01-06" +--- +# Future +`, + "stats/expired.en.md", `--- +title: expired +weight: 7 +publishdate: "2000-01-06" +expiryDate: "2001-01-06" +--- +# Expired +`, + "stats/future.en.md", `--- +title: future +weight: 6 +publishdate: "2100-01-06" +--- +# Future +`, + "stats/draft.en.md", `--- +title: expired +publishdate: "2000-01-06" +draft: true +--- +# Draft +`, + "stats/tax.nn.md", `--- +title: Tax NN +weight: 8 +publishdate: "2000-01-06" +weight: 1001 +lag: +- Sogndal +--- +# Tax NN +`, + "stats/tax.nb.md", `--- +title: Tax NB +weight: 8 +publishdate: "2000-01-06" +weight: 1002 +lag: +- Sogndal +--- +# Tax NB +`, + // Bundle + "bundles/b1/index.en.md", `--- +title: Bundle EN +publishdate: "2000-01-06" +weight: 2001 +--- +# Bundle Content EN +`, + "bundles/b1/index.md", `--- +title: Bundle Default +publishdate: "2000-01-06" +weight: 2002 +--- +# Bundle Content Default +`, + "bundles/b1/logo.png", ` +PNG Data +`) + + return &multiSiteTestBuilder{sitesBuilder: b, configFormat: configFormat, config: config, configData: configData} } diff --git a/hugolib/hugo_sites_multihost_test.go b/hugolib/hugo_sites_multihost_test.go index 5f4455371..ff69f95ae 100644 --- a/hugolib/hugo_sites_multihost_test.go +++ b/hugolib/hugo_sites_multihost_test.go @@ -1,21 +1,21 @@ package hugolib import ( - "path/filepath" "testing" - "github.com/spf13/afero" "github.com/stretchr/testify/require" ) func TestMultihosts(t *testing.T) { t.Parallel() - var multiSiteTOMLConfigTemplate = ` + assert := require.New(t) + + var configTemplate = ` paginate = 1 disablePathToLower = true -defaultContentLanguage = "{{ .DefaultContentLanguage }}" -defaultContentLanguageInSubdir = {{ .DefaultContentLanguageInSubdir }} +defaultContentLanguage = "fr" +defaultContentLanguageInSubdir = false staticDir = ["s1", "s2"] [permalinks] @@ -48,18 +48,12 @@ languageName = "Nynorsk" ` - siteConfig := testSiteConfig{Running: true, Fs: afero.NewMemMapFs(), DefaultContentLanguage: "fr", DefaultContentLanguageInSubdir: false} - sites := createMultiTestSites(t, siteConfig, multiSiteTOMLConfigTemplate) - fs := sites.Fs - th := testHelper{sites.Cfg, fs, t} - assert := require.New(t) - cfg := BuildCfg{} - err := sites.Build(cfg) - assert.NoError(err) + b := newMultiSiteTestDefaultBuilder(t).WithConfig("toml", configTemplate) + b.CreateSites().Build(BuildCfg{}) - th.assertFileContent("public/en/sect/doc1-slug/index.html", "Hello") + b.AssertFileContent("public/en/sect/doc1-slug/index.html", "Hello") - s1 := sites.Sites[0] + s1 := b.H.Sites[0] assert.Equal([]string{"s1", "s2", "ens1", "ens2"}, s1.StaticDirs()) @@ -78,26 +72,26 @@ languageName = "Nynorsk" assert.NotNil(pageWithURLInFrontMatter) assert.Equal("/superbob", pageWithURLInFrontMatter.URL()) assert.Equal("/docs/superbob/", pageWithURLInFrontMatter.RelPermalink()) - th.assertFileContent("public/en/superbob/index.html", "doc3|Hello|en") + b.AssertFileContent("public/en/superbob/index.html", "doc3|Hello|en") // check alias: - th.assertFileContent("public/en/al/alias1/index.html", `content="0; url=https://example.com/docs/superbob/"`) - th.assertFileContent("public/en/al/alias2/index.html", `content="0; url=https://example.com/docs/superbob/"`) + b.AssertFileContent("public/en/al/alias1/index.html", `content="0; url=https://example.com/docs/superbob/"`) + b.AssertFileContent("public/en/al/alias2/index.html", `content="0; url=https://example.com/docs/superbob/"`) - s2 := sites.Sites[1] + s2 := b.H.Sites[1] assert.Equal([]string{"s1", "s2", "frs1", "frs2"}, s2.StaticDirs()) s2h := s2.getPage(KindHome) assert.Equal("https://example.fr/", s2h.Permalink()) - th.assertFileContentStraight("public/fr/index.html", "French Home Page") - th.assertFileContentStraight("public/en/index.html", "Default Home Page") + b.AssertFileContent("public/fr/index.html", "French Home Page") + b.AssertFileContent("public/en/index.html", "Default Home Page") // Check paginators - th.assertFileContent("public/en/page/1/index.html", `refresh" content="0; url=https://example.com/docs/"`) - th.assertFileContent("public/nn/page/1/index.html", `refresh" content="0; url=https://example.no/"`) - th.assertFileContent("public/en/sect/page/2/index.html", "List Page 2", "Hello", "https://example.com/docs/sect/", "\"/docs/sect/page/3/") - th.assertFileContent("public/fr/sect/page/2/index.html", "List Page 2", "Bonjour", "https://example.fr/sect/") + b.AssertFileContent("public/en/page/1/index.html", `refresh" content="0; url=https://example.com/docs/"`) + b.AssertFileContent("public/nn/page/1/index.html", `refresh" content="0; url=https://example.no/"`) + b.AssertFileContent("public/en/sect/page/2/index.html", "List Page 2", "Hello", "https://example.com/docs/sect/", "\"/docs/sect/page/3/") + b.AssertFileContent("public/fr/sect/page/2/index.html", "List Page 2", "Bonjour", "https://example.fr/sect/") // Check bundles @@ -108,7 +102,7 @@ languageName = "Nynorsk" logoEn := bundleEn.Resources.GetByPrefix("logo") require.NotNil(t, logoEn) require.Equal(t, "/docs/bundles/b1/logo.png", logoEn.RelPermalink()) - require.Contains(t, readFileFromFs(t, fs.Destination, filepath.FromSlash("public/en/bundles/b1/logo.png")), "PNG Data") + b.AssertFileContent("public/en/bundles/b1/logo.png", "PNG Data") bundleFr := s2.getPage(KindPage, "bundles/b1/index.md") require.NotNil(t, bundleFr) @@ -117,6 +111,6 @@ languageName = "Nynorsk" logoFr := bundleFr.Resources.GetByPrefix("logo") require.NotNil(t, logoFr) require.Equal(t, "/bundles/b1/logo.png", logoFr.RelPermalink()) - require.Contains(t, readFileFromFs(t, fs.Destination, filepath.FromSlash("public/fr/bundles/b1/logo.png")), "PNG Data") + b.AssertFileContent("public/fr/bundles/b1/logo.png", "PNG Data") } diff --git a/hugolib/page_bundler_capture_test.go b/hugolib/page_bundler_capture_test.go index 3f9a57146..25d9be5a6 100644 --- a/hugolib/page_bundler_capture_test.go +++ b/hugolib/page_bundler_capture_test.go @@ -88,7 +88,7 @@ func TestPageBundlerCaptureSymlinks(t *testing.T) { sourceSpec := source.NewSourceSpec(cfg, fs) fileStore := &storeFilenames{} - logger := newWarningLogger() + logger := newErrorLogger() c := newCapturer(logger, sourceSpec, fileStore, nil, filepath.Join(workDir, contentDir)) assert.NoError(c.capture()) diff --git a/hugolib/page_bundler_test.go b/hugolib/page_bundler_test.go index 0344cf024..bf79d2f86 100644 --- a/hugolib/page_bundler_test.go +++ b/hugolib/page_bundler_test.go @@ -301,7 +301,7 @@ 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{}) + s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg, Logger: newErrorLogger()}, BuildCfg{}) th := testHelper{s.Cfg, s.Fs, t} diff --git a/hugolib/testhelpers_test.go b/hugolib/testhelpers_test.go index 8f2893682..e044f61db 100644 --- a/hugolib/testhelpers_test.go +++ b/hugolib/testhelpers_test.go @@ -4,9 +4,11 @@ import ( "path/filepath" "testing" + "bytes" "fmt" "regexp" "strings" + "text/template" jww "github.com/spf13/jwalterweatherman" @@ -24,6 +26,7 @@ import ( "log" "github.com/gohugoio/hugo/hugofs" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -34,8 +37,14 @@ type sitesBuilder struct { Fs *hugofs.Fs T testing.TB + // Aka the Hugo server mode. + running bool + H *HugoSites + // Default toml + configFormat string + // We will add some default if not set. templatesAdded bool i18nAdded bool @@ -47,11 +56,31 @@ func newTestSitesBuilder(t testing.TB) *sitesBuilder { v := viper.New() fs := hugofs.NewMem(v) - return &sitesBuilder{T: t, Fs: fs} + return &sitesBuilder{T: t, Fs: fs, configFormat: "toml"} } -func (s *sitesBuilder) WithTOMLConfig(conf string) *sitesBuilder { - writeSource(s.T, s.Fs, "config.toml", conf) +func (s *sitesBuilder) Running() *sitesBuilder { + s.running = true + return s +} + +func (s *sitesBuilder) WithConfigTemplate(data interface{}, format, configTemplate string) *sitesBuilder { + if format == "" { + format = "toml" + } + + templ, err := template.New("test").Parse(configTemplate) + if err != nil { + s.T.Fatal("Template parse failed:", err) + } + var b bytes.Buffer + templ.Execute(&b, data) + return s.WithConfig(format, b.String()) +} + +func (s *sitesBuilder) WithConfig(format, conf string) *sitesBuilder { + writeSource(s.T, s.Fs, "config."+format, conf) + s.configFormat = format return s } @@ -113,12 +142,19 @@ paginatePath = "side" lag = "lag" ` - return s.WithTOMLConfig(defaultMultiSiteConfig) + return s.WithConfig("toml", defaultMultiSiteConfig) } func (s *sitesBuilder) WithContent(filenameContent ...string) *sitesBuilder { s.contentAdded = true + return s.WithContentAdded(filenameContent...) +} + +func (s *sitesBuilder) WithContentAdded(filenameContent ...string) *sitesBuilder { + if len(filenameContent)%2 != 0 { + s.Fatalf("expect filenameContent in pairs") + } for i := 0; i < len(filenameContent); i += 2 { filename, content := filenameContent[i], filenameContent[i+1] writeSource(s.T, s.Fs, filepath.Join("content", filename), content) @@ -127,7 +163,14 @@ func (s *sitesBuilder) WithContent(filenameContent ...string) *sitesBuilder { } func (s *sitesBuilder) WithTemplates(filenameContent ...string) *sitesBuilder { + if len(filenameContent)%2 != 0 { + s.Fatalf("expect filenameContent in pairs") + } s.templatesAdded = true + return s.WithTemplatesAdded(filenameContent...) +} + +func (s *sitesBuilder) WithTemplatesAdded(filenameContent ...string) *sitesBuilder { for i := 0; i < len(filenameContent); i += 2 { filename, content := filenameContent[i], filenameContent[i+1] writeSource(s.T, s.Fs, filepath.Join("layouts", filename), content) @@ -150,14 +193,14 @@ func (s *sitesBuilder) CreateSites() *sitesBuilder { } if s.Cfg == nil { - cfg, err := LoadConfig(s.Fs.Source, "", "config.toml") + cfg, err := LoadConfig(s.Fs.Source, "", "config."+s.configFormat) if err != nil { s.T.Fatalf("Failed to load config: %s", err) } s.Cfg = cfg } - sites, err := NewHugoSites(deps.DepsCfg{Fs: s.Fs, Cfg: s.Cfg}) + sites, err := NewHugoSites(deps.DepsCfg{Fs: s.Fs, Cfg: s.Cfg, Running: s.running}) if err != nil { s.T.Fatalf("Failed to create sites: %s", err) } @@ -243,11 +286,22 @@ date: "2018-02-28" writeSource(t, fs, filepath.FromSlash("content/sect/doc1.nn.md"), contentTemplate) } +func (s *sitesBuilder) Fatalf(format string, args ...interface{}) { + Fatalf(s.T, format, args...) +} + +func Fatalf(t testing.TB, format string, args ...interface{}) { + trace := strings.Join(assert.CallerInfo(), "\n\r\t\t\t") + format = format + "\n%s" + args = append(args, trace) + t.Fatalf(format, args...) +} + func (s *sitesBuilder) AssertFileContent(filename string, matches ...string) { content := readDestination(s.T, s.Fs, filename) for _, match := range matches { if !strings.Contains(content, match) { - s.T.Fatalf("No match for %q in content for %s\n%q", match, filename, content) + s.Fatalf("No match for %q in content for %s\n%q", match, filename, content) } } } @@ -257,7 +311,7 @@ func (s *sitesBuilder) AssertFileContentRe(filename string, matches ...string) { for _, match := range matches { r := regexp.MustCompile(match) if !r.MatchString(content) { - s.T.Fatalf("No match for %q in content for %s\n%q", match, filename, content) + s.Fatalf("No match for %q in content for %s\n%q", match, filename, content) } } } @@ -277,14 +331,6 @@ func (th testHelper) assertFileContent(filename string, matches ...string) { } } -// TODO(bep) better name for this. It does no magic replacements depending on defaultontentLanguageInSubDir. -func (th testHelper) assertFileContentStraight(filename string, matches ...string) { - content := readDestination(th.T, th.Fs, filename) - for _, match := range matches { - require.True(th.T, strings.Contains(content, match), fmt.Sprintf("File no match for\n%q in\n%q:\n%s", strings.Replace(match, "%", "%%", -1), filename, strings.Replace(content, "%", "%%", -1))) - } -} - func (th testHelper) assertFileContentRegexp(filename string, matches ...string) { filename = th.replaceDefaultContentLanguageValue(filename) content := readDestination(th.T, th.Fs, filename) @@ -359,14 +405,14 @@ func newTestSite(t testing.TB, configKeyValues ...interface{}) *Site { s, err := NewSiteForCfg(d) if err != nil { - t.Fatalf("Failed to create Site: %s", err) + Fatalf(t, "Failed to create Site: %s", err) } return s } func newTestSitesFromConfig(t testing.TB, afs afero.Fs, tomlConfig string, layoutPathContentPairs ...string) (testHelper, *HugoSites) { if len(layoutPathContentPairs)%2 != 0 { - t.Fatalf("Layouts must be provided in pairs") + Fatalf(t, "Layouts must be provided in pairs") } writeToFs(t, afs, "config.toml", tomlConfig)