// 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 ( "fmt" "strconv" "testing" "strings" . "code.gitea.io/gitea/modules/markdown" "code.gitea.io/gitea/modules/setting" "github.com/stretchr/testify/assert" ) 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}", "user": "someUser", "repo": "someRepo", "style": IssueNameStyleNumeric, } var alphanumericMetas = map[string]string{ "format": "https://someurl.com/{user}/{repo}/{index}", "user": "someUser", "repo": "someRepo", "style": IssueNameStyleAlphanumeric, } // numericLink an HTML to a numeric-style issue func numericIssueLink(baseURL string, index int) string { 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 { return link(URLJoin(baseURL, name), name) } // urlContentsLink an HTML link whose contents is the target URL func urlContentsLink(href string) string { return link(href, href) } // link an HTML link func link(href, contents string) string { return fmt.Sprintf("%s", href, contents) } func testRenderIssueIndexPattern(t *testing.T, input, expected string, metas map[string]string) { assert.Equal(t, expected, string(RenderIssueIndexPattern([]byte(input), AppSubURL, metas))) } func TestURLJoin(t *testing.T) { type test struct { Expected string Base string Elements []string } newTest := func(expected, base string, elements ...string) test { return test{Expected: expected, Base: base, Elements: elements} } for _, test := range []test{ newTest("https://try.gitea.io/a/b/c", "https://try.gitea.io", "a/b", "c"), newTest("https://try.gitea.io/a/b/c", "https://try.gitea.io/", "/a/b/", "/c/"), newTest("https://try.gitea.io/a/c", "https://try.gitea.io/", "/a/./b/", "../c/"), } { assert.Equal(t, test.Expected, URLJoin(test.Base, test.Elements...)) } } func TestRender_IssueIndexPattern(t *testing.T) { // numeric: render inputs without valid mentions test := func(s string) { testRenderIssueIndexPattern(t, s, s, nil) testRenderIssueIndexPattern(t, s, s, numericMetas) } // should not render anything when there are no mentions test("") test("this is a test") test("test 123 123 1234") test("#") test("# # #") test("# 123") test("#abcd") test("##1234") test("test#1234") test("#1234test") test(" test #1234test") // should not render issue mention without leading space test("test#54321 issue") // should not render issue mention without trailing space test("test #54321issue") } func TestRender_IssueIndexPattern2(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(URLJoin(setting.AppSubURL, "issues"), index) } expectedNil := fmt.Sprintf(expectedFmt, links...) testRenderIssueIndexPattern(t, s, expectedNil, nil) for i, index := range indices { links[i] = numericIssueLink("https://someurl.com/someUser/someRepo/", index) } expectedNum := fmt.Sprintf(expectedFmt, links...) testRenderIssueIndexPattern(t, s, expectedNum, numericMetas) } // should render freestanding mentions test("#1234 test", "%s test", 1234) test("test #8 issue", "test %s issue", 8) test("test issue #1234", "test issue %s", 1234) // should render mentions in parentheses test("(#54321 issue)", "(%s issue)", 54321) test("test (#9801 extra) issue", "test (%s extra) issue", 9801) test("test (#1)", "test (%s)", 1) // should render multiple issue mentions in the same line test("#54321 #1243", "%s %s", 54321, 1243) test("wow (#54321 #1243)", "wow (%s %s)", 54321, 1243) test("(#4)(#5)", "(%s)(%s)", 4, 5) test("#1 (#4321) test", "%s (%s) test", 1, 4321) } func TestRender_IssueIndexPattern3(t *testing.T) { setting.AppURL = AppURL setting.AppSubURL = AppSubURL // alphanumeric: render inputs without valid mentions test := func(s string) { testRenderIssueIndexPattern(t, s, s, alphanumericMetas) } test("") test("this is a test") test("test 123 123 1234") test("#") test("##1234") test("# 123") test("#abcd") test("test #123") test("abc-1234") // issue prefix must be capital test("ABc-1234") // issue prefix must be _all_ capital test("ABCDEFGHIJK-1234") // the limit is 10 characters in the prefix test("ABC1234") // dash is required test("test ABC- test") // number is required test("test -1234 test") // prefix is required test("testABC-123 test") // leading space is required test("test ABC-123test") // trailing space is required test("ABC-0123") // no leading zero } func TestRender_IssueIndexPattern4(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)) for i, name := range names { links[i] = alphanumIssueLink("https://someurl.com/someUser/someRepo/", name) } expected := fmt.Sprintf(expectedFmt, links...) testRenderIssueIndexPattern(t, s, expected, alphanumericMetas) } test("OTT-1234 test", "%s test", "OTT-1234") test("test T-12 issue", "test %s issue", "T-12") test("test issue ABCDEFGHIJ-1234567890", "test issue %s", "ABCDEFGHIJ-1234567890") } func TestRender_AutoLink(t *testing.T) { setting.AppURL = AppURL setting.AppSubURL = AppSubURL test := func(input, expected string) { buffer := RenderSpecialLink([]byte(input), setting.AppSubURL, nil, false) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) buffer = RenderSpecialLink([]byte(input), setting.AppSubURL, nil, true) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) } // render valid issue URLs test(URLJoin(setting.AppSubURL, "issues", "3333"), numericIssueLink(URLJoin(setting.AppSubURL, "issues"), 3333)) // render external issue URLs tmp := "http://1111/2222/ssss-issues/3333?param=blah&blahh=333" test(tmp, "#3333 ") test("http://test.com/issues/33333", numericIssueLink("http://test.com/issues", 33333)) test("https://issues/333", numericIssueLink("https://issues", 333)) // render valid commit URLs tmp = URLJoin(AppSubURL, "commit", "d8a994ef243349f321568f9e36d5c3f444b99cae") test(tmp, "d8a994ef24") tmp += "#diff-2" test(tmp, "d8a994ef24 (diff-2)") // render other commit URLs tmp = "https://external-link.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2" test(tmp, "d8a994ef24 (diff-2)") } func TestRender_StandardLinks(t *testing.T) { setting.AppURL = AppURL setting.AppSubURL = AppSubURL test := func(input, expected, expectedWiki string) { buffer := RenderString(input, setting.AppSubURL, nil) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) bufferWiki := RenderWiki([]byte(input), setting.AppSubURL, nil) assert.Equal(t, strings.TrimSpace(expectedWiki), strings.TrimSpace(bufferWiki)) } googleRendered := `

