// Copyright 2017 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT package markdown_test import ( "context" "html/template" "strings" "testing" "code.gitea.io/gitea/modules/git" "code.gitea.io/gitea/modules/gitrepo" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/markup" "code.gitea.io/gitea/modules/markup/markdown" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/svg" "code.gitea.io/gitea/modules/test" "code.gitea.io/gitea/modules/util" "github.com/stretchr/testify/assert" "golang.org/x/text/cases" "golang.org/x/text/language" ) const ( AppURL = "http://localhost:3000/" testRepoOwnerName = "user13" testRepoName = "repo11" FullURL = AppURL + testRepoOwnerName + "/" + testRepoName + "/" ) // these values should match the const above var localMetas = map[string]string{ "user": testRepoOwnerName, "repo": testRepoName, } var localWikiMetas = map[string]string{ "user": testRepoOwnerName, "repo": testRepoName, "markupContentMode": "wiki", } type mockRepo struct { OwnerName string RepoName string } func (m *mockRepo) GetOwnerName() string { return m.OwnerName } func (m *mockRepo) GetName() string { return m.RepoName } func newMockRepo(ownerName, repoName string) gitrepo.Repository { return &mockRepo{ OwnerName: ownerName, RepoName: repoName, } } func TestRender_StandardLinks(t *testing.T) { setting.AppURL = AppURL test := func(input, expected, expectedWiki string) { buffer, err := markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, }, }, input) assert.NoError(t, err) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) buffer, err = markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, }, Metas: localWikiMetas, }, input) assert.NoError(t, err) assert.Equal(t, strings.TrimSpace(expectedWiki), strings.TrimSpace(string(buffer))) } googleRendered := `

` test("", googleRendered, googleRendered) lnk := util.URLJoin(FullURL, "WikiPage") lnkWiki := util.URLJoin(FullURL, "wiki", "WikiPage") test("[WikiPage](WikiPage)", `

`, `

WikiPage

`) } func TestRender_Images(t *testing.T) { setting.AppURL = AppURL test := func(input, expected string) { buffer, err := markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, }, }, input) assert.NoError(t, err) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) } url := "../../.images/src/02/train.jpg" title := "Train" href := "https://gitea.io" result := util.URLJoin(FullURL, url) // hint: With Markdown v2.5.2, there is a new syntax: [link](URL){:target="_blank"} , but we do not support it now test( "!["+title+"]("+url+")", `

`) test( "[["+title+"|"+url+"]]", `

`) test( "[!["+title+"]("+url+")]("+href+")", `

`) test( "!["+title+"]("+url+")", `

`) test( "[["+title+"|"+url+"]]", `

`) test( "[!["+title+"]("+url+")]("+href+")", `

`) } func testAnswers(baseURLContent, baseURLImages string) []string { return []string{ `

Wiki! Enjoy :)

See commit 65f1bf27bc

Ideas and codes

Bezier widget (by @r-lyeh) ocornut/imgui#786
Bezier widget (by @r-lyeh) #786
Node graph editors https://github.com/ocornut/imgui/issues/306
Memory Editor
Plot var helper

`, `

What is Wine Staging?

Wine Staging on website wine-staging.com.

Quick Links

Here are some links to the most important topics. You can find the full list of pages at the sidebar.

	Installation
	Usage

`, `

Excelsior JET allows you to create native executables for Windows, Linux and Mac OS X.

Package your libGDX application
Perform a test run by hitting the Run! button.

More tests

