2018-02-27 10:09:18 +03:00
// Copyright 2018 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 markup
import (
"fmt"
"strconv"
"strings"
"testing"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/util"
"github.com/stretchr/testify/assert"
)
2021-12-11 20:21:36 +03:00
const TestAppURL = "http://localhost:3000/"
const TestOrgRepo = "gogits/gogs"
const TestRepoURL = TestAppURL + TestOrgRepo + "/"
2018-02-27 10:09:18 +03:00
// alphanumLink an HTML link to an alphanumeric-style issue
2019-09-10 12:03:30 +03:00
func alphanumIssueLink ( baseURL , class , name string ) string {
return link ( util . URLJoin ( baseURL , name ) , class , name )
2018-02-27 10:09:18 +03:00
}
// numericLink an HTML to a numeric-style issue
2019-12-01 16:57:05 +03:00
func numericIssueLink ( baseURL , class string , index int , marker string ) string {
return link ( util . URLJoin ( baseURL , strconv . Itoa ( index ) ) , class , fmt . Sprintf ( "%s%d" , marker , index ) )
2018-02-27 10:09:18 +03:00
}
// link an HTML link
2019-09-10 12:03:30 +03:00
func link ( href , class , contents string ) string {
if class != "" {
class = " class=\"" + class + "\""
}
return fmt . Sprintf ( "<a href=\"%s\"%s>%s</a>" , href , class , contents )
2018-02-27 10:09:18 +03:00
}
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 ,
}
2021-12-11 20:21:36 +03:00
// these values should match the TestOrgRepo const above
2019-04-12 08:53:34 +03:00
var localMetas = map [ string ] string {
"user" : "gogits" ,
"repo" : "gogs" ,
}
2018-02-27 10:09:18 +03:00
func TestRender_IssueIndexPattern ( t * testing . T ) {
// numeric: render inputs without valid mentions
test := func ( s string ) {
2021-04-20 01:25:08 +03:00
testRenderIssueIndexPattern ( t , s , s , & RenderContext { } )
testRenderIssueIndexPattern ( t , s , s , & RenderContext { Metas : numericMetas } )
2018-02-27 10:09:18 +03:00
}
// 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 ( "test#1234" )
test ( "#1234test" )
2019-12-01 16:57:05 +03:00
test ( "#abcd" )
test ( "test!1234" )
test ( "!1234test" )
test ( " test !1234test" )
2019-04-07 14:18:16 +03:00
test ( "/home/gitea/#1234" )
2019-12-01 16:57:05 +03:00
test ( "/home/gitea/!1234" )
2018-02-27 10:09:18 +03:00
// 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 ) {
2021-12-11 20:21:36 +03:00
setting . AppURL = TestAppURL
2018-02-27 10:09:18 +03:00
// numeric: render inputs with valid mentions
2019-12-01 16:57:05 +03:00
test := func ( s , expectedFmt , marker string , indices ... int ) {
var path , prefix string
2021-09-15 11:45:27 +03:00
isExternal := false
2019-12-01 16:57:05 +03:00
if marker == "!" {
path = "pulls"
prefix = "http://localhost:3000/someUser/someRepo/pulls/"
} else {
path = "issues"
prefix = "https://someurl.com/someUser/someRepo/"
2021-09-15 11:45:27 +03:00
isExternal = true
2019-12-01 16:57:05 +03:00
}
2018-02-27 10:09:18 +03:00
links := make ( [ ] interface { } , len ( indices ) )
for i , index := range indices {
2021-12-11 20:21:36 +03:00
links [ i ] = numericIssueLink ( util . URLJoin ( TestRepoURL , path ) , "ref-issue" , index , marker )
2018-02-27 10:09:18 +03:00
}
expectedNil := fmt . Sprintf ( expectedFmt , links ... )
2021-04-20 01:25:08 +03:00
testRenderIssueIndexPattern ( t , s , expectedNil , & RenderContext { Metas : localMetas } )
2018-02-27 10:09:18 +03:00
2021-09-15 11:45:27 +03:00
class := "ref-issue"
if isExternal {
class += " ref-external-issue"
}
2018-02-27 10:09:18 +03:00
for i , index := range indices {
2021-09-15 11:45:27 +03:00
links [ i ] = numericIssueLink ( prefix , class , index , marker )
2018-02-27 10:09:18 +03:00
}
expectedNum := fmt . Sprintf ( expectedFmt , links ... )
2021-04-20 01:25:08 +03:00
testRenderIssueIndexPattern ( t , s , expectedNum , & RenderContext { Metas : numericMetas } )
2018-02-27 10:09:18 +03:00
}
// should render freestanding mentions
2019-12-01 16:57:05 +03:00
test ( "#1234 test" , "%s test" , "#" , 1234 )
test ( "test #8 issue" , "test %s issue" , "#" , 8 )
test ( "!1234 test" , "%s test" , "!" , 1234 )
test ( "test !8 issue" , "test %s issue" , "!" , 8 )
test ( "test issue #1234" , "test issue %s" , "#" , 1234 )
test ( "fixes issue #1234." , "fixes issue %s." , "#" , 1234 )
2018-02-27 10:09:18 +03:00
2019-04-07 14:18:16 +03:00
// should render mentions in parentheses / brackets
2019-12-01 16:57:05 +03:00
test ( "(#54321 issue)" , "(%s issue)" , "#" , 54321 )
test ( "[#54321 issue]" , "[%s issue]" , "#" , 54321 )
test ( "test (#9801 extra) issue" , "test (%s extra) issue" , "#" , 9801 )
test ( "test (!9801 extra) issue" , "test (%s extra) issue" , "!" , 9801 )
test ( "test (#1)" , "test (%s)" , "#" , 1 )
2018-02-27 10:09:18 +03:00
// should render multiple issue mentions in the same line
2019-12-01 16:57:05 +03:00
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 )
2019-09-06 03:39:54 +03:00
// should render with :
2019-12-01 16:57:05 +03:00
test ( "#1234: test" , "%s: test" , "#" , 1234 )
test ( "wow (#54321: test)" , "wow (%s: test)" , "#" , 54321 )
2018-02-27 10:09:18 +03:00
}
func TestRender_IssueIndexPattern3 ( t * testing . T ) {
2021-12-11 20:21:36 +03:00
setting . AppURL = TestAppURL
2018-02-27 10:09:18 +03:00
// alphanumeric: render inputs without valid mentions
test := func ( s string ) {
2021-04-20 01:25:08 +03:00
testRenderIssueIndexPattern ( t , s , s , & RenderContext { Metas : alphanumericMetas } )
2018-02-27 10:09:18 +03:00
}
test ( "" )
test ( "this is a test" )
test ( "test 123 123 1234" )
test ( "#" )
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 ) {
2021-12-11 20:21:36 +03:00
setting . AppURL = TestAppURL
2018-02-27 10:09:18 +03:00
// alphanumeric: render inputs with valid mentions
test := func ( s , expectedFmt string , names ... string ) {
links := make ( [ ] interface { } , len ( names ) )
for i , name := range names {
2021-09-15 11:45:27 +03:00
links [ i ] = alphanumIssueLink ( "https://someurl.com/someUser/someRepo/" , "ref-issue ref-external-issue" , name )
2018-02-27 10:09:18 +03:00
}
expected := fmt . Sprintf ( expectedFmt , links ... )
2021-04-20 01:25:08 +03:00
testRenderIssueIndexPattern ( t , s , expected , & RenderContext { Metas : alphanumericMetas } )
2018-02-27 10:09:18 +03:00
}
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" )
}
2021-04-20 01:25:08 +03:00
func testRenderIssueIndexPattern ( t * testing . T , input , expected string , ctx * RenderContext ) {
if ctx . URLPrefix == "" {
2021-12-11 20:21:36 +03:00
ctx . URLPrefix = TestAppURL
2018-02-27 10:09:18 +03:00
}
2019-04-12 08:53:34 +03:00
2021-04-20 01:25:08 +03:00
var buf strings . Builder
err := postProcess ( ctx , [ ] processor { issueIndexPatternProcessor } , strings . NewReader ( input ) , & buf )
2018-02-27 10:09:18 +03:00
assert . NoError ( t , err )
2021-04-20 01:25:08 +03:00
assert . Equal ( t , expected , buf . String ( ) )
2018-02-27 10:09:18 +03:00
}
func TestRender_AutoLink ( t * testing . T ) {
2021-12-11 20:21:36 +03:00
setting . AppURL = TestAppURL
2018-02-27 10:09:18 +03:00
test := func ( input , expected string ) {
2021-04-20 01:25:08 +03:00
var buffer strings . Builder
err := PostProcess ( & RenderContext {
2021-12-11 20:21:36 +03:00
URLPrefix : TestRepoURL ,
2021-04-20 01:25:08 +03:00
Metas : localMetas ,
} , strings . NewReader ( input ) , & buffer )
2018-02-27 10:09:18 +03:00
assert . Equal ( t , err , nil )
2021-04-20 01:25:08 +03:00
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( buffer . String ( ) ) )
buffer . Reset ( )
err = PostProcess ( & RenderContext {
2021-12-11 20:21:36 +03:00
URLPrefix : TestRepoURL ,
2021-04-20 01:25:08 +03:00
Metas : localMetas ,
IsWiki : true ,
} , strings . NewReader ( input ) , & buffer )
2018-02-27 10:09:18 +03:00
assert . Equal ( t , err , nil )
2021-04-20 01:25:08 +03:00
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( buffer . String ( ) ) )
2018-02-27 10:09:18 +03:00
}
// render valid issue URLs
2021-12-11 20:21:36 +03:00
test ( util . URLJoin ( TestRepoURL , "issues" , "3333" ) ,
numericIssueLink ( util . URLJoin ( TestRepoURL , "issues" ) , "ref-issue" , 3333 , "#" ) )
2018-02-27 10:09:18 +03:00
// render valid commit URLs
2021-12-11 20:21:36 +03:00
tmp := util . URLJoin ( TestRepoURL , "commit" , "d8a994ef243349f321568f9e36d5c3f444b99cae" )
2019-09-10 12:03:30 +03:00
test ( tmp , "<a href=\"" + tmp + "\" class=\"commit\"><code class=\"nohighlight\">d8a994ef24</code></a>" )
2018-02-27 10:09:18 +03:00
tmp += "#diff-2"
2019-09-10 12:03:30 +03:00
test ( tmp , "<a href=\"" + tmp + "\" class=\"commit\"><code class=\"nohighlight\">d8a994ef24 (diff-2)</code></a>" )
2018-02-27 10:09:18 +03:00
// render other commit URLs
2019-06-19 01:31:31 +03:00
tmp = "https://external-link.gitea.io/go-gitea/gitea/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2"
2019-09-10 12:03:30 +03:00
test ( tmp , "<a href=\"" + tmp + "\" class=\"commit\"><code class=\"nohighlight\">d8a994ef24 (diff-2)</code></a>" )
2018-02-27 10:09:18 +03:00
}
func TestRender_FullIssueURLs ( t * testing . T ) {
2021-12-11 20:21:36 +03:00
setting . AppURL = TestAppURL
2018-02-27 10:09:18 +03:00
test := func ( input , expected string ) {
2021-04-20 01:25:08 +03:00
var result strings . Builder
err := postProcess ( & RenderContext {
2021-12-11 20:21:36 +03:00
URLPrefix : TestRepoURL ,
2021-04-20 01:25:08 +03:00
Metas : localMetas ,
} , [ ] processor { fullIssuePatternProcessor } , strings . NewReader ( input ) , & result )
2018-02-27 10:09:18 +03:00
assert . NoError ( t , err )
2021-04-20 01:25:08 +03:00
assert . Equal ( t , expected , result . String ( ) )
2018-02-27 10:09:18 +03:00
}
test ( "Here is a link https://git.osgeo.org/gogs/postgis/postgis/pulls/6" ,
"Here is a link https://git.osgeo.org/gogs/postgis/postgis/pulls/6" )
test ( "Look here http://localhost:3000/person/repo/issues/4" ,
2020-01-20 07:39:21 +03:00
` Look here <a href="http://localhost:3000/person/repo/issues/4" class="ref-issue">person/repo#4</a> ` )
2018-02-27 10:09:18 +03:00
test ( "http://localhost:3000/person/repo/issues/4#issuecomment-1234" ,
2020-01-20 07:39:21 +03:00
` <a href="http://localhost:3000/person/repo/issues/4#issuecomment-1234" class="ref-issue">person/repo#4</a> ` )
2019-04-12 08:53:34 +03:00
test ( "http://localhost:3000/gogits/gogs/issues/4" ,
2020-01-20 07:39:21 +03:00
` <a href="http://localhost:3000/gogits/gogs/issues/4" class="ref-issue">#4</a> ` )
2021-10-23 16:38:12 +03:00
test ( "http://localhost:3000/gogits/gogs/issues/4 test" ,
` <a href="http://localhost:3000/gogits/gogs/issues/4" class="ref-issue">#4</a> test ` )
test ( "http://localhost:3000/gogits/gogs/issues/4?a=1&b=2#comment-123 test" ,
` <a href="http://localhost:3000/gogits/gogs/issues/4?a=1&b=2#comment-123" class="ref-issue">#4</a> test ` )
2018-02-27 10:09:18 +03:00
}
func TestRegExp_sha1CurrentPattern ( t * testing . T ) {
trueTestCases := [ ] string {
"d8a994ef243349f321568f9e36d5c3f444b99cae" ,
"abcdefabcdefabcdefabcdefabcdefabcdefabcd" ,
2019-04-07 14:18:16 +03:00
"(abcdefabcdefabcdefabcdefabcdefabcdefabcd)" ,
"[abcdefabcdefabcdefabcdefabcdefabcdefabcd]" ,
"abcdefabcdefabcdefabcdefabcdefabcdefabcd." ,
2018-02-27 10:09:18 +03:00
}
falseTestCases := [ ] string {
"test" ,
"abcdefg" ,
2019-04-07 14:18:16 +03:00
"e59ff077-2d03-4e6b-964d-63fbaea81f" ,
2018-02-27 10:09:18 +03:00
"abcdefghijklmnopqrstuvwxyzabcdefghijklmn" ,
"abcdefghijklmnopqrstuvwxyzabcdefghijklmO" ,
}
for _ , testCase := range trueTestCases {
assert . True ( t , sha1CurrentPattern . MatchString ( testCase ) )
}
for _ , testCase := range falseTestCases {
assert . False ( t , sha1CurrentPattern . MatchString ( testCase ) )
}
}
func TestRegExp_anySHA1Pattern ( t * testing . T ) {
testCases := map [ string ] [ ] string {
"https://github.com/jquery/jquery/blob/a644101ed04d0beacea864ce805e0c4f86ba1cd1/test/unit/event.js#L2703" : {
"a644101ed04d0beacea864ce805e0c4f86ba1cd1" ,
2019-04-06 21:28:45 +03:00
"/test/unit/event.js" ,
"#L2703" ,
2018-02-27 10:09:18 +03:00
} ,
"https://github.com/jquery/jquery/blob/a644101ed04d0beacea864ce805e0c4f86ba1cd1/test/unit/event.js" : {
"a644101ed04d0beacea864ce805e0c4f86ba1cd1" ,
2019-04-06 21:28:45 +03:00
"/test/unit/event.js" ,
2018-02-27 10:09:18 +03:00
"" ,
} ,
"https://github.com/jquery/jquery/commit/0705be475092aede1eddae01319ec931fb9c65fc" : {
"0705be475092aede1eddae01319ec931fb9c65fc" ,
"" ,
"" ,
} ,
"https://github.com/jquery/jquery/tree/0705be475092aede1eddae01319ec931fb9c65fc/src" : {
"0705be475092aede1eddae01319ec931fb9c65fc" ,
2019-04-06 21:28:45 +03:00
"/src" ,
2018-02-27 10:09:18 +03:00
"" ,
} ,
"https://try.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2" : {
"d8a994ef243349f321568f9e36d5c3f444b99cae" ,
"" ,
2019-04-06 21:28:45 +03:00
"#diff-2" ,
2018-02-27 10:09:18 +03:00
} ,
}
for k , v := range testCases {
assert . Equal ( t , anySHA1Pattern . FindStringSubmatch ( k ) [ 1 : ] , v )
}
}
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 ) )
}
}