Appium Flutter Driver is A Test Automation Tool for Flutter Apps

Appium Flutter Driver

Appium Flutter Driver is a test automation tool for Flutter apps on multiple platforms/OSes. Appium Flutter Driver is part of the Appium mobile test automation tool.

⚠️ pre-0.1.x version

This package is in early stage of exprienment, breaking changes and breaking codes are to be expected! All contributions, including non-code, are welcome! See TODO list below.

Flutter Driver vs Appium Flutter Driver

Even though Flutter comes with superb integration test support, Flutter Driver, it does not fit some specific use cases, such as

  • writing test in other languages than Dart
  • running integration test for Flutter app with embedded webview or native view, or existing native app with embedded Flutter view
  • running test on multiple devices simultanously
  • running integration test on device farms, such as Sauce Labs, AWS, Firebase

Under the hood, Appium Flutter Driver use the Dart VM Service Protocol with extension ext.flutter.driver, similar to Flutter Driver, to control the Flutter app-under-test (AUT).


In order to use appium-flutter-driver, we need to use appium version 1.16.0 or higher

npm i -g appium-flutter-driver


If you are unfamiliar with running Appium tests, start with Appium Getting Starting first.

Your Flutter app-under-test (AUT) must be compiled in debug or profile mode, because Flutter Driver does not support running in release mode.. Also, ensure that your Flutter AUT has enableFlutterDriverExtension() before runApp.

This snippet, taken from example dir, is a script written as an appium client with webdriverio, and assumes you have appium server (with appium-flutter-driver installed) running on the same host and default port (4723). For more info, see example’s

Desired Capabilities for flutter driver only

Capability Description Example Values
retryBackoffTime the time wait for socket connection retry for get flutter session (default 300000ms) 500
maxRetryCount the count for socket connection retry for get flutter session (default 10) 20
const wdio = require('webdriverio');
const assert = require('assert');
const { byValueKey } = require('appium-flutter-finder');

const osSpecificOps = process.env.APPIUM_OS === 'android' ? {
  platformName: 'Android',
  deviceName: 'Pixel 2',
  // @todo support non-unix style path
  app: __dirname +  '/../apps/app-free-debug.apk',
}: process.env.APPIUM_OS === 'ios' ? {
  platformName: 'iOS',
  platformVersion: '12.2',
  deviceName: 'iPhone X',
  noReset: true,
  app: __dirname +  '/../apps/',

} : {};

