OpenTAP 9.25
API Reference
Public Member Functions | Properties | List of all members
OpenTap.Cli.RunCliAction Class Reference

Test plan run CLI action. Execute a test plan with 'tap.exe run test.TapPlan' More...

Inheritance diagram for OpenTap.Cli.RunCliAction:
OpenTap.Cli.ICliAction OpenTap.ITapPlugin

Public Member Functions

int Execute (CancellationToken cancellationToken)
 Executes test plan More...
 

Properties

string Settings = "" [getset]
 Specify a bench settings profile from which to load the bench settings. The parameter given here should correspond to the name of a subdirectory of TAP_PATH%/Settings/Bench. If not specified, TAP_PATH%/Settings/Bench/Default is used.
 
string[] Search = new string[0] [getset]
 Additional directories to be searched for plugins. This option may be used multiple times, e.g., –search dir1 –search dir2.
 
string[] Metadata = new string[0] [getset]
 Set a resource metadata parameter. Use the syntax parameter=value, e.g., –metadata dut-id=5. This option may be used multiple times.
 
bool NonInteractive = false [getset]
 Never prompt for user input.
 
string[] External = new string[0] [getset]
 Set an external test plan parameter. Use the syntax parameter=value, e.g., -e delay=1.0. This option may be used multiple times, or a .csv file containing a "parameter, value" pair on each line can be specified as -e file.csv.
 
string[] TryExternal = new string[0] [getset]
 Try setting an external test plan parameter, ignoring errors if it does not exist in the test plan. Use the syntax parameter=value, e.g., -t delay=1.0. This option may be used multiple times
 
bool ListExternal = false [getset]
 List the available external test plan parameters.
 
string Results [getset]
 Enable a subset of the currently configured result listeners given as a comma-separated list, e.g., –results SQLite,CSV. To disable all result listeners use –results "".
 
bool IgnoreLoadErrors = false [getset]
 Ignore the errors for deserialization of test plan
 
string TestPlanPath = "" [getset]
 Location of test plan to be executed.
 

Detailed Description

Test plan run CLI action. Execute a test plan with 'tap.exe run test.TapPlan'

Member Function Documentation

◆ Execute()

int OpenTap.Cli.RunCliAction.Execute ( CancellationToken  cancellationToken)
inline

Executes test plan

Returns

Implements OpenTap.Cli.ICliAction.

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:25