https://google.com/

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

WikiPage

`, `

WikiPage

`) } func TestRender_ShortLinks(t *testing.T) { setting.AppURL = AppURL setting.AppSubURL = AppSubURL tree := URLJoin(AppSubURL, "src", "master") test := func(input, expected, expectedWiki string) { buffer := RenderString(input, tree, nil) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) buffer = RenderWiki([]byte(input), setting.AppSubURL, nil) assert.Equal(t, strings.TrimSpace(expectedWiki), strings.TrimSpace(string(buffer))) } rawtree := URLJoin(AppSubURL, "raw", "master") url := URLJoin(tree, "Link") imgurl := URLJoin(rawtree, "Link.jpg") urlWiki := URLJoin(AppSubURL, "wiki", "Link") imgurlWiki := URLJoin(AppSubURL, "wiki", "raw", "Link.jpg") favicon := "http://google.com/favicon.ico" test( "[[Link]]", `

Link

`, `

Link

`) test( "[[Link.jpg]]", `

Link.jpg

`, `

Link.jpg

`) test( "[["+favicon+"]]", `

`, `

`) test( "[[Name|Link]]", `

Name

`, `

Name

`) test( "[[Name|Link.jpg]]", `

Name

`, `

Name

`) test( "[[Name|Link.jpg|alt=AltName]]", `

AltName

`, `

AltName

`) test( "[[Name|Link.jpg|title=Title]]", `

Title

`, `

Title

`) test( "[[Name|Link.jpg|alt=AltName|title=Title]]", `

AltName

`, `

AltName

`) test( "[[Name|Link.jpg|alt=\"AltName\"|title='Title']]", `

AltName

`, `

AltName

