patrol 3.19.0

patrol: ^3.19.0 copied to clipboard

• Fix logging for $.native.pullToRefresh() and $.native.swipeBack(). (#2707)
• Fix $.native.enableDarkMode() and $.native.disableDarkMode() on iOS 18 simulators. (#2705)
• Add support for de, fr and pl languages for native methods that operates on strings. (#2659)
• Add support for gallery permission dialog on iOS 17. (#2659)
• Keep the app running after last step in patrol develop. (#2693)

• Bump leancode_lint to 17.0.0.
• Bump patrol_log to 0.5.0.
• Bump minimum Dart SDK to version 3.8.0.

• Add takeCameraPhoto method. (#2660)
• Add pickImageFromGallery method (#2660)
• Add pickMultipleImagesFromGallery (#2660)
• Add isVirtualDevice method (#2660)
• Add getOsVersion method (#2660)
• Allow passing null to $.native.getNativeViews() (#2660)
• Add $.native.swipeBack() method (#2608)
• Add $.native.pullToRefresh() method (#2665)

• Make activity aliases work in PatrolJUnitRunner
• Update test reports to show all exceptions thrown in Flutter. (#2362)
• Bump min Flutter SDK to 3.32.0 (#2649)

• Bump vm_service dependency to 15.0.0 (#2636)

• Fix $.enterText() issues (#2570)
• Add setMockLocation method. (#2547)
• Bump custom_lint to 0.7.0 and leancode_lint to 14.3.0. (#2574)
• Upgrade http4k to 5.47.0.0. (#2559)

• Make activity aliases work in PatrolJUnitRunner

• Bump patrol plugin iOS and macOS deployment targets to 12.0. (#2514)
• Bump Gradle version in the example app so it's possible to build them on the latest JDK 23 (#2503)
• Fix $.native.tap() not working with Selector having instance set. (#2501)
• Fix not disposed semantics issue in Flutter 3.29.0 (#2530)

• Remove exception from StepEntry. When it was too long, it caused crash because of badly formed JSON. (#2481)
• Bump patrol_finders and patrol_log versions.
• Bump compileSdk to 35. (#2488)
• Bump Gradle to 8.9.0. (#2488)
• Make Patrol works with Java 21. (#2488)

• Bump patrol_finders and patrol_log - use version with patched enterText. (#2468)

• Remove whitespace replacement on Android test name. (#2437)

• Add support for the patrol_log package. (#2387)
• Fix tapping on notification on iOS 18. (#2394)
• Fix macos functionality. (#2408)
• Bump patrol_finders and enable logging.

This version requires version 3.4.0 of patrol_cli package.

• Add clear-permissions flag on ios commands. (#2367)

This version requires version 3.3.0 of patrol_cli package.

• Bump min Flutter SDK to 3.24.0 and Dart SDK to 3.5.0 (#2371)

• Replace whitespace in test case name in PatrolJUnitRunner.java. (#2361)

• Add code coverage collection support. (#2294)
• No throw error in selectFineLocation when it's already selected. (#2302)
• Add option to select tap location in enterText and enterTextByIndex (#2312)

This version requires version 3.2.0 of patrol_cli package.

• Implement enableBluetooth and disableBluetooth methods for Android > 11. (#2254)
• Implement enableAirplaneMode and disableAirplaneMode methods for Android. (#2254)
• Implement enableLocation and disableLocation methods for Android. (#2259)
• Fix opening settings app with clean state on iOS. (#2275)
• Add native skip. (#2278)
• Add tags and exclude-tags. (#2286)

• Add privacy manifest for Apple.
• Disabled use of system proxy in iOS/macOS (could lead to broken tests).
• Fix complete breakage of MacOS automations introduced in #2219.

• Add openUrl(String url) method, for testing deeplinks. (#2219)
• Add pressVolumeUp and pressVolumeDown(). (#2223)

• Try closing system dialog when disabling wifi on iOS. (#2123)

• Bump test_api dependency to 0.7.0.
• Bump patrol_devtools_extension dependencies.
• Bump min Flutter SDK to 3.22

• Revert: Bump patrol_devtools_extension dependencies.
• Revert: Bump test_api dependency to 0.7.0.

• Bump test_api dependency to 0.7.0.
• Bump patrol_devtools_extension dependencies.
• Support customization of doubleTap delay (Android only). (#2165)

• Fix clearing textfield before entering text on iOS (#2158).

• Add clearing textfield before entering text on iOS (#2145).
• Added the NativeAutomator2, which allows to interact with native using selectors designated for a specific platform (AndroidSelector and IOSSelector) (#2132).
• Add support for --app-server-port and --test-server-port on Android (#2154).

• Fix reporting fail cause to native on ios in release mode (#2114).

• Make more Selector properties work on iOS (#2030).
• Fix handling denying Android permissions when invoked second time (#2112).

• Add optional timeout parameter to native methods (#2042).
• Add $.native.tapAt() (#2053)
• Fix native.enterText interacting with first EditText regardless of Selector passed (Android-only) (#2072)
• Print link to devtools regardless of open-devtools flag (#2076).

• Allow for changing the port when running on iOS (#2027).

  To do so, pass test-server-port (default 8081) and app-server-port (default 8082) to Patrol CLI commands (e.g patrol test)

• Fix patrolSetUp() and patrolTearDown() not working in patrol develop (#2023).

This version requires version 2.6.0 of patrol_cli package.

• Enable selecting individual tests with xcodebuild's -only-testing option. Currently iOS only, does not support macOS (#2001)
• Fix being unable to interact with the running app during testing with a finger (#2008)
• Fix non-ASCII characters displaying as gibberish in Patrol's DevTools extension (#2010)
• Fix Dart-side crash in test causing test suite to hang on iOS (#2013)

• Add support for running patrol tests on macOS (alpha) (#1847)

• Implement patrolSetUp() and patrolTearDown(), which are equivalents of vanilla setUp() and tearDown() but work with Patrol's native automation and test bundling feature (#1967) (#1721)

• Implement $.native.swipe() on iOS (#1927)

• Add screenshots to pubspec.yaml (#1917)

• Bump dependencies for Flutter 3.16 and Dart 3.2
• Populate topics in pubspec

• Fix extension code not being bundled by GitHub Actions workflow (#1902)

Give a warm welcome to the new Patrol DevTools Extension!

Patrol DevTools extension allows you to explore the native view hierarchy when developing tests with patrol develop. Now you can easily see what Android / iOS views are currently visible and discover their properties so that they can be used in native selectors like $.native.tap(). You don't have to use any external tools for that. This is just the beginning, and we plan to add more features to our extension in the future.

Other changes:

• Bump minimum supported Flutter version to 3.16

• BREAKING:

  • Remove bindingType parameter from patrolTest() function. Now only PatrolBinding is used and it's automatically initialized (#1882)
  • Remove nativeAutomation parameter from patrolTest() function. Now it's enabled by default (#1882)
  • This release also depends on patrol_finders v2 and includes its breaking changes.

• Remove dependency on integration_test plugin (#1882)

This version requires version 2.3.0 of patrol_cli package.

• Add PatrolFinder.longPress() (#1825)

• Add support for iOS 11 and 12 (#1733)
• Fix build-time and run-time crashes when app doesn't use Kotlin 1.8.x (#1782)

• Add support for nested test hierarchies using group()s (#1634)
• Replace Protocol Buffers and gRPC with a custom code generation solution that is more lightweight (#1681)
• Fix test name label blocking hit testing (#1731)

This version requires version 2.2.0 of patrol_cli package.

• Fix grantPermissionOnlyThisTime() crashing on Android <11 (#1698)

• Remove deprecation of nativeAutomation and add message about migration to patrol_finders (#1670)

• Make KeyboardBehavior.alternative not automatically try to hide the keyboard on iOS (#1638)

• Fix deprecation message for andSettle (settleBehavior -> settlePolicy) (#1622)

• Fix appId parameter missing from NativeAutomator.waitUntilVisible() (#1611)
• Fix tests crashing by stopping depending on dart:io when running with flutter_driver on the Web (#1578)

• Use proper context in PatrolJUnitRunner (#1591)
• Make Selector.instance work on iOS (#1569)
• Ignore calls to select[Fine|Coarse]Location() on iOS < 14 (#1564)
• Add support for getNativeViews on iOS (#1553)

• Add $.native.waitUntilVisible() (#1543)
• Add KeyboardBehavior enum to native enterText() methods (#1511)

• Add an alternative BrowserstackPatrolJUnitRunner, which implements a fix to make tests run on BrowserStack (#1402)

• Implement $.native.openQuickSettings() for iPhones without notch (#1510)

• Fix occasional cryptic failures of Gradle builds (#1509)

• Fix tests occasionally failing on iOS because of dangling SemanticsHandles (#1491)

• Remove dependency on package:http (#1485)

• Fix enterText() not working when running with flutter_driver on the web (#1459)

• Fix WebViews on modern Android versions (#1398). See #244 for more details.
• Implement a proper fix for tests failing when using native automation on Android + Flutter 3.10 (#1398). This replaces a workaround implemented in #1352
• Bump dependencies (#1446)

This version requires version 2.0.1 of patrol_cli package.

Patrol 2.0 is released!

• Read the changelog and migration guide here
• Read the article about how Patrol 2.0 fixes the integration_test plugin here

This version requires version 2.0.0 of patrol_cli package.

• Fix tests failing when using native automation on Android + Flutter 3.10 (#1352)

• Fix build with Android Gradle Plugin v8 (#1276)

• Fix which() not taking previous finder(s) into account (#1271)

• Fix crashing when using Gradle 8 (#1262)

• Add support for Flutter 3.10 (#1254)

This version marks the official release of Hot Restart. Learn more here.

This version requires version 1.1.4 of the patrol_cli package

• Rewrite native test reporting (#1178)

• Fix App Store warnings about non-public selectors from patrol.framework (#1096)

• Fix tap() sometimes not being able to tap on a widget that was previously found and scrolled to by scrollTo() (#1072)

• Add preliminary support for patrol develop. Requires version 1.0.6 of patrol_cli.

• Update small typo in pub.dev listing (#1034)

• Fix build of example app for Android when building on Windows (#998)

• Remove unnecessary dependency on vm_service (#986)

• Fix PATROL_WAIT (passed through --wait argument to patrol test) preventing frames from being pumped (#959)
• Fix tapping on notification crashing on iPads (#963)
• Remove no longer functional methods from PatrolBinding (#970)

• Make NativeAutomator.enterTextByIndex() have a default timeout, just like NativeAutomator.enterText() (#943)

  Documentation of these 2 methods has also been updated to explain the behavior in more detail.

• Use automated publishing with GitHub Actions on pub.dev (#953) (#955) (#956) (#957)

• Fix IndexOutOfBounds exception when waiting for native views on Android (#939)
• Fix flutter run not working in example app because of an error in Gradle build file (#940)

• Patrol 1.0 is released!

• Minor documentation fixes (#912)

• Remove unnecessary dependency on json_serializable and json_annotation (#904)

• Fix crash Instrumentation run failed due to Process crashed on Android (#902)

• Improve error message when trying to use NativeAutomator, but it's not initialized (#856)

• Add GitHub Actions showing to run Patrol tests natively on both Android and iOS (#747, #752)
• Add PatrolTestRunner class, which should be used instead of FlutterTestRunner in MainActivityTest.java file (#754)

• Strip out code that App Store is angry about by default in release iOS builds (#727)

• Make it possible to change LiveTestWidgetsFlutterBindingFramePolicy in patrolTest() (#716)

• Add support for test label overlay in PatrolBinding (#701)

• Migrate to lite Protocol Buffers and gRPC to avoid conflicts with Firebase on Android (#688)

• Fix Android dependencies leaking into dependent apps (#683)

• Fix breaking iOS builds by migrating off CGVectorMake(), which is unavailable in Swift (#676)

• Fix breaking iOS builds by setting minimum iOS version to 13.0 (#674)

• Allow for running as native Android/iOS instrumented test (Patrol Next) (#646, #671)

• Add NativeAutomator.swipe() to enable simple swiping (#669)

• Breaking: Remove PatrolTester.log() - it did not fit in there and was rarely used (#665)
• Breaking: Remove PatrolTesterConfig.appName - it's only usage was in PatrolTester.log(), and since it was removed, this field is removed as well (#665)

• Breaking: Change signature of PatrolTester.pumpAndSettle() method to use named arguments (#657)
• Fix PatrolTester.dragUntilVisible() not calling first on its Finder view parameter (#656)

• Make it possible to configure loggers of NativeAutomator and HostAutomator (#644)
• Throw PatrolFinderException when PatrolFinder.text fails (#644)

• Revamp configuration of testers, letting for more granural setup (#640):
  • Rename PatrolTestConfig to PatrolTesterConfig
  • Introduce NativeAutomatorConfig
  • Introduce HostAutomatorConfig
• Introduce HostAutomator.run() method, which lets you run programs on your computer from within your Flutter integration tests (#630)

• Fix minor bug with custom binding initialization (#636)

• Add patrolIntegrationDriver, which extends the default integrationDriver with cool features like taking screenshots. More features enabled by patrolIntegrationDriver are coming soon! (#593)
• Warn when package name and bundle identifier is not set in PatrolTestConfig (#591)

• Add PatrolFinder.which() (#571)

• Add andSettle param to PatrolFinder.scrollTo() (#501)
• Add more integration tests to the example app (#491)

In this release, we've focused on stability, reliability, and reducing flakiness.

• Add timeouts when interacting with native UI (#437)
• Implement isPermissionDialogVisible() method (#448)

• Add useBinding flag to patrolTest (#419)

• Breaking: Rename NativeAutomator.forTest() constructor to an unnamed constructor (#410)
• Add useBinding flag to NativeAutomator constructor. Defaults to true, which means that PatrolBinding is initialized during the constructor call (#410)
• Fix timeout argument to NativeAutomator being ignored (#410)

• Make $() accept a Widget as an argument (#402)

• Remove the unused appId argument from most methods (#399)
• Breaking: Rename getNativeWidgets() to getNativeViews() (#399)

• Fix handling permission prompts now working in some edge cases (#383)

• Fix package score on pub.dev (#375)

• Implement enabling and disabling cellular on iOS (#371)

• Make openApp() open the app under test when no appId is passed (#338)
• Implement enableWifi(), disableWifi(), and openRecentApps() on iOS (#338)
• Completely rewrite communication with native automation servers (#338)

• Implement enabling and disabling dark mode on iOS (#345)

• Fix spelling of "cellular" (was "celluar") (#336)
• Fix a typo in docs (#337)
• Fix README and docs mentioning the removed Patrol class (#349)

• A bunch of post-release fixes (#330)

• Stop re-exporting package:flutter_test (#308)

• Don't require host and port to be defined in patrol.toml or passed in as command-line arguments (#301)
• Rename Patrol to NativeAutomator and embed it in PatrolTester (#297)
• Print cleaner, more readable logs when native action fails (#295)

• Fix handling native permission request dialogs on older Android versions (#260)
• Populate homepage field in pubspec.yaml (#254)

• Rename to patrol (#258)
• Remove sleep from MaestroTestConfig. Use the new --wait argument available in the CLI (#251)

• Bring more functionality to iOS (#246)
  • Implement native tap(), enterText(), and handlePermission() methods on iOS
  • Maestro.forTest(): add optional packageName and bundleId arguments

• Add support for handling native permission request dialogs on Android (#232)
• Attempt to fix a weird issue with scroll not working in some rare cases (#237)
• Re-export package:flutter_test

• Make MaestroFinder.text getter more robust

• Fix a problem with StateError being thrown when MaestroTester.dragUntilVisible found more than 1 finder after dragging to it (#228)

• Some fixes to the scrolling and dragging

• Set minimum Dart version to 2.17 (#224)

• Revamp scrolling and dragging (#217)

  • New MaestroTester.dragUntilExists()
  • Fixed MaestroTester.dragUntilVisible()'s behavior
  • New MaestroTester.scrollUntilExists method
  • New MaestroTester.scrollUntilVisible method
  • MaestroFinder.dragTo was renamed to MaestroFinder.scrollTo and now also scrolls to widgets that are not yet built (e.g in a lazily-built ListView)

• Allow for more fine-grained control over timeouts (#191)

  • settleTimeout, which is used for MaestroTester.pumpAndSettle (which forwards it to WidgetTester.pumpAndSettle)
  • existsTimeout, which is used for MaestroFinder.waitUntilExists
  • visibleTimeout (previously findTimeout), which is used by MaestroFinder.waitUntilVisible (which is then used internally by MaestroFinder.tap() and MaestroFinder.enterText().

• Downgrade package:freezed to v1 beacuse customer project is not able to update to v2

• Create MaestroTestConfig class which is accepted by maestroTest function. Use it to share common configuration across all tests
• Upgrade package:freezed to v2. Dependent projects should also make this change

MaestroFinder:

• Rename visible method to waitUntilVisible
• Add waitUntilExists method
• Add exists getter
• Add visible getter

• Add MaestroFinder.dragTo
• Remove unused MaestroTester.drag and MaestroTester.dragFrom

• Convert MaestroFinder.visible getter to a method, which now also takes a timeout
• Rename MAESTRO_ARTIFACT_PATH environment variable to `MAESTRO_CACHE
• Fix MaestroTester.dragUntilVisible not waiting for the scrollable to appear
• Fix MaestroFinder.allCandidates returning incorrect results

• Throw MaestroFinderFoundNothingException when [MaestroFinder.visible] doesn't find any widget during [MaestroTester.findTimeout]

MaestroFinder:

• Now tap() and enterText() wait for the widget to become visible. The timeout can be configured by setting findTimeout in maestroTest()
• Remove index parameter from tap() and enterText(). The new way to select the widget to be tapped is to use at() before tapping. Same goes for entering text
• Add bool andSettle parameter to maestroTest function. This lets you globally configure whether to call pumpAndSettle after actions such as tap() or enterText()
• Refactor MaestroTester.dragUntilVisible to be simpler to use
• Rename withDescendant() to containing()

Native:

• Make Maestro.openNotifications() and Maestro.openQuickSettings() more robust

• Make it possible to pass Flutter's Finder to $
• Make MaestroFinder.first, MaestroFinder.last, MaestroFinder.at() return MaestroFinder, not Finder

• Improve selector engine:

  • Make it possible to pass a Key as matching to MaestroTester.call(dynamic matching) and MaestroFinder.$(dynamic matching)

• Add sleep parameter for maestroTest method

• Make WidgetTester's forwarded methods in MaestroTester accept less arguments

• Add more in-code documentation

• Improve selector engine:

  • Make it possible to pass a MaestroFinder as matching to MaestroTester.call(dynamic matching) and MaestroFinder.$(dynamic matching)
  • Fix a bug which caused chaining MaestroFinders (e.g $(Scaffold).$(Container).$(#someText)) to not work.

• Add more in-code documentation and improve README

• Add selector engine

• Introduce Selector class, which can be passed into Maestro.tap(selector).

• Add more platform functionality:

  • Maestro.enableWifi() and Maestro.disableWifi()
  • Maestro.enableCellular() and Maestro.disableCellular()
  • Maestro.enableDarkMode() and Maestro.disableDarkMode()
  • Maestro.getNotifications(), Maestro.getFirstNotification(), and Maestro.tapOnNotification(int index)

• Make Maestro.forTest() automatically call IntegrationTestWidgetsFlutterBinding.ensureInitialized()

• Fix many smaller issues

• Allow for running on many devices simultaneously
• Rename class Automator to Maestro
• Simpified test-side initialization. Now all you need is Maestro.forTest()
• Simpified driver-side initialization. Now all you need is Maestro.forDriver()

• Add support for enabling/disabling Bluetooth

• Be more noisy when an error occurs

• Fix minor logging bug

• Add basic means of controlling platform-native Widgets (TextView, EditText, and Button on Android). This also applies to WebView.
• Add enabling and disabling of Wi-Fi, Cellular, and Night Mode
• Improve stability

• Set minimum Dart version to 2.16
• Fix links to package:leancode_lint in README

• Update broken link in README.

• Update README

• Rename from maestro to maestro_test

• Split maestro and maestro_cli into separate packages

• Initial version