appium_driver
An appium binding in Dart
About
Flutter has flutter_driver which runs UI tests like Espresso/EarlGrey/Appium for Flutter elements. The driver is really awesome, but it can automate only flutter view. It cannot handle outside Flutter.
This client aims to be able to write test cases in Dart for Appium. It may help to write test code with the same programming language as the production code.
Example
Take a look at functional tests
Lint
$ dartanalyzer --options analysis_options.yaml .
format
$ dartfmt -w --fix .
pana (analyze on pub.dev)
$ dart pub run pana --source path .
Run tests
Get dependencies
$ dart pub get
Functional
$ dart pub run test test/functional
Unit
$ dart pub run test test/unit
release
- Bump the version in
pubspec.yaml
- Run
dart pub publish
Supported Commands
WebDriver commands
Please refer webdriver.dart APIshttps://pub.dev/documentation/webdriver/latest
- Some W3C actions
Appium actions
All W3C webdriver commands are available such as find_element/s, click and send keys. Below Appium specific commands are implementing.
x
directConnectXxxxx
batch commandx
CDP command:[HttpMethod.httpPost, 'session/:session_id/goog/cdp/execute']
x
[HttpMethod.httpGet, 'sessions']
x
[HttpMethod.httpGet, 'session/:session_id/contexts']
x
[HttpMethod.httpPost, 'session/:session_id/context']
x
[HttpMethod.httpGet, 'session/:session_id/context']
Deprecated.x
[HttpMethod.httpPost, 'session/:session_id/appium/element/:id/value']
Deprecated.x
[HttpMethod.httpPost, 'session/:session_id/appium/element/:id/replace_value']
Deprecatedx
[HttpMethod.httpPost, 'session/:session_id/appium/app/launch']
Deprecatedx
[HttpMethod.httpPost, 'session/:session_id/appium/app/close']
Deprecatedx
[HttpMethod.httpPost, 'session/:session_id/appium/app/reset']
x
[HttpMethod.httpPost, 'session/:session_id/appium/app/background']
x
[HttpMethod.httpPost, 'session/:session_id/appium/app/strings']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/is_locked']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/unlock']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/lock']
x
[HttpMethod.httpGet, 'session/:session_id/appium/device/system_time']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/install_app']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/remove_app']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/app_installed']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/activate_app']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/terminate_app']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/app_state']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/shake']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/hide_keyboard']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/press_keycode']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/long_press_keycode']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/push_file']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/pull_file']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/pull_folder']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/get_clipboard']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/set_clipboard']
x
[HttpMethod.httpGet, 'session/:session_id/appium/settings']
x
[HttpMethod.httpPost, 'session/:session_id/appium/settings']
x
[HttpMethod.httpGet, 'session/:session_id/appium/device/is_keyboard_shown']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/open_notifications']
x
[HttpMethod.httpPost, 'session/:session_id/appium/device/start_activity']
x
[HttpMethod.httpGet, 'session/:session_id/appium/device/current_activity']
x
[HttpMethod.httpGet, 'session/:session_id/appium/device/current_package']
x
[HttpMethod.httpGet, 'session/:session_id/appium/device/system_bars']
x
[HttpMethod.httpGet, 'session/:session_id/appium/device/display_density']
[HttpMethod.httpPost, 'session/:session_id/appium/stop_recording_screen']
[HttpMethod.httpPost, 'session/:session_id/appium/start_recording_screen']
x
[HttpMethod.httpGet, 'status']
x
[HttpMethod.httpGet, 'session/:session_id/element/:id/displayed']
x
[HttpMethod.httpGet, 'session/:session_id']
x
[HtMethod.httpGet, 'session/:session_id/location']
x
[HttpMethod.httpPost, 'session/:session_id/location']
x
[HttpMethod.httpGet, 'session/:session_id/ime/available_engines']
x
[HttpMethod.httpGet, 'session/:session_id/ime/active_engine']
x
[HttpMethod.httpGet, 'session/:session_id/ime/activated']
x
[HttpMethod.httpPost, 'session/:session_id/ime/deactivate']
x
[HttpMethod.httpPost, 'session/:session_id/ime/activate']
x
[HttpMethod.httpGet, 'session/:session_id/log/types']
x
[HttpMethod.httpPost, 'session/:session_id/log']
x
[HttpMethod.httpGet, 'session/:session_id/appium/events']
x
[HttpMethod.httpPost, 'session/:session_id/appium/log_event']
x
[HttpMethod.httpGet, 'session/:session_id/orientation']
x
[HttpMethod.httpPost, 'session/:session_id/orientation']
x
Add finder for https://github.com/truongsinh/appium-flutter-driver
Low priority
Below commands may not be supported since platform specific commands are supported as its own commands e.g. https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#platform-specific-extensions
# W3C actions should be an alternative[HttpMethod.httpPost, 'session/:session_id/touch/perform']
# W3C actions should be an alternative[HttpMethod.httpPost, 'session/:session_id/touch/multi/perform']
# Only for Selendroid[HttpMethod.httpPost, 'session/:session_id/appium/device/keyevent']
[HttpMethod.httpPost, 'session/:session_id/appium/device/finger_print']
[HttpMethod.httpPost, 'session/:session_id/appium/compare_images']
[HttpMethod.httpPost, 'session/:session_id/appium/device/toggle_airplane_mode']
[HttpMethod.httpPost, 'session/:session_id/appium/device/toggle_wifi']
[HttpMethod.httpPost, 'session/:session_id/appium/device/toggle_data']
[HttpMethod.httpPost, 'session/:session_id/appium/device/toggle_location_services']
[HttpMethod.httpPost, 'session/:session_id/appium/app/end_test_coverage']
[HttpMethod.httpPost, 'session/:session_id/appium/performanceData/types']
[HttpMethod.httpPost, 'session/:session_id/appium/getPerformanceData']
[HttpMethod.httpGet, 'session/:session_id/network_connection']
[HttpMethod.httpPost, 'session/:session_id/network_connection']
[HttpMethod.httpPost, 'session/:session_id/appium/device/send_sms']
[HttpMethod.httpPost, 'session/:session_id/appium/device/gsm_call']
[HttpMethod.httpPost, 'session/:session_id/appium/device/gsm_signal']
[HttpMethod.httpPost, 'session/:session_id/appium/device/gsm_voice']
[HttpMethod.httpPost, 'session/:session_id/appium/device/network_speed']
[HttpMethod.httpPost, 'session/:session_id/appium/device/power_capacity']
[HttpMethod.httpPost, 'session/:session_id/appium/device/power_ac']
[HttpMethod.httpPost, 'session/:session_id/appium/simulator/touch_id']
[HttpMethod.httpPost, 'session/:session_id/appium/simulator/toggle_touch_id_enrollment']
<= already has[HtMethod.httpGet, 'session/:session_id/timeouts']
<= will be deprecated in W3C. Use W3C actions instead.[HttpMethod.httpPost, 'session/:session_id/keys']