mirror of
https://github.com/go-gitea/gitea.git
synced 2026-08-03 09:04:17 +00:00
wxiaoguang
9dc04289aa
before: gitrepo vs git packages after: git package fully handle all git operations by the way, use `WithRepo(repo)` instead of `WithDir(repo.Path)` to hide path details. benefits: 1. remove all unnecessary wrappers, developers no need to struggle with "which package should be used" 2. simplify code, RepositoryFacade can (will) be used everywhere, all "path" details are (will be) hidden
293 lines
14 KiB
Go
293 lines
14 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"slices"
|
|
"testing"
|
|
"time"
|
|
|
|
auth_model "gitea.dev/models/auth"
|
|
repo_model "gitea.dev/models/repo"
|
|
"gitea.dev/models/unittest"
|
|
user_model "gitea.dev/models/user"
|
|
"gitea.dev/modules/git"
|
|
"gitea.dev/modules/setting"
|
|
api "gitea.dev/modules/structs"
|
|
repo_service "gitea.dev/services/repository"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func getExpectedContentsResponseForContents(ref, refType, lastCommitSHA string) *api.ContentsResponse {
|
|
treePath := "README.md"
|
|
selfURL := setting.AppURL + "api/v1/repos/user2/repo1/contents/" + treePath + "?ref=" + ref
|
|
htmlURL := setting.AppURL + "user2/repo1/src/" + refType + "/" + ref + "/" + treePath
|
|
gitURL := setting.AppURL + "api/v1/repos/user2/repo1/git/blobs/4b4851ad51df6a7d9f25c979345979eaeb5b349f"
|
|
return &api.ContentsResponse{
|
|
Name: treePath,
|
|
Path: treePath,
|
|
SHA: "4b4851ad51df6a7d9f25c979345979eaeb5b349f",
|
|
LastCommitSHA: new(lastCommitSHA),
|
|
LastCommitterDate: new(time.Date(2017, time.March, 19, 16, 47, 59, 0, time.FixedZone("", -14400))),
|
|
LastAuthorDate: new(time.Date(2017, time.March, 19, 16, 47, 59, 0, time.FixedZone("", -14400))),
|
|
Type: "file",
|
|
Size: 30,
|
|
Encoding: new("base64"),
|
|
Content: new("IyByZXBvMQoKRGVzY3JpcHRpb24gZm9yIHJlcG8x"),
|
|
URL: &selfURL,
|
|
HTMLURL: &htmlURL,
|
|
GitURL: &gitURL,
|
|
DownloadURL: new(setting.AppURL + "user2/repo1/raw/" + refType + "/" + ref + "/" + treePath),
|
|
Links: &api.FileLinksResponse{
|
|
Self: &selfURL,
|
|
GitURL: &gitURL,
|
|
HTMLURL: &htmlURL,
|
|
},
|
|
}
|
|
}
|
|
|
|
func TestAPIGetContents(t *testing.T) {
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
|
testAPIGetContentsRefFormats(t)
|
|
testAPIGetContents(t, u)
|
|
testAPIGetContentsExt(t)
|
|
})
|
|
}
|
|
|
|
func testAPIGetContents(t *testing.T, _ *url.URL) {
|
|
/*** SETUP ***/
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) // owner of the repo1 & repo16
|
|
org3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 3}) // owner of the repo3, is an org
|
|
user4 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4}) // owner of neither repos
|
|
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1}) // public repo
|
|
repo3 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 3}) // public repo
|
|
repo16 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 16}) // private repo
|
|
treePath := "README.md"
|
|
|
|
// Get user2's token
|
|
session := loginUser(t, user2.Name)
|
|
token2 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepository)
|
|
// Get user4's token
|
|
session = loginUser(t, user4.Name)
|
|
token4 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepository)
|
|
|
|
// Get the commit ID of the default branch
|
|
gitRepo, err := git.OpenRepository(repo1)
|
|
require.NoError(t, err)
|
|
defer gitRepo.Close()
|
|
|
|
// Make a new branch in repo1
|
|
newBranch := "test_branch"
|
|
err = repo_service.CreateNewBranch(t.Context(), user2, repo1, gitRepo, repo1.DefaultBranch, newBranch)
|
|
require.NoError(t, err)
|
|
|
|
commitID, err := gitRepo.GetBranchCommitID(t.Context(), repo1.DefaultBranch)
|
|
require.NoError(t, err)
|
|
// Make a new tag in repo1
|
|
newTag := "test_tag"
|
|
err = gitRepo.CreateTag(t.Context(), newTag, commitID)
|
|
require.NoError(t, err)
|
|
/*** END SETUP ***/
|
|
|
|
// not found
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/no-such/file.md", user2.Name, repo1.Name)
|
|
resp := MakeRequest(t, req, http.StatusNotFound)
|
|
assert.Contains(t, resp.Body.String(), "object does not exist [id: , rel_path: no-such]")
|
|
|
|
// ref is default ref
|
|
ref := repo1.DefaultBranch
|
|
refType := "branch"
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s?ref=%s", user2.Name, repo1.Name, treePath, ref)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse := DecodeJSON(t, resp, &api.ContentsResponse{})
|
|
lastCommit, _ := gitRepo.GetCommitByPath(t.Context(), "README.md")
|
|
expectedContentsResponse := getExpectedContentsResponseForContents(ref, refType, lastCommit.ID.String())
|
|
assert.Equal(t, *expectedContentsResponse, *contentsResponse)
|
|
|
|
// No ref
|
|
refType = "branch"
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s", user2.Name, repo1.Name, treePath)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsResponse{})
|
|
expectedContentsResponse = getExpectedContentsResponseForContents(repo1.DefaultBranch, refType, lastCommit.ID.String())
|
|
assert.Equal(t, *expectedContentsResponse, *contentsResponse)
|
|
|
|
// ref is the branch we created above in setup
|
|
ref = newBranch
|
|
refType = "branch"
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s?ref=%s", user2.Name, repo1.Name, treePath, ref)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsResponse{})
|
|
branchCommit, _ := gitRepo.GetBranchCommit(t.Context(), ref)
|
|
lastCommit, _ = branchCommit.GetCommitByPath(t.Context(), gitRepo, "README.md")
|
|
expectedContentsResponse = getExpectedContentsResponseForContents(ref, refType, lastCommit.ID.String())
|
|
assert.Equal(t, *expectedContentsResponse, *contentsResponse)
|
|
|
|
// ref is the new tag we created above in setup
|
|
ref = newTag
|
|
refType = "tag"
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s?ref=%s", user2.Name, repo1.Name, treePath, ref)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsResponse{})
|
|
tagCommit, _ := gitRepo.GetTagCommit(t.Context(), ref)
|
|
lastCommit, _ = tagCommit.GetCommitByPath(t.Context(), gitRepo, "README.md")
|
|
expectedContentsResponse = getExpectedContentsResponseForContents(ref, refType, lastCommit.ID.String())
|
|
assert.Equal(t, *expectedContentsResponse, *contentsResponse)
|
|
|
|
// ref is a commit
|
|
ref = commitID
|
|
refType = "commit"
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s?ref=%s", user2.Name, repo1.Name, treePath, ref)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsResponse{})
|
|
expectedContentsResponse = getExpectedContentsResponseForContents(ref, refType, commitID)
|
|
assert.Equal(t, *expectedContentsResponse, *contentsResponse)
|
|
|
|
// Test file contents a file with a bad ref
|
|
ref = "badref"
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s?ref=%s", user2.Name, repo1.Name, treePath, ref)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Test accessing private ref with user token that does not have access - should fail
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s", user2.Name, repo16.Name, treePath).
|
|
AddTokenAuth(token4)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Test access private ref of owner of token
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/readme.md", user2.Name, repo16.Name).
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
|
|
// Test access of org org3 private repo file by owner user2
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/contents/%s", org3.Name, repo3.Name, treePath).
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
}
|
|
|
|
func testAPIGetContentsRefFormats(t *testing.T) {
|
|
file := "README.md"
|
|
sha := "65f1bf27bc3bf70f64657658635e66094edbcb4d"
|
|
content := "# repo1\n\nDescription for repo1"
|
|
|
|
resp := MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/"+file), http.StatusOK)
|
|
raw, err := io.ReadAll(resp.Body)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, content, string(raw))
|
|
|
|
resp = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/"+sha+"/"+file), http.StatusOK)
|
|
raw, err = io.ReadAll(resp.Body)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, content, string(raw))
|
|
|
|
resp = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/"+file+"?ref="+sha), http.StatusOK)
|
|
raw, err = io.ReadAll(resp.Body)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, content, string(raw))
|
|
|
|
resp = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/"+file+"?ref=master"), http.StatusOK)
|
|
raw, err = io.ReadAll(resp.Body)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, content, string(raw))
|
|
|
|
_ = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/docs/README.md?ref=main"), http.StatusNotFound)
|
|
_ = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/README.md?ref=main"), http.StatusOK)
|
|
_ = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/docs/README.md?ref=sub-home-md-img-check"), http.StatusOK)
|
|
_ = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/README.md?ref=sub-home-md-img-check"), http.StatusNotFound)
|
|
|
|
// FIXME: this is an incorrect behavior, non-existing branch falls back to default branch
|
|
_ = MakeRequest(t, NewRequest(t, http.MethodGet, "/api/v1/repos/user2/repo1/raw/README.md?ref=no-such"), http.StatusOK)
|
|
}
|
|
|
|
func testAPIGetContentsExt(t *testing.T) {
|
|
session := loginUser(t, "user2")
|
|
token2 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
t.Run("DirContents", func(t *testing.T) {
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/contents-ext?ref=sub-home-md-img-check")
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse := DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.FileContents)
|
|
assert.NotNil(t, contentsResponse.DirContents)
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/contents-ext/.?ref=sub-home-md-img-check")
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.FileContents)
|
|
assert.NotNil(t, contentsResponse.DirContents)
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/contents-ext/docs?ref=sub-home-md-img-check")
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.FileContents)
|
|
assert.Equal(t, "README.md", contentsResponse.DirContents[0].Name)
|
|
assert.Nil(t, contentsResponse.DirContents[0].Encoding)
|
|
assert.Nil(t, contentsResponse.DirContents[0].Content)
|
|
assert.Nil(t, contentsResponse.DirContents[0].LastCommitSHA)
|
|
assert.Nil(t, contentsResponse.DirContents[0].LastCommitMessage)
|
|
|
|
// "includes=file_content" shouldn't affect directory listing
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/contents-ext/docs?ref=sub-home-md-img-check&includes=file_content")
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.FileContents)
|
|
assert.Equal(t, "README.md", contentsResponse.DirContents[0].Name)
|
|
assert.Nil(t, contentsResponse.DirContents[0].Encoding)
|
|
assert.Nil(t, contentsResponse.DirContents[0].Content)
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/user2/lfs/contents-ext?includes=file_content,lfs_metadata").AddTokenAuth(token2)
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.FileContents)
|
|
respFileIdx := slices.IndexFunc(contentsResponse.DirContents, func(response *api.ContentsResponse) bool { return response.Name == "jpeg.jpg" })
|
|
require.NotEqual(t, -1, respFileIdx)
|
|
respFile := contentsResponse.DirContents[respFileIdx]
|
|
assert.Equal(t, "jpeg.jpg", respFile.Name)
|
|
assert.Nil(t, respFile.Encoding)
|
|
assert.Nil(t, respFile.Content)
|
|
assert.Equal(t, new(int64(107)), respFile.LfsSize)
|
|
assert.Equal(t, new("0b8d8b5f15046343fd32f451df93acc2bdd9e6373be478b968e4cad6b6647351"), respFile.LfsOid)
|
|
})
|
|
t.Run("FileContents", func(t *testing.T) {
|
|
// by default, no file content or commit info is returned
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/contents-ext/docs/README.md?ref=sub-home-md-img-check")
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse := DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.DirContents)
|
|
assert.Equal(t, "README.md", contentsResponse.FileContents.Name)
|
|
assert.Nil(t, contentsResponse.FileContents.Encoding)
|
|
assert.Nil(t, contentsResponse.FileContents.Content)
|
|
assert.Nil(t, contentsResponse.FileContents.LastCommitSHA)
|
|
assert.Nil(t, contentsResponse.FileContents.LastCommitMessage)
|
|
|
|
// file content is only returned when `includes=file_content`
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/contents-ext/docs/README.md?ref=sub-home-md-img-check&includes=file_content,commit_metadata,commit_message")
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.DirContents)
|
|
assert.Equal(t, "README.md", contentsResponse.FileContents.Name)
|
|
assert.NotNil(t, contentsResponse.FileContents.Encoding)
|
|
assert.NotNil(t, contentsResponse.FileContents.Content)
|
|
assert.Equal(t, "4649299398e4d39a5c09eb4f534df6f1e1eb87cc", *contentsResponse.FileContents.LastCommitSHA)
|
|
assert.Equal(t, "Test how READMEs render images when found in a subfolder\n", *contentsResponse.FileContents.LastCommitMessage)
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/user2/lfs/contents-ext/jpeg.jpg?includes=file_content").AddTokenAuth(token2)
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
contentsResponse = DecodeJSON(t, resp, &api.ContentsExtResponse{})
|
|
assert.Nil(t, contentsResponse.DirContents)
|
|
assert.NotNil(t, contentsResponse.FileContents)
|
|
respFile := contentsResponse.FileContents
|
|
assert.Equal(t, "jpeg.jpg", respFile.Name)
|
|
assert.NotNil(t, respFile.Encoding)
|
|
assert.NotNil(t, respFile.Content)
|
|
assert.Nil(t, contentsResponse.FileContents.LastCommitSHA)
|
|
assert.Nil(t, contentsResponse.FileContents.LastCommitMessage)
|
|
assert.Equal(t, new(int64(107)), respFile.LfsSize)
|
|
assert.Equal(t, new("0b8d8b5f15046343fd32f451df93acc2bdd9e6373be478b968e4cad6b6647351"), respFile.LfsOid)
|
|
})
|
|
}
|