mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-11-03 12:26:05 +01:00 
			
		
		
		
	* Add API to get/edit wiki * Add swagger docs, various improvements * fmt * Fix lint and rm comment * Add page parameter * Add pagination to pages * Add tests * fmt * Update func names * Update error handling * Update type name * Fix lint * Don't delete Home * Update func name * Update routers/api/v1/repo/wiki.go Co-authored-by: delvh <dev.lh@web.de> * Remove unnecessary check * Fix lint * Use English strings * Update integrations/api_wiki_test.go Co-authored-by: delvh <dev.lh@web.de> * Update func and test names * Remove unsed check and avoid duplicated error reports * Improve error handling * Return after error * Document 404 error * Update swagger * Fix lint * Apply suggestions from code review Co-authored-by: delvh <dev.lh@web.de> * Document file encoding * fmt * Apply suggestions * Use convert * Fix integration test * simplify permissions * unify duplicate key Title/Name * improve types & return UTC timestamps * improve types pt.2 - add WikiPageMetaData.LastCommit - add WikiPageMetaData.HTMLURL - replace WikiPageMetaData.Updated with .LastCommit.Committer.Created also delete convert.ToWikiPage(), as it received too many arguments and only had one callsite anyway. sorry for bad advice earlier 🙃 * WikiPage.Content is base64 encoded * simplify error handling in wikiContentsByName() * update swagger * fix & DRY findWikiRepoCommit() error handling ListWikiPages() previously wrote error twice when repo wiki didn't exist * rename Content -> ContentBase64 * Fix test * Fix tests * Update var name * suburl -> sub_url Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: Norwin <git@nroo.de> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
		
			
				
	
	
		
			252 lines
		
	
	
		
			6.3 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			252 lines
		
	
	
		
			6.3 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2021 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 integrations
 | 
						|
 | 
						|
import (
 | 
						|
	"encoding/base64"
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/assert"
 | 
						|
)
 | 
						|
 | 
						|
func TestAPIGetWikiPage(t *testing.T) {
 | 
						|
	defer prepareTestEnv(t)()
 | 
						|
 | 
						|
	username := "user2"
 | 
						|
	session := loginUser(t, username)
 | 
						|
 | 
						|
	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/page/Home", username, "repo1")
 | 
						|
 | 
						|
	req := NewRequest(t, "GET", urlStr)
 | 
						|
	resp := session.MakeRequest(t, req, http.StatusOK)
 | 
						|
	var page *api.WikiPage
 | 
						|
	DecodeJSON(t, resp, &page)
 | 
						|
 | 
						|
	assert.Equal(t, &api.WikiPage{
 | 
						|
		WikiPageMetaData: &api.WikiPageMetaData{
 | 
						|
			Title:   "Home",
 | 
						|
			HTMLURL: page.HTMLURL,
 | 
						|
			SubURL:  "Home",
 | 
						|
			LastCommit: &api.WikiCommit{
 | 
						|
				ID: "2c54faec6c45d31c1abfaecdab471eac6633738a",
 | 
						|
				Author: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Ethan Koenig",
 | 
						|
						Email: "ethantkoenig@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2017-11-27T04:31:18Z",
 | 
						|
				},
 | 
						|
				Committer: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Ethan Koenig",
 | 
						|
						Email: "ethantkoenig@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2017-11-27T04:31:18Z",
 | 
						|
				},
 | 
						|
				Message: "Add Home.md\n",
 | 
						|
			},
 | 
						|
		},
 | 
						|
		ContentBase64: base64.RawStdEncoding.EncodeToString(
 | 
						|
			[]byte("# Home page\n\nThis is the home page!\n"),
 | 
						|
		),
 | 
						|
		CommitCount: 1,
 | 
						|
		Sidebar:     "",
 | 
						|
		Footer:      "",
 | 
						|
	}, page)
 | 
						|
}
 | 
						|
 | 
						|
