ConditionalWidgetExistsStep class

Test step that will execute the whenTrue or whenFalse sub-step based on whether a Widget with a ValueKey with a value of testableId exists on the widget tree. This does not support a delay, it will immediately execute the whenTrue or whenFalse based on whether the Widget does or does not exist at the time of the start of this step. If the Widget may not immediately be on the tree, utilize the SleepStep to add the delay before executing this.

Constructors

ConditionalWidgetExistsStep({required String testableId, dynamic whenFalse, dynamic whenTrue})

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, inherited

driver → OverrideWidgetTester

Returns the test driver that can be used to interact with widgets.

no setter, inherited

find → CommonFinders

Returns the finder that can be used to locate widgets.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stepId → String

no setter

testableId → String

final

whenFalse → dynamic

final

whenTrue → dynamic

final

Methods

execute({required CancelToken cancelToken, required TestReport report, required TestController tester}) → Future<void>

Executes the step. This will execute the whenTrue or whenFalse based on whether a Widget with a ValueKey containing the testableId exists on the widget tree when this executes.

getBehaviorDrivenDescription(TestController tester) → String

Gets the most appropriate BDD string based on the values set on the step.

inherited

log(String message, {required TestController tester}) → void

Logs a message and posts it as a status update to the TestRunner.

inherited

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.

inherited

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.

inherited

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. The error flag informs the sleeper about whether the duration is a standard duration or an error based timeout.

inherited

toJson() → Map<String, dynamic>

Converts this to a JSON compatible map. For a description of the format, see fromDynamic.

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.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromDynamic(dynamic map) → ConditionalWidgetExistsStep?

Creates an instance from a JSON-like map structure. This expects the following format:

Constants

id → const String