TestRunnerStep class abstract
Abstract step that all other test steps must extend.
- Implementers
- AssertErrorStep
- AssertSemanticsStep
- AssertValueStep
- CommentStep
- DismissKeyboardStep
- DoubleTapStep
- DragStep
- EnsureExistsStep
- ExitAppStep
- GoBackStep
- LongPressStep
- RemoveGlobalVariableStep
- RemoveVariableStep
- ScreenshotStep
- ScrollUntilVisibleStep
- SetGlobalVariableStep
- SetValueStep
- SetVariableStep
- SleepStep
- TapStep
- Annotations
Constructors
Properties
- defaultStepTimeout → Duration
-
Returns the default timeout for the step. Steps that should respond
quickly should use a relatively low value and steps that may take a long
time should return an appropriately longer time.
no setter
- driver → OverrideWidgetTester
-
Returns the test driver that can be used to interact with widgets.
no setter
- find → CommonFinders
-
Returns the finder that can be used to locate widgets.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stepId → String
-
no setter
Methods
-
execute(
{required CancelToken cancelToken, required TestReport report, required TestController tester}) → Future< void> - Function that is called when the step needs to execute.
-
getBehaviorDrivenDescription(
TestController tester) → String - Gets the most appropriate BDD string based on the values set on the step.
-
log(
String message, {required TestController tester}) → void - Logs a message and posts it as a status update to the TestRunner.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
postStepSleep(
Duration duration) → Future< void> - Gives the test step an opportunity to sleep after the step has been executed. Steps that do not interact with the application may choose to override this and reduce or elimate the delay.
-
preStepSleep(
Duration duration) → Future< void> - Gives the test step an opportunity to sleep before the step has been executed. Steps that do not interact with the application may choose to override this and reduce or elimate the delay.
-
sleep(
Duration duration, {required Stream< void> ? cancelStream, bool error = false, String? message, required TestController tester}) → Future<void> -
Sleeps for the defined Duration. This accept an optional
cancelStream
which can be used to cancel the sleep. Theerror
flag informs the sleeper about whether the duration is a standard duration or an error based timeout. -
toJson(
) → Map< String, dynamic> -
Abstract function that concrete classes must implement. This must encode
the internal data model to a JSON compatible representation.
inherited
-
toString(
) → String -
Returns the string encoded JSON representation for this class. This will
remove all null values and empty collections from the returned string.
inherited
-
waitFor(
dynamic testableId, {required CancelToken cancelToken, required TestController tester, Duration? timeout}) → Future< Finder> -
Waits for a widget with a key that has
testableId
as the value.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
-
behaviorDrivenDescriptions
→ List<
String> -
Returns the Behavior Driven Development description for the test step.
The results of this may be in Markdown and this provides a description of
the test step in a way that is more easily understood by non-developers.
final