mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 16:40:24 +08:00 
			
		
		
		
	Fixes 4762 - Content API for Creating, Updating, Deleting Files (#6314)
This commit is contained in:
		
				
					committed by
					
						
						techknowlogick
					
				
			
			
				
	
			
			
			
						parent
						
							059195b127
						
					
				
				
					commit
					2262811e40
				
			
							
								
								
									
										215
									
								
								integrations/api_repo_file_create_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										215
									
								
								integrations/api_repo_file_create_test.go
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,215 @@
 | 
			
		||||
// Copyright 2019 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"
 | 
			
		||||
	"path/filepath"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	"code.gitea.io/gitea/models"
 | 
			
		||||
	"code.gitea.io/gitea/modules/base"
 | 
			
		||||
	"code.gitea.io/gitea/modules/context"
 | 
			
		||||
	"code.gitea.io/gitea/modules/git"
 | 
			
		||||
	"code.gitea.io/gitea/modules/setting"
 | 
			
		||||
	api "code.gitea.io/sdk/gitea"
 | 
			
		||||
 | 
			
		||||
	"github.com/stretchr/testify/assert"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func getCreateFileOptions() api.CreateFileOptions {
 | 
			
		||||
	content := "This is new text"
 | 
			
		||||
	contentEncoded := base64.StdEncoding.EncodeToString([]byte(content))
 | 
			
		||||
	return api.CreateFileOptions{
 | 
			
		||||
		FileOptions: api.FileOptions{
 | 
			
		||||
			BranchName:    "master",
 | 
			
		||||
			NewBranchName: "master",
 | 
			
		||||
			Message:       "Creates new/file.txt",
 | 
			
		||||
			Author: api.Identity{
 | 
			
		||||
				Name:  "John Doe",
 | 
			
		||||
				Email: "johndoe@example.com",
 | 
			
		||||
			},
 | 
			
		||||
			Committer: api.Identity{
 | 
			
		||||
				Name:  "Jane Doe",
 | 
			
		||||
				Email: "janedoe@example.com",
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		Content: contentEncoded,
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func getExpectedFileResponseForCreate(commitID, treePath string) *api.FileResponse {
 | 
			
		||||
	sha := "a635aa942442ddfdba07468cf9661c08fbdf0ebf"
 | 
			
		||||
	return &api.FileResponse{
 | 
			
		||||
		Content: &api.FileContentResponse{
 | 
			
		||||
			Name:        filepath.Base(treePath),
 | 
			
		||||
			Path:        treePath,
 | 
			
		||||
			SHA:         sha,
 | 
			
		||||
			Size:        16,
 | 
			
		||||
			URL:         setting.AppURL + "api/v1/repos/user2/repo1/contents/" + treePath,
 | 
			
		||||
			HTMLURL:     setting.AppURL + "user2/repo1/blob/master/" + treePath,
 | 
			
		||||
			GitURL:      setting.AppURL + "api/v1/repos/user2/repo1/git/blobs/" + sha,
 | 
			
		||||
			DownloadURL: setting.AppURL + "user2/repo1/raw/branch/master/" + treePath,
 | 
			
		||||
			Type:        "blob",
 | 
			
		||||
			Links: &api.FileLinksResponse{
 | 
			
		||||
				Self:    setting.AppURL + "api/v1/repos/user2/repo1/contents/" + treePath,
 | 
			
		||||
				GitURL:  setting.AppURL + "api/v1/repos/user2/repo1/git/blobs/" + sha,
 | 
			
		||||
				HTMLURL: setting.AppURL + "user2/repo1/blob/master/" + treePath,
 | 
			
		||||
			},
 | 
			
		||||
		},
 | 
			
		||||
		Commit: &api.FileCommitResponse{
 | 
			
		||||
			CommitMeta: api.CommitMeta{
 | 
			
		||||
				URL: setting.AppURL + "api/v1/repos/user2/repo1/git/commits/" + commitID,
 | 
			
		||||
				SHA: commitID,
 | 
			
		||||
			},
 | 
			
		||||
			HTMLURL: setting.AppURL + "user2/repo1/commit/" + commitID,
 | 
			
		||||
			Author: &api.CommitUser{
 | 
			
		||||
				Identity: api.Identity{
 | 
			
		||||
					Name:  "Jane Doe",
 | 
			
		||||
					Email: "janedoe@example.com",
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Committer: &api.CommitUser{
 | 
			
		||||
				Identity: api.Identity{
 | 
			
		||||
					Name:  "John Doe",
 | 
			
		||||
					Email: "johndoe@example.com",
 | 
			
		||||
				},
 | 
			
		||||
			},
 | 
			
		||||
			Message: "Updates README.md\n",
 | 
			
		||||
		},
 | 
			
		||||
		Verification: &api.PayloadCommitVerification{
 | 
			
		||||
			Verified:  false,
 | 
			
		||||
			Reason:    "unsigned",
 | 
			
		||||
			Signature: "",
 | 
			
		||||
			Payload:   "",
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestAPICreateFile(t *testing.T) {
 | 
			
		||||
	prepareTestEnv(t)
 | 
			
		||||
	user2 := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User)               // owner of the repo1 & repo16
 | 
			
		||||
	user3 := models.AssertExistsAndLoadBean(t, &models.User{ID: 3}).(*models.User)               // owner of the repo3, is an org
 | 
			
		||||
	user4 := models.AssertExistsAndLoadBean(t, &models.User{ID: 4}).(*models.User)               // owner of neither repos
 | 
			
		||||
	repo1 := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository)   // public repo
 | 
			
		||||
	repo3 := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 3}).(*models.Repository)   // public repo
 | 
			
		||||
	repo16 := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 16}).(*models.Repository) // private repo
 | 
			
		||||
	fileID := 0
 | 
			
		||||
 | 
			
		||||
	// Get user2's token
 | 
			
		||||
	session := loginUser(t, user2.Name)
 | 
			
		||||
	token2 := getTokenForLoggedInUser(t, session)
 | 
			
		||||
	session = emptyTestSession(t)
 | 
			
		||||
	// Get user4's token
 | 
			
		||||
	session = loginUser(t, user4.Name)
 | 
			
		||||
	token4 := getTokenForLoggedInUser(t, session)
 | 
			
		||||
	session = emptyTestSession(t)
 | 
			
		||||
 | 
			
		||||
	// Test creating a file in repo1 which user2 owns, try both with branch and empty branch
 | 
			
		||||
	for _, branch := range [...]string{
 | 
			
		||||
		"master", // Branch
 | 
			
		||||
		"",       // Empty branch
 | 
			
		||||
	} {
 | 
			
		||||
		createFileOptions := getCreateFileOptions()
 | 
			
		||||
		createFileOptions.BranchName = branch
 | 
			
		||||
		fileID++
 | 
			
		||||
		treePath := fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
		url := fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user2.Name, repo1.Name, treePath, token2)
 | 
			
		||||
		req := NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
		resp := session.MakeRequest(t, req, http.StatusCreated)
 | 
			
		||||
		gitRepo, _ := git.OpenRepository(repo1.RepoPath())
 | 
			
		||||
		commitID, _ := gitRepo.GetBranchCommitID(createFileOptions.NewBranchName)
 | 
			
		||||
		expectedFileResponse := getExpectedFileResponseForCreate(commitID, treePath)
 | 
			
		||||
		var fileResponse api.FileResponse
 | 
			
		||||
		DecodeJSON(t, resp, &fileResponse)
 | 
			
		||||
		assert.EqualValues(t, expectedFileResponse.Content, fileResponse.Content)
 | 
			
		||||
		assert.EqualValues(t, expectedFileResponse.Commit.SHA, fileResponse.Commit.SHA)
 | 
			
		||||
		assert.EqualValues(t, expectedFileResponse.Commit.HTMLURL, fileResponse.Commit.HTMLURL)
 | 
			
		||||
		assert.EqualValues(t, expectedFileResponse.Commit.Author.Email, fileResponse.Commit.Author.Email)
 | 
			
		||||
		assert.EqualValues(t, expectedFileResponse.Commit.Author.Name, fileResponse.Commit.Author.Name)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// Test creating a file in a new branch
 | 
			
		||||
	createFileOptions := getCreateFileOptions()
 | 
			
		||||
	createFileOptions.BranchName = repo1.DefaultBranch
 | 
			
		||||
	createFileOptions.NewBranchName = "new_branch"
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath := fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url := fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user2.Name, repo1.Name, treePath, token2)
 | 
			
		||||
	req := NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	resp := session.MakeRequest(t, req, http.StatusCreated)
 | 
			
		||||
	var fileResponse api.FileResponse
 | 
			
		||||
	DecodeJSON(t, resp, &fileResponse)
 | 
			
		||||
	expectedSHA := "a635aa942442ddfdba07468cf9661c08fbdf0ebf"
 | 
			
		||||
	expectedHTMLURL := fmt.Sprintf("http://localhost:"+setting.HTTPPort+"/user2/repo1/blob/new_branch/new/file%d.txt", fileID)
 | 
			
		||||
	expectedDownloadURL := fmt.Sprintf("http://localhost:"+setting.HTTPPort+"/user2/repo1/raw/branch/new_branch/new/file%d.txt", fileID)
 | 
			
		||||
	assert.EqualValues(t, expectedSHA, fileResponse.Content.SHA)
 | 
			
		||||
	assert.EqualValues(t, expectedHTMLURL, fileResponse.Content.HTMLURL)
 | 
			
		||||
	assert.EqualValues(t, expectedDownloadURL, fileResponse.Content.DownloadURL)
 | 
			
		||||
 | 
			
		||||
	// Test trying to create a file that already exists, should fail
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	treePath = "README.md"
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user2.Name, repo1.Name, treePath, token2)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	resp = session.MakeRequest(t, req, http.StatusInternalServerError)
 | 
			
		||||
	expectedAPIError := context.APIError{
 | 
			
		||||
		Message: "repository file already exists [path: " + treePath + "]",
 | 
			
		||||
		URL:     base.DocURL,
 | 
			
		||||
	}
 | 
			
		||||
	var apiError context.APIError
 | 
			
		||||
	DecodeJSON(t, resp, &apiError)
 | 
			
		||||
	assert.Equal(t, expectedAPIError, apiError)
 | 
			
		||||
 | 
			
		||||
	// Test creating a file in repo1 by user4 who does not have write access
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath = fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user2.Name, repo16.Name, treePath, token4)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	session.MakeRequest(t, req, http.StatusNotFound)
 | 
			
		||||
 | 
			
		||||
	// Tests a repo with no token given so will fail
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath = fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, repo16.Name, treePath)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	session.MakeRequest(t, req, http.StatusNotFound)
 | 
			
		||||
 | 
			
		||||
	// Test using access token for a private repo that the user of the token owns
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath = fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user2.Name, repo16.Name, treePath, token2)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	session.MakeRequest(t, req, http.StatusCreated)
 | 
			
		||||
 | 
			
		||||
	// Test using org repo "user3/repo3" where user2 is a collaborator
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath = fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user3.Name, repo3.Name, treePath, token2)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	session.MakeRequest(t, req, http.StatusCreated)
 | 
			
		||||
 | 
			
		||||
	// Test using org repo "user3/repo3" with no user token
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath = fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user3.Name, repo3.Name, treePath)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	session.MakeRequest(t, req, http.StatusNotFound)
 | 
			
		||||
 | 
			
		||||
	// Test using repo "user2/repo1" where user4 is a NOT collaborator
 | 
			
		||||
	createFileOptions = getCreateFileOptions()
 | 
			
		||||
	fileID++
 | 
			
		||||
	treePath = fmt.Sprintf("new/file%d.txt", fileID)
 | 
			
		||||
	url = fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s?token=%s", user2.Name, repo1.Name, treePath, token4)
 | 
			
		||||
	req = NewRequestWithJSON(t, "POST", url, &createFileOptions)
 | 
			
		||||
	session.MakeRequest(t, req, http.StatusForbidden)
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user