Sybren A. Stüvel
17b664f152
Log any CLI command that's run in a way that can be easily copy-pasted from the task log. This can help a lot in determining whether an issue is caused by Flamenco or by the CLI program itself.
81 lines
2.1 KiB
Go
81 lines
2.1 KiB
Go
package worker
|
|
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
/* This file contains the "cli" command in the "misc" type group. */
|
|
|
|
import (
|
|
"context"
|
|
"os/exec"
|
|
|
|
"github.com/rs/zerolog"
|
|
|
|
"projects.blender.org/studio/flamenco/pkg/api"
|
|
)
|
|
|
|
type ExecParams struct {
|
|
exe string // Executable to run.
|
|
args []string // Arguments for the executable.
|
|
}
|
|
|
|
// cmdExec runs an arbitrary executable with arguments.
|
|
func (ce *CommandExecutor) cmdExec(ctx context.Context, logger zerolog.Logger, taskID string, cmd api.Command) error {
|
|
cmdCtx, cmdCtxCancel := context.WithCancel(ctx)
|
|
defer cmdCtxCancel()
|
|
|
|
execCmd, err := ce.cmdExecCommand(cmdCtx, logger, taskID, cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
logChunker := NewLogChunker(taskID, ce.listener, ce.timeService)
|
|
subprocessErr := ce.cli.RunWithTextOutput(ctx, logger, execCmd, logChunker, nil)
|
|
|
|
if subprocessErr != nil {
|
|
logger.Error().Err(subprocessErr).
|
|
Int("exitCode", execCmd.ProcessState.ExitCode()).
|
|
Msg("command exited abnormally")
|
|
return subprocessErr
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (ce *CommandExecutor) cmdExecCommand(
|
|
ctx context.Context,
|
|
logger zerolog.Logger,
|
|
taskID string,
|
|
cmd api.Command,
|
|
) (*exec.Cmd, error) {
|
|
parameters, err := cmdExecParams(logger, cmd)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
execCmd := ce.cli.CommandContext(ctx, parameters.exe, parameters.args...)
|
|
if execCmd == nil {
|
|
logger.Error().Msg("unable to create command executor")
|
|
return nil, ErrNoExecCmd
|
|
}
|
|
|
|
return execCmd, nil
|
|
}
|
|
|
|
func cmdExecParams(logger zerolog.Logger, cmd api.Command) (ExecParams, error) {
|
|
var (
|
|
parameters ExecParams
|
|
ok bool
|
|
)
|
|
|
|
if parameters.exe, ok = cmdParameter[string](cmd, "exe"); !ok || parameters.exe == "" {
|
|
logger.Warn().Interface("command", cmd).Msg("missing 'exe' parameter")
|
|
return parameters, NewParameterMissingError("exe", cmd)
|
|
}
|
|
if parameters.args, ok = cmdParameterAsStrings(cmd, "args"); !ok {
|
|
logger.Warn().Interface("command", cmd).Msg("invalid 'args' parameter")
|
|
return parameters, NewParameterInvalidError("args", cmd, "cannot convert to list of strings")
|
|
}
|
|
|
|
return parameters, nil
|
|
}
|