diff options
Diffstat (limited to 'modules/markdown/markdown_test.go')
| -rw-r--r-- | modules/markdown/markdown_test.go | 551 |
1 files changed, 514 insertions, 37 deletions
diff --git a/modules/markdown/markdown_test.go b/modules/markdown/markdown_test.go index 88b48548eb..60dd0afde2 100644 --- a/modules/markdown/markdown_test.go +++ b/modules/markdown/markdown_test.go @@ -1,21 +1,20 @@ package markdown_test import ( - "bytes" "fmt" - "net/url" - "path" "strconv" "testing" + "strings" + . "code.gitea.io/gitea/modules/markdown" "code.gitea.io/gitea/modules/setting" - - "github.com/russross/blackfriday" "github.com/stretchr/testify/assert" ) -const urlPrefix = "/prefix" +const AppURL = "http://localhost:3000/" +const Repo = "gogits/gogs" +const AppSubURL = AppURL + Repo + "/" var numericMetas = map[string]string{ "format": "https://someurl.com/{user}/{repo}/{index}", @@ -33,16 +32,12 @@ var alphanumericMetas = map[string]string{ // numericLink an HTML to a numeric-style issue func numericIssueLink(baseURL string, index int) string { - u, _ := url.Parse(baseURL) - u.Path = path.Join(u.Path, strconv.Itoa(index)) - return link(u.String(), fmt.Sprintf("#%d", index)) + return link(URLJoin(baseURL, strconv.Itoa(index)), fmt.Sprintf("#%d", index)) } // alphanumLink an HTML link to an alphanumeric-style issue func alphanumIssueLink(baseURL string, name string) string { - u, _ := url.Parse(baseURL) - u.Path = path.Join(u.Path, name) - return link(u.String(), name) + return link(URLJoin(baseURL, name), name) } // urlContentsLink an HTML link whose contents is the target URL @@ -57,7 +52,7 @@ func link(href, contents string) string { func testRenderIssueIndexPattern(t *testing.T, input, expected string, metas map[string]string) { assert.Equal(t, expected, - string(RenderIssueIndexPattern([]byte(input), urlPrefix, metas))) + string(RenderIssueIndexPattern([]byte(input), AppSubURL, metas))) } func TestRenderIssueIndexPattern(t *testing.T) { @@ -88,11 +83,14 @@ func TestRenderIssueIndexPattern(t *testing.T) { } func TestRenderIssueIndexPattern2(t *testing.T) { + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + // numeric: render inputs with valid mentions test := func(s, expectedFmt string, indices ...int) { links := make([]interface{}, len(indices)) for i, index := range indices { - links[i] = numericIssueLink(path.Join(urlPrefix, "issues"), index) + links[i] = numericIssueLink(URLJoin(setting.AppSubURL, "issues"), index) } expectedNil := fmt.Sprintf(expectedFmt, links...) testRenderIssueIndexPattern(t, s, expectedNil, nil) @@ -122,6 +120,9 @@ func TestRenderIssueIndexPattern2(t *testing.T) { } func TestRenderIssueIndexPattern3(t *testing.T) { + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + // alphanumeric: render inputs without valid mentions test := func(s string) { testRenderIssueIndexPattern(t, s, s, alphanumericMetas) @@ -146,6 +147,9 @@ func TestRenderIssueIndexPattern3(t *testing.T) { } func TestRenderIssueIndexPattern4(t *testing.T) { + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + // alphanumeric: render inputs with valid mentions test := func(s, expectedFmt string, names ...string) { links := make([]interface{}, len(names)) @@ -161,36 +165,509 @@ func TestRenderIssueIndexPattern4(t *testing.T) { } func TestRenderer_AutoLink(t *testing.T) { - setting.AppURL = "http://localhost:3000/" - htmlFlags := blackfriday.HTML_SKIP_STYLE | blackfriday.HTML_OMIT_CONTENTS - renderer := &Renderer{ - Renderer: blackfriday.HtmlRenderer(htmlFlags, "", ""), - } + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + + SubURLNoProtocol := setting.AppSubURL[5:] + test := func(input, expected string) { - buffer := new(bytes.Buffer) - renderer.AutoLink(buffer, []byte(input), blackfriday.LINK_TYPE_NORMAL) - assert.Equal(t, expected, buffer.String()) + buffer := RenderSpecialLink([]byte(input), setting.AppSubURL, map[string]string{}) + assert.Equal(t, expected, string(buffer)) } // render valid issue URLs - test("http://localhost:3000/user/repo/issues/3333", - numericIssueLink("http://localhost:3000/user/repo/issues/", 3333)) + test(URLJoin(setting.AppSubURL, "issues", "3333"), + numericIssueLink(URLJoin(setting.AppSubURL, "issues"), 3333)) - // render, but not change, invalid issue URLs - test("http://1111/2222/ssss-issues/3333?param=blah&blahh=333", - urlContentsLink("http://1111/2222/ssss-issues/3333?param=blah&blahh=333")) - test("http://test.com/issues/33333", urlContentsLink("http://test.com/issues/33333")) - test("https://issues/333", urlContentsLink("https://issues/333")) + // render external issue URLs + tmp := "//1111/2222/ssss-issues/3333?param=blah&blahh=333" + test("http:"+tmp, + "<a href=\""+tmp+"\">#3333 <i class='comment icon'></i></a>") + test("http://test.com/issues/33333", numericIssueLink("//test.com/issues", 33333)) + test("https://issues/333", numericIssueLink("//issues", 333)) // render valid commit URLs - test("http://localhost:3000/user/project/commit/d8a994ef243349f321568f9e36d5c3f444b99cae", - " <code><a href=\"http://localhost:3000/user/project/commit/d8a994ef243349f321568f9e36d5c3f444b99cae\">d8a994ef24</a></code>") - test("http://localhost:3000/user/project/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2", - " <code><a href=\"http://localhost:3000/user/project/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2\">d8a994ef24</a></code>") + tmp = URLJoin(SubURLNoProtocol, "commit", "d8a994ef243349f321568f9e36d5c3f444b99cae") + test("http://"+tmp, "<a href=\""+tmp+"\">d8a994ef24</a>") + tmp += "#diff-2" + test("http://"+tmp, "<a href=\""+tmp+"\">d8a994ef24 (diff-2)</a>") // render other commit URLs - test("https://external-link.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2", - urlContentsLink("https://external-link.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2")) - test("https://commit/d8a994ef243349f321568f9e36d5c3f444b99cae", - urlContentsLink("https://commit/d8a994ef243349f321568f9e36d5c3f444b99cae")) + tmp = "//external-link.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2" + test("https:"+tmp, "<a href=\""+tmp+"\">d8a994ef24 (diff-2)</a>") +} + +func TestRender_ShortLinks(t *testing.T) { + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + + test := func(input, expected string) { + buffer := RenderString(input, setting.AppSubURL, nil) + assert.Equal(t, expected, string(buffer)) + } + + var url = URLJoin(AppSubURL, "wiki", "Link") + var imgurl = URLJoin(AppSubURL, "wiki", "raw", "Link.jpg") + var favicon = "http://google.com/favicon.ico" + + test("[[Link]]", `<p><a href="`+url+`" rel="nofollow">Link</a></p> +`) + test("[[Link.jpg]]", `<p><a href="`+imgurl+`" rel="nofollow"><img src="`+imgurl+`" alt="Link.jpg" title="Link.jpg"/></a></p> +`) + test("[["+favicon+"]]", `<p><a href="`+favicon+`" rel="nofollow"><img src="`+favicon+`" title="favicon.ico"/></a></p> +`) + test("[[Name|Link]]", `<p><a href="`+url+`" rel="nofollow">Name</a></p> +`) + test("[[Name|Link.jpg]]", `<p><a href="`+imgurl+`" rel="nofollow"><img src="`+imgurl+`" alt="Name" title="Name"/></a></p> +`) + test("[[Name|Link.jpg|alt=AltName]]", `<p><a href="`+imgurl+`" rel="nofollow"><img src="`+imgurl+`" alt="AltName" title="AltName"/></a></p> +`) + test("[[Name|Link.jpg|title=Title]]", `<p><a href="`+imgurl+`" rel="nofollow"><img src="`+imgurl+`" alt="Title" title="Title"/></a></p> +`) + test("[[Name|Link.jpg|alt=AltName|title=Title]]", `<p><a href="`+imgurl+`" rel="nofollow"><img src="`+imgurl+`" alt="AltName" title="Title"/></a></p> +`) + test("[[Name|Link.jpg|alt=\"AltName\"|title='Title']]", `<p><a href="`+imgurl+`" rel="nofollow"><img src="`+imgurl+`" alt="AltName" title="Title"/></a></p> +`) +} + +func TestRender_Commits(t *testing.T) { + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + + test := func(input, expected string) { + buffer := RenderString(input, setting.AppSubURL, nil) + assert.Equal(t, expected, string(buffer)) + } + + var sha = "b6dd6210eaebc915fd5be5579c58cce4da2e2579" + var commit = URLJoin(AppSubURL, "commit", sha) + var subtree = URLJoin(commit, "src") + var tree = strings.Replace(subtree, "/commit/", "/tree/", -1) + var src = strings.Replace(subtree, "/commit/", "/src/", -1) + + test(sha, `<p><a href="`+commit+`" rel="nofollow">b6dd6210ea</a></p> +`) + test(commit, `<p><a href="`+commit[5:]+`" rel="nofollow">b6dd6210ea</a></p> +`) + test(tree, `<p><a href="`+src[5:]+`" rel="nofollow">b6dd6210ea/src</a></p> +`) +} + +func TestRegExp_MentionPattern(t *testing.T) { + trueTestCases := []string{ + "@Unknwon", + "@ANT_123", + "@xxx-DiN0-z-A..uru..s-xxx", + " @lol ", + " @Te/st", + } + falseTestCases := []string{ + "@ 0", + "@ ", + "@", + "", + "ABC", + } + + for _, testCase := range trueTestCases { + res := MentionPattern.MatchString(testCase) + if !res { + println() + println(testCase) + } + assert.True(t, res) + } + for _, testCase := range falseTestCases { + res := MentionPattern.MatchString(testCase) + if res { + println() + println(testCase) + } + assert.False(t, res) + } +} + +func TestRegExp_IssueNumericPattern(t *testing.T) { + trueTestCases := []string{ + "#1234", + "#0", + "#1234567890987654321", + } + falseTestCases := []string{ + "# 1234", + "# 0", + "# ", + "#", + "#ABC", + "#1A2B", + "", + "ABC", + } + + for _, testCase := range trueTestCases { + assert.True(t, IssueNumericPattern.MatchString(testCase)) + } + for _, testCase := range falseTestCases { + assert.False(t, IssueNumericPattern.MatchString(testCase)) + } +} + +func TestRegExp_IssueAlphanumericPattern(t *testing.T) { + trueTestCases := []string{ + "ABC-1234", + "A-1", + "RC-80", + "ABCDEFGHIJ-1234567890987654321234567890", + } + falseTestCases := []string{ + "RC-08", + "PR-0", + "ABCDEFGHIJK-1", + "PR_1", + "", + "#ABC", + "", + "ABC", + "GG-", + "rm-1", + } + + for _, testCase := range trueTestCases { + assert.True(t, IssueAlphanumericPattern.MatchString(testCase)) + } + for _, testCase := range falseTestCases { + assert.False(t, IssueAlphanumericPattern.MatchString(testCase)) + } +} + +func TestRegExp_Sha1CurrentPattern(t *testing.T) { + trueTestCases := []string{ + "d8a994ef243349f321568f9e36d5c3f444b99cae", + "abcdefabcdefabcdefabcdefabcdefabcdefabcd", + } + falseTestCases := []string{ + "test", + "abcdefg", + "abcdefghijklmnopqrstuvwxyzabcdefghijklmn", + "abcdefghijklmnopqrstuvwxyzabcdefghijklmO", + } + + for _, testCase := range trueTestCases { + assert.True(t, Sha1CurrentPattern.MatchString(testCase)) + } + for _, testCase := range falseTestCases { + assert.False(t, Sha1CurrentPattern.MatchString(testCase)) + } +} + +func TestRegExp_ShortLinkPattern(t *testing.T) { + trueTestCases := []string{ + "[[stuff]]", + "[[]]", + "[[stuff|title=Difficult name with spaces*!]]", + } + falseTestCases := []string{ + "test", + "abcdefg", + "[[]", + "[[", + "[]", + "]]", + "abcdefghijklmnopqrstuvwxyz", + } + + for _, testCase := range trueTestCases { + assert.True(t, ShortLinkPattern.MatchString(testCase)) + } + for _, testCase := range falseTestCases { + assert.False(t, ShortLinkPattern.MatchString(testCase)) + } +} + +func TestRegExp_AnySHA1Pattern(t *testing.T) { + testCases := map[string][]string{ + "https://github.com/jquery/jquery/blob/a644101ed04d0beacea864ce805e0c4f86ba1cd1/test/unit/event.js#L2703": []string{ + "github.com", + "jquery", + "jquery", + "blob", + "a644101ed04d0beacea864ce805e0c4f86ba1cd1", + "test/unit/event.js", + "L2703", + }, + "https://github.com/jquery/jquery/blob/a644101ed04d0beacea864ce805e0c4f86ba1cd1/test/unit/event.js": []string{ + "github.com", + "jquery", + "jquery", + "blob", + "a644101ed04d0beacea864ce805e0c4f86ba1cd1", + "test/unit/event.js", + "", + }, + "https://github.com/jquery/jquery/commit/0705be475092aede1eddae01319ec931fb9c65fc": []string{ + "github.com", + "jquery", + "jquery", + "commit", + "0705be475092aede1eddae01319ec931fb9c65fc", + "", + "", + }, + "https://github.com/jquery/jquery/tree/0705be475092aede1eddae01319ec931fb9c65fc/src": []string{ + "github.com", + "jquery", + "jquery", + "tree", + "0705be475092aede1eddae01319ec931fb9c65fc", + "src", + "", + }, + "https://try.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2": []string{ + "try.gogs.io", + "gogs", + "gogs", + "commit", + "d8a994ef243349f321568f9e36d5c3f444b99cae", + "", + "diff-2", + }, + } + + for k, v := range testCases { + assert.Equal(t, AnySHA1Pattern.FindStringSubmatch(k)[1:], v) + } +} + +func TestRegExp_IssueFullPattern(t *testing.T) { + testCases := map[string][]string{ + "https://github.com/gogits/gogs/pull/3244": []string{ + "github.com/gogits/gogs/pull/", + "3244", + "", + "", + }, + "https://github.com/gogits/gogs/issues/3247#issuecomment-231517079": []string{ + "github.com/gogits/gogs/issues/", + "3247", + "#issuecomment-231517079", + "", + }, + "https://try.gogs.io/gogs/gogs/issues/4#issue-685": []string{ + "try.gogs.io/gogs/gogs/issues/", + "4", + "#issue-685", + "", + }, + "https://youtrack.jetbrains.com/issue/JT-36485": []string{ + "youtrack.jetbrains.com/issue/", + "JT-36485", + "", + "", + }, + "https://youtrack.jetbrains.com/issue/JT-36485#comment=27-1508676": []string{ + "youtrack.jetbrains.com/issue/", + "JT-36485", + "#comment=27-1508676", + "", + }, + } + + for k, v := range testCases { + assert.Equal(t, IssueFullPattern.FindStringSubmatch(k)[1:], v) + } +} + +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 TestMisc_IsReadmeFile(t *testing.T) { + trueTestCases := []string{ + "readme", + "README", + "readME.mdown", + "README.md", + } + falseTestCases := []string{ + "test.md", + "wow.MARKDOWN", + "LOL.mDoWn", + "test", + "abcdefg", + "abcdefghijklmnopqrstuvwxyz", + "test.md.test", + } + + for _, testCase := range trueTestCases { + assert.True(t, IsReadmeFile(testCase)) + } + for _, testCase := range falseTestCases { + assert.False(t, IsReadmeFile(testCase)) + } +} + +func TestMisc_IsSameDomain(t *testing.T) { + setting.AppURL = AppURL + setting.AppSubURL = AppSubURL + + var sha = "b6dd6210eaebc915fd5be5579c58cce4da2e2579" + var commit = URLJoin(AppSubURL, "commit", sha) + + assert.True(t, IsSameDomain(commit)) + assert.False(t, IsSameDomain("http://google.com/ncr")) + assert.False(t, IsSameDomain("favicon.ico")) +} + +// 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]] + +Ideas and codes + +- Bezier widget (by @r-lyeh) https://github.com/ocornut/imgui/issues/786 +- Node graph editors https://github.com/ocornut/imgui/issues/306 +- [[Memory Editor|memory_editor_example]] +- [[Plot var helper|plot_var_example]]`, + // rendered + `<p>Wiki! Enjoy :)</p> + +<ul> +<li><a href="` + AppSubURL + `wiki/Links" rel="nofollow">Links, Language bindings, Engine bindings</a></li> +<li><a href="` + AppSubURL + `wiki/Tips" rel="nofollow">Tips</a></li> +</ul> + +<p>Ideas and codes</p> + +<ul> +<li>Bezier widget (by <a href="` + AppURL + `r-lyeh" rel="nofollow">@r-lyeh</a>)<a href="` + AppSubURL + `issues/786" rel="nofollow">#786</a></li> +<li>Node graph editors<a href="` + AppSubURL + `issues/306" rel="nofollow">#306</a></li> +<li><a href="` + AppSubURL + `wiki/memory_editor_example" rel="nofollow">Memory Editor</a></li> +<li><a href="` + AppSubURL + `wiki/plot_var_example" rel="nofollow">Plot var helper</a></li> +</ul> +`, + // 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]] | +| [[images/icon-config.png]] | [[Configuration]] | +| [[images/icon-bug.png]] | [Bugs](http://bugs.wine-staging.com) | +`, + // rendered + `<h2>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>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="` + AppSubURL + `wiki/raw/images%2Ficon-install.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images%2Ficon-install.png" alt="images/icon-install.png" title="icon-install.png"/></a></th> +<th><a href="` + AppSubURL + `wiki/Installation" rel="nofollow">Installation</a></th> +</tr> +</thead> + +<tbody> +<tr> +<td><a href="` + AppSubURL + `wiki/raw/images%2Ficon-usage.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images%2Ficon-usage.png" alt="images/icon-usage.png" title="icon-usage.png"/></a></td> +<td><a href="` + AppSubURL + `wiki/Usage" rel="nofollow">Usage</a></td> +</tr> + +<tr> +<td><a href="` + AppSubURL + `wiki/raw/images%2Ficon-config.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images%2Ficon-config.png" alt="images/icon-config.png" title="icon-config.png"/></a></td> +<td><a href="` + AppSubURL + `wiki/Configuration" rel="nofollow">Configuration</a></td> +</tr> + +<tr> +<td><a href="` + AppSubURL + `wiki/raw/images%2Ficon-bug.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images%2Ficon-bug.png" alt="images/icon-bug.png" title="icon-bug.png"/></a></td> +<td><a href="http://bugs.wine-staging.com" rel="nofollow">Bugs</a></td> +</tr> +</tbody> +</table> +`, + // 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]]`, + // rendered + `<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> +<a href="` + AppSubURL + `wiki/raw/images%2F1.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images%2F1.png" alt="images/1.png" title="1.png"/></a></li> +<li>Perform a test run by hitting the Run! button. +<a href="` + AppSubURL + `wiki/raw/images%2F2.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images%2F2.png" alt="images/2.png" title="2.png"/></a></li> +</ol> +`, +} + +func TestTotal_RenderString(t *testing.T) { + for i := 0; i < len(sameCases); i += 2 { + line := RenderString(sameCases[i], AppSubURL, map[string]string{}) + assert.Equal(t, sameCases[i+1], line) + } + + testCases := []string{} + + for i := 0; i < len(testCases); i += 2 { + line := RenderString(testCases[i], AppSubURL, map[string]string{}) + assert.Equal(t, testCases[i+1], line) + } +} + +func TestTotal_RenderWiki(t *testing.T) { + for i := 0; i < len(sameCases); i += 2 { + line := RenderWiki([]byte(sameCases[i]), AppSubURL, map[string]string{}) + assert.Equal(t, sameCases[i+1], 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 := RenderWiki([]byte(testCases[i]), AppSubURL, map[string]string{}) + assert.Equal(t, testCases[i+1], line) + } } |