OpenTAP 9.25
API Reference
Public Member Functions | Properties | List of all members
OpenTap.ITestStep Interface Reference

An interface for a TestStep. All TestSteps are instances of the ITestStep interface. More...

Inheritance diagram for OpenTap.ITestStep:
OpenTap.ITestStepParent OpenTap.IValidatingObject OpenTap.ITapPlugin OpenTap.TestStep

Public Member Functions

void PrePlanRun ()
 Called by TestPlan.Run() for each step in the test plan prior to calling the TestStepBase.Run() methods of each step.
 
void Run ()
 Called by TestPlan.Run() to run each TestStep. If this step has children (ChildTestSteps.Count > 0), then these are executed instead.
 
void PostPlanRun ()
 Called by TestPlan.Run() after completing all TestStepBase.Run() methods in the TestPlan More...
 
- Public Member Functions inherited from OpenTap.IValidatingObject
void OnPropertyChanged (string propertyName)
 Triggers the PropertyChanged event. More...
 

Properties

Verdict Verdict [getset]
 Gets or sets the verdict. Only available during TestStep run. This property value is propagated to the TestStepRun when the step run completes.

 
string Name [getset]
 Name of the step. Should be set by the user if using multiple instances of the same type.
 
bool Enabled [getset]
 Gets or sets boolean value that indicates whether this step is enabled in the TestPlan.

 
TestPlanRun PlanRun [getset]
 Gets or sets the current TestPlanRun.

 
TestStepRun StepRun [getset]
 Gets or sets the currently running and most recently started TestStepRun.
 
bool IsReadOnly [getset]
 Gets or sets boolean value that indicates whether this step is read only in the TestPlan.

 
string TypeName [get]
 Name of this TestStep type.

 
Guid Id [getset]
 Unique ID used for storing references to test steps.

 
- Properties inherited from OpenTap.ITestStepParent
ITestStepParent Parent [getset]
 Parent TestStep for this TestStep. Null if this TestStep is not a child of any other TestSteps. Only guaranteed to be set during TestPlan.Execute().
 
TestStepList ChildTestSteps [get]
 Gets or sets a list of child TestSteps. (Inherited from ITestStepParent)
 
- Properties inherited from OpenTap.IValidatingObject
ValidationRuleCollection Rules [get]
 A collection of all the currently defined validation rules. Add new rules here in order to get runtime value validation.
 

Detailed Description

An interface for a TestStep. All TestSteps are instances of the ITestStep interface.

------------------------------------------------------------------------------------------------—

The following attributes are mandatory

See also
ITestStepParent.Parent

[XmlIgnore]

------------------------------------------------------------------------------------------------—

The following attributes are recommended:

See also
ITestStepParent.ChildTestSteps

[XmlIgnore]

See also
Enabled

[Browsable(false)] [ColumnDisplayName("", Order = -101)]

See also
Id

[XmlAttribute("Id")] [Browsable(false)]

See also
PlanRun

[Browsable(false)]

See also
StepRun

[Browsable(false)]

See also
IsReadOnly

[XmlIgnore] attribute.

See also
TypeName

[ColumnDisplayName("Step Type", Order = 1)] [Browsable(false)]

See also
Verdict

[Browsable(false)] [ColumnDisplayName(Order = -99)] [XmlIgnore] [Output]

Member Function Documentation

◆ PostPlanRun()

void OpenTap.ITestStep.PostPlanRun ( )

Called by TestPlan.Run() after completing all TestStepBase.Run() methods in the TestPlan

Note that TestStep.PostPlan run is run in reverse order For example, if you had three Tests (T1, T2, and T3), and T2 was disabled, then PrePlanRun would run for T1 and T3 (in that order) PostPlanRun would run for T3 and T1 (in that order)

Implemented in OpenTap.TestStep.

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