base on Flutter-first UI testing framework. Ready for action! # Patrol [![patrol on pub.dev][patrol_badge]][patrol_link] [![patrol_finders on pub.dev][patrol_finders_badge]][patrol_finders_link] [![patrol_cli on pub.dev][patrol_cli_badge]][patrol_cli_link] [![code style][leancode_lint_badge]][leancode_lint_link] [![powered by][docs_page_badge]][docs_page_link] ![Patrol promotial graphics][promo_graphics] Simple yet powerful Flutter-first UI testing framework overcoming limitations of `flutter_test`, `integration_test`, and `flutter_driver`. Created and supported by [LeanCode](https://leancode.co). Learn more about Patrol: - [Our extensive documentation][docs] - [The article about the test bundling feature in Patrol 2.0][article_2x] - [The first stable 1.0 release article][article_1x] - [The article about the first public release][article_0x] ## Patrol custom finders Flutter's finders are powerful, but not very intuitive to use. We took them and made something awesome. Thanks to Patrol's custom finders, you'll take your tests from this: ```dart testWidgets('signs up', (WidgetTester tester) async { await tester.pumpWidget(AwesomeApp()); await tester.pumpAndSettle(); await tester.enterText( find.byKey(Key('emailTextField')), '[email protected]', ); await tester.pumpAndSettle(); await tester.enterText( find.byKey(Key('nameTextField')), 'Charlie', ); await tester.pumpAndSettle(); await tester.enterText( find.byKey(Key('passwordTextField')), 'ny4ncat', ); await tester.pumpAndSettle(); await tester.tap(find.byKey(Key('termsCheckbox'))); await tester.pumpAndSettle(); await tester.tap(find.byKey(Key('signUpButton'))); await tester.pumpAndSettle(); expect(find.text('Welcome, Charlie!'), findsOneWidget); }); ``` to this: ```dart patrolTest('signs up', (PatrolIntegrationTester $) async { await $.pumpWidgetAndSettle(AwesomeApp()); await $(#emailTextField).enterText('[email protected]'); await $(#nameTextField).enterText('Charlie'); await $(#passwordTextField).enterText('ny4ncat'); await $(#termsCheckbox).tap(); await $(#signUpButton).tap(); await $('Welcome, Charlie!').waitUntilVisible(); }); ``` [Learn more about custom finders in the docs][docs_finders]! Patrol's custom finders are also available standalone in [the patrol_finders package][patrol_finders_link]. ## Patrol native automation Flutter's default [integration_test] package can't interact with the OS your Flutter app is running on. This makes it impossible to test many critical business features, such as: - granting runtime permissions - signing into the app which through WebView or Google Services - tapping on notifications - [much more!](https://patrol.leancode.co/native/feature-parity) Patrol's native automation feature solves these problems: ```dart void main() { patrolTest('showtime', (PatrolIntegrationTester $) async { await $.pumpWidgetAndSettle(AwesomeApp()); // prepare network conditions await $.native.enableCellular(); await $.native.disableWifi(); // toggle system theme await $.native.enableDarkMode(); // handle native location permission request dialog await $.native.selectFineLocation(); await $.native.grantPermissionWhenInUse(); // tap on the first notification await $.native.openNotifications(); await $.native.tapOnNotificationByIndex(0); }); } ``` ## CLI See [packages/patrol_cli][github_patrol_cli]. The CLI is needed to enable Patrol's native automation feature in integration tests. It also makes development of integration tests much faster thanks to [Hot Restart]. To run widget tests, you can continue to use `flutter test`. ## Package See [packages/patrol][github_patrol]. ## Patrol contracts generator 1. (Optionally) add new request type: ```dart class OpenAppRequest { late String appId; } ``` 2. Add new method to `NativeAutomator`: ```dart abstract class NativeAutomator<IOSServer, AndroidServer, DartClient> { ... void openApp(OpenAppRequest request); ... } ``` 3. Run `gen_from_schema` script, few files will be updated ## Develop patrol_cli If you have previously activated patrol_cli run: ```bash dart pub global deactivate patrol_cli ``` then ```bash cd packages/patrol_cli flutter pub global activate -s path . ``` [patrol_badge]: https://img.shields.io/pub/v/patrol?label=patrol [patrol_finders_badge]: https://img.shields.io/pub/v/patrol_finders?label=patrol_finders [patrol_cli_badge]: https://img.shields.io/pub/v/patrol_cli?label=patrol_cli [leancode_lint_badge]: https://img.shields.io/badge/code%20style-leancode__lint-black [docs_page_badge]: https://img.shields.io/badge/documentation-docs.page-34C4AC.svg?style [patrol_link]: https://pub.dev/packages/patrol [patrol_finders_link]: https://pub.dev/packages/patrol_finders [patrol_cli_link]: https://pub.dev/packages/patrol_cli [leancode_lint_link]: https://pub.dev/packages/leancode_lint [docs_page_link]: https://docs.page [github_patrol]: https://github.com/leancodepl/patrol/tree/master/packages/patrol [github_patrol_finders]: https://github.com/leancodepl/patrol/tree/master/packages/patrol_finders [github_patrol_cli]: https://github.com/leancodepl/patrol/tree/master/packages/patrol_cli [docs]: https://patrol.leancode.co [docs_finders]: https://patrol.leancode.co/finders/overview [promo_graphics]: docs/assets/promo.png [article_0x]: https://leancode.co/blog/patrol-flutter-first-ui-testing-framework [article_1x]: https://leancode.co/blog/patrol-1-0-powerful-flutter-ui-testing-framework [article_2x]: https://leancode.co/blog/patrol-2-0-improved-flutter-ui-testing [integration_test]: https://github.com/flutter/flutter/tree/master/packages/integration_test [hot restart]: https://patrol.leancode.co/cli-commands/develop ", Assign "at most 3 tags" to the expected json: {"id":"9705","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"