EnsureExistsStep class Null safety

Test step that ensures a particular widget exists on the widget tree before continuing.



EnsureExistsStep({required String testableId, Duration? timeout})


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.
read-only, inherited
driver → OverrideWidgetTester
Returns the test driver that can be used to interact with widgets.
read-only, inherited
find → CommonFinders
Returns the finder that can be used to locate widgets.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
stepId String
read-only, override
testableId String
The id of the Testable widget to interact with.
timeout Duration?
The maximum amount of time this step will wait while searching for the Testable on the widget tree.


execute({required CancelToken cancelToken, required TestReport report, required TestController tester}) Future<void>
Executes the test step by ensuring the Testable with the given id exists on the widget tree before continuing. This will throw an error is the Testable with the set testableId cannot be found on the tree before the timeout is exceeded.
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.
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
postStepSleep(Duration duration) Future<void>
Overidden to ignore the delay
preStepSleep(Duration duration) Future<void>
Overidden to ignore 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. The error flag informs the sleeper about whether the duration is a standard duration or an error based timeout. [...]
@protected, 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.
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.
@protected, inherited


operator ==(Object other) bool
The equality operator. [...]

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. [...]

Static Methods

fromDynamic(dynamic map) EnsureExistsStep?
Creates an instance from a JSON-like map structure. This expects the following format: [...]


id → const String