CommentStep class Null safety

Technically not a step but is instead a place where testers can put comments into the test. Comments will be emitted into the logs in addition to being viewable in the test editor itself.

Inheritance

Constructors

CommentStep({required String comment})

Properties

comment String
The comment to put in the test.
final
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

Methods

execute({required CancelToken cancelToken, required TestReport report, required TestController tester}) Future<void>
Attempts to locate the Testable identified by the testableId and will then set the associated value to the found widget.
override
getBehaviorDrivenDescription(TestController tester) String
Gets the most appropriate BDD string based on the values set on the step.
override
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. [...]
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.
override
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.
override
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.
override
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.
@protected, inherited

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. [...]
read-only, override

Static Methods

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

Constants

id → const String
'comment'