1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
package helper
import (
"context"
"fmt"
"io"
"os"
"os/exec"
"path"
"strings"
"syscall"
"time"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
"gitlab.com/gitlab-org/gitaly/internal/config"
"gitlab.com/gitlab-org/gitaly/internal/middleware/objectdirhandler"
log "github.com/Sirupsen/logrus"
)
// Command encapsulates operations with commands creates with NewCommand
type Command struct {
io.Reader
*exec.Cmd
context context.Context
startTime time.Time
}
// GitPath returns the path to the `git` binary. See `SetGitPath` for details
// on how this is set
func GitPath() string {
if config.Config.Git.BinPath == "" {
// This shouldn't happen outside of testing, SetGitPath should be called by
// main.go to ensure correctness of the configuration on start-up.
if err := config.SetGitPath(); err != nil {
log.Fatal(err) // Bail out.
}
}
return config.Config.Git.BinPath
}
// GitCommandReader creates a git Command with the given args
func GitCommandReader(ctx context.Context, args ...string) (*Command, error) {
return NewCommand(ctx, exec.Command(GitPath(), args...), nil, nil, nil)
}
// GitlabShellCommandReader creates a gitlab-shell Command with the given args
func GitlabShellCommandReader(ctx context.Context, envs []string, executable string, args ...string) (*Command, error) {
shellPath, ok := config.GitlabShellPath()
if !ok {
return nil, fmt.Errorf("path to gitlab-shell not set")
}
// Don't allow any git-command to ask (interactively) for credentials
return NewCommand(ctx, exec.Command(path.Join(shellPath, executable), args...), nil, nil, nil, envs...)
}
// NewCommand creates a Command from an exec.Cmd
func NewCommand(ctx context.Context, cmd *exec.Cmd, stdin io.Reader, stdout, stderr io.Writer, env ...string) (*Command, error) {
grpc_logrus.Extract(ctx).WithFields(log.Fields{
"path": cmd.Path,
"args": cmd.Args,
}).Info("spawn")
command := &Command{Cmd: cmd, startTime: time.Now(), context: ctx}
// Explicitly set the environment for the command
cmd.Env = []string{
fmt.Sprintf("HOME=%s", os.Getenv("HOME")),
fmt.Sprintf("PATH=%s", os.Getenv("PATH")),
fmt.Sprintf("LD_LIBRARY_PATH=%s", os.Getenv("LD_LIBRARY_PATH")),
fmt.Sprintf("TZ=%s", os.Getenv("TZ")),
"GIT_TERMINAL_PROMPT=0",
}
cmd.Env = append(cmd.Env, env...)
if dir, ok := objectdirhandler.ObjectDir(ctx); ok {
cmd.Env = append(cmd.Env, fmt.Sprintf("GIT_OBJECT_DIRECTORY=%s", dir))
}
if dirs, ok := objectdirhandler.AltObjectDirs(ctx); ok {
dirsList := strings.Join(dirs, ":")
cmd.Env = append(cmd.Env, fmt.Sprintf("GIT_ALTERNATE_OBJECT_DIRECTORIES=%s", dirsList))
}
// Start the command in its own process group (nice for signalling)
cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
if stdin != nil {
cmd.Stdin = stdin
}
if stdout != nil {
// We don't assign a reader if an stdout override was passed. We assume
// output is going to be directly handled by the caller.
cmd.Stdout = stdout
} else {
pipe, err := cmd.StdoutPipe()
if err != nil {
return nil, fmt.Errorf("GitCommand: stdout: %v", err)
}
command.Reader = pipe
}
if stderr != nil {
cmd.Stderr = stderr
} else {
// If we don't do something with cmd.Stderr, Git errors will be lost
cmd.Stderr = os.Stderr
}
if err := cmd.Start(); err != nil {
return nil, fmt.Errorf("GitCommand: start %v: %v", cmd.Args, err)
}
return command, nil
}
// Close will send a SIGTERM signal to the process group
// belonging to the `cmd` process
func (c *Command) Close() error {
cmd := c.Cmd
ctx := c.context
process := cmd.Process
if process != nil && process.Pid > 0 {
// Send SIGTERM to the process group of cmd
syscall.Kill(-process.Pid, syscall.SIGTERM)
}
// reap our child process
err := cmd.Wait()
exitCode := 0
if err != nil {
if exitStatus, ok := ExitStatus(err); ok {
exitCode = exitStatus
}
}
c.logProcessComplete(ctx, exitCode)
return err
}
// ExitStatus will return the exit-code from an error
func ExitStatus(err error) (int, bool) {
exitError, ok := err.(*exec.ExitError)
if !ok {
return 0, false
}
waitStatus, ok := exitError.Sys().(syscall.WaitStatus)
if !ok {
return 0, false
}
return waitStatus.ExitStatus(), true
}
func (c *Command) logProcessComplete(ctx context.Context, exitCode int) {
cmd := c.Cmd
systemTime := cmd.ProcessState.SystemTime()
userTime := cmd.ProcessState.UserTime()
realTime := time.Now().Sub(c.startTime)
entry := grpc_logrus.Extract(ctx).WithFields(log.Fields{
"path": cmd.Path,
"args": cmd.Args,
"command.exitCode": exitCode,
"command.system_time_ms": systemTime.Seconds() * 1000,
"command.user_time_ms": userTime.Seconds() * 1000,
"command.real_time_ms": realTime.Seconds() * 1000,
})
if rusage, ok := cmd.ProcessState.SysUsage().(*syscall.Rusage); ok {
entry = entry.WithFields(log.Fields{
"command.maxrss": rusage.Maxrss,
"command.inblock": rusage.Inblock,
"command.oublock": rusage.Oublock,
})
}
entry.Info("spawn complete")
}
|