(from https://www.markdownguide.org/extended-syntax/)

Checkboxes

unchecked
checked
still unchecked

Definition list

First Term: This is the definition of the first term.
Second Term: This is one definition of the second term.; This is another definition of the second term.

Footnotes

Here is a simple footnote,¹ and here is a longer one.²

This is the first footnote. ↩︎
Here is one with multiple paragraphs and code.

Indent paragraphs to include them in the footnote.

{ my code }

Add as many paragraphs as you like. ↩︎

`, `

If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by Renovate Bot.

`, } } // Test cases without ambiguous links var sameCases = []string{ // dear imgui wiki markdown extract: special wiki syntax `Wiki! Enjoy :) - [[Links, Language bindings, Engine bindings|Links]] - [[Tips]] See commit 65f1bf27bc Ideas and codes - Bezier widget (by @r-lyeh) ` + AppURL + `ocornut/imgui/issues/786 - Bezier widget (by @r-lyeh) ` + FullURL + `issues/786 - Node graph editors https://github.com/ocornut/imgui/issues/306 - [[Memory Editor|memory_editor_example]] - [[Plot var helper|plot_var_example]]`, // wine-staging wiki home extract: tables, special wiki syntax, images `## What is Wine Staging? **Wine Staging** on website [wine-staging.com](http://wine-staging.com). ## Quick Links Here are some links to the most important topics. You can find the full list of pages at the sidebar. | [[images/icon-install.png]] | [[Installation]] | |--------------------------------|----------------------------------------------------------| | [[images/icon-usage.png]] | [[Usage]] | `, // libgdx wiki page: inline images with special syntax `[Excelsior JET](http://www.excelsiorjet.com/) allows you to create native executables for Windows, Linux and Mac OS X. 1. [Package your libGDX application](https://github.com/libgdx/libgdx/wiki/Gradle-on-the-Commandline#packaging-for-the-desktop) [[images/1.png]] 2. Perform a test run by hitting the Run! button. [[images/2.png]] ## More tests {#custom-id} (from https://www.markdownguide.org/extended-syntax/) ### Checkboxes - [ ] unchecked - [x] checked - [ ] still unchecked ### Definition list First Term : This is the definition of the first term. Second Term : This is one definition of the second term. : This is another definition of the second term. ### Footnotes Here is a simple footnote,[^1] and here is a longer one.[^bignote] [^1]: This is the first footnote. [^bignote]: Here is one with multiple paragraphs and code. Indent paragraphs to include them in the footnote. ` + "`{ my code }`" + ` Add as many paragraphs as you like. `, ` - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). `, } func TestTotal_RenderWiki(t *testing.T) { defer test.MockVariableValue(&markup.RenderBehaviorForTesting.ForceHardLineBreak, true)() defer test.MockVariableValue(&markup.RenderBehaviorForTesting.DisableInternalAttributes, true)() setting.AppURL = AppURL answers := testAnswers(util.URLJoin(FullURL, "wiki"), util.URLJoin(FullURL, "wiki", "raw")) for i := 0; i < len(sameCases); i++ { line, err := markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, }, Repo: newMockRepo(testRepoOwnerName, testRepoName), Metas: localWikiMetas, }, sameCases[i]) assert.NoError(t, err) assert.Equal(t, answers[i], string(line)) } testCases := []string{ // Guard wiki sidebar: special syntax `[[Guardfile-DSL / Configuring-Guard|Guardfile-DSL---Configuring-Guard]]`, // rendered `

Guardfile-DSL / Configuring-Guard

`, // special syntax `[[Name|Link]]`, // rendered `

Name