func TestAPIListWikiPages(t *testing.T) {
 | 
						|
	defer prepareTestEnv(t)()
 | 
						|
 | 
						|
	username := "user2"
 | 
						|
	session := loginUser(t, username)
 | 
						|
 | 
						|
	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/pages", username, "repo1")
 | 
						|
 | 
						|
	req := NewRequest(t, "GET", urlStr)
 | 
						|
	resp := session.MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
	var meta []*api.WikiPageMetaData
 | 
						|
	DecodeJSON(t, resp, &meta)
 | 
						|
 | 
						|
	dummymeta := []*api.WikiPageMetaData{
 | 
						|
		{
 | 
						|
			Title:   "Home",
 | 
						|
			HTMLURL: meta[0].HTMLURL,
 | 
						|
			SubURL:  "Home",
 | 
						|
			LastCommit: &api.WikiCommit{
 | 
						|
				ID: "2c54faec6c45d31c1abfaecdab471eac6633738a",
 | 
						|
				Author: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Ethan Koenig",
 | 
						|
						Email: "ethantkoenig@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2017-11-27T04:31:18Z",
 | 
						|
				},
 | 
						|
				Committer: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Ethan Koenig",
 | 
						|
						Email: "ethantkoenig@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2017-11-27T04:31:18Z",
 | 
						|
				},
 | 
						|
				Message: "Add Home.md\n",
 | 
						|
			},
 | 
						|
		},
 | 
						|
		{
 | 
						|
			Title:   "Page With Image",
 | 
						|
			HTMLURL: meta[1].HTMLURL,
 | 
						|
			SubURL:  "Page-With-Image",
 | 
						|
			LastCommit: &api.WikiCommit{
 | 
						|
				ID: "0cf15c3f66ec8384480ed9c3cf87c9e97fbb0ec3",
 | 
						|
				Author: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Gabriel Silva Simões",
 | 
						|
						Email: "simoes.sgabriel@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2019-01-25T01:41:55Z",
 | 
						|
				},
 | 
						|
				Committer: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Gabriel Silva Simões",
 | 
						|
						Email: "simoes.sgabriel@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2019-01-25T01:41:55Z",
 | 
						|
				},
 | 
						|
				Message: "Add jpeg.jpg and page with image\n",
 | 
						|
			},
 | 
						|
		},
 | 
						|
		{
 | 
						|
			Title:   "Page With Spaced Name",
 | 
						|
			HTMLURL: meta[2].HTMLURL,
 | 
						|
			SubURL:  "Page-With-Spaced-Name",
 | 
						|
			LastCommit: &api.WikiCommit{
 | 
						|
				ID: "c10d10b7e655b3dab1f53176db57c8219a5488d6",
 | 
						|
				Author: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Gabriel Silva Simões",
 | 
						|
						Email: "simoes.sgabriel@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2019-01-25T01:39:51Z",
 | 
						|
				},
 | 
						|
				Committer: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Gabriel Silva Simões",
 | 
						|
						Email: "simoes.sgabriel@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2019-01-25T01:39:51Z",
 | 
						|
				},
 | 
						|
				Message: "Add page with spaced name\n",
 | 
						|
			},
 | 
						|
		},
 | 
						|
		{
 | 
						|
			Title:   "Unescaped File",
 | 
						|
			HTMLURL: meta[3].HTMLURL,
 | 
						|
			SubURL:  "Unescaped-File",
 | 
						|
			LastCommit: &api.WikiCommit{
 | 
						|
				ID: "0dca5bd9b5d7ef937710e056f575e86c0184ba85",
 | 
						|
				Author: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "6543",
 | 
						|
						Email: "6543@obermui.de",
 | 
						|
					},
 | 
						|
					Date: "2021-07-19T16:42:46Z",
 | 
						|
				},
 | 
						|
				Committer: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "6543",
 | 
						|
						Email: "6543@obermui.de",
 | 
						|
					},
 | 
						|
					Date: "2021-07-19T16:42:46Z",
 | 
						|
				},
 | 
						|
				Message: "add unescaped file\n",
 | 
						|
			},
 | 
						|
		},
 | 
						|
	}
 | 
						|
 | 
						|
	assert.Equal(t, dummymeta, meta)
 | 
						|
}
 | 
						|
 | 
						|
