2016-10-15 07:35:32 -04:00
|
|
|
// Copyright 2015 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 (
|
|
|
|
|
"path/filepath"
|
2017-03-16 05:04:30 -04:00
|
|
|
"runtime"
|
2016-10-15 07:35:32 -04:00
|
|
|
"testing"
|
2017-01-10 04:55:03 -05:00
|
|
|
|
2017-06-13 12:42:45 -04:00
|
|
|
"github.com/gohugoio/hugo/deps"
|
2017-01-10 04:55:03 -05:00
|
|
|
"github.com/stretchr/testify/require"
|
2016-10-15 07:35:32 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
const pageWithAlias = `---
|
|
|
|
|
title: Has Alias
|
|
|
|
|
aliases: ["foo/bar/"]
|
|
|
|
|
---
|
|
|
|
|
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
|
|
|
|
|
`
|
|
|
|
|
|
2017-03-24 06:25:25 -04:00
|
|
|
const pageWithAliasMultipleOutputs = `---
|
|
|
|
|
title: Has Alias for HTML and AMP
|
|
|
|
|
aliases: ["foo/bar/"]
|
|
|
|
|
outputs: ["HTML", "AMP", "JSON"]
|
|
|
|
|
---
|
|
|
|
|
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
|
|
|
|
|
`
|
|
|
|
|
|
2016-10-15 07:35:32 -04:00
|
|
|
const basicTemplate = "<html><body>{{.Content}}</body></html>"
|
|
|
|
|
const aliasTemplate = "<html><body>ALIASTEMPLATE</body></html>"
|
|
|
|
|
|
|
|
|
|
func TestAlias(t *testing.T) {
|
2017-02-04 22:20:06 -05:00
|
|
|
t.Parallel()
|
2016-10-15 07:35:32 -04:00
|
|
|
|
2017-02-04 22:20:06 -05:00
|
|
|
var (
|
|
|
|
|
cfg, fs = newTestCfg()
|
2017-02-17 14:52:50 -05:00
|
|
|
th = testHelper{cfg, fs, t}
|
2017-02-04 22:20:06 -05:00
|
|
|
)
|
2017-01-10 04:55:03 -05:00
|
|
|
|
|
|
|
|
writeSource(t, fs, filepath.Join("content", "page.md"), pageWithAlias)
|
|
|
|
|
writeSource(t, fs, filepath.Join("layouts", "_default", "single.html"), basicTemplate)
|
|
|
|
|
|
:sparkles: Implement Page bundling and image handling
This commit is not the smallest in Hugo's history.
Some hightlights include:
* Page bundles (for complete articles, keeping images and content together etc.).
* Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`.
* Processed images are cached inside `resources/_gen/images` (default) in your project.
* Symbolic links (both files and dirs) are now allowed anywhere inside /content
* A new table based build summary
* The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below).
A site building benchmark run compared to `v0.31.1` shows that this should be slightly faster and use less memory:
```bash
▶ ./benchSite.sh "TOML,num_langs=.*,num_root_sections=5,num_pages=(500|1000),tags_per_page=5,shortcodes,render"
benchmark old ns/op new ns/op delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 101785785 78067944 -23.30%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 185481057 149159919 -19.58%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 103149918 85679409 -16.94%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 203515478 169208775 -16.86%
benchmark old allocs new allocs delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 532464 391539 -26.47%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1056549 772702 -26.87%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 555974 406630 -26.86%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1086545 789922 -27.30%
benchmark old bytes new bytes delta
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 53243246 43598155 -18.12%
BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 105811617 86087116 -18.64%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 54558852 44545097 -18.35%
BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 106903858 86978413 -18.64%
```
Fixes #3651
Closes #3158
Fixes #1014
Closes #2021
Fixes #1240
Updates #3757
2017-07-24 03:00:23 -04:00
|
|
|
s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{})
|
|
|
|
|
|
|
|
|
|
require.Len(t, s.rawAllPages, 1)
|
2016-10-15 07:35:32 -04:00
|
|
|
|
|
|
|
|
// the real page
|
2017-02-17 15:14:52 -05:00
|
|
|
th.assertFileContent(filepath.Join("public", "page", "index.html"), "For some moments the old man")
|
2016-10-15 07:35:32 -04:00
|
|
|
// the alias redirector
|
2017-02-17 15:14:52 -05:00
|
|
|
th.assertFileContent(filepath.Join("public", "foo", "bar", "index.html"), "<meta http-equiv=\"refresh\" content=\"0; ")
|
2016-10-15 07:35:32 -04:00
|
|
|
}
|
|
|
|
|
|
2017-03-24 06:25:25 -04:00
|
|
|
func TestAliasMultipleOutputFormats(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
|
|
|
|
|
|
|
|
|
var (
|
|
|
|
|
cfg, fs = newTestCfg()
|
|
|
|
|
th = testHelper{cfg, fs, t}
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
writeSource(t, fs, filepath.Join("content", "page.md"), pageWithAliasMultipleOutputs)
|
|
|
|
|
writeSource(t, fs, filepath.Join("layouts", "_default", "single.html"), basicTemplate)
|
|
|
|
|
writeSource(t, fs, filepath.Join("layouts", "_default", "single.amp.html"), basicTemplate)
|
|
|
|
|
writeSource(t, fs, filepath.Join("layouts", "_default", "single.json"), basicTemplate)
|
|
|
|
|
|
|
|
|
|
buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{})
|
|
|
|
|
|
|
|
|
|
// the real pages
|
|
|
|
|
th.assertFileContent(filepath.Join("public", "page", "index.html"), "For some moments the old man")
|
|
|
|
|
th.assertFileContent(filepath.Join("public", "amp", "page", "index.html"), "For some moments the old man")
|
|
|
|
|
th.assertFileContent(filepath.Join("public", "page", "index.json"), "For some moments the old man")
|
|
|
|
|
|
|
|
|
|
// the alias redirectors
|
|
|
|
|
th.assertFileContent(filepath.Join("public", "foo", "bar", "index.html"), "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
|
|
|
th.assertFileContent(filepath.Join("public", "foo", "bar", "amp", "index.html"), "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
|
|
|
require.False(t, destinationExists(th.Fs, filepath.Join("public", "foo", "bar", "index.json")))
|
|
|
|
|
}
|
|
|
|
|
|
2016-10-15 07:35:32 -04:00
|
|
|
func TestAliasTemplate(t *testing.T) {
|
2017-02-04 22:20:06 -05:00
|
|
|
t.Parallel()
|
2016-10-15 07:35:32 -04:00
|
|
|
|
2017-02-04 22:20:06 -05:00
|
|
|
var (
|
|
|
|
|
cfg, fs = newTestCfg()
|
2017-02-17 14:52:50 -05:00
|
|
|
th = testHelper{cfg, fs, t}
|
2017-02-04 22:20:06 -05:00
|
|
|
)
|
2017-01-10 04:55:03 -05:00
|
|
|
|
|
|
|
|
writeSource(t, fs, filepath.Join("content", "page.md"), pageWithAlias)
|
|
|
|
|
writeSource(t, fs, filepath.Join("layouts", "_default", "single.html"), basicTemplate)
|
|
|
|
|
writeSource(t, fs, filepath.Join("layouts", "alias.html"), aliasTemplate)
|
|
|
|
|
|
2017-02-04 22:20:06 -05:00
|
|
|
sites, err := NewHugoSites(deps.DepsCfg{Fs: fs, Cfg: cfg})
|
2017-01-10 04:55:03 -05:00
|
|
|
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
|
|
require.NoError(t, sites.Build(BuildCfg{}))
|
2016-10-15 07:35:32 -04:00
|
|
|
|
|
|
|
|
// the real page
|
2017-02-17 15:14:52 -05:00
|
|
|
th.assertFileContent(filepath.Join("public", "page", "index.html"), "For some moments the old man")
|
2016-10-15 07:35:32 -04:00
|
|
|
// the alias redirector
|
2017-02-17 15:14:52 -05:00
|
|
|
th.assertFileContent(filepath.Join("public", "foo", "bar", "index.html"), "ALIASTEMPLATE")
|
2016-10-15 07:35:32 -04:00
|
|
|
}
|
2017-03-16 05:04:30 -04:00
|
|
|
|
|
|
|
|
func TestTargetPathHTMLRedirectAlias(t *testing.T) {
|
|
|
|
|
h := newAliasHandler(nil, newErrorLogger(), false)
|
|
|
|
|
|
|
|
|
|
errIsNilForThisOS := runtime.GOOS != "windows"
|
|
|
|
|
|
|
|
|
|
tests := []struct {
|
|
|
|
|
value string
|
|
|
|
|
expected string
|
|
|
|
|
errIsNil bool
|
|
|
|
|
}{
|
|
|
|
|
{"", "", false},
|
|
|
|
|
{"s", filepath.FromSlash("s/index.html"), true},
|
|
|
|
|
{"/", "", false},
|
|
|
|
|
{"alias 1", filepath.FromSlash("alias 1/index.html"), true},
|
|
|
|
|
{"alias 2/", filepath.FromSlash("alias 2/index.html"), true},
|
|
|
|
|
{"alias 3.html", "alias 3.html", true},
|
|
|
|
|
{"alias4.html", "alias4.html", true},
|
|
|
|
|
{"/alias 5.html", "alias 5.html", true},
|
|
|
|
|
{"/трям.html", "трям.html", true},
|
|
|
|
|
{"../../../../tmp/passwd", "", false},
|
|
|
|
|
{"/foo/../../../../tmp/passwd", filepath.FromSlash("tmp/passwd/index.html"), true},
|
|
|
|
|
{"foo/../../../../tmp/passwd", "", false},
|
|
|
|
|
{"C:\\Windows", filepath.FromSlash("C:\\Windows/index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/trailing-space /", filepath.FromSlash("trailing-space /index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/trailing-period./", filepath.FromSlash("trailing-period./index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/tab\tseparated/", filepath.FromSlash("tab\tseparated/index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/chrome/?p=help&ctx=keyboard#topic=3227046", filepath.FromSlash("chrome/?p=help&ctx=keyboard#topic=3227046/index.html"), errIsNilForThisOS},
|
|
|
|
|
{"/LPT1/Printer/", filepath.FromSlash("LPT1/Printer/index.html"), errIsNilForThisOS},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for _, test := range tests {
|
|
|
|
|
path, err := h.targetPathAlias(test.value)
|
|
|
|
|
if (err == nil) != test.errIsNil {
|
|
|
|
|
t.Errorf("Expected err == nil => %t, got: %t. err: %s", test.errIsNil, err == nil, err)
|
|
|
|
|
continue
|
|
|
|
|
}
|
|
|
|
|
if err == nil && path != test.expected {
|
|
|
|
|
t.Errorf("Expected: \"%s\", got: \"%s\"", test.expected, path)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
