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
|
package shell
import (
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"github.com/sirupsen/logrus"
"gitlab.com/gitlab-org/gitlab-runner/common"
"gitlab.com/gitlab-org/gitlab-runner/executors"
"gitlab.com/gitlab-org/gitlab-runner/helpers/featureflags"
"gitlab.com/gitlab-org/gitlab-runner/helpers/process"
)
var newProcessKillWaiter = process.NewOSKillWait
var newCommander = process.NewOSCmd
type executor struct {
executors.AbstractExecutor
}
func (s *executor) Prepare(options common.ExecutorPrepareOptions) error {
if options.User != "" {
s.Shell().User = options.User
}
// expand environment variables to have current directory
wd, err := os.Getwd()
if err != nil {
return fmt.Errorf("getwd: %w", err)
}
mapping := func(key string) string {
switch key {
case "PWD":
return wd
default:
return ""
}
}
s.DefaultBuildsDir = os.Expand(s.DefaultBuildsDir, mapping)
s.DefaultCacheDir = os.Expand(s.DefaultCacheDir, mapping)
// Pass control to executor
err = s.AbstractExecutor.Prepare(options)
if err != nil {
return err
}
s.Println("Using Shell executor...")
return nil
}
func (s *executor) Run(cmd common.ExecutorCommand) error {
s.BuildLogger.Debugln("Using new shell command execution")
cmdOpts := process.CommandOptions{
Env: os.Environ(),
Stdout: s.Trace,
Stderr: s.Trace,
UseWindowsLegacyProcessStrategy: s.Build.IsFeatureFlagOn(featureflags.UseWindowsLegacyProcessStrategy),
}
args := s.BuildShell.Arguments
stdin, args, cleanup, err := s.shellScriptArgs(cmd, args)
if err != nil {
return err
}
defer cleanup()
cmdOpts.Stdin = stdin
// Create execution command
c := newCommander(s.BuildShell.Command, args, cmdOpts)
// Start a process
err = c.Start()
if err != nil {
return fmt.Errorf("failed to start process: %w", err)
}
// Wait for process to finish
waitCh := make(chan error, 1)
go func() {
waitErr := c.Wait()
var exitErr *exec.ExitError
if errors.As(waitErr, &exitErr) {
waitErr = &common.BuildError{Inner: waitErr, ExitCode: exitErr.ExitCode()}
}
waitCh <- waitErr
}()
// Support process abort
select {
case err = <-waitCh:
return err
case <-cmd.Context.Done():
logger := common.NewProcessLoggerAdapter(s.BuildLogger)
return newProcessKillWaiter(logger, s.Config.GetGracefulKillTimeout(), s.Config.GetForceKillTimeout()).
KillAndWait(c, waitCh)
}
}
func (s *executor) shellScriptArgs(cmd common.ExecutorCommand, args []string) (io.Reader, []string, func(), error) {
if !s.BuildShell.PassFile {
return strings.NewReader(cmd.Script), args, func() {}, nil
}
scriptDir, err := ioutil.TempDir("", "build_script")
if err != nil {
return nil, nil, func() {}, fmt.Errorf("creating tmp build script dir: %w", err)
}
cleanup := func() {
err := os.RemoveAll(scriptDir)
if err != nil {
s.BuildLogger.Warningln("Failed to remove build script directory", scriptDir, err)
}
}
scriptFile := filepath.Join(scriptDir, "script."+s.BuildShell.Extension)
err = ioutil.WriteFile(scriptFile, []byte(cmd.Script), 0700)
if err != nil {
return nil, nil, cleanup, fmt.Errorf("writing script file: %w", err)
}
return nil, append(args, scriptFile), cleanup, nil
}
func init() {
// Look for self
runnerCommand, err := os.Executable()
if err != nil {
logrus.Warningln(err)
}
RegisterExecutor("shell", runnerCommand)
}
func RegisterExecutor(executorName string, runnerCommandPath string) {
options := executors.ExecutorOptions{
DefaultCustomBuildsDirEnabled: false,
DefaultBuildsDir: "$PWD/builds",
DefaultCacheDir: "$PWD/cache",
SharedBuildsDir: true,
Shell: common.ShellScriptInfo{
Shell: common.GetDefaultShell(),
Type: common.LoginShell,
RunnerCommand: runnerCommandPath,
},
ShowHostname: false,
}
creator := func() common.Executor {
return &executor{
AbstractExecutor: executors.AbstractExecutor{
ExecutorOptions: options,
},
}
}
featuresUpdater := func(features *common.FeaturesInfo) {
features.Variables = true
features.Shared = true
if runtime.GOOS != "windows" {
features.Session = true
features.Terminal = true
}
}
common.RegisterExecutorProvider(executorName, executors.DefaultExecutorProvider{
Creator: creator,
FeaturesUpdater: featuresUpdater,
DefaultShellName: options.Shell.Shell,
})
}
|