2017-04-21 03:01:08 -04:00
// Copyright 2017 The Gitea Authors. All rights reserved.
2022-11-27 13:20:29 -05:00
// SPDX-License-Identifier: MIT
2017-04-21 03:01:08 -04:00
2016-04-22 18:28:08 -04:00
package markdown_test
import (
2022-06-16 11:47:44 -04:00
"context"
2022-10-05 14:55:36 -04:00
"os"
2017-02-13 20:13:59 -05:00
"strings"
2017-09-16 13:17:57 -04:00
"testing"
2017-02-13 20:13:59 -05:00
Refactor path & config system (#25330)
# The problem
There were many "path tricks":
* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
* The "serv" process started by OpenSSH server
* The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling
# The solution
* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.
The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default
The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default
## ⚠️ BREAKING
If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.
----
Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503
Replace #23301
Replace #22754
And maybe more
2023-06-21 01:50:26 -04:00
"code.gitea.io/gitea/models/unittest"
2022-01-19 18:26:57 -05:00
"code.gitea.io/gitea/modules/git"
2021-10-11 08:12:06 -04:00
"code.gitea.io/gitea/modules/log"
2021-04-19 18:25:08 -04:00
"code.gitea.io/gitea/modules/markup"
2023-10-23 22:54:59 -04:00
"code.gitea.io/gitea/modules/markup/markdown"
2016-11-10 11:24:48 -05:00
"code.gitea.io/gitea/modules/setting"
2018-02-20 07:50:42 -05:00
"code.gitea.io/gitea/modules/util"
2017-09-16 13:17:57 -04:00
2017-02-08 01:29:07 -05:00
"github.com/stretchr/testify/assert"
2016-04-22 18:28:08 -04:00
)
2022-01-20 12:46:10 -05:00
const (
AppURL = "http://localhost:3000/"
Repo = "gogits/gogs"
AppSubURL = AppURL + Repo + "/"
)
2016-04-22 18:28:08 -04:00
2019-04-12 01:53:34 -04:00
// these values should match the Repo const above
var localMetas = map [ string ] string {
2019-08-14 04:04:55 -04:00
"user" : "gogits" ,
"repo" : "gogs" ,
2022-09-02 15:18:23 -04:00
"repoPath" : "../../../tests/gitea-repositories-meta/user13/repo11.git/" ,
2019-04-12 01:53:34 -04:00
}
2022-06-16 11:47:44 -04:00
func TestMain ( m * testing . M ) {
Refactor path & config system (#25330)
# The problem
There were many "path tricks":
* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
* The "serv" process started by OpenSSH server
* The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling
# The solution
* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.
The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default
The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default
## ⚠️ BREAKING
If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.
----
Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503
Replace #23301
Replace #22754
And maybe more
2023-06-21 01:50:26 -04:00
unittest . InitSettings ( )
2022-06-16 11:47:44 -04:00
if err := git . InitSimple ( context . Background ( ) ) ; err != nil {
log . Fatal ( "git init failed, err: %v" , err )
}
2022-10-22 13:15:52 -04:00
markup . Init ( & markup . ProcessorHelper {
IsUsernameMentionable : func ( ctx context . Context , username string ) bool {
return username == "r-lyeh"
} ,
} )
2022-10-05 14:55:36 -04:00
os . Exit ( m . Run ( ) )
2022-06-16 11:47:44 -04:00
}
2017-02-24 09:59:56 -05:00
func TestRender_StandardLinks ( t * testing . T ) {
2017-02-13 20:13:59 -05:00
setting . AppURL = AppURL
setting . AppSubURL = AppSubURL
2017-02-24 09:59:56 -05:00
test := func ( input , expected , expectedWiki string ) {
2023-10-23 22:54:59 -04:00
buffer , err := markdown . RenderString ( & markup . RenderContext {
2023-03-05 16:59:05 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : setting . AppSubURL ,
} , input )
assert . NoError ( t , err )
2019-07-23 14:50:39 -04:00
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( buffer ) )
2021-04-19 18:25:08 -04:00
2023-10-23 22:54:59 -04:00
buffer , err = markdown . RenderString ( & markup . RenderContext {
2023-03-05 16:59:05 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : setting . AppSubURL ,
IsWiki : true ,
} , input )
2021-07-18 08:09:34 -04:00
assert . NoError ( t , err )
2021-04-19 18:25:08 -04:00
assert . Equal ( t , strings . TrimSpace ( expectedWiki ) , strings . TrimSpace ( buffer ) )
2017-02-24 09:59:56 -05:00
}
googleRendered := ` <p><a href="https://google.com/" rel="nofollow">https://google.com/</a></p> `
test ( "<https://google.com/>" , googleRendered , googleRendered )
2018-02-20 07:50:42 -05:00
lnk := util . URLJoin ( AppSubURL , "WikiPage" )
lnkWiki := util . URLJoin ( AppSubURL , "wiki" , "WikiPage" )
2017-02-24 09:59:56 -05:00
test ( "[WikiPage](WikiPage)" ,
` <p><a href=" ` + lnk + ` " rel="nofollow">WikiPage</a></p> ` ,
` <p><a href=" ` + lnkWiki + ` " rel="nofollow">WikiPage</a></p> ` )
}
func TestRender_Images ( t * testing . T ) {
setting . AppURL = AppURL
setting . AppSubURL = AppSubURL
test := func ( input , expected string ) {
2023-10-23 22:54:59 -04:00
buffer , err := markdown . RenderString ( & markup . RenderContext {
2023-03-05 16:59:05 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : setting . AppSubURL ,
} , input )
assert . NoError ( t , err )
2019-07-23 14:50:39 -04:00
assert . Equal ( t , strings . TrimSpace ( expected ) , strings . TrimSpace ( buffer ) )
2017-02-24 09:59:56 -05:00
}
url := "../../.images/src/02/train.jpg"
title := "Train"
2018-10-30 18:26:28 -04:00
href := "https://gitea.io"
2018-02-20 07:50:42 -05:00
result := util . URLJoin ( AppSubURL , url )
2021-10-11 08:12:06 -04: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 09:59:56 -05:00
test (
"![" + title + "](" + url + ")" ,
2021-10-11 08:12:06 -04:00
` <p><a href=" ` + result + ` " target="_blank" rel="nofollow noopener"><img src=" ` + result + ` " alt=" ` + title + ` "/></a></p> ` )
2017-02-24 09:59:56 -05:00
test (
"[[" + title + "|" + url + "]]" ,
2018-02-27 02:09:18 -05:00
` <p><a href=" ` + result + ` " rel="nofollow"><img src=" ` + result + ` " title=" ` + title + ` " alt=" ` + title + ` "/></a></p> ` )
2018-10-30 18:26:28 -04:00
test (
"[![" + title + "](" + url + ")](" + href + ")" ,
` <p><a href=" ` + href + ` " rel="nofollow"><img src=" ` + result + ` " alt=" ` + title + ` "/></a></p> ` )
2021-04-10 12:26:28 -04:00
url = "/../../.images/src/02/train.jpg"
test (
"![" + title + "](" + url + ")" ,
2021-10-11 08:12:06 -04:00
` <p><a href=" ` + result + ` " target="_blank" rel="nofollow noopener"><img src=" ` + result + ` " alt=" ` + title + ` "/></a></p> ` )
2021-04-10 12:26:28 -04: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-13 20:13:59 -05:00
}
2017-02-24 09:59:56 -05:00
func testAnswers ( baseURLContent , baseURLImages string ) [ ] string {
return [ ] string {
` < p > Wiki ! Enjoy : ) < / p >
< ul >
2017-07-06 12:05:35 -04:00
< li > < a href = "` + baseURLContent + `/Links" rel = "nofollow" > Links , Language bindings , Engine bindings < / a > < / li >
< li > < a href = "` + baseURLContent + `/Tips" rel = "nofollow" > Tips < / a > < / li >
2017-02-24 09:59:56 -05:00
< / ul >
2019-08-14 04:04:55 -04:00
< p > See commit < a href = "http://localhost:3000/gogits/gogs/commit/65f1bf27bc" rel = "nofollow" > < code > 65 f1bf27bc < / code > < / a > < / p >
2017-02-24 09:59:56 -05:00
< p > Ideas and codes < / p >
< ul >
2020-01-19 23:39:21 -05:00
< 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 >
2018-02-27 02:09:18 -05: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>
2017-07-06 12:05:35 -04:00
< 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 >
2017-02-24 09:59:56 -05:00
< / ul >
` ,
2019-12-23 17:38:50 -05:00
` < h2 id = "user-content-what-is-wine-staging" > What is Wine Staging ? < / h2 >
2017-02-13 20:13:59 -05:00
< p > < strong > Wine Staging < / strong > on website < a href = "http://wine-staging.com" rel = "nofollow" > wine - staging . com < / a > . < / p >
2019-12-23 17:38:50 -05:00
< h2 id = "user-content-quick-links" > Quick Links < / h2 >
2017-02-13 20:13:59 -05: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 >
2018-02-27 02:09:18 -05:00
< 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 >
2017-07-06 12:05:35 -04:00
< th > < a href = "` + baseURLContent + `/Installation" rel = "nofollow" > Installation < / a > < / th >
2017-02-13 20:13:59 -05:00
< / tr >
< / thead >
< tbody >
< tr >
2018-02-27 02:09:18 -05:00
< 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 >
2017-07-06 12:05:35 -04:00
< td > < a href = "` + baseURLContent + `/Usage" rel = "nofollow" > Usage < / a > < / td >
2017-02-13 20:13:59 -05:00
< / tr >
< / tbody >
< / table >
` ,
2017-02-24 09:59:56 -05: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-13 20:13:59 -05:00
< ol >
2020-04-21 18:13:56 -04: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 / >
2018-02-27 02:09:18 -05:00
< a href = "` + baseURLImages + `/images/1.png" rel = "nofollow" > < img src = "` + baseURLImages + `/images/1.png" title = "1.png" alt = "images/1.png" / > < / a > < / li >
2020-04-21 18:13:56 -04:00
< li > Perform a test run by hitting the Run ! button . < br / >
2018-02-27 02:09:18 -05:00
< a href = "` + baseURLImages + `/images/2.png" rel = "nofollow" > < img src = "` + baseURLImages + `/images/2.png" title = "2.png" alt = "images/2.png" / > < / a > < / li >
2017-02-13 20:13:59 -05:00
< / ol >
2019-12-23 17:38:50 -05:00
< h2 id = "user-content-custom-id" > More tests < / h2 >
2019-03-21 09:53:06 -04:00
< p > ( from < a href = "https://www.markdownguide.org/extended-syntax/" rel = "nofollow" > https : //www.markdownguide.org/extended-syntax/</a>)</p>
2020-05-03 16:17:24 -04:00
< h3 id = "user-content-checkboxes" > Checkboxes < / h3 >
2020-05-10 19:14:49 -04:00
< ul >
2021-05-23 10:14:03 -04: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-03 16:17:24 -04:00
< / ul >
2019-12-23 17:38:50 -05:00
< h3 id = "user-content-definition-list" > Definition list < / h3 >
2019-03-21 09:53:06 -04: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-23 17:38:50 -05: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 09:53:06 -04:00
< div >
< hr / >
< ol >
2019-12-30 20:53:28 -05: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 09:53:06 -04:00
< p > Indent paragraphs to include them in the footnote . < / p >
< p > < code > { my code } < / code > < / p >
2019-12-30 20:53:28 -05:00
< p > Add as many paragraphs as you like . < a href = "#fnref:user-content-bignote" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
2019-03-21 09:53:06 -04:00
< / ol >
< / div >
2022-03-24 11:47:37 -04: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-13 20:13:59 -05:00
` ,
2017-02-24 09:59:56 -05:00
}
2017-02-13 20:13:59 -05:00
}
2017-09-16 13:17:57 -04: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 09:59:56 -05:00
2019-08-14 04:04:55 -04:00
See commit 65 f1bf27bc
2019-04-16 03:53:57 -04:00
2017-09-16 13:17:57 -04:00
Ideas and codes
2017-02-13 20:13:59 -05:00
2017-09-16 13:17:57 -04:00
- Bezier widget ( by @ r - lyeh ) ` + AppURL + ` ocornut / imgui / issues / 786
2019-04-12 01:53:34 -04:00
- Bezier widget ( by @ r - lyeh ) ` + AppURL + ` gogits / gogs / issues / 786
2017-09-16 13:17:57 -04: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-13 20:13:59 -05:00
2017-09-16 13:17:57 -04: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 09:53:06 -04:00
[ [ images / 2. png ] ]
# # More tests { # custom - id }
( from https : //www.markdownguide.org/extended-syntax/)
2020-05-03 16:17:24 -04:00
# # # Checkboxes
- [ ] unchecked
- [ x ] checked
- [ ] still unchecked
2019-03-21 09:53:06 -04: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 11:47:37 -04: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-13 20:13:59 -05:00
}
func TestTotal_RenderWiki ( t * testing . T ) {
2021-05-09 09:29:49 -04:00
setting . AppURL = AppURL
setting . AppSubURL = AppSubURL
2018-02-20 07:50:42 -05:00
answers := testAnswers ( util . URLJoin ( AppSubURL , "wiki/" ) , util . URLJoin ( AppSubURL , "wiki" , "raw/" ) )
2017-02-24 09:59:56 -05:00
for i := 0 ; i < len ( sameCases ) ; i ++ {
2023-10-23 22:54:59 -04:00
line , err := markdown . RenderString ( & markup . RenderContext {
2022-01-19 18:26:57 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : AppSubURL ,
Metas : localMetas ,
IsWiki : true ,
} , sameCases [ i ] )
assert . NoError ( t , err )
2017-02-24 09:59:56 -05:00
assert . Equal ( t , answers [ i ] , line )
2017-02-13 20:13:59 -05:00
}
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 {
2023-10-23 22:54:59 -04:00
line , err := markdown . RenderString ( & markup . RenderContext {
2023-03-05 16:59:05 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : AppSubURL ,
IsWiki : true ,
} , testCases [ i ] )
assert . NoError ( t , err )
2017-02-13 20:13:59 -05:00
assert . Equal ( t , testCases [ i + 1 ] , line )
}
2016-04-22 18:28:08 -04:00
}
2017-09-16 13:17:57 -04:00
func TestTotal_RenderString ( t * testing . T ) {
2021-05-09 09:29:49 -04:00
setting . AppURL = AppURL
setting . AppSubURL = AppSubURL
2018-02-20 07:50:42 -05:00
answers := testAnswers ( util . URLJoin ( AppSubURL , "src" , "master/" ) , util . URLJoin ( AppSubURL , "raw" , "master/" ) )
2017-09-16 13:17:57 -04:00
for i := 0 ; i < len ( sameCases ) ; i ++ {
2023-10-23 22:54:59 -04:00
line , err := markdown . RenderString ( & markup . RenderContext {
2022-01-19 18:26:57 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : util . URLJoin ( AppSubURL , "src" , "master/" ) ,
Metas : localMetas ,
} , sameCases [ i ] )
assert . NoError ( t , err )
2017-09-16 13:17:57 -04:00
assert . Equal ( t , answers [ i ] , line )
}
testCases := [ ] string { }
for i := 0 ; i < len ( testCases ) ; i += 2 {
2023-10-23 22:54:59 -04:00
line , err := markdown . RenderString ( & markup . RenderContext {
2023-03-05 16:59:05 -05:00
Ctx : git . DefaultContext ,
2021-04-19 18:25:08 -04:00
URLPrefix : AppSubURL ,
} , testCases [ i ] )
assert . NoError ( t , err )
2017-09-16 13:17:57 -04:00
assert . Equal ( t , testCases [ i + 1 ] , line )
}
}
2019-11-12 21:27:11 -05:00
func TestRender_RenderParagraphs ( t * testing . T ) {
test := func ( t * testing . T , str string , cnt int ) {
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderRawString ( & markup . RenderContext { Ctx : git . DefaultContext } , str )
2021-04-19 18:25:08 -04: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" )
2023-10-23 22:54:59 -04:00
res , err = markdown . RenderRawString ( & markup . RenderContext { Ctx : git . DefaultContext } , mac )
2021-04-19 18:25:08 -04: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" )
2023-10-23 22:54:59 -04:00
res , err = markdown . RenderRawString ( & markup . RenderContext { Ctx : git . DefaultContext } , dos )
2021-04-19 18:25:08 -04: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-12 21:27:11 -05: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-14 12:36:51 -04:00
2021-03-15 19:20:05 -04: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 08:12:06 -04:00
log . Info ( "Test markdown render error with fuzzy data: %x, the following errors can be recovered" , testcase )
2023-10-23 22:54:59 -04:00
_ , err := markdown . RenderRawString ( & markup . RenderContext { Ctx : git . DefaultContext } , string ( testcase ) )
2021-04-19 18:25:08 -04:00
assert . NoError ( t , err )
2021-03-15 19:20:05 -04:00
}
}
2021-03-14 12:36:51 -04:00
func TestRenderSiblingImages_Issue12925 ( t * testing . T ) {
testcase := ` ! [ image1 ] ( / image1 )
! [ image2 ] ( / image2 )
`
2021-10-11 08:12:06 -04: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-14 12:36:51 -04:00
`
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderRawString ( & markup . RenderContext { Ctx : git . DefaultContext } , testcase )
2021-04-19 18:25:08 -04:00
assert . NoError ( t , err )
2021-03-14 12:36:51 -04:00
assert . Equal ( t , expected , res )
2021-12-15 18:49:12 -05:00
}
2021-03-15 19:20:05 -04:00
2021-12-15 18:49:12 -05: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 >
`
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderString ( & markup . RenderContext { Ctx : git . DefaultContext } , testcase )
2021-12-15 18:49:12 -05:00
assert . NoError ( t , err )
assert . Equal ( t , expected , res )
2021-03-14 12:36:51 -04:00
}
2022-10-05 14:55:36 -04:00
2022-10-21 08:00:53 -04:00
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 {
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderString ( & markup . RenderContext { Ctx : git . DefaultContext } , test . testcase )
2022-10-21 08:00:53 -04:00
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 {
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderString ( & markup . RenderContext { Ctx : git . DefaultContext } , test )
2022-10-21 08:00:53 -04: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-05 14:55:36 -04: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 ,
} ,
{
` $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 ,
} ,
2023-11-26 14:43:51 -05:00
{
` \[a b\] ` ,
` <pre class="code-block is-loading"><code class="chroma language-math display">a b</code></pre> ` + nl ,
} ,
{
` \[a b] ` ,
` <p>[a b]</p> ` + nl ,
} ,
{
` $$a ` ,
` <p>$$a</p> ` + nl ,
} ,
2022-10-05 14:55:36 -04:00
}
for _ , test := range testcases {
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderString ( & markup . RenderContext { Ctx : git . DefaultContext } , test . testcase )
2022-10-05 14:55:36 -04:00
assert . NoError ( t , err , "Unexpected error in testcase: %q" , test . testcase )
assert . Equal ( t , test . expected , res , "Unexpected result in testcase %q" , test . testcase )
}
}
2023-06-13 02:44:47 -04: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 {
2023-10-23 22:54:59 -04:00
res , err := markdown . RenderString ( & markup . RenderContext { Ctx : git . DefaultContext } , test . testcase )
2023-06-13 02:44:47 -04:00
assert . NoError ( t , err , "Unexpected error in testcase: %q" , test . testcase )
assert . Equal ( t , test . expected , res , "Unexpected result in testcase %q" , test . testcase )
}
}
2023-12-18 06:40:05 -05:00
func TestFootnote ( t * testing . T ) {
testcases := [ ] struct {
testcase string
expected string
} {
{
` Citation needed [ ^ 0 ] .
[ ^ 0 ] : Source ` ,
` < p > Citation needed < sup id = "fnref:user-content-0" > < a href = "#fn:user-content-0" rel = "nofollow" > 1 < / a > < / sup > . < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-0" >
< p > Source < a href = "#fnref:user-content-0" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed[^0] ` ,
` < p > Citation needed [ ^ 0 ] < / p >
` ,
} ,
{
` Citation needed [ ^ 1 ] , Citation needed twice [ ^ 3 ]
[ ^ 3 ] : Source ` ,
` < p > Citation needed [ ^ 1 ] , Citation needed twice < sup id = "fnref:user-content-3" > < a href = "#fn:user-content-3" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-3" >
< p > Source < a href = "#fnref:user-content-3" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 1 ] : Source ` ,
` < p > Citation needed [ ^ 0 ] < / p >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 0 ] : Source 1
[ ^ 0 ] : Source 2 ` ,
` < p > Citation needed < sup id = "fnref:user-content-0" > < a href = "#fn:user-content-0" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-0" >
< p > Source 1 < a href = "#fnref:user-content-0" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed ! [ ^ 0 ]
[ ^ 0 ] : Source ` ,
` < p > Citation needed < sup id = "fnref:user-content-0" > < a href = "#fn:user-content-0" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-0" >
< p > Source < a href = "#fnref:user-content-0" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Trigger [^ ` ,
` < p > Trigger [ ^ < / p >
` ,
} ,
{
` Trigger 2 [^0 ` ,
` < p > Trigger 2 [ ^ 0 < / p >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 0 ] : Source with citation needed [ ^ 1 ]
[ ^ 1 ] : Source ` ,
` < p > Citation needed < sup id = "fnref:user-content-0" > < a href = "#fn:user-content-0" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-0" >
< p > Source with citation needed < sup id = "fnref:user-content-1" > < a href = "#fn:user-content-1" rel = "nofollow" > 2 < / a > < / sup > < a href = "#fnref:user-content-0" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< li id = "fn:user-content-1" >
< p > Source < a href = "#fnref:user-content-1" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed [ ^ # ]
[ ^ # ] : Source ` ,
` < p > Citation needed < sup id = "fnref:user-content-1" > < a href = "#fn:user-content-1" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-1" >
< p > Source < a href = "#fnref:user-content-1" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 0 ] : Source ` ,
` < p > Citation needed [ ^ 0 ] < br / >
[ ^ 0 ] : Source < / p >
` ,
} ,
{
` [ ^ 0 ] : Source
Citation needed [ ^ 0 ] . ` ,
` < p > Citation needed < sup id = "fnref:user-content-0" > < a href = "#fn:user-content-0" rel = "nofollow" > 1 < / a > < / sup > . < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-0" >
< p > Source < a href = "#fnref:user-content-0" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed [ ^ ]
[ ^ ] : Source ` ,
` < p > Citation needed [ ^ ] < br / >
[ ^ ] : Source < / p >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 0 ] Source ` ,
` < p > Citation needed [ ^ 0 ] < br / >
[ ^ 0 ] Source < / p >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 0 Source ` ,
` < p > Citation needed [ ^ 0 ] < br / >
[ ^ 0 Source < / p >
` ,
} ,
{
` Citation needed[^0] [^0]: Source ` ,
` < p > Citation needed [ ^ 0 ] [ ^ 0 ] : Source < / p >
` ,
} ,
{
` Citation needed [ ^ Source here 0 # 9 - 3 ]
[ ^ Source here 0 # 9 - 3 ] : Source ` ,
` < p > Citation needed < sup id = "fnref:user-content-source-here-0-9-3" > < a href = "#fn:user-content-source-here-0-9-3" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-source-here-0-9-3" >
< p > Source < a href = "#fnref:user-content-source-here-0-9-3" rel = "nofollow" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
` ,
} ,
{
` Citation needed [ ^ 0 ]
[ ^ 0 ] : ` ,
` < p > Citation needed < sup id = "fnref:user-content-0" > < a href = "#fn:user-content-0" rel = "nofollow" > 1 < / a > < / sup > < / p >
< div >
< hr / >
< ol >
< li id = "fn:user-content-0" >
< a href = "#fnref:user-content-0" rel = "nofollow" > ↩ ︎ < / a > < / li >
< / ol >
< / div >
` ,
} ,
}
for _ , test := range testcases {
res , err := markdown . RenderString ( & markup . RenderContext { Ctx : git . DefaultContext } , 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 )
}
}
