github.com/graemephi/kahugo@v0.62.3-0.20211121071557-d78c0423784d/hugolib/pages_language_merge_test.go (about)

     1  // Copyright 2019 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package hugolib
    15  
    16  import (
    17  	"fmt"
    18  	"testing"
    19  
    20  	qt "github.com/frankban/quicktest"
    21  	"github.com/gohugoio/hugo/resources/resource"
    22  )
    23  
    24  // TODO(bep) move and rewrite in resource/page.
    25  
    26  func TestMergeLanguages(t *testing.T) {
    27  	t.Parallel()
    28  	c := qt.New(t)
    29  
    30  	b := newTestSiteForLanguageMerge(t, 30)
    31  	b.CreateSites()
    32  
    33  	b.Build(BuildCfg{SkipRender: true})
    34  
    35  	h := b.H
    36  
    37  	enSite := h.Sites[0]
    38  	frSite := h.Sites[1]
    39  	nnSite := h.Sites[2]
    40  
    41  	c.Assert(len(enSite.RegularPages()), qt.Equals, 31)
    42  	c.Assert(len(frSite.RegularPages()), qt.Equals, 6)
    43  	c.Assert(len(nnSite.RegularPages()), qt.Equals, 12)
    44  
    45  	for i := 0; i < 2; i++ {
    46  		mergedNN := nnSite.RegularPages().MergeByLanguage(enSite.RegularPages())
    47  		c.Assert(len(mergedNN), qt.Equals, 31)
    48  		for i := 1; i <= 31; i++ {
    49  			expectedLang := "en"
    50  			if i == 2 || i%3 == 0 || i == 31 {
    51  				expectedLang = "nn"
    52  			}
    53  			p := mergedNN[i-1]
    54  			c.Assert(p.Language().Lang, qt.Equals, expectedLang)
    55  		}
    56  	}
    57  
    58  	mergedFR := frSite.RegularPages().MergeByLanguage(enSite.RegularPages())
    59  	c.Assert(len(mergedFR), qt.Equals, 31)
    60  	for i := 1; i <= 31; i++ {
    61  		expectedLang := "en"
    62  		if i%5 == 0 {
    63  			expectedLang = "fr"
    64  		}
    65  		p := mergedFR[i-1]
    66  		c.Assert(p.Language().Lang, qt.Equals, expectedLang)
    67  	}
    68  
    69  	firstNN := nnSite.RegularPages()[0]
    70  	c.Assert(len(firstNN.Sites()), qt.Equals, 4)
    71  	c.Assert(firstNN.Sites().First().Language().Lang, qt.Equals, "en")
    72  
    73  	nnBundle := nnSite.getPage("page", "bundle")
    74  	enBundle := enSite.getPage("page", "bundle")
    75  
    76  	c.Assert(len(enBundle.Resources()), qt.Equals, 6)
    77  	c.Assert(len(nnBundle.Resources()), qt.Equals, 2)
    78  
    79  	var ri interface{} = nnBundle.Resources()
    80  
    81  	// This looks less ugly in the templates ...
    82  	mergedNNResources := ri.(resource.ResourcesLanguageMerger).MergeByLanguage(enBundle.Resources())
    83  	c.Assert(len(mergedNNResources), qt.Equals, 6)
    84  
    85  	unchanged, err := nnSite.RegularPages().MergeByLanguageInterface(nil)
    86  	c.Assert(err, qt.IsNil)
    87  	c.Assert(unchanged, deepEqualsPages, nnSite.RegularPages())
    88  }
    89  
    90  func TestMergeLanguagesTemplate(t *testing.T) {
    91  	t.Parallel()
    92  
    93  	b := newTestSiteForLanguageMerge(t, 15)
    94  	b.WithTemplates("home.html", `
    95  {{ $pages := .Site.RegularPages }}
    96  {{ .Scratch.Set "pages" $pages }}
    97  {{ if eq .Language.Lang "nn" }}:
    98  {{ $enSite := index .Sites 0 }}
    99  {{ $frSite := index .Sites 1 }}
   100  {{ $nnBundle := .Site.GetPage "page" "bundle" }}
   101  {{ $enBundle := $enSite.GetPage "page" "bundle" }}
   102  {{ .Scratch.Set "pages" ($pages | lang.Merge $frSite.RegularPages| lang.Merge $enSite.RegularPages) }}
   103  {{ .Scratch.Set "pages2" (sort ($nnBundle.Resources | lang.Merge $enBundle.Resources) "Title") }}
   104  {{ end }}
   105  {{ $pages := .Scratch.Get "pages" }}
   106  {{ $pages2 := .Scratch.Get "pages2" }}
   107  Pages1: {{ range $i, $p := $pages }}{{ add $i 1 }}: {{ .File.Path }} {{ .Language.Lang }} | {{ end }}
   108  Pages2: {{ range $i, $p := $pages2 }}{{ add $i 1 }}: {{ .Title }} {{ .Language.Lang }} | {{ end }}
   109  
   110  `,
   111  		"shortcodes/shortcode.html", "MyShort",
   112  		"shortcodes/lingo.html", "MyLingo",
   113  	)
   114  
   115  	b.CreateSites()
   116  	b.Build(BuildCfg{})
   117  
   118  	b.AssertFileContent("public/nn/index.html", "Pages1: 1: p1.md en | 2: p2.nn.md nn | 3: p3.nn.md nn | 4: p4.md en | 5: p5.fr.md fr | 6: p6.nn.md nn | 7: p7.md en | 8: p8.md en | 9: p9.nn.md nn | 10: p10.fr.md fr | 11: p11.md en | 12: p12.nn.md nn | 13: p13.md en | 14: p14.md en | 15: p15.nn.md nn")
   119  	b.AssertFileContent("public/nn/index.html", "Pages2: 1: doc100 en | 2: doc101 nn | 3: doc102 nn | 4: doc103 en | 5: doc104 en | 6: doc105 en")
   120  }
   121  
   122  func newTestSiteForLanguageMerge(t testing.TB, count int) *sitesBuilder {
   123  	contentTemplate := `---
   124  title: doc%d
   125  weight: %d
   126  date: "2018-02-28"
   127  ---
   128  # doc
   129  *some "content"*
   130  
   131  {{< shortcode >}}
   132  
   133  {{< lingo >}}
   134  `
   135  
   136  	builder := newTestSitesBuilder(t).WithDefaultMultiSiteConfig()
   137  
   138  	// We need some content with some missing translations.
   139  	// "en" is the main language, so add some English content + some Norwegian (nn, nynorsk) content.
   140  	var contentPairs []string
   141  	for i := 1; i <= count; i++ {
   142  		content := fmt.Sprintf(contentTemplate, i, i)
   143  		contentPairs = append(contentPairs, []string{fmt.Sprintf("p%d.md", i), content}...)
   144  		if i == 2 || i%3 == 0 {
   145  			// Add page 2,3, 6, 9 ... to both languages
   146  			contentPairs = append(contentPairs, []string{fmt.Sprintf("p%d.nn.md", i), content}...)
   147  		}
   148  		if i%5 == 0 {
   149  			// Add some French content, too.
   150  			contentPairs = append(contentPairs, []string{fmt.Sprintf("p%d.fr.md", i), content}...)
   151  		}
   152  	}
   153  
   154  	// See https://github.com/gohugoio/hugo/issues/4644
   155  	// Add a bundles
   156  	j := 100
   157  	contentPairs = append(contentPairs, []string{"bundle/index.md", fmt.Sprintf(contentTemplate, j, j)}...)
   158  	for i := 0; i < 6; i++ {
   159  		contentPairs = append(contentPairs, []string{fmt.Sprintf("bundle/pb%d.md", i), fmt.Sprintf(contentTemplate, i+j, i+j)}...)
   160  	}
   161  	contentPairs = append(contentPairs, []string{"bundle/index.nn.md", fmt.Sprintf(contentTemplate, j, j)}...)
   162  	for i := 1; i < 3; i++ {
   163  		contentPairs = append(contentPairs, []string{fmt.Sprintf("bundle/pb%d.nn.md", i), fmt.Sprintf(contentTemplate, i+j, i+j)}...)
   164  	}
   165  
   166  	builder.WithContent(contentPairs...)
   167  	return builder
   168  }
   169  
   170  func BenchmarkMergeByLanguage(b *testing.B) {
   171  	const count = 100
   172  
   173  	// newTestSiteForLanguageMerge creates count+1 pages.
   174  	builder := newTestSiteForLanguageMerge(b, count-1)
   175  	builder.CreateSites()
   176  	builder.Build(BuildCfg{SkipRender: true})
   177  	h := builder.H
   178  
   179  	enSite := h.Sites[0]
   180  	nnSite := h.Sites[2]
   181  
   182  	for i := 0; i < b.N; i++ {
   183  		merged := nnSite.RegularPages().MergeByLanguage(enSite.RegularPages())
   184  		if len(merged) != count {
   185  			b.Fatal("Count mismatch")
   186  		}
   187  	}
   188  }