AssertFirestoreValueStep class
Test step that asserts that the value equals (or does not equal) a specific value.
Constructors
- AssertFirestoreValueStep({required String collectionPath, required String documentId, required bool equals, required String? value})
Properties
- collectionPath → String
-
The collection path to look for the Document in.
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.
no setterinherited
- documentId → String
-
The id of the Document to look for.
final
- driver → OverrideWidgetTester
-
Returns the test driver that can be used to interact with widgets.
no setterinherited
- equals → bool
-
Set to
true
if the value from theTestable
must equal the set value. Set tofalse
if the value from theTestable
must not equal the value.final - find → CommonFinders
-
Returns the finder that can be used to locate widgets.
no setterinherited
- 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
- value → String?
-
The value to test againt when comparing the
Testable
's value.final
Methods
-
execute(
{required CancelToken cancelToken, required TestReport report, required TestController tester}) → Future< void> - Executes the step. This will first look for the Document then compare the value form the document to the value.
-
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 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. Theerror
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) → AssertFirestoreValueStep? - Creates an instance from a JSON-like map structure. This expects the following format: