README
¶
run_task_matrix Task
Description
The run_task_matrix task is designed to execute a specified task multiple times, each with different input values drawn from an array. This task is ideal for scenarios where you need to test a task under various conditions or with different sets of data.
Configuration Parameters
-
runConcurrent:
Determines whether the child tasks (instances of the task being run for each matrix value) should run concurrently or sequentially. Iftrue, all tasks run at the same time; iffalse, they run one after the other. -
succeedTaskCount:
The number of child tasks that need to succeed (result status "success") for therun_task_matrixtask to stop and return a success result. A value of 0 means all child tasks need to succeed for the overall task to be considered successful. -
failTaskCount:
The number of child tasks that may to fail (result status "failure") before therun_task_matrixtask to stops and returns a failure result. A value of 0 means that the appearance of any failure in child tasks will cause the overall task to fail. -
failOnUndecided:
If set to true, therun_task_matrixtask will fail if neither thesucceedTaskCountnor thefailTaskCountis reached. -
matrixValues:
An array of values that form the matrix. Each value in this array is used to run the child task with a different input. -
matrixVar:
The name of the variable to which the current matrix value is assigned for each child task. This allows the child task to access and use the specific value from the matrix. -
task:
The definition of the task to be executed for each matrix value. This task is run repeatedly, once for each value in thematrixValuesarray, with the current value made accessible via the variable named inmatrixVar.
Defaults
Default settings for the run_task_matrix task:
- name: run_task_matrix
config:
runConcurrent: false
succeedTaskCount: 0
failTaskCount: 0
failOnUndecided: true
matrixValues: []
matrixVar: ""
task: {}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "run_task_matrix" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Run a task multiple times based on an input array.", Config: DefaultConfig(), NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
// matrix variable name
RunConcurrent bool `yaml:"runConcurrent" json:"runConcurrent"`
// number of successful child tasks to make this task succeed (0 = all tasks)
SucceedTaskCount uint64 `yaml:"succeedTaskCount" json:"succeedTaskCount"`
// number of failed child tasks to make this task fail (0 = all tasks)
FailTaskCount uint64 `yaml:"failTaskCount" json:"failTaskCount"`
// fail task if neither succeedTaskCount nor failTaskCount is reached, but all tasks completed
FailOnUndecided bool `yaml:"failOnUndecided" json:"failOnUndecided"`
// matrix variable name
MatrixValues []interface{} `yaml:"matrixValues" json:"matrixValues"`
// matrix variable name
MatrixVar string `yaml:"matrixVar" json:"matrixVar"`
// child task
Task *helper.RawMessageMasked `yaml:"task" json:"task"`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files