`) } 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, strings.TrimSpace(expected), strings.TrimSpace(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, `

b6dd6210ea

`) test(commit, `

b6dd6210ea

`) test(tree, `

b6dd6210ea/src

`) test("commit "+sha, `

commit b6dd6210ea

`) } func TestRender_Images(t *testing.T) { setting.AppURL = AppURL setting.AppSubURL = AppSubURL test := func(input, expected string) { buffer := RenderString(input, setting.AppSubURL, nil) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) } url := "../../.images/src/02/train.jpg" title := "Train" result := URLJoin(AppSubURL, url) test( "!["+title+"]("+url+")", `

`+title+`

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

`+title+`

`) } func TestRender_CrossReferences(t *testing.T) { setting.AppURL = AppURL setting.AppSubURL = AppSubURL test := func(input, expected string) { buffer := RenderString(input, setting.AppSubURL, nil) assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(string(buffer))) } test( "gogits/gogs#12345", `

gogits/gogs#12345

`) } 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": { "https", "github.com", "jquery", "jquery", "blob", "a644101ed04d0beacea864ce805e0c4f86ba1cd1", "test/unit/event.js", "L2703", }, "https://github.com/jquery/jquery/blob/a644101ed04d0beacea864ce805e0c4f86ba1cd1/test/unit/event.js": { "https", "github.com", "jquery", "jquery", "blob", "a644101ed04d0beacea864ce805e0c4f86ba1cd1", "test/unit/event.js", "", }, "https://github.com/jquery/jquery/commit/0705be475092aede1eddae01319ec931fb9c65fc": { "https", "github.com", "jquery", "jquery", "commit", "0705be475092aede1eddae01319ec931fb9c65fc", "", "", }, "https://github.com/jquery/jquery/tree/0705be475092aede1eddae01319ec931fb9c65fc/src": { "https", "github.com", "jquery", "jquery", "tree", "0705be475092aede1eddae01319ec931fb9c65fc", "src", "", }, "https://try.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2": { "https", "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": { "https", "github.com/gogits/gogs/pull/", "3244", "", "", }, "https://github.com/gogits/gogs/issues/3247#issuecomment-231517079": { "https", "github.com/gogits/gogs/issues/", "3247", "#issuecomment-231517079", "", }, "https://try.gogs.io/gogs/gogs/issues/4#issue-685": { "https", "try.gogs.io/gogs/gogs/issues/", "4", "#issue-685", "", }, "https://youtrack.jetbrains.com/issue/JT-36485": { "https", "youtrack.jetbrains.com/issue/", "JT-36485", "", "", }, "https://youtrack.jetbrains.com/issue/JT-36485#comment=27-1508676": { "https", "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_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]]`, // 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]]`, } func testAnswers(baseURLContent, baseURLImages string) []string { return []string{ `

Wiki! Enjoy :)

Ideas and codes

`, `

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.

images/icon-install.png Installation
images/icon-usage.png Usage
`, `

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

  1. Package your libGDX application images/1.png
  2. Perform a test run by hitting the Run! button. images/2.png
`, } } func TestTotal_RenderString(t *testing.T) { answers := testAnswers(URLJoin(AppSubURL, "src", "master/"), URLJoin(AppSubURL, "raw", "master/")) for i := 0; i < len(sameCases); i++ { line := RenderString(sameCases[i], URLJoin(AppSubURL, "src", "master/"), nil) assert.Equal(t, answers[i], line) } testCases := []string{} for i := 0; i < len(testCases); i += 2 { line := RenderString(testCases[i], AppSubURL, nil) assert.Equal(t, testCases[i+1], line) } } func TestTotal_RenderWiki(t *testing.T) { answers := testAnswers(URLJoin(AppSubURL, "wiki/"), URLJoin(AppSubURL, "wiki", "raw/")) for i := 0; i < len(sameCases); i++ { line := RenderWiki([]byte(sameCases[i]), AppSubURL, nil) assert.Equal(t, answers[i], 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 := RenderWiki([]byte(testCases[i]), AppSubURL, nil) assert.Equal(t, testCases[i+1], line) } }