mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-25 21:44:20 -04:00
Close #7570 1. Clearly define the wiki path behaviors, see `services/wiki/wiki_path.go` and tests 2. Keep compatibility with old contents 3. Allow to use dashes in titles, eg: "2000-01-02 Meeting record" 4. Add a "Pages" link in the dropdown, otherwise users can't go to the Pages page easily. 5. Add a "View original git file" link in the Pages list, even if some file names are broken, users still have a chance to edit or remove it, without cloning the wiki repo to local. 6. Fix 500 error when the name contains prefix spaces. This PR also introduces the ability to support sub-directories, but it can't be done at the moment due to there are a lot of legacy wiki data, which use "%2F" in file names. ![image](https://user-images.githubusercontent.com/2114189/232239004-3359d7b9-7bf3-4ff3-8446-bfb0e79645dd.png) ![image](https://user-images.githubusercontent.com/2114189/232239020-74b92c72-bf73-4377-a319-1c85609f82b1.png) Co-authored-by: Giteabot <teabot@gitea.io>
223 lines
6.6 KiB
Go
223 lines
6.6 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package repo
|
|
|
|
import (
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"testing"
|
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/test"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/services/forms"
|
|
wiki_service "code.gitea.io/gitea/services/wiki"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
const (
|
|
content = "Wiki contents for unit tests"
|
|
message = "Wiki commit message for unit tests"
|
|
)
|
|
|
|
func wikiEntry(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) *git.TreeEntry {
|
|
wikiRepo, err := git.OpenRepository(git.DefaultContext, repo.WikiPath())
|
|
assert.NoError(t, err)
|
|
defer wikiRepo.Close()
|
|
commit, err := wikiRepo.GetBranchCommit("master")
|
|
assert.NoError(t, err)
|
|
entries, err := commit.ListEntries()
|
|
assert.NoError(t, err)
|
|
for _, entry := range entries {
|
|
if entry.Name() == wiki_service.WebPathToGitPath(wikiName) {
|
|
return entry
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func wikiContent(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) string {
|
|
entry := wikiEntry(t, repo, wikiName)
|
|
if !assert.NotNil(t, entry) {
|
|
return ""
|
|
}
|
|
reader, err := entry.Blob().DataAsync()
|
|
assert.NoError(t, err)
|
|
defer reader.Close()
|
|
bytes, err := io.ReadAll(reader)
|
|
assert.NoError(t, err)
|
|
return string(bytes)
|
|
}
|
|
|
|
func assertWikiExists(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) {
|
|
assert.NotNil(t, wikiEntry(t, repo, wikiName))
|
|
}
|
|
|
|
func assertWikiNotExists(t *testing.T, repo *repo_model.Repository, wikiName wiki_service.WebPath) {
|
|
assert.Nil(t, wikiEntry(t, repo, wikiName))
|
|
}
|
|
|
|
func assertPagesMetas(t *testing.T, expectedNames []string, metas interface{}) {
|
|
pageMetas, ok := metas.([]PageMeta)
|
|
if !assert.True(t, ok) {
|
|
return
|
|
}
|
|
if !assert.Len(t, pageMetas, len(expectedNames)) {
|
|
return
|
|
}
|
|
for i, pageMeta := range pageMetas {
|
|
assert.EqualValues(t, expectedNames[i], pageMeta.Name)
|
|
}
|
|
}
|
|
|
|
func TestWiki(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_pages")
|
|
ctx.SetParams("*", "Home")
|
|
test.LoadRepo(t, ctx, 1)
|
|
Wiki(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, "Home", ctx.Data["Title"])
|
|
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
|
|
}
|
|
|
|
func TestWikiPages(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_pages")
|
|
test.LoadRepo(t, ctx, 1)
|
|
WikiPages(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assertPagesMetas(t, []string{"Home", "Page With Image", "Page With Spaced Name", "Unescaped File"}, ctx.Data["Pages"])
|
|
}
|
|
|
|
func TestNewWiki(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_new")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
NewWiki(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, ctx.Tr("repo.wiki.new_page"), ctx.Data["Title"])
|
|
}
|
|
|
|
func TestNewWikiPost(t *testing.T) {
|
|
for _, title := range []string{
|
|
"New page",
|
|
"&&&&",
|
|
} {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_new")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
web.SetForm(ctx, &forms.NewWikiForm{
|
|
Title: title,
|
|
Content: content,
|
|
Message: message,
|
|
})
|
|
NewWikiPost(ctx)
|
|
assert.EqualValues(t, http.StatusSeeOther, ctx.Resp.Status())
|
|
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title))
|
|
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)), content)
|
|
}
|
|
}
|
|
|
|
func TestNewWikiPost_ReservedName(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/?action=_new")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
web.SetForm(ctx, &forms.NewWikiForm{
|
|
Title: "_edit",
|
|
Content: content,
|
|
Message: message,
|
|
})
|
|
NewWikiPost(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, ctx.Tr("repo.wiki.reserved_page"), ctx.Flash.ErrorMsg)
|
|
assertWikiNotExists(t, ctx.Repo.Repository, "_edit")
|
|
}
|
|
|
|
func TestEditWiki(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/Home?action=_edit")
|
|
ctx.SetParams("*", "Home")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
EditWiki(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assert.EqualValues(t, "Home", ctx.Data["Title"])
|
|
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, "Home"), ctx.Data["content"])
|
|
}
|
|
|
|
func TestEditWikiPost(t *testing.T) {
|
|
for _, title := range []string{
|
|
"Home",
|
|
"New/<page>",
|
|
} {
|
|
unittest.PrepareTestEnv(t)
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/Home?action=_new")
|
|
ctx.SetParams("*", "Home")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
web.SetForm(ctx, &forms.NewWikiForm{
|
|
Title: title,
|
|
Content: content,
|
|
Message: message,
|
|
})
|
|
EditWikiPost(ctx)
|
|
assert.EqualValues(t, http.StatusSeeOther, ctx.Resp.Status())
|
|
assertWikiExists(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title))
|
|
assert.Equal(t, wikiContent(t, ctx.Repo.Repository, wiki_service.UserTitleToWebPath("", title)), content)
|
|
if title != "Home" {
|
|
assertWikiNotExists(t, ctx.Repo.Repository, "Home")
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestDeleteWikiPagePost(t *testing.T) {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/Home?action=_delete")
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
DeleteWikiPagePost(ctx)
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status())
|
|
assertWikiNotExists(t, ctx.Repo.Repository, "Home")
|
|
}
|
|
|
|
func TestWikiRaw(t *testing.T) {
|
|
for filepath, filetype := range map[string]string{
|
|
"jpeg.jpg": "image/jpeg",
|
|
"images/jpeg.jpg": "image/jpeg",
|
|
"Page With Spaced Name": "text/plain; charset=utf-8",
|
|
"Page-With-Spaced-Name": "text/plain; charset=utf-8",
|
|
"Page With Spaced Name.md": "", // there is no "Page With Spaced Name.md" in repo
|
|
"Page-With-Spaced-Name.md": "text/plain; charset=utf-8",
|
|
} {
|
|
unittest.PrepareTestEnv(t)
|
|
|
|
ctx := test.MockContext(t, "user2/repo1/wiki/raw/"+url.PathEscape(filepath))
|
|
ctx.SetParams("*", filepath)
|
|
test.LoadUser(t, ctx, 2)
|
|
test.LoadRepo(t, ctx, 1)
|
|
WikiRaw(ctx)
|
|
if filetype == "" {
|
|
assert.EqualValues(t, http.StatusNotFound, ctx.Resp.Status(), "filepath: %s", filepath)
|
|
} else {
|
|
assert.EqualValues(t, http.StatusOK, ctx.Resp.Status(), "filepath: %s", filepath)
|
|
assert.EqualValues(t, filetype, ctx.Resp.Header().Get("Content-Type"), "filepath: %s", filepath)
|
|
}
|
|
}
|
|
}
|