OpenTap.Cli Namespace Reference

Command Line Interface handling. More...

Classes
class	CliActionExecutor
	Helper used to execute ICliActions. More...
class	CommandLineArgumentAttribute
	When used on a property inside a ICliAction, this attribute indicates a command line arugment or switch. More...
class	ExitCodeException
	Thrown from OpenTap.Cli.ICliAction.Execute to set a specific exit code More...
interface	ICliAction
	Plugin type that defines a sub command for the OpenTAP CLI (tap.exe). Deriving from this, and annotating the class and any public properties with CommandLineArgumentAttribute and UnnamedCommandLineArgument attributes will allow it to be called from the OpenTAP CLI. More...
class	RunCliAction
	Test plan run CLI action. Execute a test plan with 'tap.exe run test.TapPlan' More...
class	UnnamedCommandLineArgument
	Used on properties of a ICliAction to define an unnamed arguments on the CLI. These can be ordered to handle cases where some values are required and others can occur multiple times. The property type will indicate how many will be consumed. The type can be either string or string[]. In case of string[] all the remaining arguments will be assigned to this property. More...

Enumerations
enum	ExitCodes {   Success = 0 , UserCancelled = 192 , GeneralException = 193 , UnknownCliAction = 194 ,   LicenseError = 195 , ArgumentParseError = 196 , ArgumentError = 197 , NetworkError = 198 ,   PackageResolutionError = 199 }
	ExitCodes reserved by OpenTAP. Uses range 192 to 255. OpenTAP Plugins should use positive numbers between 1 and 191 for custom error codes. For best cross platform compatibility all exitcodes should be positive and between 0 and 255. More...

Detailed Description

Command Line Interface handling.

Enumeration Type Documentation

ExitCodes

enum OpenTap.Cli.ExitCodes

ExitCodes reserved by OpenTAP. Uses range 192 to 255. OpenTAP Plugins should use positive numbers between 1 and 191 for custom error codes. For best cross platform compatibility all exitcodes should be positive and between 0 and 255.

Enumerator
Success	CLI action completed successfully
UserCancelled	User cancelled CLI action
GeneralException	CLI action threw an unhandled exception
UnknownCliAction	No CLI action found matching commands
LicenseError	CLI action missing a license
ArgumentParseError	Unable to parse one or more arguments
ArgumentError	One or more arguments is incorrect
NetworkError	Network error occurred
PackageResolutionError	Package resolution Error