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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
|
//go:build !no_workceptor
// +build !no_workceptor
package workceptor
import (
"bufio"
"context"
"flag"
"fmt"
"io"
"os"
"os/exec"
"os/signal"
"path"
"strconv"
"strings"
"sync"
"syscall"
"time"
"github.com/ghjm/cmdline"
"github.com/google/shlex"
"github.com/spf13/viper"
)
type BaseWorkUnitForWorkUnit interface {
CancelContext()
ID() string
Init(w *Workceptor, unitID string, workType string, fs FileSystemer, watcher WatcherWrapper)
LastUpdateError() error
Load() error
MonitorLocalStatus()
Release(force bool) error
Save() error
SetFromParams(_ map[string]string) error
Status() *StatusFileData
StatusFileName() string
StdoutFileName() string
UnitDir() string
UnredactedStatus() *StatusFileData
UpdateBasicStatus(state int, detail string, stdoutSize int64)
UpdateFullStatus(statusFunc func(*StatusFileData))
GetStatusCopy() StatusFileData
GetStatusWithoutExtraData() *StatusFileData
SetStatusExtraData(interface{})
GetStatusLock() *sync.RWMutex
GetWorkceptor() *Workceptor
SetWorkceptor(*Workceptor)
GetContext() context.Context
GetCancel() context.CancelFunc
}
// commandUnit implements the WorkUnit interface for the Receptor command worker plugin.
type commandUnit struct {
BaseWorkUnitForWorkUnit
command string
baseParams string
allowRuntimeParams bool
done bool
}
// CommandExtraData is the content of the ExtraData JSON field for a command worker.
type CommandExtraData struct {
Pid int
Params string
}
func termThenKill(cmd *exec.Cmd, doneChan chan bool) {
if cmd.Process == nil {
return
}
pserr := cmd.Process.Signal(os.Interrupt)
if pserr != nil {
MainInstance.nc.GetLogger().Warning("Error processing Interrupt Signal: %+v", pserr)
}
select {
case <-doneChan:
return
case <-time.After(10 * time.Second):
MainInstance.nc.GetLogger().Warning("timed out waiting for pid %d to terminate with SIGINT", cmd.Process.Pid)
}
if cmd.Process != nil {
MainInstance.nc.GetLogger().Info("sending SIGKILL to pid %d", cmd.Process.Pid)
pkerr := cmd.Process.Kill()
if pkerr != nil {
MainInstance.nc.GetLogger().Warning("Error killing pid %d: %+v", cmd.Process.Pid, pkerr)
}
}
}
// cmdWaiter hangs around and waits for the command to be done because apparently you
// can't safely call exec.Cmd.Exited() unless you already know the command has exited.
func cmdWaiter(cmd *exec.Cmd, doneChan chan bool) {
_ = cmd.Wait()
doneChan <- true
}
// commandRunner is run in a separate process, to monitor the subprocess and report back metadata.
func commandRunner(command string, params string, unitdir string) error {
status := StatusFileData{}
status.ExtraData = &CommandExtraData{}
statusFilename := path.Join(unitdir, "status")
err := status.UpdateBasicStatus(statusFilename, WorkStatePending, "Not started yet", 0)
if err != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err)
}
var cmd *exec.Cmd
if params == "" {
cmd = exec.Command(command)
} else {
paramList, err := shlex.Split(params)
if err != nil {
return err
}
cmd = exec.Command(command, paramList...)
}
termChan := make(chan os.Signal, 1)
signal.Notify(termChan, syscall.SIGINT, syscall.SIGTERM)
stdin, err := os.Open(path.Join(unitdir, "stdin"))
if err != nil {
return err
}
payloadDebug, _ := strconv.Atoi(os.Getenv("RECEPTOR_PAYLOAD_TRACE_LEVEL"))
if payloadDebug != 0 {
splitUnitDir := strings.Split(unitdir, "/")
workUnitID := splitUnitDir[len(splitUnitDir)-1]
stdinStream, err := cmd.StdinPipe()
if err != nil {
return err
}
var payload string
reader := bufio.NewReader(stdin)
for {
response, err := reader.ReadString('\n')
if err != nil {
if err.Error() != "EOF" {
MainInstance.nc.GetLogger().Error("Error reading work unit %v stdin: %v\n", workUnitID, err)
}
break
}
payload += response
}
MainInstance.nc.GetLogger().DebugPayload(payloadDebug, payload, workUnitID, "stdin")
io.WriteString(stdinStream, payload)
stdinStream.Close()
} else {
cmd.Stdin = stdin
}
stdout, err := os.OpenFile(path.Join(unitdir, "stdout"), os.O_CREATE+os.O_WRONLY+os.O_SYNC, 0o600)
if err != nil {
return err
}
cmd.Stdout = stdout
cmd.Stderr = stdout
err = cmd.Start()
if err != nil {
return err
}
doneChan := make(chan bool, 1)
go cmdWaiter(cmd, doneChan)
writeStatusFailures := 0
loop:
for {
select {
case <-doneChan:
break loop
case <-termChan:
termThenKill(cmd, doneChan)
err = status.UpdateBasicStatus(statusFilename, WorkStateFailed, "Killed", stdoutSize(unitdir))
if err != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err)
}
os.Exit(-1)
case <-time.After(250 * time.Millisecond):
err = status.UpdateBasicStatus(statusFilename, WorkStateRunning, fmt.Sprintf("Running: PID %d", cmd.Process.Pid), stdoutSize(unitdir))
if err != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err)
writeStatusFailures++
if writeStatusFailures > 3 {
MainInstance.nc.GetLogger().Error("Exceeded retries for updating status file %s: %s", statusFilename, err)
os.Exit(-1)
}
} else {
writeStatusFailures = 0
}
}
}
if err != nil {
err = status.UpdateBasicStatus(statusFilename, WorkStateFailed, fmt.Sprintf("Error: %s", err), stdoutSize(unitdir))
if err != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err)
}
return err
}
if cmd.ProcessState.Success() {
err = status.UpdateBasicStatus(statusFilename, WorkStateSucceeded, cmd.ProcessState.String(), stdoutSize(unitdir))
if err != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err)
}
} else {
err = status.UpdateBasicStatus(statusFilename, WorkStateFailed, cmd.ProcessState.String(), stdoutSize(unitdir))
if err != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err)
}
}
err = stdin.Close()
if err != nil {
MainInstance.nc.GetLogger().Error("Error closing %s: %s", path.Join(unitdir, "stdin"), err)
}
err = stdout.Close()
if err != nil {
MainInstance.nc.GetLogger().Error("Error closing %s: %s", path.Join(unitdir, "stdout"), err)
}
os.Exit(cmd.ProcessState.ExitCode())
return nil
}
func combineParams(baseParams string, userParams string) string {
var allParams string
switch {
case userParams == "":
allParams = baseParams
case baseParams == "":
allParams = userParams
default:
allParams = strings.Join([]string{baseParams, userParams}, " ")
}
return allParams
}
// SetFromParams sets the in-memory state from parameters.
func (cw *commandUnit) SetFromParams(params map[string]string) error {
cmdParams, ok := params["params"]
if !ok {
cmdParams = ""
}
if cmdParams != "" && !cw.allowRuntimeParams {
return fmt.Errorf("extra params provided but not allowed")
}
cw.GetStatusCopy().ExtraData.(*CommandExtraData).Params = combineParams(cw.baseParams, cmdParams)
return nil
}
// Status returns a copy of the status currently loaded in memory.
func (cw *commandUnit) Status() *StatusFileData {
return cw.UnredactedStatus()
}
// UnredactedStatus returns a copy of the status currently loaded in memory, including secrets.
func (cw *commandUnit) UnredactedStatus() *StatusFileData {
cw.GetStatusLock().RLock()
status := cw.GetStatusWithoutExtraData()
ed, ok := cw.GetStatusCopy().ExtraData.(*CommandExtraData)
if ok {
edCopy := *ed
status.ExtraData = &edCopy
}
cw.GetStatusLock().RUnlock()
return status
}
// runCommand actually runs the exec.Cmd. This is in a separate function so the Python worker can call it.
func (cw *commandUnit) runCommand(cmd *exec.Cmd) error {
cmdSetDetach(cmd)
cw.done = false
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if err := cmd.Start(); err != nil {
cw.UpdateBasicStatus(WorkStateFailed, fmt.Sprintf("Failed to start command runner: %s", err), 0)
return err
}
cw.UpdateFullStatus(func(status *StatusFileData) {
if status.ExtraData == nil {
status.ExtraData = &CommandExtraData{}
}
status.ExtraData.(*CommandExtraData).Pid = cmd.Process.Pid
})
doneChan := make(chan bool)
go func() {
<-doneChan
cw.done = true
cw.UpdateFullStatus(func(status *StatusFileData) {
status.ExtraData = nil
})
}()
go cmdWaiter(cmd, doneChan)
go cw.MonitorLocalStatus()
return nil
}
// Start launches a job with given parameters.
func (cw *commandUnit) Start() error {
level := cw.GetWorkceptor().nc.GetLogger().GetLogLevel()
levelName, _ := cw.GetWorkceptor().nc.GetLogger().LogLevelToName(level)
cw.UpdateBasicStatus(WorkStatePending, "Launching command runner", 0)
// TODO: This is another place where we rely on a pre-built binary for testing.
// Consider invoking the commandRunner directly?
var receptorBin string
if flag.Lookup("test.v") == nil {
receptorBin = os.Args[0]
} else {
receptorBin = "receptor"
}
cmd := exec.Command(receptorBin, "--node", "id=worker",
"--log-level", levelName,
"--command-runner",
fmt.Sprintf("command=%s", cw.command),
fmt.Sprintf("params=%s", cw.Status().ExtraData.(*CommandExtraData).Params),
fmt.Sprintf("unitdir=%s", cw.UnitDir()))
return cw.runCommand(cmd)
}
// Restart resumes monitoring a job after a Receptor restart.
func (cw *commandUnit) Restart() error {
if err := cw.Load(); err != nil {
return err
}
state := cw.Status().State
if IsComplete(state) {
// Job already complete - no need to restart monitoring
return nil
}
if state == WorkStatePending {
// Job never started - mark it failed
cw.UpdateBasicStatus(WorkStateFailed, "Pending at restart", stdoutSize(cw.UnitDir()))
}
go cw.MonitorLocalStatus()
return nil
}
// Cancel stops a running job.
func (cw *commandUnit) Cancel() error {
cw.CancelContext()
status := cw.Status()
ced, ok := status.ExtraData.(*CommandExtraData)
if !ok || ced.Pid <= 0 {
return nil
}
proc, err := os.FindProcess(ced.Pid)
if err != nil {
return err
}
defer proc.Release()
err = proc.Signal(os.Interrupt)
if err != nil {
if strings.Contains(err.Error(), "already finished") {
return nil
}
return err
}
proc.Wait()
cw.UpdateBasicStatus(WorkStateCanceled, "Canceled", -1)
return nil
}
// Release releases resources associated with a job. Implies Cancel.
func (cw *commandUnit) Release(force bool) error {
err := cw.Cancel()
if err != nil && !force {
return err
}
return cw.BaseWorkUnitForWorkUnit.Release(force)
}
// **************************************************************************
// Command line
// **************************************************************************
// CommandWorkerCfg is the cmdline configuration object for a worker that runs a command.
type CommandWorkerCfg struct {
WorkType string `required:"true" description:"Name for this worker type"`
Command string `required:"true" description:"Command to run to process units of work"`
Params string `description:"Command-line parameters"`
AllowRuntimeParams bool `description:"Allow users to add more parameters" default:"false"`
VerifySignature bool `description:"Verify a signed work submission" default:"false"`
}
func (cfg CommandWorkerCfg) NewWorker(bwu BaseWorkUnitForWorkUnit, w *Workceptor, unitID string, workType string) WorkUnit {
if bwu == nil {
bwu = &BaseWorkUnit{
status: StatusFileData{
ExtraData: &CommandExtraData{},
},
}
}
cw := &commandUnit{
BaseWorkUnitForWorkUnit: bwu,
command: cfg.Command,
baseParams: cfg.Params,
allowRuntimeParams: cfg.AllowRuntimeParams,
}
cw.BaseWorkUnitForWorkUnit.Init(w, unitID, workType, FileSystem{}, nil)
return cw
}
func (cfg CommandWorkerCfg) GetWorkType() string {
return cfg.WorkType
}
func (cfg CommandWorkerCfg) GetVerifySignature() bool {
return cfg.VerifySignature
}
// Run runs the action.
func (cfg CommandWorkerCfg) Run() error {
if cfg.VerifySignature && MainInstance.VerifyingKey == "" {
return fmt.Errorf("VerifySignature for work command '%s' is true, but the work verification public key is not specified", cfg.WorkType)
}
err := MainInstance.RegisterWorker(cfg.WorkType, cfg.NewWorker, cfg.VerifySignature)
return err
}
// commandRunnerCfg is a hidden command line option for a command runner process.
type commandRunnerCfg struct {
Command string `required:"true"`
Params string `required:"true"`
UnitDir string `required:"true"`
}
// Run runs the action.
func (cfg commandRunnerCfg) Run() error {
err := commandRunner(cfg.Command, cfg.Params, cfg.UnitDir)
if err != nil {
statusFilename := path.Join(cfg.UnitDir, "status")
err2 := (&StatusFileData{}).UpdateBasicStatus(statusFilename, WorkStateFailed, err.Error(), stdoutSize(cfg.UnitDir))
if err2 != nil {
MainInstance.nc.GetLogger().Error("Error updating status file %s: %s", statusFilename, err2)
}
MainInstance.nc.GetLogger().Error("Command runner exited with error: %s\n", err)
os.Exit(-1)
}
os.Exit(0)
return nil
}
type SigningKeyPrivateCfg struct {
PrivateKey string `description:"Private key to sign work submissions" barevalue:"yes" default:""`
TokenExpiration string `description:"Expiration of the signed json web token, e.g. 3h or 3h30m" default:""`
}
type VerifyingKeyPublicCfg struct {
PublicKey string `description:"Public key to verify signed work submissions" barevalue:"yes" default:""`
}
func filenameExists(filename string) error {
if _, err := os.Stat(filename); err != nil {
if os.IsNotExist(err) {
return fmt.Errorf("%s does not exist", filename)
}
return err
}
return nil
}
func (cfg SigningKeyPrivateCfg) Prepare() error {
duration, err := cfg.PrepareSigningKeyPrivateCfg()
if err != nil {
return fmt.Errorf(err.Error()) //nolint:govet,staticcheck
}
MainInstance.SigningExpiration = *duration
MainInstance.SigningKey = cfg.PrivateKey
return nil
}
func (cfg SigningKeyPrivateCfg) PrepareSigningKeyPrivateCfg() (*time.Duration, error) {
err := filenameExists(cfg.PrivateKey)
if err != nil {
return nil, err
}
if cfg.TokenExpiration != "" {
duration, err := time.ParseDuration(cfg.TokenExpiration)
if err != nil {
return nil, fmt.Errorf("failed to parse TokenExpiration -- valid examples include '1.5h', '30m', '30m10s'")
}
return &duration, nil
}
return nil, nil
}
func (cfg VerifyingKeyPublicCfg) Prepare() error {
err := filenameExists(cfg.PublicKey)
if err != nil {
return err
}
MainInstance.VerifyingKey = cfg.PublicKey
return nil
}
func (cfg VerifyingKeyPublicCfg) PrepareVerifyingKeyPublicCfg() error {
err := filenameExists(cfg.PublicKey)
if err != nil {
return err
}
return nil
}
func init() {
version := viper.GetInt("version")
if version > 1 {
return
}
cmdline.RegisterConfigTypeForApp("receptor-workers",
"work-signing", "Private key to sign work submissions", SigningKeyPrivateCfg{}, cmdline.Singleton, cmdline.Section(workersSection))
cmdline.RegisterConfigTypeForApp("receptor-workers",
"work-verification", "Public key to verify work submissions", VerifyingKeyPublicCfg{}, cmdline.Singleton, cmdline.Section(workersSection))
cmdline.RegisterConfigTypeForApp("receptor-workers",
"work-command", "Run a worker using an external command", CommandWorkerCfg{}, cmdline.Section(workersSection))
cmdline.RegisterConfigTypeForApp("receptor-workers",
"command-runner", "Wrapper around a process invocation", commandRunnerCfg{}, cmdline.Hidden)
}
|