wehub-resource-sync
502 lines
12 KiB
Go
502 lines
12 KiB
Go
// Copyright 2025 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 tplimpl_test
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/hugolib"
|
|
)
|
|
|
|
func TestEmbeddedLinkRenderHook(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- hugo.toml --
|
|
disableKinds = ['rss','sitemap','taxonomy','term']
|
|
[markup.goldmark.renderHooks.link]
|
|
useEmbedded = 'always'
|
|
-- layouts/list.html --
|
|
{{ .Content }}
|
|
-- layouts/single.html --
|
|
{{ .Content }}
|
|
-- assets/a.txt --
|
|
irrelevant
|
|
-- content/_index.md --
|
|
---
|
|
title: home
|
|
---
|
|
-- content/s1/_index.md --
|
|
---
|
|
title: s1
|
|
---
|
|
-- content/s1/p1.md --
|
|
---
|
|
title: s1/p1
|
|
---
|
|
-- content/s1/p2/index.md --
|
|
---
|
|
title: s1/p2
|
|
---
|
|
[500](a.txt) // global resource
|
|
[510](b.txt) // page resource
|
|
[520](./b.txt) // page resource
|
|
-- content/s1/p2/b.txt --
|
|
irrelevant
|
|
-- content/s1/p3.md --
|
|
---
|
|
title: s1/p3
|
|
---
|
|
// Remote
|
|
[10](https://a.org)
|
|
|
|
// fragment
|
|
[100](/#foo)
|
|
[110](#foo)
|
|
[120](p1#foo)
|
|
[130](p1/#foo)
|
|
|
|
// section page
|
|
[200](s1)
|
|
[210](/s1)
|
|
[220](../s1)
|
|
[230](s1/)
|
|
[240](/s1/)
|
|
[250](../s1/)
|
|
|
|
// regular page
|
|
[300](p1)
|
|
[310](/s1/p1)
|
|
[320](../s1/p1)
|
|
[330](p1/)
|
|
[340](/s1/p1/)
|
|
[350](../s1/p1/)
|
|
|
|
// leaf bundle
|
|
[400](p2)
|
|
[410](/s1/p2)
|
|
[420](../s1/p2)
|
|
[430](p2/)
|
|
[440](/s1/p2/)
|
|
[450](../s1/p2/)
|
|
|
|
// empty
|
|
[]()
|
|
`
|
|
|
|
b := hugolib.Test(t, files)
|
|
|
|
b.AssertFileContent("public/s1/p3/index.html",
|
|
`<a href="https://a.org">10</a>`,
|
|
`<a href="/#foo">100</a>`,
|
|
`<a href="/s1/p3/#foo">110</a>`,
|
|
`<a href="/s1/p1/#foo">120</a>`,
|
|
`<a href="/s1/p1/#foo">130</a>`,
|
|
|
|
`<a href="/s1/">200</a>`,
|
|
`<a href="/s1/">210</a>`,
|
|
`<a href="/s1/">220</a>`,
|
|
`<a href="/s1/">230</a>`,
|
|
`<a href="/s1/">240</a>`,
|
|
`<a href="/s1/">250</a>`,
|
|
|
|
`<a href="/s1/p1/">300</a>`,
|
|
`<a href="/s1/p1/">310</a>`,
|
|
`<a href="/s1/p1/">320</a>`,
|
|
`<a href="/s1/p1/">330</a>`,
|
|
`<a href="/s1/p1/">340</a>`,
|
|
`<a href="/s1/p1/">350</a>`,
|
|
|
|
`<a href="/s1/p2/">400</a>`,
|
|
`<a href="/s1/p2/">410</a>`,
|
|
`<a href="/s1/p2/">420</a>`,
|
|
`<a href="/s1/p2/">430</a>`,
|
|
`<a href="/s1/p2/">440</a>`,
|
|
`<a href="/s1/p2/">450</a>`,
|
|
|
|
`<a href=""></a>`,
|
|
)
|
|
|
|
b.AssertFileContent("public/s1/p2/index.html",
|
|
`<a href="/a.txt">500</a>`,
|
|
`<a href="/s1/p2/b.txt">510</a>`,
|
|
`<a href="/s1/p2/b.txt">520</a>`,
|
|
)
|
|
}
|
|
|
|
// Issue 12203
|
|
// Issue 12468
|
|
// Issue 12514
|
|
func TestEmbeddedImageRenderHook(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- hugo.toml --
|
|
baseURL = 'https://example.org/dir/'
|
|
disableKinds = ['home','rss','section','sitemap','taxonomy','term']
|
|
[markup.goldmark.extensions.typographer]
|
|
disable = true
|
|
[markup.goldmark.parser]
|
|
wrapStandAloneImageWithinParagraph = false
|
|
[markup.goldmark.parser.attribute]
|
|
block = false
|
|
[markup.goldmark.renderHooks.image]
|
|
useEmbedded = 'always'
|
|
-- content/p1/index.md --
|
|
![]()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{.foo #bar}
|
|
|
|
|
|
{id="\"><script>alert()</script>"}
|
|
-- content/p1/pixel.png --
|
|
iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==
|
|
-- layouts/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
b := hugolib.Test(t, files)
|
|
b.AssertFileContent("public/p1/index.html",
|
|
`<img src="" alt="">`,
|
|
`<img src="/dir/p1/pixel.png" alt="alt1">`,
|
|
`<img src="/dir/p1/pixel.png" alt="alt2-&<>'" title="&<>'">`,
|
|
`<img src="/dir/p1/pixel.png?a=b&c=d#fragment" alt="alt3">`,
|
|
`<img src="/dir/p1/pixel.png" alt="alt4">`,
|
|
)
|
|
|
|
files = strings.Replace(files, "block = false", "block = true", -1)
|
|
|
|
b = hugolib.Test(t, files)
|
|
b.AssertFileContent("public/p1/index.html",
|
|
`<img src="" alt="">`,
|
|
`<img src="/dir/p1/pixel.png" alt="alt1">`,
|
|
`<img src="/dir/p1/pixel.png" alt="alt2-&<>'" title="&<>'">`,
|
|
`<img src="/dir/p1/pixel.png?a=b&c=d#fragment" alt="alt3" class="foo" id="bar">`,
|
|
`<img src="/dir/p1/pixel.png" alt="alt4" id=""><script>alert()</script>">`,
|
|
)
|
|
}
|
|
|
|
// Issue 13535
|
|
func TestEmbeddedLinkAndImageRenderHookConfig(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- hugo.toml --
|
|
disableKinds = ['home','rss','section','sitemap','taxonomy','term']
|
|
|
|
[markup.goldmark]
|
|
duplicateResourceFiles = false
|
|
|
|
[markup.goldmark.renderHooks.image]
|
|
#KEY_VALUE
|
|
|
|
[markup.goldmark.renderHooks.link]
|
|
#KEY_VALUE
|
|
|
|
#LANGUAGES
|
|
-- content/s1/p1/index.md --
|
|
---
|
|
title: p1
|
|
---
|
|
[p2](p2)
|
|
|
|
[a](a.txt)
|
|
|
|
|
|
-- content/s1/p1/a.txt --
|
|
-- content/s1/p1/b.jpg --
|
|
-- content/s1/p2.md --
|
|
---
|
|
title: p2
|
|
---
|
|
-- layouts/all.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
const customHooks string = `
|
|
-- layouts/s1/_markup/render-link.html --
|
|
custom link render hook: {{ .Text }}|{{ .Destination }}
|
|
-- layouts/s1/_markup/render-image.html --
|
|
custom image render hook: {{ .Text }}|{{ .Destination }}
|
|
`
|
|
|
|
const languages string = `
|
|
[languages.en]
|
|
[languages.fr]
|
|
`
|
|
|
|
const (
|
|
fileToCheck = "public/s1/p1/index.html"
|
|
wantCustom string = "<p>custom link render hook: p2|p2</p>\n<p>custom link render hook: a|a.txt</p>\n<p>custom image render hook: b|b.jpg</p>"
|
|
wantEmbedded string = "<p><a href=\"/s1/p2/\">p2</a></p>\n<p><a href=\"/s1/p1/a.txt\">a</a></p>\n<p><img src=\"/s1/p1/b.jpg\" alt=\"b\"></p>"
|
|
wantGoldmark string = "<p><a href=\"p2\">p2</a></p>\n<p><a href=\"a.txt\">a</a></p>\n<p><img src=\"b.jpg\" alt=\"b\"></p>"
|
|
)
|
|
|
|
tests := []struct {
|
|
id string // the test id
|
|
isMultilingual bool // whether the site is multilingual single-host
|
|
hasCustomHooks bool // whether the site has custom link and image render hooks
|
|
keyValuePair string // the useEmbedded key-value pair
|
|
want string // the expected content of public/s1/p1/index.html
|
|
}{
|
|
{"01", false, false, "", wantGoldmark}, // monolingual
|
|
{"02", false, false, "useEmbedded = 'always'", wantEmbedded}, // monolingual, useEmbedded = 'always'
|
|
{"03", false, false, "useEmbedded = 'auto'", wantGoldmark}, // monolingual, useEmbedded = 'auto'
|
|
{"04", false, false, "useEmbedded = 'fallback'", wantEmbedded}, // monolingual, useEmbedded = 'fallback'
|
|
{"05", false, false, "useEmbedded = 'never'", wantGoldmark}, // monolingual, useEmbedded = 'never'
|
|
{"06", false, true, "", wantCustom}, // monolingual, with custom hooks
|
|
{"07", false, true, "useEmbedded = 'always'", wantEmbedded}, // monolingual, with custom hooks, useEmbedded = 'always'
|
|
{"08", false, true, "useEmbedded = 'auto'", wantCustom}, // monolingual, with custom hooks, useEmbedded = 'auto'
|
|
{"09", false, true, "useEmbedded = 'fallback'", wantCustom}, // monolingual, with custom hooks, useEmbedded = 'fallback'
|
|
{"10", false, true, "useEmbedded = 'never'", wantCustom}, // monolingual, with custom hooks, useEmbedded = 'never'
|
|
{"11", true, false, "", wantEmbedded}, // multilingual
|
|
{"12", true, false, "useEmbedded = 'always'", wantEmbedded}, // multilingual, useEmbedded = 'always'
|
|
{"13", true, false, "useEmbedded = 'auto'", wantEmbedded}, // multilingual, useEmbedded = 'auto'
|
|
{"14", true, false, "useEmbedded = 'fallback'", wantEmbedded}, // multilingual, useEmbedded = 'fallback'
|
|
{"15", true, false, "useEmbedded = 'never'", wantGoldmark}, // multilingual, useEmbedded = 'never'
|
|
{"16", true, true, "", wantCustom}, // multilingual, with custom hooks
|
|
{"17", true, true, "useEmbedded = 'always'", wantEmbedded}, // multilingual, with custom hooks, useEmbedded = 'always'
|
|
{"18", true, true, "useEmbedded = 'auto'", wantCustom}, // multilingual, with custom hooks, useEmbedded = 'auto'
|
|
{"19", true, true, "useEmbedded = 'fallback'", wantCustom}, // multilingual, with custom hooks, useEmbedded = 'fallback'
|
|
{"20", true, true, "useEmbedded = 'never'", wantCustom}, // multilingual, with custom hooks, useEmbedded = 'never'
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.id, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
f := files
|
|
if tt.isMultilingual {
|
|
f = strings.ReplaceAll(f, "#LANGUAGES", languages)
|
|
}
|
|
if tt.hasCustomHooks {
|
|
f = f + customHooks
|
|
}
|
|
f = strings.ReplaceAll(f, "#KEY_VALUE", tt.keyValuePair)
|
|
|
|
b := hugolib.Test(t, f)
|
|
b.AssertFileContent(fileToCheck, tt.want)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRenderHookMultilingual(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- hugo.toml --
|
|
baseURL = 'https://example.org/'
|
|
defaultContentLanguage = 'en'
|
|
[markup.goldmark.renderHooks.image]
|
|
useEmbedded = 'never'
|
|
[languages.en]
|
|
weight = 1
|
|
[languages.tr]
|
|
weight = 2
|
|
-- content/p1.en.md --
|
|
---
|
|
title: p1
|
|
---
|
|
|
|
-- content/p1.tr.md --
|
|
---
|
|
title: p1
|
|
---
|
|
|
|
-- layouts/_markup/render-image.tr.html --
|
|
TR-IMAGE
|
|
-- layouts/_default/single.html --
|
|
{{ .Content }}
|
|
`
|
|
|
|
b := hugolib.Test(t, files)
|
|
|
|
b.AssertFileContent("public/p1/index.html", "<img src=\"img.jpg\" alt=\"alt\">")
|
|
b.AssertFileContent("public/tr/p1/index.html", "TR-IMAGE")
|
|
}
|
|
|
|
// Hooks:
|
|
// table
|
|
// passthrough
|
|
// link
|
|
// image
|
|
// heading
|
|
// codeblock
|
|
// blockquote
|
|
func TestRenderHooksPosition(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- hugo.toml --
|
|
[markup]
|
|
[markup.goldmark]
|
|
[markup.goldmark.extensions]
|
|
[markup.goldmark.extensions.passthrough]
|
|
enable = true
|
|
[markup.goldmark.extensions.passthrough.delimiters]
|
|
block = [['\[', '\]'], ['$$', '$$']]
|
|
inline = [['\(', '\)']]
|
|
-- layouts/_markup/render-table.html --
|
|
HOOK_CONTENT
|
|
-- layouts/_markup/render-passthrough.html --
|
|
HOOK_CONTENT
|
|
-- layouts/_markup/render-link.html --
|
|
HOOK_CONTENT
|
|
-- layouts/_markup/render-image.html --
|
|
HOOK_CONTENT
|
|
-- layouts/_markup/render-heading.html --
|
|
HOOK_CONTENT
|
|
-- layouts/_markup/render-codeblock.html --
|
|
HOOK_CONTENT
|
|
-- layouts/_markup/render-blockquote.html --
|
|
HOOK_CONTENT
|
|
-- layouts/shortcodes/myheading.html --
|
|
{{ $s := .Get 0 -}}
|
|
|
|
|
|
{{ printf "## %s" $s }}
|
|
-- layouts/shortcodes/mylink.html --
|
|
{{ $s := .Get 0 -}}
|
|
|
|
A
|
|
|
|
B
|
|
|
|
{{ printf "[%s](%s)" $s $s }}
|
|
|
|
|
|
C
|
|
-- layouts/single.html --
|
|
{{ .Content }}
|
|
-- content/p1.md --
|
|
---
|
|
title: "p1"
|
|
---
|
|
|
|
[p1](/p1)
|
|
[p2](/p2)
|
|
7
|
|
8
|
|
{{% mylink "p3" %}}
|
|
10
|
|
11
|
|
12
|
|
## My Heading 2
|
|
14
|
|
### My Heading 3
|
|
16
|
|
{{% myheading "h4" %}}
|
|
18
|
|
## Table 1
|
|
20
|
|
| Month | Savings |
|
|
| -------- | ------- |
|
|
| January | $250 |
|
|
| February | $80 |
|
|
| March | $420 |
|
|
|
|
> blockquote 1
|
|
|
|
Foo.
|
|
|
|
> blockquote 2
|
|
|
|
|
|
### Code block
|
|
|
|
§§§go
|
|
fmt.Println("hello")
|
|
§§§
|
|
|
|
## PassThrough
|
|
|
|
\[block1\]
|
|
|
|
\[block2\]
|
|
|
|
This is an \(inline\) passthrough element with opening and closing inline delimiters.
|
|
|
|
|
|
`
|
|
|
|
files = strings.ReplaceAll(files, "HOOK_CONTENT", `
|
|
{{ $pos := .Position }}
|
|
{{ printf "%T" . }}|{{ path.Base $pos.Filename }}|{{ printf "%d:%d" $pos.LineNumber $pos.ColumnNumber }}|{{ $.Ordinal }}|
|
|
`)
|
|
b := hugolib.Test(t, files)
|
|
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"goldmark.linkContext|p1.md|5:1|0|",
|
|
"goldmark.linkContext|p1.md|6:2|1|",
|
|
"goldmark.linkContext|p1.md|9:1|2|",
|
|
"goldmark.headingContext|p1.md|13:1|0|",
|
|
"goldmark.headingContext|p1.md|15:1|1|",
|
|
"goldmark.headingContext|p1.md|17:1|2|",
|
|
"tables.tableContext|p1.md|20:1|0|",
|
|
"blockquotes.blockquoteContext|p1.md|27:1|0|",
|
|
"blockquotes.blockquoteContext|p1.md|31:1|1|",
|
|
"codeblocks.codeBlockContext|p1.md|36:1|0|",
|
|
"passthrough.passthroughContext|p1.md|42:1|0|",
|
|
"passthrough.passthroughContext|p1.md|44:2|1|",
|
|
"passthrough.passthroughContext|p1.md|46:12|2|",
|
|
)
|
|
}
|
|
|
|
func TestRenderHooksPositionRenderString(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
files := `
|
|
-- hugo.toml --
|
|
-- assets/a.txt --
|
|
|
|
## Heading
|
|
|
|
[link](b.txt)
|
|
|
|
-- assets/b.txt --
|
|
{{% myshortcode %}}
|
|
{{< myshortcode >}}
|
|
|
|
|
|
|
|
[link](a.txt)
|
|
-- layouts/shortcodes/myshortcode.html --
|
|
My Shortcode.
|
|
# This is a heading in the shortcode.
|
|
Some text.
|
|
-- layouts/_markup/render-link.html --
|
|
{{ $pos := .Position }}
|
|
{{ printf "%T" . }}|{{ path.Join $pos.Filename }}|{{ printf "%d:%d" $pos.LineNumber $pos.ColumnNumber }}|{{ $.Ordinal }}|
|
|
-- layouts/all.html --
|
|
{{ $a := resources.Get "a.txt" }}
|
|
a: {{ .RenderString $a.Content }}
|
|
b: {{ .RenderString (resources.Get "b.txt").Content }}
|
|
-- content/p1.md --
|
|
|
|
|
|
`
|
|
|
|
b := hugolib.Test(t, files)
|
|
b.AssertFileContent("public/p1/index.html",
|
|
"/content/p1.md (rendered from string)|4:1|0|",
|
|
"/content/p1.md (rendered from string)|6:3|0|",
|
|
)
|
|
}
|