`, } for i := 0; i < len(testCases); i += 2 { line, err := markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, }, Metas: localWikiMetas, }, testCases[i]) assert.NoError(t, err) assert.EqualValues(t, testCases[i+1], string(line)) } } func TestTotal_RenderString(t *testing.T) { defer test.MockVariableValue(&markup.RenderBehaviorForTesting.ForceHardLineBreak, true)() defer test.MockVariableValue(&markup.RenderBehaviorForTesting.DisableInternalAttributes, true)() setting.AppURL = AppURL answers := testAnswers(util.URLJoin(FullURL, "src", "master"), util.URLJoin(FullURL, "media", "master")) for i := 0; i < len(sameCases); i++ { line, err := markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, BranchPath: "master", }, Repo: newMockRepo(testRepoOwnerName, testRepoName), Metas: localMetas, }, sameCases[i]) assert.NoError(t, err) assert.Equal(t, answers[i], string(line)) } testCases := []string{} for i := 0; i < len(testCases); i += 2 { line, err := markdown.RenderString(&markup.RenderContext{ Ctx: git.DefaultContext, Links: markup.Links{ Base: FullURL, }, }, testCases[i]) assert.NoError(t, err) assert.Equal(t, template.HTML(testCases[i+1]), line) } } func TestRender_RenderParagraphs(t *testing.T) { test := func(t *testing.T, str string, cnt int) { res, err := markdown.RenderRawString(&markup.RenderContext{Ctx: git.DefaultContext}, str) assert.NoError(t, err) assert.Equal(t, cnt, strings.Count(res, "

` defer test.MockVariableValue(&markup.RenderBehaviorForTesting.ForceHardLineBreak, true)() res, err := markdown.RenderRawString(&markup.RenderContext{Ctx: git.DefaultContext}, testcase) assert.NoError(t, err) assert.Equal(t, expected, res) } func TestRenderEmojiInLinks_Issue12331(t *testing.T) { testcase := `[Link with emoji :moon: in text](https://gitea.io)` expected := `

Link with emoji 🌔 in text

` res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, testcase) assert.NoError(t, err) assert.Equal(t, template.HTML(expected), res) } func TestColorPreview(t *testing.T) { const nl = "\n" positiveTests := []struct { testcase string expected string }{ { // do not render color names "The CSS class `red` is there", "

The CSS class red is there

\n", }, { // hex "`#FF0000`", `

#FF0000

` + nl, }, { // rgb "`rgb(16, 32, 64)`", `

rgb(16, 32, 64)

` + nl, }, { // short hex "This is the color white `#0a0`", `

This is the color white #0a0

` + nl, }, { // hsl "HSL stands for hue, saturation, and lightness. An example: `hsl(0, 100%, 50%)`.", `

HSL stands for hue, saturation, and lightness. An example: hsl(0, 100%, 50%).

` + nl, }, { // uppercase hsl "HSL stands for hue, saturation, and lightness. An example: `HSL(0, 100%, 50%)`.", `

HSL stands for hue, saturation, and lightness. An example: HSL(0, 100%, 50%).

` + nl, }, } for _, test := range positiveTests { res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, test.testcase) assert.NoError(t, err, "Unexpected error in testcase: %q", test.testcase) assert.Equal(t, template.HTML(test.expected), res, "Unexpected result in testcase %q", test.testcase) } negativeTests := []string{ // not a color code "`FF0000`", // inside a code block "```javascript" + nl + `const red = "#FF0000";` + nl + "```", // no backticks "rgb(166, 32, 64)", // typo "`hsI(0, 100%, 50%)`", // looks like a color but not really "`hsl(40, 60, 80)`", } for _, test := range negativeTests { res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, test) assert.NoError(t, err, "Unexpected error in testcase: %q", test) assert.NotContains(t, res, `a

` + nl, }, { "$ a $", `

a

` + nl, }, { "$a$ $b$", `

a b

` + nl, }, { `$a$ $b$`, `

a b

` + nl, }, { `$a$.`, `

a.

` + nl, }, { `.$a$`, `

.$a$

` + nl, }, { `$a a$b b$`, `

$a a$b b$

` + nl, }, { `a a$b b`, `

a a$b b

` + nl, }, { `a$b $a a$b b$`, `

a$b $a a$b b$

` + nl, }, { "a$x$", `

a$x$

` + nl, }, { "$x$a", `

$x$a

` + nl, }, { "$$a$$", `

` + nl, }, { "$a$ ($b$) [$c$] {$d$}", `

a (b) [$c$] {$d$}

` + nl, }, { "$$a$$ test", `

a test

` + nl, }, { "test $$a$$", `

test a

` + nl, }, } for _, test := range testcases { res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, test.testcase) assert.NoError(t, err, "Unexpected error in testcase: %q", test.testcase) assert.Equal(t, template.HTML(test.expected), res, "Unexpected result in testcase %q", test.testcase) } } func TestTaskList(t *testing.T) { testcases := []struct { testcase string expected string }{ { // data-source-position should take into account YAML frontmatter. `--- foo: bar --- - [ ] task 1`, `

foo
bar

task 1

`, }, } for _, test := range testcases { res, err := markdown.RenderString(&markup.RenderContext{Ctx: git.DefaultContext}, test.testcase) assert.NoError(t, err, "Unexpected error in testcase: %q", test.testcase) assert.Equal(t, template.HTML(test.expected), res, "Unexpected result in testcase %q", test.testcase) } } func TestRenderLinks(t *testing.T) { input := ` space @mention-user${SPACE}${SPACE} /just/a/path.bin https://example.com/file.bin [local link](file.bin) [remote link](https://example.com) [[local link|file.bin]] [[remote link|https://example.com]] ![local image](image.jpg) ![local image](path/file) ![local image](/path/file) ![remote image](https://example.com/image.jpg) [[local image|image.jpg]] [[remote link|https://example.com/image.jpg]] https://example.com/user/repo/compare/88fc37a3c0a4dda553bdcfc80c178a58247f42fb...12fc37a3c0a4dda553bdcfc80c178a58247f42fb#hash com 88fc37a3c0a4dda553bdcfc80c178a58247f42fb...12fc37a3c0a4dda553bdcfc80c178a58247f42fb pare https://example.com/user/repo/commit/88fc37a3c0a4dda553bdcfc80c178a58247f42fb com 88fc37a3c0a4dda553bdcfc80c178a58247f42fb mit :+1: mail@domain.com @mention-user test #123 space${SPACE}${SPACE} ` input = strings.ReplaceAll(input, "${SPACE}", " ") // replace ${SPACE} with " ", to avoid some editor's auto-trimming cases := []struct { Links markup.Links IsWiki bool Expected string }{ { // 0 Links: markup.Links{}, IsWiki: false, Expected: `

space @mention-user
/just/a/path.bin
https://example.com/file.bin
local link
remote link
local link
remote link

88fc37a3c0...12fc37a3c0 (hash)
com 88fc37a3c0a4dda553bdcfc80c178a58247f42fb...12fc37a3c0a4dda553bdcfc80c178a58247f42fb pare
88fc37a3c0
com 88fc37a3c0a4dda553bdcfc80c178a58247f42fb mit
👍
mail@domain.com
@mention-user test
#123
space

`, }, { // 1 Links: markup.Links{}, IsWiki: true, Expected: `

`, }, { // 2 Links: markup.Links{ Base: "https://gitea.io/", }, IsWiki: false, Expected: `

`, }, { // 3 Links: markup.Links{ Base: "https://gitea.io/", }, IsWiki: true, Expected: `

`, }, { // 4 Links: markup.Links{ Base: "/relative/path", }, IsWiki: false, Expected: `

`, }, { // 5 Links: markup.Links{ Base: "/relative/path", }, IsWiki: true, Expected: `

`, }, { // 6 Links: markup.Links{ Base: "/user/repo", BranchPath: "branch/main", }, IsWiki: false, Expected: `

`, }, { // 7 Links: markup.Links{ Base: "/relative/path", BranchPath: "branch/main", }, IsWiki: true, Expected: `

`, }, { // 8 Links: markup.Links{ Base: "/user/repo", TreePath: "sub/folder", }, IsWiki: false, Expected: `

`, }, { // 9 Links: markup.Links{ Base: "/relative/path", TreePath: "sub/folder", }, IsWiki: true, Expected: `

`, }, { // 10 Links: markup.Links{ Base: "/user/repo", BranchPath: "branch/main", TreePath: "sub/folder", }, IsWiki: false, Expected: `

`, }, { // 11 Links: markup.Links{ Base: "/relative/path", BranchPath: "branch/main", TreePath: "sub/folder", }, IsWiki: true, Expected: `

`, }, } defer test.MockVariableValue(&markup.RenderBehaviorForTesting.ForceHardLineBreak, true)() defer test.MockVariableValue(&markup.RenderBehaviorForTesting.DisableInternalAttributes, true)() for i, c := range cases { result, err := markdown.RenderString(&markup.RenderContext{ Ctx: context.Background(), Links: c.Links, Metas: util.Iif(c.IsWiki, map[string]string{"markupContentMode": "wiki"}, map[string]string{}), }, input) assert.NoError(t, err, "Unexpected error in testcase: %v", i) assert.Equal(t, c.Expected, string(result), "Unexpected result in testcase %v", i) } } func TestAttention(t *testing.T) { defer svg.MockIcon("octicon-info")() defer svg.MockIcon("octicon-light-bulb")() defer svg.MockIcon("octicon-report")() defer svg.MockIcon("octicon-alert")() defer svg.MockIcon("octicon-stop")() renderAttention := func(attention, icon string) string { tmpl := `

{Attention}
` tmpl = strings.ReplaceAll(tmpl, "{attention}", attention) tmpl = strings.ReplaceAll(tmpl, "{icon}", icon) tmpl = strings.ReplaceAll(tmpl, "{Attention}", cases.Title(language.English).String(attention)) return tmpl } test := func(input, expected string) { result, err := markdown.RenderString(&markup.RenderContext{Ctx: context.Background()}, input) assert.NoError(t, err) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(result))) } test(` > [!NOTE] > text `, renderAttention("note", "octicon-info")+"\n
text
\n

") test(`> [!note]`, renderAttention("note", "octicon-info")+"\n") test(`> [!tip]`, renderAttention("tip", "octicon-light-bulb")+"\n") test(`> [!important]`, renderAttention("important", "octicon-report")+"\n") test(`> [!warning]`, renderAttention("warning", "octicon-alert")+"\n") test(`> [!caution]`, renderAttention("caution", "octicon-stop")+"\n") // escaped by mdformat test(`> \[!NOTE\]`, renderAttention("note", "octicon-info")+"\n") // legacy GitHub style test(`> **warning**`, renderAttention("warning", "octicon-alert")+"\n") } func BenchmarkSpecializedMarkdown(b *testing.B) { // 240856 4719 ns/op for i := 0; i < b.N; i++ { markdown.SpecializedMarkdown(&markup.RenderContext{}) } } func BenchmarkMarkdownRender(b *testing.B) { // 23202 50840 ns/op for i := 0; i < b.N; i++ { _, _ = markdown.RenderString(&markup.RenderContext{Ctx: context.Background()}, "https://example.com\n- a\n- b\n") } }