Need help with appium-flutter-driver?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

truongsinh
163 Stars 61 Forks MIT License 162 Commits 40 Opened issues

Description

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.

Services available

!
?

Need anything else?

Contributors list

# 56,772
Dart
gitlab
GraphQL
gatsbyj...
49 commits
# 6,702
C#
Elixir
appium
kotlin-...
26 commits
# 322,316
Android
driver
appium
HTML
21 commits
# 208,593
Ruby
Shell
broadca...
Dart
3 commits
# 10,232
Dart
iOS
Flutter
flutter...
2 commits
# 4,411
Java
Docker
seleniu...
seleniu...
1 commit
# 941
JavaScr...
appium
C#
webdriv...
1 commit

Appium Flutter Driver

Build Status Greenkeeper badge NPM version Downloads Dependency Status devDependency Status

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.

:warning: 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).

Installation

In order to use

appium-flutter-driver
, we need to use
appium
version
1.16.0
or higher
npm i -g appium-flutter-driver

Usage

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 README.md

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/Runner.zip',

} : {};

const opts = { port: 4723, capabilities: { ...osSpecificOps, 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');

driver.deleteSession(); })();

API

Legend:

| Icon | Description | | - | - | | :whitecheckmark: | integrated to CI | | :ok: | manual tested without CI | | :warning: | availalbe without manual tested | | :x: | unavailable |

Finders

| Flutter Driver API | Status | WebDriver example | | - | - | - | | ancestor | :ok: | | | bySemanticsLabel | :ok: | | | byTooltip | :ok: |

byTooltip('Increment')
| | byType | :ok: |
byType('TextField')
| | byValueKey | :ok: |
byValueKey('counter')
| | descendant | :ok: | | | pageBack | :ok: |
pageBack()
| | text | :ok: |
byText('foo')
|

Commands

| Flutter API | Status | WebDriver example | Scope | | - | - | - | - | | FlutterDriver.connectedTo | :ok: |

wdio.remote(opts)
| Session | | checkHealth | :ok: |

driver.execute('flutter:checkHealth')
| Session | | clearTextbox | :ok: |
driver.elementClear(find.byType('TextField'))
| Session | | clearTimeline | :ok: |
driver.execute('flutter:clearTimeline')
| Session | | close | :ok: |
driver.deleteSession()
| Session | | enterText | :ok: |
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 | :ok: |
driver.execute('flutter:forceGC')
| Session | | getBottomLeft | :ok: |
driver.execute('flutter:getBottomLeft', buttonFinder)
| Widget | | getBottomRight | :ok: |
driver.execute('flutter:getBottomRight', buttonFinder)
| Widget | | getCenter | :ok: |
driver.execute('flutter:getCenter', buttonFinder)
| Widget | | getRenderObjectDiagnostics | :ok: |
driver.execute('flutter:getRenderObjectDiagnostics', counterTextFinder)
| Widget | | getRenderTree | :ok: |
driver.execute('flutter: getRenderTree')
| Session | | getSemanticsId | :ok: |
driver.execute('flutter:getSemanticsId', counterTextFinder)
| Widget | | getText | :ok: |
driver.getElementText(counterTextFinder)
| Widget | | getTopLeft | :ok: |
driver.execute('flutter:getTopLeft', buttonFinder)
| Widget | | getTopRight | :ok: |
driver.execute('flutter:getTopRight', buttonFinder)
| Widget | | getVmFlags | :x: | | Session | | getWidgetDiagnostics | :x: | | Widget | | requestData | :x: | | Session | | runUnsynchronized | :x: | | Session | | screenshot | :ok: |
driver.takeScreenshot()
| Session | | screenshot | :ok: |
driver.saveScreenshot('a.png')
| Session | | scroll | :ok: |
driver.execute('flutter:scroll', find.byType('ListView'), {dx: 50, dy: -100, durationMilliseconds: 200, frequency: 30})
| Widget | | scrollIntoView | :ok: |
driver.execute('flutter:scrollIntoView', find.byType('TextField'), {alignment: 0.1})
| Widget | | scrollUntilVisible | :ok: |
driver.execute('flutter:scrollUntilVisible', find.byType('ListView'), {item:find.byType('TextField'), dxScroll: 90, dyScroll: -400});
| Widget | | setSemantics | :x: | | Session | | setTextEntryEmulation | :x: | | Session | | startTracing | :x: | | Session | | stopTracingAndDownloadTimeline | :x: | | Session | | tap | :ok: |
driver.elementClick(buttonFinder)
| Widget | | tap | :ok: |
driver.touchAction({action: 'tap', element: {elementId: buttonFinder}})
| Widget | | traceAction | :x: | | Session | | waitFor | :ok: |
driver.execute('flutter:waitFor', buttonFinder, {durationMilliseconds: 100})
| Widget | | waitForAbsent | :ok: |
driver.execute('flutter:waitForAbsent', buttonFinder)
| Widget | | waitUntilNoTransientCallbacks | :x: | | Widget | | :question: | :ok: |
setContext
| Appium | | :question: | :warning: |
getCurrentContext
| Appium | | :question: | :warning: |
getContexts
| Appium | | :question: | :x: |
longTap
| Widget |

TODO

  • [ ] 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

Test Status

Saucelabs Test Status

Powered by Saucelabs

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.