mirror of
https://github.com/gohugoio/hugo.git
synced 2024-06-02 06:02:30 +00:00
597e418cb0
The main motivation of this commit is to add a `page.Page` interface to replace the very file-oriented `hugolib.Page` struct. This is all a preparation step for issue #5074, "pages from other data sources". But this also fixes a set of annoying limitations, especially related to custom output formats, and shortcodes. Most notable changes: * The inner content of shortcodes using the `{{%` as the outer-most delimiter will now be sent to the content renderer, e.g. Blackfriday. This means that any markdown will partake in the global ToC and footnote context etc. * The Custom Output formats are now "fully virtualized". This removes many of the current limitations. * The taxonomy list type now has a reference to the `Page` object. This improves the taxonomy template `.Title` situation and make common template constructs much simpler. See #5074 Fixes #5763 Fixes #5758 Fixes #5090 Fixes #5204 Fixes #4695 Fixes #5607 Fixes #5707 Fixes #5719 Fixes #3113 Fixes #5706 Fixes #5767 Fixes #5723 Fixes #5769 Fixes #5770 Fixes #5771 Fixes #5759 Fixes #5776 Fixes #5777 Fixes #5778
142 lines
4.8 KiB
Go
142 lines
4.8 KiB
Go
// Copyright 2019 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"
|
|
"runtime"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
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.
|
|
`
|
|
|
|
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.
|
|
`
|
|
|
|
const basicTemplate = "<html><body>{{.Content}}</body></html>"
|
|
const aliasTemplate = "<html><body>ALIASTEMPLATE</body></html>"
|
|
|
|
func TestAlias(t *testing.T) {
|
|
t.Parallel()
|
|
assert := require.New(t)
|
|
|
|
b := newTestSitesBuilder(t)
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAlias)
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
assert.Equal(1, len(b.H.Sites))
|
|
require.Len(t, b.H.Sites[0].RegularPages(), 1)
|
|
|
|
// the real page
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
|
// the alias redirector
|
|
b.AssertFileContent("public/foo/bar/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
}
|
|
|
|
func TestAliasMultipleOutputFormats(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
assert := require.New(t)
|
|
|
|
b := newTestSitesBuilder(t)
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAliasMultipleOutputs)
|
|
|
|
b.WithTemplates(
|
|
"_default/single.html", basicTemplate,
|
|
"_default/single.amp.html", basicTemplate,
|
|
"_default/single.json", basicTemplate)
|
|
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
// the real pages
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
|
b.AssertFileContent("public/amp/page/index.html", "For some moments the old man")
|
|
b.AssertFileContent("public/page/index.json", "For some moments the old man")
|
|
|
|
// the alias redirectors
|
|
b.AssertFileContent("public/foo/bar/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
b.AssertFileContent("public/foo/bar/amp/index.html", "<meta http-equiv=\"refresh\" content=\"0; ")
|
|
assert.False(b.CheckExists("public/foo/bar/index.json"))
|
|
}
|
|
|
|
func TestAliasTemplate(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
b := newTestSitesBuilder(t)
|
|
b.WithSimpleConfigFile().WithContent("page.md", pageWithAlias).WithTemplatesAdded("alias.html", aliasTemplate)
|
|
|
|
b.CreateSites().Build(BuildCfg{})
|
|
|
|
// the real page
|
|
b.AssertFileContent("public/page/index.html", "For some moments the old man")
|
|
// the alias redirector
|
|
b.AssertFileContent("public/foo/bar/index.html", "ALIASTEMPLATE")
|
|
}
|
|
|
|
func TestTargetPathHTMLRedirectAlias(t *testing.T) {
|
|
h := newAliasHandler(nil, loggers.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)
|
|
}
|
|
}
|
|
}
|