func TestAPINewWikiPage(t *testing.T) {
 | 
						|
	for _, title := range []string{
 | 
						|
		"New page",
 | 
						|
		"&&&&",
 | 
						|
	} {
 | 
						|
		defer prepareTestEnv(t)()
 | 
						|
		username := "user2"
 | 
						|
		session := loginUser(t, username)
 | 
						|
		token := getTokenForLoggedInUser(t, session)
 | 
						|
 | 
						|
		urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/new?token=%s", username, "repo1", token)
 | 
						|
 | 
						|
		req := NewRequestWithJSON(t, "POST", urlStr, &api.CreateWikiPageOptions{
 | 
						|
			Title:         title,
 | 
						|
			ContentBase64: base64.StdEncoding.EncodeToString([]byte("Wiki page content for API unit tests")),
 | 
						|
			Message:       "",
 | 
						|
		})
 | 
						|
		session.MakeRequest(t, req, http.StatusCreated)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestAPIEditWikiPage(t *testing.T) {
 | 
						|
	defer prepareTestEnv(t)()
 | 
						|
	username := "user2"
 | 
						|
	session := loginUser(t, username)
 | 
						|
	token := getTokenForLoggedInUser(t, session)
 | 
						|
 | 
						|
	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/page/Page-With-Spaced-Name?token=%s", username, "repo1", token)
 | 
						|
 | 
						|
	req := NewRequestWithJSON(t, "PATCH", urlStr, &api.CreateWikiPageOptions{
 | 
						|
		Title:         "edited title",
 | 
						|
		ContentBase64: base64.StdEncoding.EncodeToString([]byte("Edited wiki page content for API unit tests")),
 | 
						|
		Message:       "",
 | 
						|
	})
 | 
						|
	session.MakeRequest(t, req, http.StatusOK)
 | 
						|
}
 | 
						|
 | 
						|
func TestAPIListPageRevisions(t *testing.T) {
 | 
						|
	defer prepareTestEnv(t)()
 | 
						|
	username := "user2"
 | 
						|
	session := loginUser(t, username)
 | 
						|
 | 
						|
	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/wiki/revisions/Home", username, "repo1")
 | 
						|
 | 
						|
	req := NewRequest(t, "GET", urlStr)
 | 
						|
	resp := session.MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
	var revisions *api.WikiCommitList
 | 
						|
	DecodeJSON(t, resp, &revisions)
 | 
						|
 | 
						|
	dummyrevisions := &api.WikiCommitList{
 | 
						|
		WikiCommits: []*api.WikiCommit{
 | 
						|
			{
 | 
						|
				ID: "2c54faec6c45d31c1abfaecdab471eac6633738a",
 | 
						|
				Author: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Ethan Koenig",
 | 
						|
						Email: "ethantkoenig@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2017-11-27T04:31:18Z",
 | 
						|
				},
 | 
						|
				Committer: &api.CommitUser{
 | 
						|
					Identity: api.Identity{
 | 
						|
						Name:  "Ethan Koenig",
 | 
						|
						Email: "ethantkoenig@gmail.com",
 | 
						|
					},
 | 
						|
					Date: "2017-11-27T04:31:18Z",
 | 
						|
				},
 | 
						|
				Message: "Add Home.md\n",
 | 
						|
			},
 | 
						|
		},
 | 
						|
		Count: 1,
 | 
						|
	}
 | 
						|
 | 
						|
	assert.Equal(t, dummyrevisions, revisions)
 | 
						|
}
 |