README
¶
run_external_tasks Task
Description
The run_external_tasks task is designed to execute a set of tasks specified in an external test playbook. This functionality is key for integrating modular and reusable test configurations that are maintained outside the primary Assertoor configuration file.
Configuration Parameters
-
testFile:
The path to the external test playbook file. This file contains the configuration for the tasks to be executed, including task definitions and any specific settings required for those tasks. -
testConfig:
A dictionary of static configuration parameters that are passed to the external test playbook. These configurations are used to customize or override settings within the external test playbook. -
testConfigVars:
A dictionary of dynamic variable expressions that are evaluated and also passed to the external test playbook. -
expectFailure:
A boolean that specifies whether the task is expected to fail. If set totrue, the task will be considered successful if the external tasks fail. -
ignoreFailure:
A boolean that indicates whether failures in the external tasks should be ignored. Iftrue, therun_external_taskstask will report success regardless of any failures that occur during the execution of the external tasks. This can be useful when the outcomes of the tasks are not critical to the overall test objectives.
Defaults
Default settings for the run_external_tasks task:
- name: run_external_tasks
config:
testFile: ""
testConfig: {}
testConfigVars: {}
expectFailure: false
ignoreFailure: false
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "run_external_tasks" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Run external test playbook.", Category: "flow-control", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{}, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
TestFile string `yaml:"testFile" json:"testFile" require:"A" desc:"Path to the external test file to execute."`
TestConfig map[string]any `yaml:"testConfig" json:"testConfig" desc:"Configuration values to pass to the external test."`
TestConfigVars map[string]string `yaml:"testConfigVars" json:"testConfigVars" format:"expressionMap" desc:"Variable mappings for external test configuration."`
ExpectFailure bool `yaml:"expectFailure" json:"expectFailure" desc:"If true, expect the external test to fail (inverts success condition)."`
IgnoreFailure bool `yaml:"ignoreFailure" json:"ignoreFailure" desc:"If true, ignore failures from the external test."`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files