mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-10-20 17:12:25 +00:00 
			
		
		
		
	* OpenRepositoryCtx -> OpenRepository * OpenRepository -> openRepositoryWithDefaultContext, only for internal usage
		
			
				
	
	
		
			410 lines
		
	
	
	
		
			14 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			410 lines
		
	
	
	
		
			14 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // 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 (
 | |
| 	"net/url"
 | |
| 	"path/filepath"
 | |
| 	"testing"
 | |
| 	"time"
 | |
| 
 | |
| 	repo_model "code.gitea.io/gitea/models/repo"
 | |
| 	"code.gitea.io/gitea/modules/git"
 | |
| 	"code.gitea.io/gitea/modules/setting"
 | |
| 	api "code.gitea.io/gitea/modules/structs"
 | |
| 	"code.gitea.io/gitea/modules/test"
 | |
| 	files_service "code.gitea.io/gitea/services/repository/files"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| )
 | |
| 
 | |
| func getCreateRepoFileOptions(repo *repo_model.Repository) *files_service.UpdateRepoFileOptions {
 | |
| 	return &files_service.UpdateRepoFileOptions{
 | |
| 		OldBranch: repo.DefaultBranch,
 | |
| 		NewBranch: repo.DefaultBranch,
 | |
| 		TreePath:  "new/file.txt",
 | |
| 		Message:   "Creates new/file.txt",
 | |
| 		Content:   "This is a NEW file",
 | |
| 		IsNewFile: true,
 | |
| 		Author:    nil,
 | |
| 		Committer: nil,
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func getUpdateRepoFileOptions(repo *repo_model.Repository) *files_service.UpdateRepoFileOptions {
 | |
| 	return &files_service.UpdateRepoFileOptions{
 | |
| 		OldBranch: repo.DefaultBranch,
 | |
| 		NewBranch: repo.DefaultBranch,
 | |
| 		TreePath:  "README.md",
 | |
| 		Message:   "Updates README.md",
 | |
| 		SHA:       "4b4851ad51df6a7d9f25c979345979eaeb5b349f",
 | |
| 		Content:   "This is UPDATED content for the README file",
 | |
| 		IsNewFile: false,
 | |
| 		Author:    nil,
 | |
| 		Committer: nil,
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func getExpectedFileResponseForRepofilesCreate(commitID string) *api.FileResponse {
 | |
| 	treePath := "new/file.txt"
 | |
| 	encoding := "base64"
 | |
| 	content := "VGhpcyBpcyBhIE5FVyBmaWxl"
 | |
| 	selfURL := setting.AppURL + "api/v1/repos/user2/repo1/contents/" + treePath + "?ref=master"
 | |
| 	htmlURL := setting.AppURL + "user2/repo1/src/branch/master/" + treePath
 | |
| 	gitURL := setting.AppURL + "api/v1/repos/user2/repo1/git/blobs/103ff9234cefeee5ec5361d22b49fbb04d385885"
 | |
| 	downloadURL := setting.AppURL + "user2/repo1/raw/branch/master/" + treePath
 | |
| 	return &api.FileResponse{
 | |
| 		Content: &api.ContentsResponse{
 | |
| 			Name:        filepath.Base(treePath),
 | |
| 			Path:        treePath,
 | |
| 			SHA:         "103ff9234cefeee5ec5361d22b49fbb04d385885",
 | |
| 			Type:        "file",
 | |
| 			Size:        18,
 | |
| 			Encoding:    &encoding,
 | |
| 			Content:     &content,
 | |
| 			URL:         &selfURL,
 | |
| 			HTMLURL:     &htmlURL,
 | |
| 			GitURL:      &gitURL,
 | |
| 			DownloadURL: &downloadURL,
 | |
| 			Links: &api.FileLinksResponse{
 | |
| 				Self:    &selfURL,
 | |
| 				GitURL:  &gitURL,
 | |
| 				HTMLURL: &htmlURL,
 | |
| 			},
 | |
| 		},
 | |
| 		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:  "User Two",
 | |
| 					Email: "user2@noreply.example.org",
 | |
| 				},
 | |
| 				Date: time.Now().UTC().Format(time.RFC3339),
 | |
| 			},
 | |
| 			Committer: &api.CommitUser{
 | |
| 				Identity: api.Identity{
 | |
| 					Name:  "User Two",
 | |
| 					Email: "user2@noreply.example.org",
 | |
| 				},
 | |
| 				Date: time.Now().UTC().Format(time.RFC3339),
 | |
| 			},
 | |
| 			Parents: []*api.CommitMeta{
 | |
| 				{
 | |
| 					URL: setting.AppURL + "api/v1/repos/user2/repo1/git/commits/65f1bf27bc3bf70f64657658635e66094edbcb4d",
 | |
| 					SHA: "65f1bf27bc3bf70f64657658635e66094edbcb4d",
 | |
| 				},
 | |
| 			},
 | |
| 			Message: "Updates README.md\n",
 | |
| 			Tree: &api.CommitMeta{
 | |
| 				URL: setting.AppURL + "api/v1/repos/user2/repo1/git/trees/f93e3a1a1525fb5b91020da86e44810c87a2d7bc",
 | |
| 				SHA: "f93e3a1a1525fb5b91020git dda86e44810c87a2d7bc",
 | |
| 			},
 | |
| 		},
 | |
| 		Verification: &api.PayloadCommitVerification{
 | |
| 			Verified:  false,
 | |
| 			Reason:    "gpg.error.not_signed_commit",
 | |
| 			Signature: "",
 | |
| 			Payload:   "",
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func getExpectedFileResponseForRepofilesUpdate(commitID, filename string) *api.FileResponse {
 | |
| 	encoding := "base64"
 | |
| 	content := "VGhpcyBpcyBVUERBVEVEIGNvbnRlbnQgZm9yIHRoZSBSRUFETUUgZmlsZQ=="
 | |
| 	selfURL := setting.AppURL + "api/v1/repos/user2/repo1/contents/" + filename + "?ref=master"
 | |
| 	htmlURL := setting.AppURL + "user2/repo1/src/branch/master/" + filename
 | |
| 	gitURL := setting.AppURL + "api/v1/repos/user2/repo1/git/blobs/dbf8d00e022e05b7e5cf7e535de857de57925647"
 | |
| 	downloadURL := setting.AppURL + "user2/repo1/raw/branch/master/" + filename
 | |
| 	return &api.FileResponse{
 | |
| 		Content: &api.ContentsResponse{
 | |
| 			Name:        filename,
 | |
| 			Path:        filename,
 | |
| 			SHA:         "dbf8d00e022e05b7e5cf7e535de857de57925647",
 | |
| 			Type:        "file",
 | |
| 			Size:        43,
 | |
| 			Encoding:    &encoding,
 | |
| 			Content:     &content,
 | |
| 			URL:         &selfURL,
 | |
| 			HTMLURL:     &htmlURL,
 | |
| 			GitURL:      &gitURL,
 | |
| 			DownloadURL: &downloadURL,
 | |
| 			Links: &api.FileLinksResponse{
 | |
| 				Self:    &selfURL,
 | |
| 				GitURL:  &gitURL,
 | |
| 				HTMLURL: &htmlURL,
 | |
| 			},
 | |
| 		},
 | |
| 		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:  "User Two",
 | |
| 					Email: "user2@noreply.example.org",
 | |
| 				},
 | |
| 				Date: time.Now().UTC().Format(time.RFC3339),
 | |
| 			},
 | |
| 			Committer: &api.CommitUser{
 | |
| 				Identity: api.Identity{
 | |
| 					Name:  "User Two",
 | |
| 					Email: "user2@noreply.example.org",
 | |
| 				},
 | |
| 				Date: time.Now().UTC().Format(time.RFC3339),
 | |
| 			},
 | |
| 			Parents: []*api.CommitMeta{
 | |
| 				{
 | |
| 					URL: setting.AppURL + "api/v1/repos/user2/repo1/git/commits/65f1bf27bc3bf70f64657658635e66094edbcb4d",
 | |
| 					SHA: "65f1bf27bc3bf70f64657658635e66094edbcb4d",
 | |
| 				},
 | |
| 			},
 | |
| 			Message: "Updates README.md\n",
 | |
| 			Tree: &api.CommitMeta{
 | |
| 				URL: setting.AppURL + "api/v1/repos/user2/repo1/git/trees/f93e3a1a1525fb5b91020da86e44810c87a2d7bc",
 | |
| 				SHA: "f93e3a1a1525fb5b91020da86e44810c87a2d7bc",
 | |
| 			},
 | |
| 		},
 | |
| 		Verification: &api.PayloadCommitVerification{
 | |
| 			Verified:  false,
 | |
| 			Reason:    "gpg.error.not_signed_commit",
 | |
| 			Signature: "",
 | |
| 			Payload:   "",
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func TestCreateOrUpdateRepoFileForCreate(t *testing.T) {
 | |
| 	// setup
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		ctx := test.MockContext(t, "user2/repo1")
 | |
| 		ctx.SetParams(":id", "1")
 | |
| 		test.LoadRepo(t, ctx, 1)
 | |
| 		test.LoadRepoCommit(t, ctx)
 | |
| 		test.LoadUser(t, ctx, 2)
 | |
| 		test.LoadGitRepo(t, ctx)
 | |
| 		defer ctx.Repo.GitRepo.Close()
 | |
| 
 | |
| 		repo := ctx.Repo.Repository
 | |
| 		doer := ctx.Doer
 | |
| 		opts := getCreateRepoFileOptions(repo)
 | |
| 
 | |
| 		// test
 | |
| 		fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 
 | |
| 		// asserts
 | |
| 		assert.NoError(t, err)
 | |
| 		gitRepo, _ := git.OpenRepository(git.DefaultContext, repo.RepoPath())
 | |
| 		defer gitRepo.Close()
 | |
| 
 | |
| 		commitID, _ := gitRepo.GetBranchCommitID(opts.NewBranch)
 | |
| 		expectedFileResponse := getExpectedFileResponseForRepofilesCreate(commitID)
 | |
| 		assert.NotNil(t, expectedFileResponse)
 | |
| 		if expectedFileResponse != nil {
 | |
| 			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)
 | |
| 		}
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestCreateOrUpdateRepoFileForUpdate(t *testing.T) {
 | |
| 	// setup
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		ctx := test.MockContext(t, "user2/repo1")
 | |
| 		ctx.SetParams(":id", "1")
 | |
| 		test.LoadRepo(t, ctx, 1)
 | |
| 		test.LoadRepoCommit(t, ctx)
 | |
| 		test.LoadUser(t, ctx, 2)
 | |
| 		test.LoadGitRepo(t, ctx)
 | |
| 		defer ctx.Repo.GitRepo.Close()
 | |
| 
 | |
| 		repo := ctx.Repo.Repository
 | |
| 		doer := ctx.Doer
 | |
| 		opts := getUpdateRepoFileOptions(repo)
 | |
| 
 | |
| 		// test
 | |
| 		fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 
 | |
| 		// asserts
 | |
| 		assert.NoError(t, err)
 | |
| 		gitRepo, _ := git.OpenRepository(git.DefaultContext, repo.RepoPath())
 | |
| 		defer gitRepo.Close()
 | |
| 
 | |
| 		commitID, _ := gitRepo.GetBranchCommitID(opts.NewBranch)
 | |
| 		expectedFileResponse := getExpectedFileResponseForRepofilesUpdate(commitID, opts.TreePath)
 | |
| 		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)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestCreateOrUpdateRepoFileForUpdateWithFileMove(t *testing.T) {
 | |
| 	// setup
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		ctx := test.MockContext(t, "user2/repo1")
 | |
| 		ctx.SetParams(":id", "1")
 | |
| 		test.LoadRepo(t, ctx, 1)
 | |
| 		test.LoadRepoCommit(t, ctx)
 | |
| 		test.LoadUser(t, ctx, 2)
 | |
| 		test.LoadGitRepo(t, ctx)
 | |
| 		defer ctx.Repo.GitRepo.Close()
 | |
| 
 | |
| 		repo := ctx.Repo.Repository
 | |
| 		doer := ctx.Doer
 | |
| 		opts := getUpdateRepoFileOptions(repo)
 | |
| 		opts.FromTreePath = "README.md"
 | |
| 		opts.TreePath = "README_new.md" // new file name, README_new.md
 | |
| 
 | |
| 		// test
 | |
| 		fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 
 | |
| 		// asserts
 | |
| 		assert.NoError(t, err)
 | |
| 		gitRepo, _ := git.OpenRepository(git.DefaultContext, repo.RepoPath())
 | |
| 		defer gitRepo.Close()
 | |
| 
 | |
| 		commit, _ := gitRepo.GetBranchCommit(opts.NewBranch)
 | |
| 		expectedFileResponse := getExpectedFileResponseForRepofilesUpdate(commit.ID.String(), opts.TreePath)
 | |
| 		// assert that the old file no longer exists in the last commit of the branch
 | |
| 		fromEntry, err := commit.GetTreeEntryByPath(opts.FromTreePath)
 | |
| 		switch err.(type) {
 | |
| 		case git.ErrNotExist:
 | |
| 			// correct, continue
 | |
| 		default:
 | |
| 			t.Fatalf("expected git.ErrNotExist, got:%v", err)
 | |
| 		}
 | |
| 		toEntry, err := commit.GetTreeEntryByPath(opts.TreePath)
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.Nil(t, fromEntry)  // Should no longer exist here
 | |
| 		assert.NotNil(t, toEntry) // Should exist here
 | |
| 		// assert SHA has remained the same but paths use the new file name
 | |
| 		assert.EqualValues(t, expectedFileResponse.Content.SHA, fileResponse.Content.SHA)
 | |
| 		assert.EqualValues(t, expectedFileResponse.Content.Name, fileResponse.Content.Name)
 | |
| 		assert.EqualValues(t, expectedFileResponse.Content.Path, fileResponse.Content.Path)
 | |
| 		assert.EqualValues(t, expectedFileResponse.Content.URL, fileResponse.Content.URL)
 | |
| 		assert.EqualValues(t, expectedFileResponse.Commit.SHA, fileResponse.Commit.SHA)
 | |
| 		assert.EqualValues(t, expectedFileResponse.Commit.HTMLURL, fileResponse.Commit.HTMLURL)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| // Test opts with branch names removed, should get same results as above test
 | |
| func TestCreateOrUpdateRepoFileWithoutBranchNames(t *testing.T) {
 | |
| 	// setup
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		ctx := test.MockContext(t, "user2/repo1")
 | |
| 		ctx.SetParams(":id", "1")
 | |
| 		test.LoadRepo(t, ctx, 1)
 | |
| 		test.LoadRepoCommit(t, ctx)
 | |
| 		test.LoadUser(t, ctx, 2)
 | |
| 		test.LoadGitRepo(t, ctx)
 | |
| 		defer ctx.Repo.GitRepo.Close()
 | |
| 
 | |
| 		repo := ctx.Repo.Repository
 | |
| 		doer := ctx.Doer
 | |
| 		opts := getUpdateRepoFileOptions(repo)
 | |
| 		opts.OldBranch = ""
 | |
| 		opts.NewBranch = ""
 | |
| 
 | |
| 		// test
 | |
| 		fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 
 | |
| 		// asserts
 | |
| 		assert.NoError(t, err)
 | |
| 		gitRepo, _ := git.OpenRepository(git.DefaultContext, repo.RepoPath())
 | |
| 		defer gitRepo.Close()
 | |
| 
 | |
| 		commitID, _ := gitRepo.GetBranchCommitID(repo.DefaultBranch)
 | |
| 		expectedFileResponse := getExpectedFileResponseForRepofilesUpdate(commitID, opts.TreePath)
 | |
| 		assert.EqualValues(t, expectedFileResponse.Content, fileResponse.Content)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestCreateOrUpdateRepoFileErrors(t *testing.T) {
 | |
| 	// setup
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		ctx := test.MockContext(t, "user2/repo1")
 | |
| 		ctx.SetParams(":id", "1")
 | |
| 		test.LoadRepo(t, ctx, 1)
 | |
| 		test.LoadRepoCommit(t, ctx)
 | |
| 		test.LoadUser(t, ctx, 2)
 | |
| 		test.LoadGitRepo(t, ctx)
 | |
| 		defer ctx.Repo.GitRepo.Close()
 | |
| 
 | |
| 		repo := ctx.Repo.Repository
 | |
| 		doer := ctx.Doer
 | |
| 
 | |
| 		t.Run("bad branch", func(t *testing.T) {
 | |
| 			opts := getUpdateRepoFileOptions(repo)
 | |
| 			opts.OldBranch = "bad_branch"
 | |
| 			fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 			assert.Error(t, err)
 | |
| 			assert.Nil(t, fileResponse)
 | |
| 			expectedError := "branch does not exist [name: " + opts.OldBranch + "]"
 | |
| 			assert.EqualError(t, err, expectedError)
 | |
| 		})
 | |
| 
 | |
| 		t.Run("bad SHA", func(t *testing.T) {
 | |
| 			opts := getUpdateRepoFileOptions(repo)
 | |
| 			origSHA := opts.SHA
 | |
| 			opts.SHA = "bad_sha"
 | |
| 			fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 			assert.Nil(t, fileResponse)
 | |
| 			assert.Error(t, err)
 | |
| 			expectedError := "sha does not match [given: " + opts.SHA + ", expected: " + origSHA + "]"
 | |
| 			assert.EqualError(t, err, expectedError)
 | |
| 		})
 | |
| 
 | |
| 		t.Run("new branch already exists", func(t *testing.T) {
 | |
| 			opts := getUpdateRepoFileOptions(repo)
 | |
| 			opts.NewBranch = "develop"
 | |
| 			fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 			assert.Nil(t, fileResponse)
 | |
| 			assert.Error(t, err)
 | |
| 			expectedError := "branch already exists [name: " + opts.NewBranch + "]"
 | |
| 			assert.EqualError(t, err, expectedError)
 | |
| 		})
 | |
| 
 | |
| 		t.Run("treePath is empty:", func(t *testing.T) {
 | |
| 			opts := getUpdateRepoFileOptions(repo)
 | |
| 			opts.TreePath = ""
 | |
| 			fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 			assert.Nil(t, fileResponse)
 | |
| 			assert.Error(t, err)
 | |
| 			expectedError := "path contains a malformed path component [path: ]"
 | |
| 			assert.EqualError(t, err, expectedError)
 | |
| 		})
 | |
| 
 | |
| 		t.Run("treePath is a git directory:", func(t *testing.T) {
 | |
| 			opts := getUpdateRepoFileOptions(repo)
 | |
| 			opts.TreePath = ".git"
 | |
| 			fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 			assert.Nil(t, fileResponse)
 | |
| 			assert.Error(t, err)
 | |
| 			expectedError := "path contains a malformed path component [path: " + opts.TreePath + "]"
 | |
| 			assert.EqualError(t, err, expectedError)
 | |
| 		})
 | |
| 
 | |
| 		t.Run("create file that already exists", func(t *testing.T) {
 | |
| 			opts := getCreateRepoFileOptions(repo)
 | |
| 			opts.TreePath = "README.md" // already exists
 | |
| 			fileResponse, err := files_service.CreateOrUpdateRepoFile(git.DefaultContext, repo, doer, opts)
 | |
| 			assert.Nil(t, fileResponse)
 | |
| 			assert.Error(t, err)
 | |
| 			expectedError := "repository file already exists [path: " + opts.TreePath + "]"
 | |
| 			assert.EqualError(t, err, expectedError)
 | |
| 		})
 | |
| 	})
 | |
| }
 |