Move some functions to gitrepo package (#35543)

Refactor Git command functions to use WithXXX methods instead of exposing RunOpts. This change simplifies reuse across gitrepo and improves consistency, encapsulation, and maintainability of command options. --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

Author: lunny

cmd/admin.go

@@ -121,7 +121,7 @@ func runRepoSyncReleases(ctx context.Context, _ *cli.Command) error {
 }
 log.Trace("Processing next %d repos of %d", len(repos), count)
 for _, repo := range repos {
-log.Trace("Synchronizing repo %s with path %s", repo.FullName(), repo.RepoPath())
+log.Trace("Synchronizing repo %s with path %s", repo.FullName(), repo.RelativePath())
 gitRepo, err := gitrepo.OpenRepository(ctx, repo)
 if err != nil {
 log.Warn("OpenRepository: %v", err)
@@ -147,7 +147,7 @@ func runRepoSyncReleases(ctx context.Context, _ *cli.Command) error {
 continue
 }
 
-log.Trace(" repo %s releases synchronized to tags: from %d to %d",
+log.Trace("repo %s releases synchronized to tags: from %d to %d",
 repo.FullName(), oldnum, count)
 gitRepo.Close()
 }

cmd/hook.go

@@ -313,7 +313,7 @@ func runHookPostReceive(ctx context.Context, c *cli.Command) error {
 setup(ctx, c.Bool("debug"))
 
 // First of all run update-server-info no matter what
-if _, _, err := gitcmd.NewCommand("update-server-info").RunStdString(ctx, nil); err != nil {
+if _, _, err := gitcmd.NewCommand("update-server-info").RunStdString(ctx); err != nil {
 return fmt.Errorf("failed to call 'git update-server-info': %w", err)
 }
 

models/migrations/v1_12/v128.go

@@ -84,17 +84,17 @@ func FixMergeBase(ctx context.Context, x *xorm.Engine) error {
 
 if !pr.HasMerged {
 var err error
-pr.MergeBase, _, err = gitcmd.NewCommand("merge-base").AddDashesAndList(pr.BaseBranch, gitRefName).RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+pr.MergeBase, _, err = gitcmd.NewCommand("merge-base").AddDashesAndList(pr.BaseBranch, gitRefName).WithDir(repoPath).RunStdString(ctx)
 if err != nil {
 var err2 error
-pr.MergeBase, _, err2 = gitcmd.NewCommand("rev-parse").AddDynamicArguments(git.BranchPrefix+pr.BaseBranch).RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+pr.MergeBase, _, err2 = gitcmd.NewCommand("rev-parse").AddDynamicArguments(git.BranchPrefix + pr.BaseBranch).WithDir(repoPath).RunStdString(ctx)
 if err2 != nil {
 log.Error("Unable to get merge base for PR ID %d, Index %d in %s/%s. Error: %v & %v", pr.ID, pr.Index, baseRepo.OwnerName, baseRepo.Name, err, err2)
 continue
 }
 }
 } else {
-parentsString, _, err := gitcmd.NewCommand("rev-list", "--parents", "-n", "1").AddDynamicArguments(pr.MergedCommitID).RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+parentsString, _, err := gitcmd.NewCommand("rev-list", "--parents", "-n", "1").AddDynamicArguments(pr.MergedCommitID).WithDir(repoPath).RunStdString(ctx)
 if err != nil {
 log.Error("Unable to get parents for merged PR ID %d, Index %d in %s/%s. Error: %v", pr.ID, pr.Index, baseRepo.OwnerName, baseRepo.Name, err)
 continue
@@ -108,7 +108,7 @@ func FixMergeBase(ctx context.Context, x *xorm.Engine) error {
 refs = append(refs, gitRefName)
 cmd := gitcmd.NewCommand("merge-base").AddDashesAndList(refs...)
 
-pr.MergeBase, _, err = cmd.RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+pr.MergeBase, _, err = cmd.WithDir(repoPath).RunStdString(ctx)
 if err != nil {
 log.Error("Unable to get merge base for merged PR ID %d, Index %d in %s/%s. Error: %v", pr.ID, pr.Index, baseRepo.OwnerName, baseRepo.Name, err)
 continue

models/migrations/v1_12/v134.go

@@ -80,7 +80,7 @@ func RefixMergeBase(ctx context.Context, x *xorm.Engine) error {
 
 gitRefName := fmt.Sprintf("refs/pull/%d/head", pr.Index)
 
-parentsString, _, err := gitcmd.NewCommand("rev-list", "--parents", "-n", "1").AddDynamicArguments(pr.MergedCommitID).RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+parentsString, _, err := gitcmd.NewCommand("rev-list", "--parents", "-n", "1").AddDynamicArguments(pr.MergedCommitID).WithDir(repoPath).RunStdString(ctx)
 if err != nil {
 log.Error("Unable to get parents for merged PR ID %d, Index %d in %s/%s. Error: %v", pr.ID, pr.Index, baseRepo.OwnerName, baseRepo.Name, err)
 continue
@@ -95,7 +95,7 @@ func RefixMergeBase(ctx context.Context, x *xorm.Engine) error {
 refs = append(refs, gitRefName)
 cmd := gitcmd.NewCommand("merge-base").AddDashesAndList(refs...)
 
-pr.MergeBase, _, err = cmd.RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+pr.MergeBase, _, err = cmd.WithDir(repoPath).RunStdString(ctx)
 if err != nil {
 log.Error("Unable to get merge base for merged PR ID %d, Index %d in %s/%s. Error: %v", pr.ID, pr.Index, baseRepo.OwnerName, baseRepo.Name, err)
 continue

modules/git/attribute/batch.go

@@ -77,13 +77,12 @@ func NewBatchChecker(repo *git.Repository, treeish string, attributes []string)
 _ = lw.Close()
 }()
 stdErr := new(bytes.Buffer)
-err := cmd.Run(ctx, &gitcmd.RunOpts{
-Env: envs,
-Dir: repo.Path,
-Stdin: stdinReader,
-Stdout: lw,
-Stderr: stdErr,
-})
+err := cmd.WithEnv(envs).
+WithDir(repo.Path).
+WithStdin(stdinReader).
+WithStdout(lw).
+WithStderr(stdErr).
+Run(ctx)
 
 if err != nil && !git.IsErrCanceledOrKilled(err) {
 log.Error("Attribute checker for commit %s exits with error: %v", treeish, err)

modules/git/attribute/checker.go

@@ -71,12 +71,11 @@ func CheckAttributes(ctx context.Context, gitRepo *git.Repository, treeish strin
 stdOut := new(bytes.Buffer)
 stdErr := new(bytes.Buffer)
 
-if err := cmd.Run(ctx, &gitcmd.RunOpts{
-Env: append(os.Environ(), envs...),
-Dir: gitRepo.Path,
-Stdout: stdOut,
-Stderr: stdErr,
-}); err != nil {
+if err := cmd.WithEnv(append(os.Environ(), envs...)).
+WithDir(gitRepo.Path).
+WithStdout(stdOut).
+WithStderr(stdErr).
+Run(ctx); err != nil {
 return nil, fmt.Errorf("failed to run check-attr: %w\n%s\n%s", err, stdOut.String(), stdErr.String())
 }
 

modules/git/batch_reader.go

@@ -31,10 +31,9 @@ type WriteCloserError interface {
 func ensureValidGitRepository(ctx context.Context, repoPath string) error {
 stderr := strings.Builder{}
 err := gitcmd.NewCommand("rev-parse").
-Run(ctx, &gitcmd.RunOpts{
-Dir: repoPath,
-Stderr: &stderr,
-})
+WithDir(repoPath).
+WithStderr(&stderr).
+Run(ctx)
 if err != nil {
 return gitcmd.ConcatenateError(err, (&stderr).String())
 }
@@ -63,14 +62,12 @@ func catFileBatchCheck(ctx context.Context, repoPath string) (WriteCloserError,
 go func() {
 stderr := strings.Builder{}
 err := gitcmd.NewCommand("cat-file", "--batch-check").
-Run(ctx, &gitcmd.RunOpts{
-Dir: repoPath,
-Stdin: batchStdinReader,
-Stdout: batchStdoutWriter,
-Stderr: &stderr,
-
-UseContextTimeout: true,
-})
+WithDir(repoPath).
+WithStdin(batchStdinReader).
+WithStdout(batchStdoutWriter).
+WithStderr(&stderr).
+WithUseContextTimeout(true).
+Run(ctx)
 if err != nil {
 _ = batchStdoutWriter.CloseWithError(gitcmd.ConcatenateError(err, (&stderr).String()))
 _ = batchStdinReader.CloseWithError(gitcmd.ConcatenateError(err, (&stderr).String()))
@@ -111,14 +108,12 @@ func catFileBatch(ctx context.Context, repoPath string) (WriteCloserError, *bufi
 go func() {
 stderr := strings.Builder{}
 err := gitcmd.NewCommand("cat-file", "--batch").
-Run(ctx, &gitcmd.RunOpts{
-Dir: repoPath,
-Stdin: batchStdinReader,
-Stdout: batchStdoutWriter,
-Stderr: &stderr,
-
-UseContextTimeout: true,
-})
+WithDir(repoPath).
+WithStdin(batchStdinReader).
+WithStdout(batchStdoutWriter).
+WithStderr(&stderr).
+WithUseContextTimeout(true).
+Run(ctx)
 if err != nil {
 _ = batchStdoutWriter.CloseWithError(gitcmd.ConcatenateError(err, (&stderr).String()))
 _ = batchStdinReader.CloseWithError(gitcmd.ConcatenateError(err, (&stderr).String()))

modules/git/blame.go

@@ -166,12 +166,11 @@ func CreateBlameReader(ctx context.Context, objectFormat ObjectFormat, repoPath
 go func() {
 stderr := bytes.Buffer{}
 // TODO: it doesn't work for directories (the directories shouldn't be "blamed"), and the "err" should be returned by "Read" but not by "Close"
-err := cmd.Run(ctx, &gitcmd.RunOpts{
-UseContextTimeout: true,
-Dir: repoPath,
-Stdout: stdout,
-Stderr: &stderr,
-})
+err := cmd.WithDir(repoPath).
+WithUseContextTimeout(true).
+WithStdout(stdout).
+WithStderr(&stderr).
+Run(ctx)
 done <- err
 _ = stdout.Close()
 if err != nil {

modules/git/commit.go

@@ -93,7 +93,7 @@ func AddChanges(ctx context.Context, repoPath string, all bool, files ...string)
 cmd.AddArguments("--all")
 }
 cmd.AddDashesAndList(files...)
-_, _, err := cmd.RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+_, _, err := cmd.WithDir(repoPath).RunStdString(ctx)
 return err
 }
 
@@ -122,7 +122,7 @@ func CommitChanges(ctx context.Context, repoPath string, opts CommitChangesOptio
 }
 cmd.AddOptionFormat("--message=%s", opts.Message)
 
-_, _, err := cmd.RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+_, _, err := cmd.WithDir(repoPath).RunStdString(ctx)
 // No stderr but exit status 1 means nothing to commit.
 if err != nil && err.Error() == "exit status 1" {
 return nil
@@ -141,7 +141,7 @@ func AllCommitsCount(ctx context.Context, repoPath string, hidePRRefs bool, file
 cmd.AddDashesAndList(files...)
 }
 
-stdout, _, err := cmd.RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+stdout, _, err := cmd.WithDir(repoPath).RunStdString(ctx)
 if err != nil {
 return 0, err
 }
@@ -173,7 +173,7 @@ func CommitsCount(ctx context.Context, opts CommitsCountOptions) (int64, error)
 cmd.AddDashesAndList(opts.RelPath...)
 }
 
-stdout, _, err := cmd.RunStdString(ctx, &gitcmd.RunOpts{Dir: opts.RepoPath})
+stdout, _, err := cmd.WithDir(opts.RepoPath).RunStdString(ctx)
 if err != nil {
 return 0, err
 }
@@ -208,7 +208,10 @@ func (c *Commit) HasPreviousCommit(objectID ObjectID) (bool, error) {
 return false, nil
 }
 
-_, _, err := gitcmd.NewCommand("merge-base", "--is-ancestor").AddDynamicArguments(that, this).RunStdString(c.repo.Ctx, &gitcmd.RunOpts{Dir: c.repo.Path})
+_, _, err := gitcmd.NewCommand("merge-base", "--is-ancestor").
+AddDynamicArguments(that, this).
+WithDir(c.repo.Path).
+RunStdString(c.repo.Ctx)
 if err == nil {
 return true, nil
 }
@@ -354,7 +357,7 @@ func (c *Commit) GetBranchName() (string, error) {
 cmd.AddArguments("--exclude", "refs/tags/*")
 }
 cmd.AddArguments("--name-only", "--no-undefined").AddDynamicArguments(c.ID.String())
-data, _, err := cmd.RunStdString(c.repo.Ctx, &gitcmd.RunOpts{Dir: c.repo.Path})
+data, _, err := cmd.WithDir(c.repo.Path).RunStdString(c.repo.Ctx)
 if err != nil {
 // handle special case where git can not describe commit
 if strings.Contains(err.Error(), "cannot describe") {
@@ -432,11 +435,12 @@ func GetCommitFileStatus(ctx context.Context, repoPath, commitID string) (*Commi
 }()
 
 stderr := new(bytes.Buffer)
-err := gitcmd.NewCommand("log", "--name-status", "-m", "--pretty=format:", "--first-parent", "--no-renames", "-z", "-1").AddDynamicArguments(commitID).Run(ctx, &gitcmd.RunOpts{
-Dir: repoPath,
-Stdout: w,
-Stderr: stderr,
-})
+err := gitcmd.NewCommand("log", "--name-status", "-m", "--pretty=format:", "--first-parent", "--no-renames", "-z", "-1").
+AddDynamicArguments(commitID).
+WithDir(repoPath).
+WithStdout(w).
+WithStderr(stderr).
+Run(ctx)
 w.Close() // Close writer to exit parsing goroutine
 if err != nil {
 return nil, gitcmd.ConcatenateError(err, stderr.String())
@@ -448,7 +452,10 @@ func GetCommitFileStatus(ctx context.Context, repoPath, commitID string) (*Commi
 
 // GetFullCommitID returns full length (40) of commit ID by given short SHA in a repository.
 func GetFullCommitID(ctx context.Context, repoPath, shortID string) (string, error) {
-commitID, _, err := gitcmd.NewCommand("rev-parse").AddDynamicArguments(shortID).RunStdString(ctx, &gitcmd.RunOpts{Dir: repoPath})
+commitID, _, err := gitcmd.NewCommand("rev-parse").
+AddDynamicArguments(shortID).
+WithDir(repoPath).
+RunStdString(ctx)
 if err != nil {
 if strings.Contains(err.Error(), "exit status 128") {
 return "", ErrNotExist{shortID, ""}

modules/git/config.go

@@ -118,7 +118,9 @@ func syncGitConfig(ctx context.Context) (err error) {
 }
 
 func configSet(ctx context.Context, key, value string) error {
-stdout, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key).RunStdString(ctx, nil)
+stdout, _, err := gitcmd.NewCommand("config", "--global", "--get").
+AddDynamicArguments(key).
+RunStdString(ctx)
 if err != nil && !gitcmd.IsErrorExitCode(err, 1) {
 return fmt.Errorf("failed to get git config %s, err: %w", key, err)
 }
@@ -128,23 +130,24 @@ func configSet(ctx context.Context, key, value string) error {
 return nil
 }
 
-_, _, err = gitcmd.NewCommand("config", "--global").AddDynamicArguments(key, value).RunStdString(ctx, nil)
-if err != nil {
+if _, _, err = gitcmd.NewCommand("config", "--global").
+AddDynamicArguments(key, value).
+RunStdString(ctx); err != nil {
 return fmt.Errorf("failed to set git global config %s, err: %w", key, err)
 }
 
 return nil
 }
 
 func configSetNonExist(ctx context.Context, key, value string) error {
-_, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key).RunStdString(ctx, nil)
+_, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key).RunStdString(ctx)
 if err == nil {
 // already exist
 return nil
 }
 if gitcmd.IsErrorExitCode(err, 1) {
 // not exist, set new config
-_, _, err = gitcmd.NewCommand("config", "--global").AddDynamicArguments(key, value).RunStdString(ctx, nil)
+_, _, err = gitcmd.NewCommand("config", "--global").AddDynamicArguments(key, value).RunStdString(ctx)
 if err != nil {
 return fmt.Errorf("failed to set git global config %s, err: %w", key, err)
 }
@@ -155,14 +158,14 @@ func configSetNonExist(ctx context.Context, key, value string) error {
 }
 
 func configAddNonExist(ctx context.Context, key, value string) error {
-_, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key, regexp.QuoteMeta(value)).RunStdString(ctx, nil)
+_, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key, regexp.QuoteMeta(value)).RunStdString(ctx)
 if err == nil {
 // already exist
 return nil
 }
 if gitcmd.IsErrorExitCode(err, 1) {
 // not exist, add new config
-_, _, err = gitcmd.NewCommand("config", "--global", "--add").AddDynamicArguments(key, value).RunStdString(ctx, nil)
+_, _, err = gitcmd.NewCommand("config", "--global", "--add").AddDynamicArguments(key, value).RunStdString(ctx)
 if err != nil {
 return fmt.Errorf("failed to add git global config %s, err: %w", key, err)
 }
@@ -172,10 +175,10 @@ func configAddNonExist(ctx context.Context, key, value string) error {
 }
 
 func configUnsetAll(ctx context.Context, key, value string) error {
-_, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key).RunStdString(ctx, nil)
+_, _, err := gitcmd.NewCommand("config", "--global", "--get").AddDynamicArguments(key).RunStdString(ctx)
 if err == nil {
 // exist, need to remove
-_, _, err = gitcmd.NewCommand("config", "--global", "--unset-all").AddDynamicArguments(key, regexp.QuoteMeta(value)).RunStdString(ctx, nil)
+_, _, err = gitcmd.NewCommand("config", "--global", "--unset-all").AddDynamicArguments(key, regexp.QuoteMeta(value)).RunStdString(ctx)
 if err != nil {
 return fmt.Errorf("failed to unset git global config %s, err: %w", key, err)
 }