2019-09-18 14:39:45 +09:00
|
|
|
// Copyright 2019 The Gitea Authors.
|
|
|
|
// All rights reserved.
|
2022-11-28 03:20:29 +09:00
|
|
|
// SPDX-License-Identifier: MIT
|
2019-09-18 14:39:45 +09:00
|
|
|
|
|
|
|
package pull
|
|
|
|
|
|
|
|
import (
|
2022-01-20 08:26:57 +09:00
|
|
|
"context"
|
2023-11-05 06:09:19 +09:00
|
|
|
"errors"
|
|
|
|
"fmt"
|
2022-01-20 08:26:57 +09:00
|
|
|
|
2021-09-24 20:32:56 +09:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2022-06-13 00:51:54 +09:00
|
|
|
git_model "code.gitea.io/gitea/models/git"
|
2022-06-13 18:37:59 +09:00
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
2019-09-18 14:39:45 +09:00
|
|
|
"code.gitea.io/gitea/modules/git"
|
Simplify how git repositories are opened (#28937)
## Purpose
This is a refactor toward building an abstraction over managing git
repositories.
Afterwards, it does not matter anymore if they are stored on the local
disk or somewhere remote.
## What this PR changes
We used `git.OpenRepository` everywhere previously.
Now, we should split them into two distinct functions:
Firstly, there are temporary repositories which do not change:
```go
git.OpenRepository(ctx, diskPath)
```
Gitea managed repositories having a record in the database in the
`repository` table are moved into the new package `gitrepo`:
```go
gitrepo.OpenRepository(ctx, repo_model.Repo)
```
Why is `repo_model.Repository` the second parameter instead of file
path?
Because then we can easily adapt our repository storage strategy.
The repositories can be stored locally, however, they could just as well
be stored on a remote server.
## Further changes in other PRs
- A Git Command wrapper on package `gitrepo` could be created. i.e.
`NewCommand(ctx, repo_model.Repository, commands...)`. `git.RunOpts{Dir:
repo.RepoPath()}`, the directory should be empty before invoking this
method and it can be filled in the function only. #28940
- Remove the `RepoPath()`/`WikiPath()` functions to reduce the
possibility of mistakes.
---------
Co-authored-by: delvh <dev.lh@web.de>
2024-01-28 05:09:51 +09:00
|
|
|
"code.gitea.io/gitea/modules/gitrepo"
|
2023-05-17 17:11:13 +09:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
2020-01-22 12:46:04 +09:00
|
|
|
"code.gitea.io/gitea/modules/structs"
|
|
|
|
|
2023-05-17 17:11:13 +09:00
|
|
|
"github.com/gobwas/glob"
|
2019-09-18 14:39:45 +09:00
|
|
|
)
|
|
|
|
|
2020-01-22 12:46:04 +09:00
|
|
|
// MergeRequiredContextsCommitStatus returns a commit status state for given required contexts
|
2022-06-13 00:51:54 +09:00
|
|
|
func MergeRequiredContextsCommitStatus(commitStatuses []*git_model.CommitStatus, requiredContexts []string) structs.CommitStatusState {
|
2023-05-17 17:11:13 +09:00
|
|
|
// matchedCount is the number of `CommitStatus.Context` that match any context of `requiredContexts`
|
|
|
|
matchedCount := 0
|
|
|
|
returnedStatus := structs.CommitStatusSuccess
|
|
|
|
|
|
|
|
if len(requiredContexts) > 0 {
|
|
|
|
requiredContextsGlob := make(map[string]glob.Glob, len(requiredContexts))
|
|
|
|
for _, ctx := range requiredContexts {
|
|
|
|
if gp, err := glob.Compile(ctx); err != nil {
|
|
|
|
log.Error("glob.Compile %s failed. Error: %v", ctx, err)
|
|
|
|
} else {
|
|
|
|
requiredContextsGlob[ctx] = gp
|
|
|
|
}
|
2020-01-22 12:46:04 +09:00
|
|
|
}
|
|
|
|
|
2024-03-08 14:02:13 +09:00
|
|
|
for _, gp := range requiredContextsGlob {
|
2023-05-17 17:11:13 +09:00
|
|
|
var targetStatus structs.CommitStatusState
|
2024-03-08 14:02:13 +09:00
|
|
|
for _, commitStatus := range commitStatuses {
|
2023-05-17 17:11:13 +09:00
|
|
|
if gp.Match(commitStatus.Context) {
|
|
|
|
targetStatus = commitStatus.State
|
|
|
|
matchedCount++
|
|
|
|
break
|
|
|
|
}
|
2020-01-22 12:46:04 +09:00
|
|
|
}
|
|
|
|
|
2024-03-08 14:02:13 +09:00
|
|
|
// If required rule not match any action, then it is pending
|
|
|
|
if targetStatus == "" {
|
|
|
|
if structs.CommitStatusPending.NoBetterThan(returnedStatus) {
|
|
|
|
returnedStatus = structs.CommitStatusPending
|
|
|
|
}
|
|
|
|
break
|
|
|
|
}
|
|
|
|
|
|
|
|
if targetStatus.NoBetterThan(returnedStatus) {
|
2023-05-17 17:11:13 +09:00
|
|
|
returnedStatus = targetStatus
|
|
|
|
}
|
2020-01-22 12:46:04 +09:00
|
|
|
}
|
2023-05-17 17:11:13 +09:00
|
|
|
}
|
|
|
|
|
2024-03-09 00:43:48 +09:00
|
|
|
if matchedCount == 0 && returnedStatus == structs.CommitStatusSuccess {
|
2023-05-17 17:11:13 +09:00
|
|
|
status := git_model.CalcCommitStatus(commitStatuses)
|
|
|
|
if status != nil {
|
|
|
|
return status.State
|
2020-01-22 12:46:04 +09:00
|
|
|
}
|
2024-03-19 22:03:28 +09:00
|
|
|
return ""
|
2020-01-22 12:46:04 +09:00
|
|
|
}
|
2023-05-17 17:11:13 +09:00
|
|
|
|
2020-01-22 12:46:04 +09:00
|
|
|
return returnedStatus
|
|
|
|
}
|
|
|
|
|
2019-09-18 14:39:45 +09:00
|
|
|
// IsCommitStatusContextSuccess returns true if all required status check contexts succeed.
|
2022-06-13 00:51:54 +09:00
|
|
|
func IsCommitStatusContextSuccess(commitStatuses []*git_model.CommitStatus, requiredContexts []string) bool {
|
2019-09-30 11:33:40 +09:00
|
|
|
// If no specific context is required, require that last commit status is a success
|
|
|
|
if len(requiredContexts) == 0 {
|
2022-06-13 00:51:54 +09:00
|
|
|
status := git_model.CalcCommitStatus(commitStatuses)
|
2020-01-22 12:46:04 +09:00
|
|
|
if status == nil || status.State != structs.CommitStatusSuccess {
|
2019-09-30 11:33:40 +09:00
|
|
|
return false
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
2019-09-18 14:39:45 +09:00
|
|
|
for _, ctx := range requiredContexts {
|
|
|
|
var found bool
|
|
|
|
for _, commitStatus := range commitStatuses {
|
|
|
|
if commitStatus.Context == ctx {
|
2020-01-22 12:46:04 +09:00
|
|
|
if commitStatus.State != structs.CommitStatusSuccess {
|
2019-09-18 14:39:45 +09:00
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
found = true
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if !found {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsPullCommitStatusPass returns if all required status checks PASS
|
2022-06-13 18:37:59 +09:00
|
|
|
func IsPullCommitStatusPass(ctx context.Context, pr *issues_model.PullRequest) (bool, error) {
|
2023-01-16 17:00:22 +09:00
|
|
|
pb, err := git_model.GetFirstMatchProtectedBranchRule(ctx, pr.BaseRepoID, pr.BaseBranch)
|
|
|
|
if err != nil {
|
2023-11-05 06:09:19 +09:00
|
|
|
return false, fmt.Errorf("GetFirstMatchProtectedBranchRule: %w", err)
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|
2023-01-16 17:00:22 +09:00
|
|
|
if pb == nil || !pb.EnableStatusCheck {
|
2019-09-18 14:39:45 +09:00
|
|
|
return true, nil
|
|
|
|
}
|
|
|
|
|
2022-01-20 08:26:57 +09:00
|
|
|
state, err := GetPullRequestCommitStatusState(ctx, pr)
|
2020-01-22 12:46:04 +09:00
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
return state.IsSuccess(), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPullRequestCommitStatusState returns pull request merged commit status state
|
2022-06-13 18:37:59 +09:00
|
|
|
func GetPullRequestCommitStatusState(ctx context.Context, pr *issues_model.PullRequest) (structs.CommitStatusState, error) {
|
2020-02-19 04:34:08 +09:00
|
|
|
// Ensure HeadRepo is loaded
|
2022-11-19 17:12:33 +09:00
|
|
|
if err := pr.LoadHeadRepo(ctx); err != nil {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", fmt.Errorf("LoadHeadRepo: %w", err)
|
2020-02-19 04:34:08 +09:00
|
|
|
}
|
|
|
|
|
2019-09-18 14:39:45 +09:00
|
|
|
// check if all required status checks are successful
|
Simplify how git repositories are opened (#28937)
## Purpose
This is a refactor toward building an abstraction over managing git
repositories.
Afterwards, it does not matter anymore if they are stored on the local
disk or somewhere remote.
## What this PR changes
We used `git.OpenRepository` everywhere previously.
Now, we should split them into two distinct functions:
Firstly, there are temporary repositories which do not change:
```go
git.OpenRepository(ctx, diskPath)
```
Gitea managed repositories having a record in the database in the
`repository` table are moved into the new package `gitrepo`:
```go
gitrepo.OpenRepository(ctx, repo_model.Repo)
```
Why is `repo_model.Repository` the second parameter instead of file
path?
Because then we can easily adapt our repository storage strategy.
The repositories can be stored locally, however, they could just as well
be stored on a remote server.
## Further changes in other PRs
- A Git Command wrapper on package `gitrepo` could be created. i.e.
`NewCommand(ctx, repo_model.Repository, commands...)`. `git.RunOpts{Dir:
repo.RepoPath()}`, the directory should be empty before invoking this
method and it can be filled in the function only. #28940
- Remove the `RepoPath()`/`WikiPath()` functions to reduce the
possibility of mistakes.
---------
Co-authored-by: delvh <dev.lh@web.de>
2024-01-28 05:09:51 +09:00
|
|
|
headGitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, pr.HeadRepo)
|
2019-09-18 14:39:45 +09:00
|
|
|
if err != nil {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", fmt.Errorf("RepositoryFromContextOrOpen: %w", err)
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|
2022-01-20 08:26:57 +09:00
|
|
|
defer closer.Close()
|
2019-09-18 14:39:45 +09:00
|
|
|
|
2022-06-13 18:37:59 +09:00
|
|
|
if pr.Flow == issues_model.PullRequestFlowGithub && !headGitRepo.IsBranchExist(pr.HeadBranch) {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", errors.New("head branch does not exist, can not merge")
|
2021-07-28 18:42:56 +09:00
|
|
|
}
|
2022-06-13 18:37:59 +09:00
|
|
|
if pr.Flow == issues_model.PullRequestFlowAGit && !git.IsReferenceExist(ctx, headGitRepo.Path, pr.GetGitRefName()) {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", errors.New("head branch does not exist, can not merge")
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|
|
|
|
|
2021-07-28 18:42:56 +09:00
|
|
|
var sha string
|
2022-06-13 18:37:59 +09:00
|
|
|
if pr.Flow == issues_model.PullRequestFlowGithub {
|
2021-07-28 18:42:56 +09:00
|
|
|
sha, err = headGitRepo.GetBranchCommitID(pr.HeadBranch)
|
|
|
|
} else {
|
|
|
|
sha, err = headGitRepo.GetRefCommitID(pr.GetGitRefName())
|
|
|
|
}
|
2019-09-18 14:39:45 +09:00
|
|
|
if err != nil {
|
2021-07-28 18:42:56 +09:00
|
|
|
return "", err
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|
|
|
|
|
2022-11-19 17:12:33 +09:00
|
|
|
if err := pr.LoadBaseRepo(ctx); err != nil {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", fmt.Errorf("LoadBaseRepo: %w", err)
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|
|
|
|
|
2024-03-22 21:53:52 +09:00
|
|
|
commitStatuses, _, err := git_model.GetLatestCommitStatus(ctx, pr.BaseRepo.ID, sha, db.ListOptionsAll)
|
2019-09-18 14:39:45 +09:00
|
|
|
if err != nil {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", fmt.Errorf("GetLatestCommitStatus: %w", err)
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|
|
|
|
|
2023-01-16 17:00:22 +09:00
|
|
|
pb, err := git_model.GetFirstMatchProtectedBranchRule(ctx, pr.BaseRepoID, pr.BaseBranch)
|
|
|
|
if err != nil {
|
2023-11-05 06:09:19 +09:00
|
|
|
return "", fmt.Errorf("GetFirstMatchProtectedBranchRule: %w", err)
|
2022-05-08 02:05:52 +09:00
|
|
|
}
|
|
|
|
var requiredContexts []string
|
2023-01-16 17:00:22 +09:00
|
|
|
if pb != nil {
|
|
|
|
requiredContexts = pb.StatusCheckContexts
|
2022-05-08 02:05:52 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
return MergeRequiredContextsCommitStatus(commitStatuses, requiredContexts), nil
|
2019-09-18 14:39:45 +09:00
|
|
|
}
|