patrol_finders library
Streamlined, high-level API on top of flutter_test.
Classes
- PatrolFinder
-
Patrol custom finder, also known as
$. - PatrolTester
-
PatrolTester wraps a WidgetTester. It provides support for Patrol
custom finder, a.k.a
$. - PatrolTesterConfig
- Common configuration for PatrolTester and PatrolFinder.
Enums
- SettlePolicy
- Specifies how methods such as PatrolTester.tap or PatrolTester.enterText perform pumping, i.e. rendering new frames.
Extensions
-
ActionCombiner
on Future<
PatrolFinder> - Useful methods that make chained finders more readable.
Constants
- defaultScrollDelta → const double
- Default amount to drag by when scrolling.
- defaultScrollMaxIteration → const int
- Default maximum number of drags during scrolling.
Functions
-
createFinder(
dynamic matching) → Finder -
Creates a Finder from
matching. -
patrolWidgetTest(
String description, PatrolWidgetTestCallback callback, {bool? skip, Timeout? timeout, bool semanticsEnabled = true, TestVariant< Object?> variant = const DefaultTestVariant(), dynamic tags, PatrolTesterConfig config = const PatrolTesterConfig()}) → void - Like testWidgets, but with support for Patrol custom finders.
Typedefs
-
PatrolWidgetTestCallback
= Future<
void> Function(PatrolTester $) - Signature for callback to patrolWidgetTest.
Exceptions / Errors
- PatrolFinderException
- Thrown when some PatrolFinder's method fails.
- PatrolTimeoutException
- Thrown when some Patrol method fails to complete within the allowed time.
- WaitUntilExistsTimeoutException
- Thrown when PatrolFinder did not find anything in the allowed time and timed out.
- WaitUntilVisibleTimeoutException
- Indicates that PatrolFinder did not find anything in the allowed time and timed out.