123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538 |
- // Copyright 2017 The Gitea Authors. All rights reserved.
- // Use of this source code is governed by a MIT-style
- // license that can be found in the LICENSE file.
-
- package markdown_test
-
- import (
- "context"
- "os"
- "strings"
- "testing"
-
- "code.gitea.io/gitea/modules/git"
- "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/util"
-
- "github.com/stretchr/testify/assert"
- )
-
- const (
- AppURL = "http://localhost:3000/"
- Repo = "gogits/gogs"
- AppSubURL = AppURL + Repo + "/"
- )
-
- // these values should match the Repo const above
- var localMetas = map[string]string{
- "user": "gogits",
- "repo": "gogs",
- "repoPath": "../../../tests/gitea-repositories-meta/user13/repo11.git/",
- }
-
- func TestMain(m *testing.M) {
- setting.LoadAllowEmpty()
- if err := git.InitSimple(context.Background()); err != nil {
- log.Fatal("git init failed, err: %v", err)
- }
- markup.Init(&markup.ProcessorHelper{
- IsUsernameMentionable: func(ctx context.Context, username string) bool {
- return username == "r-lyeh"
- },
- })
- os.Exit(m.Run())
- }
-
- func TestRender_StandardLinks(t *testing.T) {
- setting.AppURL = AppURL
- setting.AppSubURL = AppSubURL
-
- test := func(input, expected, expectedWiki string) {
- buffer, err := RenderString(&markup.RenderContext{
- URLPrefix: setting.AppSubURL,
- }, input)
- assert.NoError(t, err)
- assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
-
- buffer, err = RenderString(&markup.RenderContext{
- URLPrefix: setting.AppSubURL,
- IsWiki: true,
- }, input)
- assert.NoError(t, err)
- assert.Equal(t, strings.TrimSpace(expectedWiki), strings.TrimSpace(buffer))
- }
-
- googleRendered := `<p><a href="https://google.com/" rel="nofollow">https://google.com/</a></p>`
- test("<https://google.com/>", googleRendered, googleRendered)
-
- lnk := util.URLJoin(AppSubURL, "WikiPage")
- lnkWiki := util.URLJoin(AppSubURL, "wiki", "WikiPage")
- test("[WikiPage](WikiPage)",
- `<p><a href="`+lnk+`" rel="nofollow">WikiPage</a></p>`,
- `<p><a href="`+lnkWiki+`" rel="nofollow">WikiPage</a></p>`)
- }
-
- func TestMisc_IsMarkdownFile(t *testing.T) {
- setting.Markdown.FileExtensions = []string{".md", ".markdown", ".mdown", ".mkd"}
- trueTestCases := []string{
- "test.md",
- "wow.MARKDOWN",
- "LOL.mDoWn",
- }
- falseTestCases := []string{
- "test",
- "abcdefg",
- "abcdefghijklmnopqrstuvwxyz",
- "test.md.test",
- }
-
- for _, testCase := range trueTestCases {
- assert.True(t, IsMarkdownFile(testCase))
- }
- for _, testCase := range falseTestCases {
- assert.False(t, IsMarkdownFile(testCase))
- }
- }
-
- func TestRender_Images(t *testing.T) {
- setting.AppURL = AppURL
- setting.AppSubURL = AppSubURL
-
- test := func(input, expected string) {
- buffer, err := RenderString(&markup.RenderContext{
- URLPrefix: setting.AppSubURL,
- }, input)
- assert.NoError(t, err)
- assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
- }
-
- url := "../../.images/src/02/train.jpg"
- title := "Train"
- href := "https://gitea.io"
- result := util.URLJoin(AppSubURL, 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+")",
- `<p><a href="`+result+`" target="_blank" rel="nofollow noopener"><img src="`+result+`" alt="`+title+`"/></a></p>`)
-
- test(
- "[["+title+"|"+url+"]]",
- `<p><a href="`+result+`" rel="nofollow"><img src="`+result+`" title="`+title+`" alt="`+title+`"/></a></p>`)
- test(
- "[!["+title+"]("+url+")]("+href+")",
- `<p><a href="`+href+`" rel="nofollow"><img src="`+result+`" alt="`+title+`"/></a></p>`)
-
- url = "/../../.images/src/02/train.jpg"
- test(
- "!["+title+"]("+url+")",
- `<p><a href="`+result+`" target="_blank" rel="nofollow noopener"><img src="`+result+`" alt="`+title+`"/></a></p>`)
-
- test(
- "[["+title+"|"+url+"]]",
- `<p><a href="`+result+`" rel="nofollow"><img src="`+result+`" title="`+title+`" alt="`+title+`"/></a></p>`)
- test(
- "[!["+title+"]("+url+")]("+href+")",
- `<p><a href="`+href+`" rel="nofollow"><img src="`+result+`" alt="`+title+`"/></a></p>`)
- }
-
- func testAnswers(baseURLContent, baseURLImages string) []string {
- return []string{
- `<p>Wiki! Enjoy :)</p>
- <ul>
- <li><a href="` + baseURLContent + `/Links" rel="nofollow">Links, Language bindings, Engine bindings</a></li>
- <li><a href="` + baseURLContent + `/Tips" rel="nofollow">Tips</a></li>
- </ul>
- <p>See commit <a href="http://localhost:3000/gogits/gogs/commit/65f1bf27bc" rel="nofollow"><code>65f1bf27bc</code></a></p>
- <p>Ideas and codes</p>
- <ul>
- <li>Bezier widget (by <a href="` + AppURL + `r-lyeh" rel="nofollow">@r-lyeh</a>) <a href="http://localhost:3000/ocornut/imgui/issues/786" class="ref-issue" rel="nofollow">ocornut/imgui#786</a></li>
- <li>Bezier widget (by <a href="` + AppURL + `r-lyeh" rel="nofollow">@r-lyeh</a>) <a href="http://localhost:3000/gogits/gogs/issues/786" class="ref-issue" rel="nofollow">#786</a></li>
- <li>Node graph editors <a href="https://github.com/ocornut/imgui/issues/306" rel="nofollow">https://github.com/ocornut/imgui/issues/306</a></li>
- <li><a href="` + baseURLContent + `/memory_editor_example" rel="nofollow">Memory Editor</a></li>
- <li><a href="` + baseURLContent + `/plot_var_example" rel="nofollow">Plot var helper</a></li>
- </ul>
- `,
- `<h2 id="user-content-what-is-wine-staging">What is Wine Staging?</h2>
- <p><strong>Wine Staging</strong> on website <a href="http://wine-staging.com" rel="nofollow">wine-staging.com</a>.</p>
- <h2 id="user-content-quick-links">Quick Links</h2>
- <p>Here are some links to the most important topics. You can find the full list of pages at the sidebar.</p>
- <table>
- <thead>
- <tr>
- <th><a href="` + baseURLImages + `/images/icon-install.png" rel="nofollow"><img src="` + baseURLImages + `/images/icon-install.png" title="icon-install.png" alt="images/icon-install.png"/></a></th>
- <th><a href="` + baseURLContent + `/Installation" rel="nofollow">Installation</a></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a href="` + baseURLImages + `/images/icon-usage.png" rel="nofollow"><img src="` + baseURLImages + `/images/icon-usage.png" title="icon-usage.png" alt="images/icon-usage.png"/></a></td>
- <td><a href="` + baseURLContent + `/Usage" rel="nofollow">Usage</a></td>
- </tr>
- </tbody>
- </table>
- `,
- `<p><a href="http://www.excelsiorjet.com/" rel="nofollow">Excelsior JET</a> allows you to create native executables for Windows, Linux and Mac OS X.</p>
- <ol>
- <li><a href="https://github.com/libgdx/libgdx/wiki/Gradle-on-the-Commandline#packaging-for-the-desktop" rel="nofollow">Package your libGDX application</a><br/>
- <a href="` + baseURLImages + `/images/1.png" rel="nofollow"><img src="` + baseURLImages + `/images/1.png" title="1.png" alt="images/1.png"/></a></li>
- <li>Perform a test run by hitting the Run! button.<br/>
- <a href="` + baseURLImages + `/images/2.png" rel="nofollow"><img src="` + baseURLImages + `/images/2.png" title="2.png" alt="images/2.png"/></a></li>
- </ol>
- <h2 id="user-content-custom-id">More tests</h2>
- <p>(from <a href="https://www.markdownguide.org/extended-syntax/" rel="nofollow">https://www.markdownguide.org/extended-syntax/</a>)</p>
- <h3 id="user-content-checkboxes">Checkboxes</h3>
- <ul>
- <li class="task-list-item"><input type="checkbox" disabled="" data-source-position="434"/>unchecked</li>
- <li class="task-list-item"><input type="checkbox" disabled="" data-source-position="450" checked=""/>checked</li>
- <li class="task-list-item"><input type="checkbox" disabled="" data-source-position="464"/>still unchecked</li>
- </ul>
- <h3 id="user-content-definition-list">Definition list</h3>
- <dl>
- <dt>First Term</dt>
- <dd>This is the definition of the first term.</dd>
- <dt>Second Term</dt>
- <dd>This is one definition of the second term.</dd>
- <dd>This is another definition of the second term.</dd>
- </dl>
- <h3 id="user-content-footnotes">Footnotes</h3>
- <p>Here is a simple footnote,<sup id="fnref:user-content-1"><a href="#fn:user-content-1" rel="nofollow">1</a></sup> and here is a longer one.<sup id="fnref:user-content-bignote"><a href="#fn:user-content-bignote" rel="nofollow">2</a></sup></p>
- <div>
- <hr/>
- <ol>
- <li id="fn:user-content-1">
- <p>This is the first footnote. <a href="#fnref:user-content-1" rel="nofollow">↩︎</a></p>
- </li>
- <li id="fn:user-content-bignote">
- <p>Here is one with multiple paragraphs and code.</p>
- <p>Indent paragraphs to include them in the footnote.</p>
- <p><code>{ my code }</code></p>
- <p>Add as many paragraphs as you like. <a href="#fnref:user-content-bignote" rel="nofollow">↩︎</a></p>
- </li>
- </ol>
- </div>
- `, `<ul>
- <li class="task-list-item"><input type="checkbox" disabled="" data-source-position="3"/> If you want to rebase/retry this PR, click this checkbox.</li>
- </ul>
- <hr/>
- <p>This PR has been generated by <a href="https://github.com/renovatebot/renovate" rel="nofollow">Renovate Bot</a>.</p>
- `,
- }
- }
-
- // 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) ` + AppURL + `gogits/gogs/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.
- `,
- `
- - [ ] <!-- rebase-check --> If you want to rebase/retry this PR, click this checkbox.
-
- ---
-
- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
-
- <!-- test-comment -->`,
- }
-
- func TestTotal_RenderWiki(t *testing.T) {
- setting.AppURL = AppURL
- setting.AppSubURL = AppSubURL
-
- answers := testAnswers(util.URLJoin(AppSubURL, "wiki/"), util.URLJoin(AppSubURL, "wiki", "raw/"))
-
- for i := 0; i < len(sameCases); i++ {
- line, err := RenderString(&markup.RenderContext{
- Ctx: git.DefaultContext,
- URLPrefix: AppSubURL,
- Metas: localMetas,
- IsWiki: true,
- }, sameCases[i])
- assert.NoError(t, err)
- assert.Equal(t, answers[i], line)
- }
-
- testCases := []string{
- // Guard wiki sidebar: special syntax
- `[[Guardfile-DSL / Configuring-Guard|Guardfile-DSL---Configuring-Guard]]`,
- // rendered
- `<p><a href="` + AppSubURL + `wiki/Guardfile-DSL---Configuring-Guard" rel="nofollow">Guardfile-DSL / Configuring-Guard</a></p>
- `,
- // special syntax
- `[[Name|Link]]`,
- // rendered
- `<p><a href="` + AppSubURL + `wiki/Link" rel="nofollow">Name</a></p>
- `,
- }
-
- for i := 0; i < len(testCases); i += 2 {
- line, err := RenderString(&markup.RenderContext{
- URLPrefix: AppSubURL,
- IsWiki: true,
- }, testCases[i])
- assert.NoError(t, err)
- assert.Equal(t, testCases[i+1], line)
- }
- }
-
- func TestTotal_RenderString(t *testing.T) {
- setting.AppURL = AppURL
- setting.AppSubURL = AppSubURL
-
- answers := testAnswers(util.URLJoin(AppSubURL, "src", "master/"), util.URLJoin(AppSubURL, "raw", "master/"))
-
- for i := 0; i < len(sameCases); i++ {
- line, err := RenderString(&markup.RenderContext{
- Ctx: git.DefaultContext,
- URLPrefix: util.URLJoin(AppSubURL, "src", "master/"),
- Metas: localMetas,
- }, sameCases[i])
- assert.NoError(t, err)
- assert.Equal(t, answers[i], line)
- }
-
- testCases := []string{}
-
- for i := 0; i < len(testCases); i += 2 {
- line, err := RenderString(&markup.RenderContext{
- URLPrefix: AppSubURL,
- }, testCases[i])
- assert.NoError(t, err)
- assert.Equal(t, testCases[i+1], line)
- }
- }
-
- func TestRender_RenderParagraphs(t *testing.T) {
- test := func(t *testing.T, str string, cnt int) {
- res, err := RenderRawString(&markup.RenderContext{}, str)
- assert.NoError(t, err)
- assert.Equal(t, cnt, strings.Count(res, "<p"), "Rendered result for unix should have %d paragraph(s) but has %d:\n%s\n", cnt, strings.Count(res, "<p"), res)
-
- mac := strings.ReplaceAll(str, "\n", "\r")
- res, err = RenderRawString(&markup.RenderContext{}, mac)
- assert.NoError(t, err)
- assert.Equal(t, cnt, strings.Count(res, "<p"), "Rendered result for mac should have %d paragraph(s) but has %d:\n%s\n", cnt, strings.Count(res, "<p"), res)
-
- dos := strings.ReplaceAll(str, "\n", "\r\n")
- res, err = RenderRawString(&markup.RenderContext{}, dos)
- assert.NoError(t, err)
- assert.Equal(t, cnt, strings.Count(res, "<p"), "Rendered result for windows should have %d paragraph(s) but has %d:\n%s\n", cnt, strings.Count(res, "<p"), res)
- }
-
- test(t, "\nOne\nTwo\nThree", 1)
- test(t, "\n\nOne\nTwo\nThree", 1)
- test(t, "\n\nOne\nTwo\nThree\n\n\n", 1)
- test(t, "A\n\nB\nC\n", 2)
- test(t, "A\n\n\nB\nC\n", 2)
- }
-
- func TestMarkdownRenderRaw(t *testing.T) {
- testcases := [][]byte{
- { // clusterfuzz_testcase_minimized_fuzz_markdown_render_raw_6267570554535936
- 0x2a, 0x20, 0x2d, 0x0a, 0x09, 0x20, 0x60, 0x5b, 0x0a, 0x09, 0x20, 0x60,
- 0x5b,
- },
- { // clusterfuzz_testcase_minimized_fuzz_markdown_render_raw_6278827345051648
- 0x2d, 0x20, 0x2d, 0x0d, 0x09, 0x60, 0x0d, 0x09, 0x60,
- },
- { // clusterfuzz_testcase_minimized_fuzz_markdown_render_raw_6016973788020736[] = {
- 0x7b, 0x63, 0x6c, 0x61, 0x73, 0x73, 0x3d, 0x35, 0x7d, 0x0a, 0x3d,
- },
- }
-
- for _, testcase := range testcases {
- log.Info("Test markdown render error with fuzzy data: %x, the following errors can be recovered", testcase)
- _, err := RenderRawString(&markup.RenderContext{}, string(testcase))
- assert.NoError(t, err)
- }
- }
-
- func TestRenderSiblingImages_Issue12925(t *testing.T) {
- testcase := `![image1](/image1)
- ![image2](/image2)
- `
- expected := `<p><a href="/image1" target="_blank" rel="nofollow noopener"><img src="/image1" alt="image1"></a><br>
- <a href="/image2" target="_blank" rel="nofollow noopener"><img src="/image2" alt="image2"></a></p>
- `
- res, err := RenderRawString(&markup.RenderContext{}, 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 := `<p><a href="https://gitea.io" rel="nofollow">Link with emoji <span class="emoji" aria-label="waxing gibbous moon">🌔</span> in text</a></p>
- `
- res, err := RenderString(&markup.RenderContext{}, testcase)
- assert.NoError(t, err)
- assert.Equal(t, expected, res)
- }
-
- func TestColorPreview(t *testing.T) {
- const nl = "\n"
- positiveTests := []struct {
- testcase string
- expected string
- }{
- { // hex
- "`#FF0000`",
- `<p><code>#FF0000<span class="color-preview" style="background-color: #FF0000"></span></code></p>` + nl,
- },
- { // rgb
- "`rgb(16, 32, 64)`",
- `<p><code>rgb(16, 32, 64)<span class="color-preview" style="background-color: rgb(16, 32, 64)"></span></code></p>` + nl,
- },
- { // short hex
- "This is the color white `#000`",
- `<p>This is the color white <code>#000<span class="color-preview" style="background-color: #000"></span></code></p>` + nl,
- },
- { // hsl
- "HSL stands for hue, saturation, and lightness. An example: `hsl(0, 100%, 50%)`.",
- `<p>HSL stands for hue, saturation, and lightness. An example: <code>hsl(0, 100%, 50%)<span class="color-preview" style="background-color: hsl(0, 100%, 50%)"></span></code>.</p>` + nl,
- },
- { // uppercase hsl
- "HSL stands for hue, saturation, and lightness. An example: `HSL(0, 100%, 50%)`.",
- `<p>HSL stands for hue, saturation, and lightness. An example: <code>HSL(0, 100%, 50%)<span class="color-preview" style="background-color: HSL(0, 100%, 50%)"></span></code>.</p>` + nl,
- },
- }
-
- for _, test := range positiveTests {
- res, err := RenderString(&markup.RenderContext{}, test.testcase)
- assert.NoError(t, err, "Unexpected error in testcase: %q", test.testcase)
- assert.Equal(t, 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 := RenderString(&markup.RenderContext{}, test)
- assert.NoError(t, err, "Unexpected error in testcase: %q", test)
- assert.NotContains(t, res, `<span class="color-preview" style="background-color: `, "Unexpected result in testcase %q", test)
- }
- }
-
- func TestMathBlock(t *testing.T) {
- const nl = "\n"
- testcases := []struct {
- testcase string
- expected string
- }{
- {
- "$a$",
- `<p><code class="language-math is-loading">a</code></p>` + nl,
- },
- {
- "$ a $",
- `<p><code class="language-math is-loading">a</code></p>` + nl,
- },
- {
- "$a$ $b$",
- `<p><code class="language-math is-loading">a</code> <code class="language-math is-loading">b</code></p>` + nl,
- },
- {
- `\(a\) \(b\)`,
- `<p><code class="language-math is-loading">a</code> <code class="language-math is-loading">b</code></p>` + nl,
- },
- {
- `$a a$b b$`,
- `<p><code class="language-math is-loading">a a$b b</code></p>` + nl,
- },
- {
- `a a$b b`,
- `<p>a a$b b</p>` + nl,
- },
- {
- `a$b $a a$b b$`,
- `<p>a$b <code class="language-math is-loading">a a$b b</code></p>` + nl,
- },
- {
- "$$a$$",
- `<pre class="code-block is-loading"><code class="chroma language-math display">a</code></pre>` + nl,
- },
- }
-
- for _, test := range testcases {
- res, err := RenderString(&markup.RenderContext{}, test.testcase)
- assert.NoError(t, err, "Unexpected error in testcase: %q", test.testcase)
- assert.Equal(t, test.expected, res, "Unexpected result in testcase %q", test.testcase)
-
- }
- }
|