mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 15:28:54 +00:00
Joe Mooring
3d21b0687b
Fixes an issue where improper attribute derivation from the page's relative permalink caused failures with `outdir`, `imagesoutdir`, and `imagesdir` when `markup.asciidocext.workingFolderCurrent` is enabled. The updated logic now correctly handles: - Multi-byte characters - Multilingual multi-host sites - Site builds from a subdirectory - Pages using ugly URLs Supports diagram caching as implemented in v3.1.0 of the asciidoctor-diagram extension: - Enables caching by default - Sets default cache location to the compiled value of caches.misc.dir Reduces duration of integration tests by: - Generating GoAT diagrams instead of Ditaa diagrams - Taking advantage of asciidoctor-diagram caching Closes #9202 Closes #10183 Closes #10473 Closes #14160
407 lines
11 KiB
Go
407 lines
11 KiB
Go
// Copyright 2024 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 asciidocext converts AsciiDoc to HTML using the Asciidoctor
|
|
// external binary. The `asciidoc` module is reserved for a future golang
|
|
// implementation.
|
|
|
|
package asciidocext_test
|
|
|
|
import (
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/common/collections"
|
|
"github.com/gohugoio/hugo/common/hexec"
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/config/security"
|
|
"github.com/gohugoio/hugo/config/testconfig"
|
|
"github.com/gohugoio/hugo/markup/asciidocext"
|
|
"github.com/gohugoio/hugo/markup/asciidocext/asciidocext_config"
|
|
"github.com/gohugoio/hugo/markup/asciidocext/internal"
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
"github.com/gohugoio/hugo/markup/markup_config"
|
|
"github.com/spf13/afero"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
var defaultAsciiDocExtConfigAsJSON []byte
|
|
|
|
func init() {
|
|
var err error
|
|
defaultAsciiDocExtConfigAsJSON, err = json.Marshal(markup_config.Default.AsciiDocExt)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
func resetDefaultAsciiDocExtConfig() {
|
|
markup_config.Default.AsciiDocExt = asciidocext_config.Config{}
|
|
err := json.Unmarshal(defaultAsciiDocExtConfigAsJSON, &markup_config.Default.AsciiDocExt)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
func TestAsciidoctorDefaultArgs(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
conf := testconfig.GetTestConfig(afero.NewMemMapFs(), cfg)
|
|
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Conf: conf,
|
|
Logger: loggers.NewDefault(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*internal.AsciiDocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args, err := ac.ParseArgs(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
expected := []string{"--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorNonDefaultArgs(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
t.Cleanup(func() {
|
|
resetDefaultAsciiDocExtConfig()
|
|
})
|
|
|
|
mconf := markup_config.Default
|
|
mconf.AsciiDocExt.Backend = "manpage"
|
|
mconf.AsciiDocExt.NoHeaderOrFooter = false
|
|
mconf.AsciiDocExt.SafeMode = "safe"
|
|
mconf.AsciiDocExt.SectionNumbers = true
|
|
mconf.AsciiDocExt.Verbose = true
|
|
mconf.AsciiDocExt.Trace = false
|
|
mconf.AsciiDocExt.FailureLevel = "warn"
|
|
|
|
conf := testconfig.GetTestConfigSectionFromStruct("markup", mconf)
|
|
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Conf: conf,
|
|
Logger: loggers.NewDefault(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*internal.AsciiDocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args, err := ac.ParseArgs(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
expected := []string{"-b", "manpage", "--section-numbers", "--verbose", "--failure-level", "warn", "--safe-mode", "safe"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorDisallowedArgs(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
t.Cleanup(func() {
|
|
resetDefaultAsciiDocExtConfig()
|
|
})
|
|
|
|
mconf := markup_config.Default
|
|
mconf.AsciiDocExt.Backend = "disallowed-backend"
|
|
mconf.AsciiDocExt.Extensions = []string{"./disallowed-extension"}
|
|
mconf.AsciiDocExt.Attributes = map[string]any{"outdir": "disallowed-attribute"}
|
|
mconf.AsciiDocExt.SafeMode = "disallowed-safemode"
|
|
mconf.AsciiDocExt.FailureLevel = "disallowed-failurelevel"
|
|
|
|
conf := testconfig.GetTestConfigSectionFromStruct("markup", mconf)
|
|
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Conf: conf,
|
|
Logger: loggers.NewDefault(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*internal.AsciiDocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args, err := ac.ParseArgs(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
expected := []string{"--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorArbitraryExtension(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
t.Cleanup(func() {
|
|
resetDefaultAsciiDocExtConfig()
|
|
})
|
|
|
|
mconf := markup_config.Default
|
|
mconf.AsciiDocExt.Extensions = []string{"arbitrary-extension"}
|
|
conf := testconfig.GetTestConfigSectionFromStruct("markup", mconf)
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Conf: conf,
|
|
Logger: loggers.NewDefault(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*internal.AsciiDocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args, err := ac.ParseArgs(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
expected := []string{"-r", "arbitrary-extension", "--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorDisallowedExtension(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
t.Cleanup(func() {
|
|
resetDefaultAsciiDocExtConfig()
|
|
})
|
|
|
|
for _, disallowedExtension := range []string{
|
|
`foo-bar//`,
|
|
`foo-bar\\ `,
|
|
`../../foo-bar`,
|
|
`/foo-bar`,
|
|
`C:\foo-bar`,
|
|
`foo-bar.rb`,
|
|
`foo.bar`,
|
|
} {
|
|
mconf := markup_config.Default
|
|
mconf.AsciiDocExt.Extensions = []string{disallowedExtension}
|
|
conf := testconfig.GetTestConfigSectionFromStruct("markup", mconf)
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Conf: conf,
|
|
Logger: loggers.NewDefault(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*internal.AsciiDocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args, err := ac.ParseArgs(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
expected := []string{"--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
}
|
|
|
|
func TestAsciidoctorAttributes(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
t.Cleanup(func() {
|
|
resetDefaultAsciiDocExtConfig()
|
|
})
|
|
|
|
cfg := config.FromTOMLConfigString(`
|
|
[markup]
|
|
[markup.asciidocext]
|
|
trace = false
|
|
[markup.asciidocext.attributes]
|
|
my-base-url = "https://gohugo.io/"
|
|
my-attribute-name = "my value"
|
|
my-attribute-true = true
|
|
my-attribute-false = false
|
|
`)
|
|
conf := testconfig.GetTestConfig(nil, cfg)
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Conf: conf,
|
|
Logger: loggers.NewDefault(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*internal.AsciiDocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
expectedValues := map[string]bool{
|
|
"my-base-url=https://gohugo.io/": true,
|
|
"my-attribute-name=my value": true,
|
|
"my-attribute-true": true,
|
|
"'!my-attribute-false'": true,
|
|
}
|
|
|
|
args, err := ac.ParseArgs(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(len(args), qt.Equals, 9)
|
|
c.Assert(args[0], qt.Equals, "-a")
|
|
c.Assert(expectedValues[args[1]], qt.Equals, true)
|
|
c.Assert(args[2], qt.Equals, "-a")
|
|
c.Assert(expectedValues[args[3]], qt.Equals, true)
|
|
c.Assert(args[4], qt.Equals, "-a")
|
|
c.Assert(expectedValues[args[5]], qt.Equals, true)
|
|
c.Assert(args[6], qt.Equals, "-a")
|
|
c.Assert(expectedValues[args[7]], qt.Equals, true)
|
|
c.Assert(args[8], qt.Equals, "--no-header-footer")
|
|
}
|
|
|
|
func getProvider(c *qt.C, mConfStr string) converter.Provider {
|
|
confStr := `
|
|
[security]
|
|
[security.exec]
|
|
allow = ['asciidoctor']
|
|
`
|
|
confStr += mConfStr
|
|
|
|
cfg := config.FromTOMLConfigString(confStr)
|
|
conf := testconfig.GetTestConfig(nil, cfg)
|
|
securityConfig := conf.GetConfigSection("security").(security.Config)
|
|
|
|
p, err := asciidocext.Provider.New(
|
|
converter.ProviderConfig{
|
|
Logger: loggers.NewDefault(),
|
|
Conf: conf,
|
|
Exec: hexec.New(securityConfig, "", loggers.NewDefault()),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
return p
|
|
}
|
|
|
|
func TestConvert(t *testing.T) {
|
|
if ok, err := asciidocext.Supports(); !ok {
|
|
t.Skip(err)
|
|
}
|
|
c := qt.New(t)
|
|
|
|
p := getProvider(c, "")
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
b, err := conv.Convert(converter.RenderContext{Src: []byte("testContent")})
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(string(b.Bytes()), qt.Equals, "<div class=\"paragraph\">\n<p>testContent</p>\n</div>\n")
|
|
}
|
|
|
|
func TestTableOfContents(t *testing.T) {
|
|
if ok, err := asciidocext.Supports(); !ok {
|
|
t.Skip(err)
|
|
}
|
|
c := qt.New(t)
|
|
p := getProvider(c, "")
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
r, err := conv.Convert(converter.RenderContext{Src: []byte(`:toc: macro
|
|
:toclevels: 4
|
|
toc::[]
|
|
|
|
=== Introduction
|
|
|
|
== Section 1
|
|
|
|
=== Section 1.1
|
|
|
|
==== Section 1.1.1
|
|
|
|
=== Section 1.2
|
|
|
|
testContent
|
|
|
|
== Section 2
|
|
`)})
|
|
c.Assert(err, qt.IsNil)
|
|
toc, ok := r.(converter.TableOfContentsProvider)
|
|
c.Assert(ok, qt.Equals, true)
|
|
|
|
c.Assert(toc.TableOfContents().Identifiers, qt.DeepEquals, collections.SortedStringSlice{"_introduction", "_section_1", "_section_1_1", "_section_1_1_1", "_section_1_2", "_section_2"})
|
|
// Although "Introduction" has a level 3 markup heading, AsciiDoc treats the first heading as level 2.
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_introduction"].Level, qt.Equals, 2)
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_section_1"].Level, qt.Equals, 2)
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_section_1_1"].Level, qt.Equals, 3)
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_section_1_1_1"].Level, qt.Equals, 4)
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_section_1_2"].Level, qt.Equals, 3)
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_section_2"].Level, qt.Equals, 2)
|
|
c.Assert(string(r.Bytes()), qt.Not(qt.Contains), "<div id=\"toc\" class=\"toc\">")
|
|
}
|
|
|
|
func TestTableOfContentsWithCode(t *testing.T) {
|
|
if ok, err := asciidocext.Supports(); !ok {
|
|
t.Skip(err)
|
|
}
|
|
c := qt.New(t)
|
|
p := getProvider(c, "")
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
r, err := conv.Convert(converter.RenderContext{Src: []byte(`:toc: auto
|
|
|
|
== Some ` + "`code`" + ` in the title
|
|
`)})
|
|
c.Assert(err, qt.IsNil)
|
|
toc, ok := r.(converter.TableOfContentsProvider)
|
|
c.Assert(ok, qt.Equals, true)
|
|
c.Assert(toc.TableOfContents().HeadingsMap["_some_code_in_the_title"].Title, qt.Equals, "Some <code>code</code> in the title")
|
|
c.Assert(string(r.Bytes()), qt.Not(qt.Contains), "<div id=\"toc\" class=\"toc\">")
|
|
}
|
|
|
|
func TestTableOfContentsPreserveTOC(t *testing.T) {
|
|
if ok, err := asciidocext.Supports(); !ok {
|
|
t.Skip(err)
|
|
}
|
|
c := qt.New(t)
|
|
confStr := `
|
|
[markup]
|
|
[markup.asciidocExt]
|
|
preserveTOC = true
|
|
`
|
|
p := getProvider(c, confStr)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
r, err := conv.Convert(converter.RenderContext{Src: []byte(`:toc:
|
|
:idprefix:
|
|
:idseparator: -
|
|
|
|
== Some title
|
|
`)})
|
|
c.Assert(err, qt.IsNil)
|
|
toc, ok := r.(converter.TableOfContentsProvider)
|
|
c.Assert(ok, qt.Equals, true)
|
|
|
|
c.Assert(toc.TableOfContents().Identifiers, qt.DeepEquals, collections.SortedStringSlice{"some-title"})
|
|
c.Assert(string(r.Bytes()), qt.Contains, "<div id=\"toc\" class=\"toc\">")
|
|
}
|