1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
// 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 (
"fmt"
"math/rand"
"path/filepath"
"strings"
"testing"
"github.com/spf13/afero"
)
type siteBuildingBenchmarkConfig struct {
Frontmatter string
NumPages int
RootSections int
Render bool
Shortcodes bool
NumTags int
TagsPerPage int
}
func (s siteBuildingBenchmarkConfig) String() string {
// Make it comma separated with no spaces, so it is both Bash and regexp friendly.
// To make it a short as possible, we only shows bools when enabled and ints when >= 0 (RootSections > 1)
sep := ","
id := s.Frontmatter + sep
if s.RootSections > 1 {
id += fmt.Sprintf("num_root_sections=%d%s", s.RootSections, sep)
}
id += fmt.Sprintf("num_pages=%d%s", s.NumPages, sep)
if s.NumTags > 0 {
id += fmt.Sprintf("num_tags=%d%s", s.NumTags, sep)
}
if s.TagsPerPage > 0 {
id += fmt.Sprintf("tags_per_page=%d%s", s.TagsPerPage, sep)
}
if s.Shortcodes {
id += "shortcodes" + sep
}
if s.Render {
id += "render" + sep
}
return strings.TrimSuffix(id, sep)
}
func BenchmarkSiteBuilding(b *testing.B) {
var conf siteBuildingBenchmarkConfig
for _, frontmatter := range []string{"YAML", "TOML"} {
conf.Frontmatter = frontmatter
for _, rootSections := range []int{1, 5} {
conf.RootSections = rootSections
for _, numTags := range []int{0, 1, 10, 20, 50, 100, 500, 1000, 5000} {
conf.NumTags = numTags
for _, tagsPerPage := range []int{0, 1, 5, 20, 50, 80} {
conf.TagsPerPage = tagsPerPage
for _, numPages := range []int{1, 10, 100, 500, 1000, 5000, 10000} {
conf.NumPages = numPages
for _, render := range []bool{false, true} {
conf.Render = render
for _, shortcodes := range []bool{false, true} {
conf.Shortcodes = shortcodes
doBenchMarkSiteBuilding(conf, b)
}
}
}
}
}
}
}
}
func doBenchMarkSiteBuilding(conf siteBuildingBenchmarkConfig, b *testing.B) {
b.Run(conf.String(), func(b *testing.B) {
sites := createHugoBenchmarkSites(b, b.N, conf)
b.ResetTimer()
for i := 0; i < b.N; i++ {
h := sites[0]
err := h.Build(BuildCfg{SkipRender: !conf.Render})
if err != nil {
b.Fatal(err)
}
// Try to help the GC
sites[0] = nil
sites = sites[1:len(sites)]
}
})
}
func createHugoBenchmarkSites(b *testing.B, count int, cfg siteBuildingBenchmarkConfig) []*HugoSites {
someMarkdown := `
An h1 header
============
Paragraphs are separated by a blank line.
2nd paragraph. *Italic* and **bold**. Itemized lists
look like:
* this one
* that one
* the other one
Note that --- not considering the asterisk --- the actual text
content starts at 4-columns in.
> Block quotes are
> written like so.
>
> They can span multiple paragraphs,
> if you like.
Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
in chapters 12--14"). Three dots ... will be converted to an ellipsis.
Unicode is supported. ☺
`
someMarkdownWithShortCode := someMarkdown + `
{{< myShortcode >}}
`
pageTemplateTOML := `+++
title = "%s"
tags = %s
+++
%s
`
pageTemplateYAML := `---
title: "%s"
tags:
%s
---
%s
`
siteConfig := `
baseURL = "http://example.com/blog"
paginate = 10
defaultContentLanguage = "en"
[Taxonomies]
tag = "tags"
category = "categories"
`
numTags := cfg.NumTags
if cfg.TagsPerPage > numTags {
numTags = cfg.TagsPerPage
}
var (
contentPagesContent [3]string
tags = make([]string, numTags)
pageTemplate string
)
for i := 0; i < numTags; i++ {
tags[i] = fmt.Sprintf("Hugo %d", i+1)
}
var tagsStr string
if cfg.Shortcodes {
contentPagesContent = [3]string{
someMarkdownWithShortCode,
strings.Repeat(someMarkdownWithShortCode, 2),
strings.Repeat(someMarkdownWithShortCode, 3),
}
} else {
contentPagesContent = [3]string{
someMarkdown,
strings.Repeat(someMarkdown, 2),
strings.Repeat(someMarkdown, 3),
}
}
sites := make([]*HugoSites, count)
for i := 0; i < count; i++ {
// Maybe consider reusing the Source fs
mf := afero.NewMemMapFs()
th, h := newTestSitesFromConfig(b, mf, siteConfig,
"layouts/_default/single.html", `Single HTML|{{ .Title }}|{{ .Content }}`,
"layouts/_default/list.html", `List HTML|{{ .Title }}|{{ .Content }}`,
"layouts/shortcodes/myShortcode.html", `<p>MyShortcode</p>`)
fs := th.Fs
pagesPerSection := cfg.NumPages / cfg.RootSections
for i := 0; i < cfg.RootSections; i++ {
for j := 0; j < pagesPerSection; j++ {
var tagsSlice []string
if numTags > 0 {
tagsStart := rand.Intn(numTags) - cfg.TagsPerPage
if tagsStart < 0 {
tagsStart = 0
}
tagsSlice = tags[tagsStart : tagsStart+cfg.TagsPerPage]
}
if cfg.Frontmatter == "TOML" {
pageTemplate = pageTemplateTOML
tagsStr = "[]"
if cfg.TagsPerPage > 0 {
tagsStr = strings.Replace(fmt.Sprintf("%q", tagsSlice), " ", ", ", -1)
}
} else {
// YAML
pageTemplate = pageTemplateYAML
for _, tag := range tagsSlice {
tagsStr += "\n- " + tag
}
}
content := fmt.Sprintf(pageTemplate, fmt.Sprintf("Title%d_%d", i, j), tagsStr, contentPagesContent[rand.Intn(3)])
writeSource(b, fs, filepath.Join(
|