README
¶
run_command Task
Description
The run_command task is designed to execute a specified shell command. This task is useful for integrating external scripts or commands into the testing workflow.
Configuration Parameters
-
allowed_to_fail: Determines the task's behavior in response to the command's exit status. If set tofalse, the task will not fail even if the command exits with a failure code. This is useful for commands where a non-zero exit status does not necessarily indicate a critical problem. -
command: The command to be executed, along with its arguments. This should be provided as an array, where the first element is the command and subsequent elements are the arguments. For example, to list files in the current directory with detailed information, you would use["ls", "-la", "."].
Defaults
Default settings for the run_command task:
- name: run_command
config:
allowed_to_fail: false
command: []
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "run_command" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Runs a shell command.", Category: "utility", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{ { Name: "stdout", Type: "string", Description: "The combined stdout/stderr output from the command.", }, { Name: "error", Type: "string", Description: "The error message if the command failed.", }, }, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
AllowedToFail bool `yaml:"allowed_to_fail" json:"allowed_to_fail" desc:"If true, the task succeeds even if the command fails."`
Command []string `yaml:"command" json:"command" require:"A" desc:"The command and arguments to execute."`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files