Move Git executable to local command

Author: lunny

modules/git/batch_reader.go

@@ -33,7 +33,7 @@ type WriteCloserError interface {
 func EnsureValidGitRepository(ctx context.Context, repoPath string) error {
 	stderr := strings.Builder{}
 	err := NewCommand(ctx, "rev-parse").
-		SetDescription(fmt.Sprintf("%s rev-parse [repo_path: %s]", GitExecutable, repoPath)).
+		SetDescription(fmt.Sprintf("rev-parse [repo_path: %s]", repoPath)).
 		Run(&RunOpts{
 			Dir:    repoPath,
 			Stderr: &stderr,
@@ -69,7 +69,7 @@ func CatFileBatchCheck(ctx context.Context, repoPath string) (WriteCloserError,
 	go func() {
 		stderr := strings.Builder{}
 		err := NewCommand(ctx, "cat-file", "--batch-check").
-			SetDescription(fmt.Sprintf("%s cat-file --batch-check [repo_path: %s] (%s:%d)", GitExecutable, repoPath, filename, line)).
+			SetDescription(fmt.Sprintf("cat-file --batch-check [repo_path: %s] (%s:%d)", repoPath, filename, line)).
 			Run(&RunOpts{
 				Dir:    repoPath,
 				Stdin:  batchStdinReader,
@@ -119,7 +119,7 @@ func CatFileBatch(ctx context.Context, repoPath string) (WriteCloserError, *bufi
 	go func() {
 		stderr := strings.Builder{}
 		err := NewCommand(ctx, "cat-file", "--batch").
-			SetDescription(fmt.Sprintf("%s cat-file --batch [repo_path: %s] (%s:%d)", GitExecutable, repoPath, filename, line)).
+			SetDescription(fmt.Sprintf("cat-file --batch [repo_path: %s] (%s:%d)", repoPath, filename, line)).
 			Run(&RunOpts{
 				Dir:    repoPath,
 				Stdin:  batchStdinReader,

modules/git/blame.go

@@ -14,6 +14,7 @@ import (
 	"regexp"
 
 	"code.gitea.io/gitea/modules/process"
+	"code.gitea.io/gitea/modules/setting"
 )
 
 // BlamePart represents block of blame - continuous lines with one sha
@@ -114,7 +115,7 @@ func (r *BlameReader) Close() error {
 
 // CreateBlameReader creates reader for given repository, commit and file
 func CreateBlameReader(ctx context.Context, repoPath, commitID, file string) (*BlameReader, error) {
-	return createBlameReader(ctx, repoPath, GitExecutable, "blame", commitID, "--porcelain", "--", file)
+	return createBlameReader(ctx, repoPath, setting.Git.Path, "blame", commitID, "--porcelain", "--", file)
 }
 
 func createBlameReader(ctx context.Context, dir string, command ...string) (*BlameReader, error) {

modules/git/cmd/local.go

@@ -90,6 +90,7 @@ func (c *LocalCommand) Run(opts *RunOpts) error {
 		}
 		desc = fmt.Sprintf("%s %s [repo_path: %s]", c.args[0], strings.Join(args, " "), opts.Dir)
 	}
+	desc = fmt.Sprintf("[%s] %s", c.service.GitExecutable, desc)
 
 	ctx, cancel, finished := process.GetManager().AddContextTimeout(c.parentContext, opts.Timeout, desc)
 	defer finished()
@@ -135,6 +136,10 @@ func (c *LocalCommand) Run(opts *RunOpts) error {
 	return ctx.Err()
 }
 
+// defaultGitExecutable is the command name of git
+// Could be updated to an absolute path while initialization
+const defaultGitExecutable = "git"
+
 // LocalService represents a command service to create local git commands
 type LocalService struct {
 	GitExecutable  string // git binary location
@@ -146,8 +151,17 @@ var _ Service = &LocalService{}
 
 // NewLocalService returns a local service
 func NewLocalService(gitExecutable, repoRootPath string, defaultTimeout time.Duration) *LocalService {
+	// If path is empty, we use the default value of GitExecutable "git" to search for the location of git.
+	if gitExecutable == "" {
+		gitExecutable = defaultGitExecutable
+	}
+	absPath, err := exec.LookPath(gitExecutable)
+	if err != nil {
+		panic(fmt.Sprintf("Git not found: %v", err))
+	}
+
 	return &LocalService{
-		GitExecutable:  gitExecutable,
+		GitExecutable:  absPath,
 		RepoRootPath:   repoRootPath,
 		defaultTimeout: defaultTimeout,
 	}

modules/git/command.go

@@ -28,7 +28,7 @@ var (
 
 func getCmdService() cmd.Service {
 	cmdServiceOnce.Do(func() {
-		cmdService = cmd.NewLocalService(GitExecutable, setting.RepoRootPath, time.Duration(setting.Git.Timeout.Default)*time.Second)
+		cmdService = cmd.NewLocalService(setting.Git.Path, setting.RepoRootPath, time.Duration(setting.Git.Timeout.Default)*time.Second)
 	})
 	return cmdService
 }

modules/git/git.go

@@ -28,10 +28,6 @@ var (
 	// If everything works fine, the code for git 1.x could be removed in a separate PR before 1.17 frozen.
 	GitVersionRequired = "2.0.0"
 
-	// GitExecutable is the command name of git
-	// Could be updated to an absolute path while initialization
-	GitExecutable = "git"
-
 	// DefaultContext is the default context to run git commands in
 	// will be overwritten by Init with HammerContext
 	DefaultContext = context.Background()
@@ -82,19 +78,9 @@ func LoadGitVersion() error {
 	return err
 }
 
-// SetExecutablePath changes the path of git executable and checks the file permission and version.
-func SetExecutablePath(path string) error {
-	// If path is empty, we use the default value of GitExecutable "git" to search for the location of git.
-	if path != "" {
-		GitExecutable = path
-	}
-	absPath, err := exec.LookPath(GitExecutable)
-	if err != nil {
-		return fmt.Errorf("git not found: %w", err)
-	}
-	GitExecutable = absPath
-
-	err = LoadGitVersion()
+// checkGitVersion checks the file permission and version.
+func checkGitVersion() error {
+	err := LoadGitVersion()
 	if err != nil {
 		return fmt.Errorf("unable to load git version: %w", err)
 	}
@@ -136,7 +122,7 @@ func VersionInfo() string {
 func Init(ctx context.Context) error {
 	DefaultContext = ctx
 
-	if err := SetExecutablePath(setting.Git.Path); err != nil {
+	if err := checkGitVersion(); err != nil {
 		return err
 	}
 

routers/web/repo/http.go

@@ -472,7 +472,7 @@ func serviceRPC(ctx gocontext.Context, h serviceHandler, service string) {
 
 	var stderr bytes.Buffer
 	cmd := git.NewCommand(h.r.Context(), service, "--stateless-rpc", h.dir)
-	cmd.SetDescription(fmt.Sprintf("%s %s %s [repo_path: %s]", git.GitExecutable, service, "--stateless-rpc", h.dir))
+	cmd.SetDescription(fmt.Sprintf("%s %s [repo_path: %s]", service, "--stateless-rpc", h.dir))
 	if err := cmd.Run(&git.RunOpts{
 		Dir:    h.dir,
 		Env:    append(os.Environ(), h.environ...),