const opts = {
  port: 4723,
  capabilities: {
    automationName: 'Flutter',
    retryBackoffTime: 500

(async () => {
  const counterTextFinder = byValueKey('counter');
  const buttonFinder = byValueKey('increment');

  const driver = await wdio.remote(opts);

  if (process.env.APPIUM_OS === 'android') {
    await driver.switchContext('NATIVE_APP');
    await (await driver.$('~fab')).click();
    await driver.switchContext('FLUTTER');
  } else {
    console.log('Switching context to `NATIVE_APP` is currently only applicable to Android demo app.')

  assert.strictEqual(await driver.getElementText(counterTextFinder), '0');

  await driver.elementClick(buttonFinder);
  await driver.touchAction({
    action: 'tap',
    element: { elementId: buttonFinder }

  assert.strictEqual(await driver.getElementText(counterTextFinder), '2');




Icon Description
βœ… integrated to CI
πŸ†— manual tested without CI
⚠️ availalbe without manual tested
❌ unavailable


Flutter Driver API Status WebDriver example
ancestor πŸ†—
bySemanticsLabel πŸ†—
byTooltip πŸ†— byTooltip('Increment')
byType πŸ†— byType('TextField')
byValueKey πŸ†— byValueKey('counter')
descendant πŸ†—
pageBack πŸ†— pageBack()
text πŸ†— byText('foo')


Flutter API Status WebDriver example Scope
FlutterDriver.connectedTo πŸ†— wdio.remote(opts) Session
checkHealth πŸ†— driver.execute('flutter:checkHealth') Session
clearTextbox πŸ†— driver.elementClear(find.byType('TextField')) Session
clearTimeline πŸ†— driver.execute('flutter:clearTimeline') Session
close πŸ†— driver.deleteSession() Session
enterText πŸ†— driver.elementSendKeys(find.byType('TextField'), 'I can enter text') (no focus required)
driver.elementClick(find.byType('TextField')); driver.execute('flutter:enterText', 'I can enter text') (focus required by tap/click first) Session
forceGC πŸ†— driver.execute('flutter:forceGC') Session
getBottomLeft πŸ†— driver.execute('flutter:getBottomLeft', buttonFinder) Widget
getBottomRight πŸ†— driver.execute('flutter:getBottomRight', buttonFinder) Widget
getCenter πŸ†— driver.execute('flutter:getCenter', buttonFinder) Widget
getRenderObjectDiagnostics πŸ†— driver.execute('flutter:getRenderObjectDiagnostics', counterTextFinder) Widget
getRenderTree πŸ†— driver.execute('flutter: getRenderTree') Session
getSemanticsId πŸ†— driver.execute('flutter:getSemanticsId', counterTextFinder) Widget
getText πŸ†— driver.getElementText(counterTextFinder) Widget
getTopLeft πŸ†— driver.execute('flutter:getTopLeft', buttonFinder) Widget
getTopRight πŸ†— driver.execute('flutter:getTopRight', buttonFinder) Widget
getVmFlags ❌ Session
getWidgetDiagnostics ❌ Widget
requestData ❌ Session
runUnsynchronized ❌ Session
screenshot πŸ†— driver.takeScreenshot() Session
screenshot πŸ†— driver.saveScreenshot('a.png') Session
scroll πŸ†— driver.execute('flutter:scroll', find.byType('ListView'), {dx: 50, dy: -100, durationMilliseconds: 200, frequency: 30}) Widget
scrollIntoView πŸ†— driver.execute('flutter:scrollIntoView', find.byType('TextField'), {alignment: 0.1}) Widget
scrollUntilVisible πŸ†— driver.execute('flutter:scrollUntilVisible', find.byType('ListView'), {item:find.byType('TextField'), dxScroll: 90, dyScroll: -400}); Widget
setSemantics ❌ Session
setTextEntryEmulation ❌ Session
startTracing ❌ Session
stopTracingAndDownloadTimeline ❌ Session
tap πŸ†— driver.elementClick(buttonFinder) Widget
tap πŸ†— driver.touchAction({action: 'tap', element: {elementId: buttonFinder}}) Widget
traceAction ❌ Session
waitFor πŸ†— driver.execute('flutter:waitFor', buttonFinder, {durationMilliseconds: 100}) Widget
waitForAbsent πŸ†— driver.execute('flutter:waitForAbsent', buttonFinder) Widget
waitUntilNoTransientCallbacks ❌ Widget
❓ πŸ†— setContext Appium
❓ ⚠️ getCurrentContext Appium
❓ ⚠️ getContexts Appium
❓ ❌ longTap Widget


  • [ ] iOS Real device
  • [ ] CI (unit test / integration test with demo app)
  • [ ] CD (automatic publish to npm)
  • [x] finder as a seperate package
  • [ ] switching context between Flutter and AndroidView
  • [ ] switching context between Flutter and UiKitView
  • [ ] switching context between Flutter and webview
  • [ ] Flutter-version-aware API
  • [ ] Error handling

Download Details:

Author: truongsinh

Source Code:

#flutter #dart #mobile-apps

What is GEEK

Buddha Community

Appium Flutter Driver is A Test Automation Tool for Flutter Apps

Google's Flutter 1.20 stable announced with new features - Navoki

Flutter Google cross-platform UI framework has released a new version 1.20 stable.

Flutter is Google’s UI framework to make apps for Android, iOS, Web, Windows, Mac, Linux, and Fuchsia OS. Since the last 2 years, the flutter Framework has already achieved popularity among mobile developers to develop Android and iOS apps. In the last few releases, Flutter also added the support of making web applications and desktop applications.

Last month they introduced the support of the Linux desktop app that can be distributed through Canonical Snap Store(Snapcraft), this enables the developers to publish there Linux desktop app for their users and publish on Snap Store.  If you want to learn how to Publish Flutter Desktop app in Snap Store that here is the tutorial.

Flutter 1.20 Framework is built on Google’s made Dart programming language that is a cross-platform language providing native performance, new UI widgets, and other more features for the developer usage.

Here are the few key points of this release:

Performance improvements for Flutter and Dart

In this release, they have got multiple performance improvements in the Dart language itself. A new improvement is to reduce the app size in the release versions of the app. Another performance improvement is to reduce junk in the display of app animation by using the warm-up phase.


If your app is junk information during the first run then the Skia Shading Language shader provides for pre-compilation as part of your app’s build. This can speed it up by more than 2x.

Added a better support of mouse cursors for web and desktop flutter app,. Now many widgets will show cursor on top of them or you can specify the type of supported cursor you want.

Autofill for mobile text fields

Autofill was already supported in native applications now its been added to the Flutter SDK. Now prefilled information stored by your OS can be used for autofill in the application. This feature will be available soon on the flutter web.


A new widget for interaction

InteractiveViewer is a new widget design for common interactions in your app like pan, zoom drag and drop for resizing the widget. Informations on this you can check more on this API documentation where you can try this widget on the DartPad. In this release, drag-drop has more features added like you can know precisely where the drop happened and get the position.

Updated Material Slider, RangeSlider, TimePicker, and DatePicker

In this new release, there are many pre-existing widgets that were updated to match the latest material guidelines, these updates include better interaction with Slider and RangeSliderDatePicker with support for date range and time picker with the new style.


New pubspec.yaml format

Other than these widget updates there is some update within the project also like in pubspec.yaml file format. If you are a flutter plugin publisher then your old pubspec.yaml  is no longer supported to publish a plugin as the older format does not specify for which platform plugin you are making. All existing plugin will continue to work with flutter apps but you should make a plugin update as soon as possible.

Preview of embedded Dart DevTools in Visual Studio Code

Visual Studio code flutter extension got an update in this release. You get a preview of new features where you can analyze that Dev tools in your coding workspace. Enable this feature in your vs code by _dart.previewEmbeddedDevTools_setting. Dart DevTools menu you can choose your favorite page embed on your code workspace.

Network tracking

The updated the Dev tools comes with the network page that enables network profiling. You can track the timings and other information like status and content type of your** network calls** within your app. You can also monitor gRPC traffic.

Generate type-safe platform channels for platform interop

Pigeon is a command-line tool that will generate types of safe platform channels without adding additional dependencies. With this instead of manually matching method strings on platform channel and serializing arguments, you can invoke native class and pass nonprimitive data objects by directly calling the Dartmethod.

There is still a long list of updates in the new version of Flutter 1.2 that we cannot cover in this blog. You can get more details you can visit the official site to know more. Also, you can subscribe to the Navoki newsletter to get updates on these features and upcoming new updates and lessons. In upcoming new versions, we might see more new features and improvements.

You can get more free Flutter tutorials you can follow these courses:

#dart #developers #flutter #app developed #dart devtools in visual studio code #firebase local emulator suite in flutter #flutter autofill #flutter date picker #flutter desktop linux app build and publish on snapcraft store #flutter pigeon #flutter range slider #flutter slider #flutter time picker #flutter tutorial #flutter widget #google flutter #linux #navoki #pubspec format #setup flutter desktop on windows

Aurelie  Block

Aurelie Block


Top 10 Automation Testing Tools: 2020 Edition

The demand for delivering quality software faster β€” or β€œQuality at Speed” β€” requires organizations to search for solutions in Agile, continuous integration (CI), and DevOps methodologies. Test automation is an essential part of these aspects. The latest World Quality Report 2018–2019 suggests that test automation is the biggest bottleneck to deliver β€œQuality at Speed,” as it is an enabler of successful Agile and DevOps adoption.

Test automation cannot be realized without good tools; as they determine how automation is performed and whether the benefits of automation can be delivered. Test automation tools is a crucial component in the DevOps toolchain. The current test automation trends have increased in applying artificial intelligence and machine learning (AI/ML) to offer advanced capabilities for test optimization, intelligent test generation, execution, and reporting. It will be worthwhile to understand which tools are best poised to take advantage of these trends.****

#automation-testing #automation-testing-tools #testing #testing-tools #selenium #open-source #test-automation #automated-testing

Idrish Dhankot

Idrish Dhankot


Hire Dedicated Flutter App Developer USA| Flutter App Developers

Hire Flutter App Developers: WebClues Infotech is a Flutter App Development company. Our Flutter mobile app development team can create cross-platform apps for different industry verticals. Our Flutter developers will help you extend your business’s scope by developing enhanced functionality and a feature-rich app. To provide a rich user experience to your users, hire dedicated Flutter app developers from WebClues Infotech today!

#hire flutter app developers #hire dedicated flutter app developer usa #hire flutter app developer usa #hire dedicated flutter app developer #hire flutter developer #flutter app development company

Best Flutter App Development Company

Are you looking for the best flutter app development company? Then AppClues Infotech is the leading flutter app development company in USA offering the best service worldwide. We focused on developing hybrid mobile apps on Android & iOS and assures our end-user about exceptional and functionally-rich mobile apps.

For more info:
Call: +1-978-309-9910

#top flutter app development company in usa #best flutter app development service #best flutter app development company #hire flutter app developers #flutter app development company #expert flutter app development company

Best Flutter App Development Company in USA & India

AppClues Infotech is one of the best flutter app development company in USA & India. Our diverse and experienced team of developers can help you sketch the smartest and quickest solution for your mobile app development projects with the most superior technology.

For more info:
Call: +1-978-309-9910

#top flutter app development company in usa #best flutter app development service #best flutter app development company #hire flutter app developers #flutter app development company in usa & india #custom flutter app development service