Open sourceActive

Patrol

Patrol 4.0 introduces Platform Automation API, deprecating native automation entry points.

Field note

What it does

Patrol is an end-to-end UI testing framework for Flutter apps. Version 4.0 introduces the Platform Automation API and starts deprecating legacy native automation entry points like $.native and $.native2. This page provides migration guidance from native to platform automation.

Capabilities

Available capabilities

Cross-platform mobile actions Batching strategy Remote test parsing iOS-only actions Custom Finders Native Test Execution Native test artifact build Cloud Device Farm Integration Android-only actions Platform Automation XCTest parsing Web automation Build-time Test Discovery Mobile Automation Parallel Test Execution Platform Automation API Selector types

Android Espresso Support

Supports running Patrol tests as Espresso tests on Android.

Android support

Emits standard instrumentation APKs for Android testing.

Automated Testing

Automates end-to-end testing workflow for Flutter apps.

Browser Dialog Handling

E2E testing

End-to-end testing for Flutter apps.

iOS simulator support

Registers XCTest methods at runtime for iOS simulator testing.

iOS XCUITest Support

Supports running Patrol tests as XCUITest on iOS.

Marathon integration

Integrates with Marathon for parallel execution on local device pools.

Native automation deprecation

Native feature testing

Test native features in Flutter apps.

Network Condition Control

Enable or disable Wi-Fi, cellular, and other network conditions.

Notification Interaction

Open notifications and tap on them.

Patrol build command

patrolWidgetTest

A test function that provides PatrolTester for simplified testing.

Permission Handling

Handle native location permission request dialogs and grant permissions.

Sharding Support

Supports sharding XCUITest tests on SauceLabs using an explicit list of test identifiers.

Simplified Finders

Custom finders that reduce boilerplate compared to standard Flutter finders.

Stable and Maintainable Tests

Helps write stable, maintainable, and meaningful tests.

System Theme Toggle

Toggle dark mode and other system themes.

UI testing

UI testing for Flutter apps.

UI Testing Framework

Patrol is a powerful UI testing framework for Flutter apps.

waitUntilVisible

Waits until a widget is visible.