2017-04-21 15:01:08 +08:00
// Copyright 2017 The Gitea Authors. All rights reserved.
2022-11-28 02:20:29 +08:00
// SPDX-License-Identifier: MIT
2017-04-21 15:01:08 +08:00
2016-04-23 06:28:08 +08:00
package markdown_test
import (
2024-11-24 16:18:57 +08:00
"context"
2024-03-01 15:11:51 +08:00
"html/template"
2017-02-14 09:13:59 +08:00
"strings"
2017-09-17 01:17:57 +08:00
"testing"
2017-02-14 09:13:59 +08:00
2021-10-11 20:12:06 +08:00
"code.gitea.io/gitea/modules/log"
2021-04-20 06:25:08 +08:00
"code.gitea.io/gitea/modules/markup"
2023-10-24 10:54:59 +08:00
"code.gitea.io/gitea/modules/markup/markdown"
2016-11-11 00:24:48 +08:00
"code.gitea.io/gitea/modules/setting"
2024-03-22 20:16:23 +08:00
"code.gitea.io/gitea/modules/svg"
2024-11-14 13:02:11 +08:00
"code.gitea.io/gitea/modules/test"
2018-02-20 20:50:42 +08:00
"code.gitea.io/gitea/modules/util"
2017-09-17 01:17:57 +08:00
2017-02-08 14:29:07 +08:00
"github.com/stretchr/testify/assert"
2024-03-22 20:16:23 +08:00
"golang.org/x/text/cases"
"golang.org/x/text/language"
2016-04-23 06:28:08 +08:00
)
2022-01-21 01:46:10 +08:00
const (
2024-05-30 15:04:01 +08:00
AppURL = "http://localhost:3000/"
testRepoOwnerName = "user13"
testRepoName = "repo11"
FullURL = AppURL + testRepoOwnerName + "/" + testRepoName + "/"
2022-01-21 01:46:10 +08:00
)
2016-04-23 06:28:08 +08:00
2024-02-29 11:39:24 +08:00
// these values should match the const above
2019-04-12 13:53:34 +08:00
var localMetas = map [ string ] string {
2024-05-30 15:04:01 +08:00
"user" : testRepoOwnerName ,
"repo" : testRepoName ,
2019-04-12 13:53:34 +08:00
}
2017-02-24 22:59:56 +08:00
func TestRender_StandardLinks ( t * testing . T ) {
2024-11-24 16:18:57 +08:00
test := func ( input , expected string ) {
buffer , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , input )
2021-04-20 06:25:08 +08:00
assert . NoError ( t , err )
2024-03-01 15:11:51 +08:00
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( string ( buffer ) ) )
2017-02-24 22:59:56 +08:00
}
googleRendered := ` <p><a href="https://google.com/" rel="nofollow">https://google.com/</a></p> `
2024-11-24 16:18:57 +08:00
test ( "<https://google.com/>" , googleRendered )
test ( "[Link](Link)" , ` <p><a href="/Link" rel="nofollow">Link</a></p> ` )
2017-02-24 22:59:56 +08:00
}
func TestRender_Images ( t * testing . T ) {
setting . AppURL = AppURL
test := func ( input , expected string ) {
2024-11-24 16:18:57 +08:00
buffer , err := markdown . RenderString ( markup . NewTestRenderContext ( FullURL ) , input )
2021-04-20 06:25:08 +08:00
assert . NoError ( t , err )
2024-03-01 15:11:51 +08:00
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( string ( buffer ) ) )
2017-02-24 22:59:56 +08:00
}
url := "../../.images/src/02/train.jpg"
title := "Train"
2018-10-31 06:26:28 +08:00
href := "https://gitea.io"
2024-02-29 11:39:24 +08:00
result := util . URLJoin ( FullURL , url )
2021-10-11 20:12:06 +08:00
// hint: With Markdown v2.5.2, there is a new syntax: [link](URL){:target="_blank"} , but we do not support it now
2017-02-24 22:59:56 +08:00
test (
"![" + title + "](" + url + ")" ,
2021-10-11 20:12:06 +08:00
` <p><a href=" ` + result + ` " target="_blank" rel="nofollow noopener"><img src=" ` + result + ` " alt=" ` + title + ` "/></a></p> ` )
2017-02-24 22:59:56 +08:00
test (
"[[" + title + "|" + url + "]]" ,
2018-02-27 15:09:18 +08:00
` <p><a href=" ` + result + ` " rel="nofollow"><img src=" ` + result + ` " title=" ` + title + ` " alt=" ` + title + ` "/></a></p> ` )
2018-10-31 06:26:28 +08:00
test (
"[![" + title + "](" + url + ")](" + href + ")" ,
` <p><a href=" ` + href + ` " rel="nofollow"><img src=" ` + result + ` " alt=" ` + title + ` "/></a></p> ` )
2021-04-11 00:26:28 +08:00
test (
"![" + title + "](" + url + ")" ,
2021-10-11 20:12:06 +08:00
` <p><a href=" ` + result + ` " target="_blank" rel="nofollow noopener"><img src=" ` + result + ` " alt=" ` + title + ` "/></a></p> ` )
2021-04-11 00:26:28 +08:00
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> ` )
2017-02-14 09:13:59 +08:00
}
2024-11-24 16:18:57 +08:00
func testAnswers ( baseURL string ) [ ] string {
2017-02-24 22:59:56 +08:00
return [ ] string {
` < p > Wiki ! Enjoy : ) < / p >
< ul >
2024-11-24 16:18:57 +08:00
< li > < a href = "` + baseURL + `/Links" rel = "nofollow" > Links , Language bindings , Engine bindings < / a > < / li >
< li > < a href = "` + baseURL + `/Tips" rel = "nofollow" > Tips < / a > < / li >
2017-02-24 22:59:56 +08:00
< / ul >
2024-05-30 15:04:01 +08:00
< p > See commit < a href = "/` + testRepoOwnerName + `/` + testRepoName + `/commit/65f1bf27bc" rel = "nofollow" > < code > 65 f1bf27bc < / code > < / a > < / p >
2017-02-24 22:59:56 +08:00
< p > Ideas and codes < / p >
< ul >
2024-03-13 18:34:58 +08:00
< li > Bezier widget ( by < a href = "/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 >
2024-05-30 15:04:01 +08:00
< li > Bezier widget ( by < a href = "/r-lyeh" rel = "nofollow" > @ r - lyeh < / a > ) < a href = "` + FullURL + `issues/786" class = "ref-issue" rel = "nofollow" > # 786 < / a > < / li >
2018-02-27 15:09:18 +08:00
< li > Node graph editors < a href = "https://github.com/ocornut/imgui/issues/306" rel = "nofollow" > https : //github.com/ocornut/imgui/issues/306</a></li>
2024-11-24 16:18:57 +08:00
< li > < a href = "` + baseURL + `/memory_editor_example" rel = "nofollow" > Memory Editor < / a > < / li >
< li > < a href = "` + baseURL + `/plot_var_example" rel = "nofollow" > Plot var helper < / a > < / li >
2017-02-24 22:59:56 +08:00
< / ul >
` ,
2019-12-24 06:38:50 +08:00
` < h2 id = "user-content-what-is-wine-staging" > What is Wine Staging ? < / h2 >
2017-02-14 09:13:59 +08:00
< p > < strong > Wine Staging < / strong > on website < a href = "http://wine-staging.com" rel = "nofollow" > wine - staging . com < / a > . < / p >
2019-12-24 06:38:50 +08:00
< h2 id = "user-content-quick-links" > Quick Links < / h2 >
2017-02-14 09:13:59 +08:00
< 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 >
2024-11-24 16:18:57 +08:00
< th > < a href = "` + baseURL + `/images/icon-install.png" rel = "nofollow" > < img src = "` + baseURL + `/images/icon-install.png" title = "icon-install.png" alt = "images/icon-install.png" / > < / a > < / th >
< th > < a href = "` + baseURL + `/Installation" rel = "nofollow" > Installation < / a > < / th >
2017-02-14 09:13:59 +08:00
< / tr >
< / thead >
< tbody >
< tr >
2024-11-24 16:18:57 +08:00
< td > < a href = "` + baseURL + `/images/icon-usage.png" rel = "nofollow" > < img src = "` + baseURL + `/images/icon-usage.png" title = "icon-usage.png" alt = "images/icon-usage.png" / > < / a > < / td >
< td > < a href = "` + baseURL + `/Usage" rel = "nofollow" > Usage < / a > < / td >
2017-02-14 09:13:59 +08:00
< / tr >
< / tbody >
< / table >
` ,
2017-02-24 22:59:56 +08:00
` < 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 >
2017-02-14 09:13:59 +08:00
< ol >
2020-04-22 06:13:56 +08:00
< 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 / >
2024-11-24 16:18:57 +08:00
< a href = "` + baseURL + `/images/1.png" rel = "nofollow" > < img src = "` + baseURL + `/images/1.png" title = "1.png" alt = "images/1.png" / > < / a > < / li >
2020-04-22 06:13:56 +08:00
< li > Perform a test run by hitting the Run ! button . < br / >
2024-11-24 16:18:57 +08:00
< a href = "` + baseURL + `/images/2.png" rel = "nofollow" > < img src = "` + baseURL + `/images/2.png" title = "2.png" alt = "images/2.png" / > < / a > < / li >
2017-02-14 09:13:59 +08:00
< / ol >
2019-12-24 06:38:50 +08:00
< h2 id = "user-content-custom-id" > More tests < / h2 >
2019-03-21 21:53:06 +08:00
< p > ( from < a href = "https://www.markdownguide.org/extended-syntax/" rel = "nofollow" > https : //www.markdownguide.org/extended-syntax/</a>)</p>
2020-05-04 04:17:24 +08:00
< h3 id = "user-content-checkboxes" > Checkboxes < / h3 >
2020-05-11 07:14:49 +08:00
< ul >
2021-05-23 22:14:03 +08:00
< 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 >
2020-05-04 04:17:24 +08:00
< / ul >
2019-12-24 06:38:50 +08:00
< h3 id = "user-content-definition-list" > Definition list < / h3 >
2019-03-21 21:53:06 +08:00
< 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 >
2019-12-24 06:38:50 +08:00
< 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 >
2019-03-21 21:53:06 +08:00
< div >
< hr / >
< ol >
2019-12-31 09:53:28 +08:00
< 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 >
2019-03-21 21:53:06 +08:00
< p > Indent paragraphs to include them in the footnote . < / p >
< p > < code > { my code } < / code > < / p >
2019-12-31 09:53:28 +08:00
< p > Add as many paragraphs as you like . < a href = "#fnref:user-content-bignote" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
2019-03-21 21:53:06 +08:00
< / ol >
< / div >
2022-03-24 23:47:37 +08:00
` , ` < 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 >
2017-02-14 09:13:59 +08:00
` ,
2017-02-24 22:59:56 +08:00
}
2017-02-14 09:13:59 +08:00
}
2017-09-17 01:17:57 +08:00
// 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 ] ]
2017-02-24 22:59:56 +08:00
2019-08-14 16:04:55 +08:00
See commit 65 f1bf27bc
2019-04-16 15:53:57 +08:00
2017-09-17 01:17:57 +08:00
Ideas and codes
2017-02-14 09:13:59 +08:00
2017-09-17 01:17:57 +08:00
- Bezier widget ( by @ r - lyeh ) ` + AppURL + ` ocornut / imgui / issues / 786
2024-05-30 15:04:01 +08:00
- Bezier widget ( by @ r - lyeh ) ` + FullURL + ` issues / 786
2017-09-17 01:17:57 +08:00
- 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).
2017-02-14 09:13:59 +08:00
2017-09-17 01:17:57 +08:00
# # 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 .
2019-03-21 21:53:06 +08:00
[ [ images / 2. png ] ]
# # More tests { # custom - id }
( from https : //www.markdownguide.org/extended-syntax/)
2020-05-04 04:17:24 +08:00
# # # Checkboxes
- [ ] unchecked
- [ x ] checked
- [ ] still unchecked
2019-03-21 21:53:06 +08:00
# # # 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 .
` ,
2022-03-24 23:47:37 +08:00
`
- [ ] < ! -- 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 -- > ` ,
2017-02-14 09:13:59 +08:00
}
2017-09-17 01:17:57 +08:00
func TestTotal_RenderString ( t * testing . T ) {
2024-11-14 13:02:11 +08:00
defer test . MockVariableValue ( & markup . RenderBehaviorForTesting . ForceHardLineBreak , true ) ( )
2024-11-24 16:18:57 +08:00
defer test . MockVariableValue ( & markup . RenderBehaviorForTesting . DisableAdditionalAttributes , true ) ( )
markup . Init ( & markup . RenderHelperFuncs {
IsUsernameMentionable : func ( ctx context . Context , username string ) bool {
return username == "r-lyeh"
} ,
} )
answers := testAnswers ( "" )
2017-09-17 01:17:57 +08:00
for i := 0 ; i < len ( sameCases ) ; i ++ {
2024-11-24 16:18:57 +08:00
line , err := markdown . RenderString ( markup . NewTestRenderContext ( localMetas ) , sameCases [ i ] )
2021-04-20 06:25:08 +08:00
assert . NoError ( t , err )
2024-11-14 13:02:11 +08:00
assert . Equal ( t , answers [ i ] , string ( line ) )
2017-09-17 01:17:57 +08:00
}
}
2019-11-13 10:27:11 +08:00
func TestRender_RenderParagraphs ( t * testing . T ) {
test := func ( t * testing . T , str string , cnt int ) {
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderRawString ( markup . NewTestRenderContext ( ) , str )
2021-04-20 06:25:08 +08:00
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" )
2024-11-22 13:48:09 +08:00
res , err = markdown . RenderRawString ( markup . NewTestRenderContext ( ) , mac )
2021-04-20 06:25:08 +08:00
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" )
2024-11-22 13:48:09 +08:00
res , err = markdown . RenderRawString ( markup . NewTestRenderContext ( ) , dos )
2021-04-20 06:25:08 +08:00
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 )
2019-11-13 10:27:11 +08:00
}
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 )
}
2021-03-15 00:36:51 +08:00
2021-03-16 07:20:05 +08:00
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 {
2021-10-11 20:12:06 +08:00
log . Info ( "Test markdown render error with fuzzy data: %x, the following errors can be recovered" , testcase )
2024-11-22 13:48:09 +08:00
_ , err := markdown . RenderRawString ( markup . NewTestRenderContext ( ) , string ( testcase ) )
2021-04-20 06:25:08 +08:00
assert . NoError ( t , err )
2021-03-16 07:20:05 +08:00
}
}
2021-03-15 00:36:51 +08:00
func TestRenderSiblingImages_Issue12925 ( t * testing . T ) {
testcase := ` ! [ image1 ] ( / image1 )
! [ image2 ] ( / image2 )
`
2021-10-11 20:12:06 +08:00
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 >
2021-03-15 00:36:51 +08:00
`
2024-11-14 13:02:11 +08:00
defer test . MockVariableValue ( & markup . RenderBehaviorForTesting . ForceHardLineBreak , true ) ( )
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderRawString ( markup . NewTestRenderContext ( ) , testcase )
2021-04-20 06:25:08 +08:00
assert . NoError ( t , err )
2021-03-15 00:36:51 +08:00
assert . Equal ( t , expected , res )
2021-12-16 07:49:12 +08:00
}
2021-03-16 07:20:05 +08:00
2021-12-16 07:49:12 +08:00
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 >
`
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , testcase )
2021-12-16 07:49:12 +08:00
assert . NoError ( t , err )
2024-03-01 15:11:51 +08:00
assert . Equal ( t , template . HTML ( expected ) , res )
2021-03-15 00:36:51 +08:00
}
2022-10-06 02:55:36 +08:00
2022-10-21 20:00:53 +08:00
func TestColorPreview ( t * testing . T ) {
const nl = "\n"
positiveTests := [ ] struct {
testcase string
expected string
} {
2024-03-31 19:17:34 +08:00
{ // do not render color names
"The CSS class `red` is there" ,
"<p>The CSS class <code>red</code> is there</p>\n" ,
} ,
2022-10-21 20:00:53 +08:00
{ // 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
2024-03-31 19:17:34 +08:00
"This is the color white `#0a0`" ,
` <p>This is the color white <code>#0a0<span class="color-preview" style="background-color: #0a0"></span></code></p> ` + nl ,
2022-10-21 20:00:53 +08:00
} ,
{ // 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 {
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , test . testcase )
2022-10-21 20:00:53 +08:00
assert . NoError ( t , err , "Unexpected error in testcase: %q" , test . testcase )
2024-03-01 15:11:51 +08:00
assert . Equal ( t , template . HTML ( test . expected ) , res , "Unexpected result in testcase %q" , test . testcase )
2022-10-21 20:00:53 +08:00
}
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 {
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , test )
2022-10-21 20:00:53 +08:00
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 )
}
}
2022-10-06 02:55:36 +08:00
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 ,
} ,
2024-04-03 02:15:40 +08:00
{
` $a$. ` ,
` <p><code class="language-math is-loading">a</code>.</p> ` + nl ,
} ,
{
` .$a$ ` ,
` <p>.$a$</p> ` + nl ,
} ,
2022-10-06 02:55:36 +08:00
{
` $a a$b b$ ` ,
2024-04-03 02:15:40 +08:00
` <p>$a a$b b$</p> ` + nl ,
2022-10-06 02:55:36 +08:00
} ,
{
` a a$b b ` ,
` <p>a a$b b</p> ` + nl ,
} ,
{
` a$b $a a$b b$ ` ,
2024-04-03 02:15:40 +08:00
` <p>a$b $a a$b b$</p> ` + nl ,
} ,
{
"a$x$" ,
` <p>a$x$</p> ` + nl ,
} ,
{
"$x$a" ,
` <p>$x$a</p> ` + nl ,
2022-10-06 02:55:36 +08:00
} ,
{
"$$a$$" ,
` <pre class="code-block is-loading"><code class="chroma language-math display">a</code></pre> ` + nl ,
} ,
2024-06-20 10:12:54 +08:00
{
"$a$ ($b$) [$c$] {$d$}" ,
` <p><code class="language-math is-loading">a</code> (<code class="language-math is-loading">b</code>) [$c$] { $d$}</p> ` + nl ,
} ,
2024-06-30 07:23:47 +08:00
{
"$$a$$ test" ,
` <p><code class="language-math display is-loading">a</code> test</p> ` + nl ,
} ,
{
"test $$a$$" ,
` <p>test <code class="language-math display is-loading">a</code></p> ` + nl ,
} ,
2022-10-06 02:55:36 +08:00
}
for _ , test := range testcases {
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , test . testcase )
2022-10-06 02:55:36 +08:00
assert . NoError ( t , err , "Unexpected error in testcase: %q" , test . testcase )
2024-03-01 15:11:51 +08:00
assert . Equal ( t , template . HTML ( test . expected ) , res , "Unexpected result in testcase %q" , test . testcase )
2022-10-06 02:55:36 +08:00
}
}
2023-06-13 14:44:47 +08:00
func TestTaskList ( t * testing . T ) {
testcases := [ ] struct {
testcase string
expected string
} {
{
// data-source-position should take into account YAML frontmatter.
` -- -
foo : bar
-- -
- [ ] task 1 ` ,
` < details > < summary > < i class = "icon table" > < / i > < / summary > < table >
< thead >
< tr >
< th > foo < / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > bar < / td >
< / tr >
< / tbody >
< / table >
< / details > < ul >
< li class = "task-list-item" > < input type = "checkbox" disabled = "" data - source - position = "19" / > task 1 < / li >
< / ul >
` ,
} ,
}
for _ , test := range testcases {
2024-11-22 13:48:09 +08:00
res , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , test . testcase )
2023-06-13 14:44:47 +08:00
assert . NoError ( t , err , "Unexpected error in testcase: %q" , test . testcase )
2024-03-01 15:11:51 +08:00
assert . Equal ( t , template . HTML ( test . expected ) , res , "Unexpected result in testcase %q" , test . testcase )
2023-06-13 14:44:47 +08:00
}
}
2024-01-15 16:49:24 +08:00
func TestRenderLinks ( t * testing . T ) {
2024-03-01 15:11:51 +08:00
input := ` space @ mention - user $ { SPACE } $ { SPACE }
2024-01-15 16:49:24 +08:00
/ 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 )
2024-01-27 11:36:01 +08:00
! [ local image ] ( path / file )
! [ local image ] ( / path / file )
2024-01-15 16:49:24 +08:00
! [ 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 88 fc37a3c0a4dda553bdcfc80c178a58247f42fb ... 12 fc37a3c0a4dda553bdcfc80c178a58247f42fb pare
https : //example.com/user/repo/commit/88fc37a3c0a4dda553bdcfc80c178a58247f42fb
com 88 fc37a3c0a4dda553bdcfc80c178a58247f42fb mit
: + 1 :
mail @ domain . com
@ mention - user test
# 123
2024-03-01 15:11:51 +08:00
space $ { SPACE } $ { SPACE }
2024-01-15 16:49:24 +08:00
`
2024-03-01 15:11:51 +08:00
input = strings . ReplaceAll ( input , "${SPACE}" , " " ) // replace ${SPACE} with " ", to avoid some editor's auto-trimming
2024-01-15 16:49:24 +08:00
cases := [ ] struct {
Expected string
} {
2024-11-24 16:18:57 +08:00
{
2024-01-15 16:49:24 +08:00
Expected : ` < p > space @ mention - user < br / >
/ just / a / path . bin < br / >
< a href = "https://example.com/file.bin" rel = "nofollow" > https : //example.com/file.bin</a><br/>
< a href = "/file.bin" rel = "nofollow" > local link < / a > < br / >
< a href = "https://example.com" rel = "nofollow" > remote link < / a > < br / >
2024-06-18 11:09:20 +08:00
< a href = "/file.bin" rel = "nofollow" > local link < / a > < br / >
2024-01-15 16:49:24 +08:00
< a href = "https://example.com" rel = "nofollow" > remote link < / a > < br / >
< a href = "/image.jpg" target = "_blank" rel = "nofollow noopener" > < img src = "/image.jpg" alt = "local image" / > < / a > < br / >
2024-01-27 11:36:01 +08:00
< a href = "/path/file" target = "_blank" rel = "nofollow noopener" > < img src = "/path/file" alt = "local image" / > < / a > < br / >
< a href = "/path/file" target = "_blank" rel = "nofollow noopener" > < img src = "/path/file" alt = "local image" / > < / a > < br / >
2024-01-15 16:49:24 +08:00
< a href = "https://example.com/image.jpg" target = "_blank" rel = "nofollow noopener" > < img src = "https://example.com/image.jpg" alt = "remote image" / > < / a > < br / >
< a href = "/image.jpg" rel = "nofollow" > < img src = "/image.jpg" title = "local image" alt = "local image" / > < / a > < br / >
< a href = "https://example.com/image.jpg" rel = "nofollow" > < img src = "https://example.com/image.jpg" title = "remote link" alt = "remote link" / > < / a > < br / >
2024-11-16 16:41:44 +08:00
< a href = "https://example.com/user/repo/compare/88fc37a3c0a4dda553bdcfc80c178a58247f42fb...12fc37a3c0a4dda553bdcfc80c178a58247f42fb#hash" rel = "nofollow" > < code > 88 fc37a3c0 ... 12 fc37a3c0 ( hash ) < / code > < / a > < br / >
2024-01-15 16:49:24 +08:00
com 88 fc37a3c0a4dda553bdcfc80c178a58247f42fb ... 12 fc37a3c0a4dda553bdcfc80c178a58247f42fb pare < br / >
2024-11-16 16:41:44 +08:00
< a href = "https://example.com/user/repo/commit/88fc37a3c0a4dda553bdcfc80c178a58247f42fb" rel = "nofollow" > < code > 88 fc37a3c0 < / code > < / a > < br / >
2024-01-15 16:49:24 +08:00
com 88 fc37a3c0a4dda553bdcfc80c178a58247f42fb mit < br / >
< span class = "emoji" aria - label = "thumbs up" > 👍 < / span > < br / >
< a href = "mailto:mail@domain.com" rel = "nofollow" > mail @ domain . com < / a > < br / >
@ mention - user test < br / >
# 123 < br / >
space < / p >
` ,
} ,
}
2024-11-14 13:02:11 +08:00
defer test . MockVariableValue ( & markup . RenderBehaviorForTesting . ForceHardLineBreak , true ) ( )
2024-11-24 16:18:57 +08:00
defer test . MockVariableValue ( & markup . RenderBehaviorForTesting . DisableAdditionalAttributes , true ) ( )
2024-01-15 16:49:24 +08:00
for i , c := range cases {
2024-11-24 16:18:57 +08:00
result , err := markdown . RenderString ( markup . NewTestRenderContext ( localMetas ) , input )
2024-01-15 16:49:24 +08:00
assert . NoError ( t , err , "Unexpected error in testcase: %v" , i )
2024-11-14 13:02:11 +08:00
assert . Equal ( t , c . Expected , string ( result ) , "Unexpected result in testcase %v" , i )
2024-01-15 16:49:24 +08:00
}
}
2024-03-22 20:16:23 +08:00
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 := ` <blockquote class="attention-header attention- { attention}"><p><svg class="attention-icon attention- { attention} svg { icon}" width="16" height="16"></svg><strong class="attention- { attention}"> { Attention}</strong></p> `
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 ) {
2024-11-22 13:48:09 +08:00
result , err := markdown . RenderString ( markup . NewTestRenderContext ( ) , input )
2024-03-22 20:16:23 +08:00
assert . NoError ( t , err )
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( string ( result ) ) )
}
test ( `
> [ ! NOTE ]
> text
` , renderAttention ( "note" , "octicon-info" ) + "\n<p>text</p>\n</blockquote>" )
test ( ` > [!note] ` , renderAttention ( "note" , "octicon-info" ) + "\n</blockquote>" )
test ( ` > [!tip] ` , renderAttention ( "tip" , "octicon-light-bulb" ) + "\n</blockquote>" )
test ( ` > [!important] ` , renderAttention ( "important" , "octicon-report" ) + "\n</blockquote>" )
test ( ` > [!warning] ` , renderAttention ( "warning" , "octicon-alert" ) + "\n</blockquote>" )
test ( ` > [!caution] ` , renderAttention ( "caution" , "octicon-stop" ) + "\n</blockquote>" )
2024-06-04 23:35:29 +08:00
// escaped by mdformat
test ( ` > \[!NOTE\] ` , renderAttention ( "note" , "octicon-info" ) + "\n</blockquote>" )
// legacy GitHub style
test ( ` > **warning** ` , renderAttention ( "warning" , "octicon-alert" ) + "\n</blockquote>" )
2024-03-22 20:16:23 +08:00
}
2024-11-18 13:25:42 +08:00
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 ++ {
2024-11-22 13:48:09 +08:00
_ , _ = markdown . RenderString ( markup . NewTestRenderContext ( ) , "https://example.com\n- a\n- b\n" )
2024-11-18 13:25:42 +08:00
}
}