LogVariablesStep class

Emits out one or all the current variables to the logs.

Constructors

LogVariablesStep({String? logLevel, String? variableName})

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 setterinherited
driver → OverrideWidgetTester
Returns the test driver that can be used to interact with widgets.
no setterinherited
find → CommonFinders
Returns the finder that can be used to locate widgets.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
logLevel String?
The log level to use when writing the variables out. As a note, the default level that the framework listens for is INFO, so you may need to change that level if you use more fine levels here.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stepId String
no setter
variableName String?
The name of the variable to log out. If set, only this specific variable will be logged. Otherwise, all variables will be logged.
final

Methods

execute({required CancelToken cancelToken, required TestReport report, required TestController tester}) Future<void>
Executes the step. This emit all the current variables using the appropriate level. If level is not set, or set to an invalid value, this will
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.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postStepSleep(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 _) 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. 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 Properties

behaviorDrivenDescriptions List<String>
no setter

Static Methods

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

Constants

id → const String