377 lines
12 KiB
Go
377 lines
12 KiB
Go
// Copyright 2019 The Gitea Authors.
|
|
// All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package pull
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/models/db"
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
access_model "code.gitea.io/gitea/models/perm/access"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unit"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/graceful"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/notification"
|
|
"code.gitea.io/gitea/modules/process"
|
|
"code.gitea.io/gitea/modules/queue"
|
|
"code.gitea.io/gitea/modules/timeutil"
|
|
"code.gitea.io/gitea/modules/util"
|
|
asymkey_service "code.gitea.io/gitea/services/asymkey"
|
|
)
|
|
|
|
// prPatchCheckerQueue represents a queue to handle update pull request tests
|
|
var prPatchCheckerQueue queue.UniqueQueue
|
|
|
|
var (
|
|
ErrIsClosed = errors.New("pull is closed")
|
|
ErrUserNotAllowedToMerge = models.ErrDisallowedToMerge{}
|
|
ErrHasMerged = errors.New("has already been merged")
|
|
ErrIsWorkInProgress = errors.New("work in progress PRs cannot be merged")
|
|
ErrIsChecking = errors.New("cannot merge while conflict checking is in progress")
|
|
ErrNotMergableState = errors.New("not in mergeable state")
|
|
ErrDependenciesLeft = errors.New("is blocked by an open dependency")
|
|
)
|
|
|
|
// AddToTaskQueue adds itself to pull request test task queue.
|
|
func AddToTaskQueue(pr *issues_model.PullRequest) {
|
|
err := prPatchCheckerQueue.PushFunc(strconv.FormatInt(pr.ID, 10), func() error {
|
|
pr.Status = issues_model.PullRequestStatusChecking
|
|
err := pr.UpdateColsIfNotMerged(db.DefaultContext, "status")
|
|
if err != nil {
|
|
log.Error("AddToTaskQueue.UpdateCols[%d].(add to queue): %v", pr.ID, err)
|
|
} else {
|
|
log.Trace("Adding PR ID: %d to the test pull requests queue", pr.ID)
|
|
}
|
|
return err
|
|
})
|
|
if err != nil && err != queue.ErrAlreadyInQueue {
|
|
log.Error("Error adding prID %d to the test pull requests queue: %v", pr.ID, err)
|
|
}
|
|
}
|
|
|
|
// CheckPullMergable check if the pull mergable based on all conditions (branch protection, merge options, ...)
|
|
func CheckPullMergable(stdCtx context.Context, doer *user_model.User, perm *access_model.Permission, pr *issues_model.PullRequest, manuallMerge, force bool) error {
|
|
return db.WithTx(stdCtx, func(ctx context.Context) error {
|
|
if pr.HasMerged {
|
|
return ErrHasMerged
|
|
}
|
|
|
|
if err := pr.LoadIssue(ctx); err != nil {
|
|
return err
|
|
} else if pr.Issue.IsClosed {
|
|
return ErrIsClosed
|
|
}
|
|
|
|
if allowedMerge, err := IsUserAllowedToMerge(ctx, pr, *perm, doer); err != nil {
|
|
return err
|
|
} else if !allowedMerge {
|
|
return ErrUserNotAllowedToMerge
|
|
}
|
|
|
|
if manuallMerge {
|
|
// don't check rules to "auto merge", doer is going to mark this pull as merged manually
|
|
return nil
|
|
}
|
|
|
|
if pr.IsWorkInProgress() {
|
|
return ErrIsWorkInProgress
|
|
}
|
|
|
|
if !pr.CanAutoMerge() && !pr.IsEmpty() {
|
|
return ErrNotMergableState
|
|
}
|
|
|
|
if pr.IsChecking() {
|
|
return ErrIsChecking
|
|
}
|
|
|
|
if err := CheckPullBranchProtections(ctx, pr, false); err != nil {
|
|
if models.IsErrDisallowedToMerge(err) {
|
|
if force {
|
|
if isRepoAdmin, err2 := access_model.IsUserRepoAdmin(ctx, pr.BaseRepo, doer); err2 != nil {
|
|
return err2
|
|
} else if !isRepoAdmin {
|
|
return err
|
|
}
|
|
}
|
|
} else {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if _, err := isSignedIfRequired(ctx, pr, doer); err != nil {
|
|
return err
|
|
}
|
|
|
|
if noDeps, err := issues_model.IssueNoDependenciesLeft(ctx, pr.Issue); err != nil {
|
|
return err
|
|
} else if !noDeps {
|
|
return ErrDependenciesLeft
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// isSignedIfRequired check if merge will be signed if required
|
|
func isSignedIfRequired(ctx context.Context, pr *issues_model.PullRequest, doer *user_model.User) (bool, error) {
|
|
if err := pr.LoadProtectedBranch(ctx); err != nil {
|
|
return false, err
|
|
}
|
|
|
|
if pr.ProtectedBranch == nil || !pr.ProtectedBranch.RequireSignedCommits {
|
|
return true, nil
|
|
}
|
|
|
|
sign, _, _, err := asymkey_service.SignMerge(ctx, pr, doer, pr.BaseRepo.RepoPath(), pr.BaseBranch, pr.GetGitRefName())
|
|
|
|
return sign, err
|
|
}
|
|
|
|
// checkAndUpdateStatus checks if pull request is possible to leaving checking status,
|
|
// and set to be either conflict or mergeable.
|
|
func checkAndUpdateStatus(ctx context.Context, pr *issues_model.PullRequest) {
|
|
// Status is not changed to conflict means mergeable.
|
|
if pr.Status == issues_model.PullRequestStatusChecking {
|
|
pr.Status = issues_model.PullRequestStatusMergeable
|
|
}
|
|
|
|
// Make sure there is no waiting test to process before leaving the checking status.
|
|
has, err := prPatchCheckerQueue.Has(strconv.FormatInt(pr.ID, 10))
|
|
if err != nil {
|
|
log.Error("Unable to check if the queue is waiting to reprocess pr.ID %d. Error: %v", pr.ID, err)
|
|
}
|
|
|
|
if !has {
|
|
if err := pr.UpdateColsIfNotMerged(ctx, "merge_base", "status", "conflicted_files", "changed_protected_files"); err != nil {
|
|
log.Error("Update[%d]: %v", pr.ID, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
// getMergeCommit checks if a pull request got merged
|
|
// Returns the git.Commit of the pull request if merged
|
|
func getMergeCommit(ctx context.Context, pr *issues_model.PullRequest) (*git.Commit, error) {
|
|
if pr.BaseRepo == nil {
|
|
var err error
|
|
pr.BaseRepo, err = repo_model.GetRepositoryByID(ctx, pr.BaseRepoID)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("GetRepositoryByID: %w", err)
|
|
}
|
|
}
|
|
|
|
indexTmpPath, err := os.MkdirTemp(os.TempDir(), "gitea-"+pr.BaseRepo.Name)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed to create temp dir for repository %s: %w", pr.BaseRepo.RepoPath(), err)
|
|
}
|
|
defer func() {
|
|
if err := util.RemoveAll(indexTmpPath); err != nil {
|
|
log.Warn("Unable to remove temporary index path: %s: Error: %v", indexTmpPath, err)
|
|
}
|
|
}()
|
|
|
|
headFile := pr.GetGitRefName()
|
|
|
|
// Check if a pull request is merged into BaseBranch
|
|
_, _, err = git.NewCommand(ctx, "merge-base", "--is-ancestor").AddDynamicArguments(headFile, pr.BaseBranch).
|
|
RunStdString(&git.RunOpts{Dir: pr.BaseRepo.RepoPath(), Env: []string{"GIT_INDEX_FILE=" + indexTmpPath, "GIT_DIR=" + pr.BaseRepo.RepoPath()}})
|
|
if err != nil {
|
|
// Errors are signaled by a non-zero status that is not 1
|
|
if strings.Contains(err.Error(), "exit status 1") {
|
|
return nil, nil
|
|
}
|
|
return nil, fmt.Errorf("git merge-base --is-ancestor: %w", err)
|
|
}
|
|
|
|
commitIDBytes, err := os.ReadFile(pr.BaseRepo.RepoPath() + "/" + headFile)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("ReadFile(%s): %w", headFile, err)
|
|
}
|
|
commitID := string(commitIDBytes)
|
|
if len(commitID) < 40 {
|
|
return nil, fmt.Errorf(`ReadFile(%s): invalid commit-ID "%s"`, headFile, commitID)
|
|
}
|
|
cmd := commitID[:40] + ".." + pr.BaseBranch
|
|
|
|
// Get the commit from BaseBranch where the pull request got merged
|
|
mergeCommit, _, err := git.NewCommand(ctx, "rev-list", "--ancestry-path", "--merges", "--reverse").AddDynamicArguments(cmd).
|
|
RunStdString(&git.RunOpts{Dir: "", Env: []string{"GIT_INDEX_FILE=" + indexTmpPath, "GIT_DIR=" + pr.BaseRepo.RepoPath()}})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("git rev-list --ancestry-path --merges --reverse: %w", err)
|
|
} else if len(mergeCommit) < 40 {
|
|
// PR was maybe fast-forwarded, so just use last commit of PR
|
|
mergeCommit = commitID[:40]
|
|
}
|
|
|
|
gitRepo, err := git.OpenRepository(ctx, pr.BaseRepo.RepoPath())
|
|
if err != nil {
|
|
return nil, fmt.Errorf("OpenRepository: %w", err)
|
|
}
|
|
defer gitRepo.Close()
|
|
|
|
commit, err := gitRepo.GetCommit(mergeCommit[:40])
|
|
if err != nil {
|
|
return nil, fmt.Errorf("GetMergeCommit[%v]: %w", mergeCommit[:40], err)
|
|
}
|
|
|
|
return commit, nil
|
|
}
|
|
|
|
// manuallyMerged checks if a pull request got manually merged
|
|
// When a pull request got manually merged mark the pull request as merged
|
|
func manuallyMerged(ctx context.Context, pr *issues_model.PullRequest) bool {
|
|
if err := pr.LoadBaseRepo(ctx); err != nil {
|
|
log.Error("PullRequest[%d].LoadBaseRepo: %v", pr.ID, err)
|
|
return false
|
|
}
|
|
|
|
if unit, err := pr.BaseRepo.GetUnit(ctx, unit.TypePullRequests); err == nil {
|
|
config := unit.PullRequestsConfig()
|
|
if !config.AutodetectManualMerge {
|
|
return false
|
|
}
|
|
} else {
|
|
log.Error("PullRequest[%d].BaseRepo.GetUnit(unit.TypePullRequests): %v", pr.ID, err)
|
|
return false
|
|
}
|
|
|
|
commit, err := getMergeCommit(ctx, pr)
|
|
if err != nil {
|
|
log.Error("PullRequest[%d].getMergeCommit: %v", pr.ID, err)
|
|
return false
|
|
}
|
|
if commit != nil {
|
|
pr.MergedCommitID = commit.ID.String()
|
|
pr.MergedUnix = timeutil.TimeStamp(commit.Author.When.Unix())
|
|
pr.Status = issues_model.PullRequestStatusManuallyMerged
|
|
merger, _ := user_model.GetUserByEmail(commit.Author.Email)
|
|
|
|
// When the commit author is unknown set the BaseRepo owner as merger
|
|
if merger == nil {
|
|
if pr.BaseRepo.Owner == nil {
|
|
if err = pr.BaseRepo.GetOwner(ctx); err != nil {
|
|
log.Error("BaseRepo.GetOwner[%d]: %v", pr.ID, err)
|
|
return false
|
|
}
|
|
}
|
|
merger = pr.BaseRepo.Owner
|
|
}
|
|
pr.Merger = merger
|
|
pr.MergerID = merger.ID
|
|
|
|
if merged, err := pr.SetMerged(ctx); err != nil {
|
|
log.Error("PullRequest[%d].setMerged : %v", pr.ID, err)
|
|
return false
|
|
} else if !merged {
|
|
return false
|
|
}
|
|
|
|
notification.NotifyMergePullRequest(ctx, merger, pr)
|
|
|
|
log.Info("manuallyMerged[%d]: Marked as manually merged into %s/%s by commit id: %s", pr.ID, pr.BaseRepo.Name, pr.BaseBranch, commit.ID.String())
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// InitializePullRequests checks and tests untested patches of pull requests.
|
|
func InitializePullRequests(ctx context.Context) {
|
|
prs, err := issues_model.GetPullRequestIDsByCheckStatus(issues_model.PullRequestStatusChecking)
|
|
if err != nil {
|
|
log.Error("Find Checking PRs: %v", err)
|
|
return
|
|
}
|
|
for _, prID := range prs {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
default:
|
|
if err := prPatchCheckerQueue.PushFunc(strconv.FormatInt(prID, 10), func() error {
|
|
log.Trace("Adding PR ID: %d to the pull requests patch checking queue", prID)
|
|
return nil
|
|
}); err != nil {
|
|
log.Error("Error adding prID: %s to the pull requests patch checking queue %v", prID, err)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// handle passed PR IDs and test the PRs
|
|
func handle(data ...queue.Data) []queue.Data {
|
|
for _, datum := range data {
|
|
id, _ := strconv.ParseInt(datum.(string), 10, 64)
|
|
|
|
testPR(id)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func testPR(id int64) {
|
|
pullWorkingPool.CheckIn(fmt.Sprint(id))
|
|
defer pullWorkingPool.CheckOut(fmt.Sprint(id))
|
|
ctx, _, finished := process.GetManager().AddContext(graceful.GetManager().HammerContext(), fmt.Sprintf("Test PR[%d] from patch checking queue", id))
|
|
defer finished()
|
|
|
|
pr, err := issues_model.GetPullRequestByID(ctx, id)
|
|
if err != nil {
|
|
log.Error("GetPullRequestByID[%d]: %v", id, err)
|
|
return
|
|
}
|
|
|
|
if pr.HasMerged {
|
|
return
|
|
}
|
|
|
|
if manuallyMerged(ctx, pr) {
|
|
return
|
|
}
|
|
|
|
if err := TestPatch(pr); err != nil {
|
|
log.Error("testPatch[%d]: %v", pr.ID, err)
|
|
pr.Status = issues_model.PullRequestStatusError
|
|
if err := pr.UpdateCols("status"); err != nil {
|
|
log.Error("update pr [%d] status to PullRequestStatusError failed: %v", pr.ID, err)
|
|
}
|
|
return
|
|
}
|
|
checkAndUpdateStatus(ctx, pr)
|
|
}
|
|
|
|
// CheckPrsForBaseBranch check all pulls with bseBrannch
|
|
func CheckPrsForBaseBranch(baseRepo *repo_model.Repository, baseBranchName string) error {
|
|
prs, err := issues_model.GetUnmergedPullRequestsByBaseInfo(baseRepo.ID, baseBranchName)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, pr := range prs {
|
|
AddToTaskQueue(pr)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Init runs the task queue to test all the checking status pull requests
|
|
func Init() error {
|
|
prPatchCheckerQueue = queue.CreateUniqueQueue("pr_patch_checker", handle, "")
|
|
|
|
if prPatchCheckerQueue == nil {
|
|
return fmt.Errorf("Unable to create pr_patch_checker Queue")
|
|
}
|
|
|
|
go graceful.GetManager().RunWithShutdownFns(prPatchCheckerQueue.Run)
|
|
go graceful.GetManager().RunWithShutdownContext(InitializePullRequests)
|
|
return nil
|
|
}
|