mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-11 21:25:16 +01:00
e3750370df
The old `HTMLRender` is not ideal. 1. It shouldn't be initialized multiple times, it consumes a lot of memory and is slow. 2. It shouldn't depend on short-lived requests, the `WatchLocalChanges` needs a long-running context. 3. It doesn't make sense to use FuncsMap slice. HTMLRender was designed to only work for GItea's specialized 400+ templates, so it's good to make it a global shared instance.
243 lines
6.8 KiB
Go
243 lines
6.8 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package misc
|
|
|
|
import (
|
|
go_context "context"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"strings"
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/markup"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/templates"
|
|
"code.gitea.io/gitea/modules/util"
|
|
"code.gitea.io/gitea/modules/web"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
const (
|
|
AppURL = "http://localhost:3000/"
|
|
Repo = "gogits/gogs"
|
|
AppSubURL = AppURL + Repo + "/"
|
|
)
|
|
|
|
func createContext(req *http.Request) (*context.Context, *httptest.ResponseRecorder) {
|
|
rnd := templates.HTMLRenderer()
|
|
resp := httptest.NewRecorder()
|
|
c := &context.Context{
|
|
Req: req,
|
|
Resp: context.NewResponse(resp),
|
|
Render: rnd,
|
|
Data: make(map[string]interface{}),
|
|
}
|
|
defer c.Close()
|
|
|
|
return c, resp
|
|
}
|
|
|
|
func wrap(ctx *context.Context) *context.APIContext {
|
|
return &context.APIContext{
|
|
Context: ctx,
|
|
}
|
|
}
|
|
|
|
func testRenderMarkup(t *testing.T, mode, filePath, text, responseBody string, responseCode int) {
|
|
setting.AppURL = AppURL
|
|
|
|
options := api.MarkupOption{
|
|
Mode: mode,
|
|
Text: "",
|
|
Context: Repo,
|
|
Wiki: true,
|
|
FilePath: filePath,
|
|
}
|
|
requrl, _ := url.Parse(util.URLJoin(AppURL, "api", "v1", "markup"))
|
|
req := &http.Request{
|
|
Method: "POST",
|
|
URL: requrl,
|
|
}
|
|
m, resp := createContext(req)
|
|
ctx := wrap(m)
|
|
|
|
options.Text = text
|
|
web.SetForm(ctx, &options)
|
|
Markup(ctx)
|
|
assert.Equal(t, responseBody, resp.Body.String())
|
|
assert.Equal(t, responseCode, resp.Code)
|
|
resp.Body.Reset()
|
|
}
|
|
|
|
func testRenderMarkdown(t *testing.T, mode, text, responseBody string, responseCode int) {
|
|
setting.AppURL = AppURL
|
|
|
|
options := api.MarkdownOption{
|
|
Mode: mode,
|
|
Text: "",
|
|
Context: Repo,
|
|
Wiki: true,
|
|
}
|
|
requrl, _ := url.Parse(util.URLJoin(AppURL, "api", "v1", "markdown"))
|
|
req := &http.Request{
|
|
Method: "POST",
|
|
URL: requrl,
|
|
}
|
|
m, resp := createContext(req)
|
|
ctx := wrap(m)
|
|
|
|
options.Text = text
|
|
web.SetForm(ctx, &options)
|
|
Markdown(ctx)
|
|
assert.Equal(t, responseBody, resp.Body.String())
|
|
assert.Equal(t, responseCode, resp.Code)
|
|
resp.Body.Reset()
|
|
}
|
|
|
|
func TestAPI_RenderGFM(t *testing.T) {
|
|
markup.Init(&markup.ProcessorHelper{
|
|
IsUsernameMentionable: func(ctx go_context.Context, username string) bool {
|
|
return username == "r-lyeh"
|
|
},
|
|
})
|
|
|
|
testCasesCommon := []string{
|
|
// dear imgui wiki markdown extract: special wiki syntax
|
|
`Wiki! Enjoy :)
|
|
- [[Links, Language bindings, Engine bindings|Links]]
|
|
- [[Tips]]
|
|
- Bezier widget (by @r-lyeh) https://github.com/ocornut/imgui/issues/786`,
|
|
// rendered
|
|
`<p>Wiki! Enjoy :)</p>
|
|
<ul>
|
|
<li><a href="` + AppSubURL + `wiki/Links" rel="nofollow">Links, Language bindings, Engine bindings</a></li>
|
|
<li><a href="` + AppSubURL + `wiki/Tips" rel="nofollow">Tips</a></li>
|
|
<li>Bezier widget (by <a href="` + AppURL + `r-lyeh" rel="nofollow">@r-lyeh</a>) <a href="https://github.com/ocornut/imgui/issues/786" rel="nofollow">https://github.com/ocornut/imgui/issues/786</a></li>
|
|
</ul>
|
|
`,
|
|
// 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>
|
|
`,
|
|
// empty
|
|
``,
|
|
// rendered
|
|
``,
|
|
}
|
|
|
|
testCasesDocument := []string{
|
|
// wine-staging wiki home extract: 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.
|
|
|
|
[[Configuration]]
|
|
[[images/icon-bug.png]]
|
|
`,
|
|
// rendered
|
|
`<h2 id="user-content-what-is-wine-staging">What is Wine Staging?</h2>
|
|
<p><strong>Wine Staging</strong> on website <a href="http://wine-staging.com" rel="nofollow">wine-staging.com</a>.</p>
|
|
<h2 id="user-content-quick-links">Quick Links</h2>
|
|
<p>Here are some links to the most important topics. You can find the full list of pages at the sidebar.</p>
|
|
<p><a href="` + AppSubURL + `wiki/Configuration" rel="nofollow">Configuration</a>
|
|
<a href="` + AppSubURL + `wiki/raw/images/icon-bug.png" rel="nofollow"><img src="` + AppSubURL + `wiki/raw/images/icon-bug.png" title="icon-bug.png" alt="images/icon-bug.png"/></a></p>
|
|
`,
|
|
}
|
|
|
|
for i := 0; i < len(testCasesCommon); i += 2 {
|
|
text := testCasesCommon[i]
|
|
response := testCasesCommon[i+1]
|
|
testRenderMarkdown(t, "gfm", text, response, http.StatusOK)
|
|
testRenderMarkup(t, "gfm", "", text, response, http.StatusOK)
|
|
testRenderMarkdown(t, "comment", text, response, http.StatusOK)
|
|
testRenderMarkup(t, "comment", "", text, response, http.StatusOK)
|
|
testRenderMarkup(t, "file", "path/test.md", text, response, http.StatusOK)
|
|
}
|
|
|
|
for i := 0; i < len(testCasesDocument); i += 2 {
|
|
text := testCasesDocument[i]
|
|
response := testCasesDocument[i+1]
|
|
testRenderMarkdown(t, "gfm", text, response, http.StatusOK)
|
|
testRenderMarkup(t, "gfm", "", text, response, http.StatusOK)
|
|
testRenderMarkup(t, "file", "path/test.md", text, response, http.StatusOK)
|
|
}
|
|
|
|
testRenderMarkup(t, "file", "path/test.unknown", "## Test", "Unsupported render extension: .unknown\n", http.StatusUnprocessableEntity)
|
|
testRenderMarkup(t, "unknown", "", "## Test", "Unknown mode: unknown\n", http.StatusUnprocessableEntity)
|
|
}
|
|
|
|
var simpleCases = []string{
|
|
// Guard wiki sidebar: special syntax
|
|
`[[Guardfile-DSL / Configuring-Guard|Guardfile-DSL---Configuring-Guard]]`,
|
|
// rendered
|
|
`<p>[[Guardfile-DSL / Configuring-Guard|Guardfile-DSL---Configuring-Guard]]</p>
|
|
`,
|
|
// special syntax
|
|
`[[Name|Link]]`,
|
|
// rendered
|
|
`<p>[[Name|Link]]</p>
|
|
`,
|
|
// empty
|
|
``,
|
|
// rendered
|
|
``,
|
|
}
|
|
|
|
func TestAPI_RenderSimple(t *testing.T) {
|
|
setting.AppURL = AppURL
|
|
|
|
options := api.MarkdownOption{
|
|
Mode: "markdown",
|
|
Text: "",
|
|
Context: Repo,
|
|
}
|
|
requrl, _ := url.Parse(util.URLJoin(AppURL, "api", "v1", "markdown"))
|
|
req := &http.Request{
|
|
Method: "POST",
|
|
URL: requrl,
|
|
}
|
|
m, resp := createContext(req)
|
|
ctx := wrap(m)
|
|
|
|
for i := 0; i < len(simpleCases); i += 2 {
|
|
options.Text = simpleCases[i]
|
|
web.SetForm(ctx, &options)
|
|
Markdown(ctx)
|
|
assert.Equal(t, simpleCases[i+1], resp.Body.String())
|
|
resp.Body.Reset()
|
|
}
|
|
}
|
|
|
|
func TestAPI_RenderRaw(t *testing.T) {
|
|
setting.AppURL = AppURL
|
|
|
|
requrl, _ := url.Parse(util.URLJoin(AppURL, "api", "v1", "markdown"))
|
|
req := &http.Request{
|
|
Method: "POST",
|
|
URL: requrl,
|
|
}
|
|
m, resp := createContext(req)
|
|
ctx := wrap(m)
|
|
|
|
for i := 0; i < len(simpleCases); i += 2 {
|
|
ctx.Req.Body = io.NopCloser(strings.NewReader(simpleCases[i]))
|
|
MarkdownRaw(ctx)
|
|
assert.Equal(t, simpleCases[i+1], resp.Body.String())
|
|
resp.Body.Reset()
|
|
}
|
|
}
|