appium_driver 0.1.1

An Appium binding for Dart. Support WebDriver W3C spec inheriting webdriver.dart.

appium_driver

This is not a stable project yet.

An appium client in Dart

Why

Flutter has flutter_driver which runs UI tests like Espresso/EarlGrey/Appium. The driver is really awesome, but it can automate only flutter view. It cannot handle outside Flutter.

According to some issues on the Flutter repo, they have a plan to make findable Flutter elements by Espresso/EarlGrey framework. But it means test cases should be Java/Kotlin or Swift/Objective-C. After the change, Appium also can handle elements via UIA2 or Espresso driver and XCUITest driver though.

I assumed users, who use Flutter fully or a part of, would like to implement UI tests in Dart.

Hence, this repository is another PoC for calling flutter_driver via HTTP requests in https://github.com/KazuCocoa/proto-flutter-driver-server

Example

Take a look at functional tests

Lint

$ dartanalyzer --options analysis_options.yaml .

format

$ dartfmt -w --fix .

Run tests

Get dependencies

$ pub get

Functional

$ pub run test test/functional

Unit

$ pub run test test/unit

release

• Bump the version in pubspec.yml
• Run pub publish

Supported Commands

WebDriver commands

Please refer webdriver.dart APIs

• Some W3C actions
  • https://pub.dev/documentation/webdriver/latest/webdriver.io/Mouse-class.html
  • https://github.com/google/webdriver.dart/blob/6d7943ef098d3c938b1f4da5a8590fe827f3dd80/lib/src/handler/w3c/mouse.dart

Appium actions

All W3C webdriver commands are available such as find_element/s, click and send keys. Below Appium specific commands are implementing.

• ✅ directConnectXxxx
• ❌ batch command
• ✅ [HttpMethod.httpGet, 'sessions']
• ✅ [HttpMethod.httpGet, 'session/:session_id/contexts']
• ✅ [HttpMethod.httpPost, 'session/:session_id/context']
• ✅ [HttpMethod.httpGet, 'session/:session_id/context']
• ❌ [HttpMethod.httpPost, 'session/:session_id/touch/perform']
• ❌ [HttpMethod.httpPost, 'session/:session_id/touch/multi/perform']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/element/:id/value']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/element/:id/replace_value']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/app/launch']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/app/close']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/app/reset']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/app/background']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/app/strings']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/is_locked']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/unlock']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/lock']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/device/system_time']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/install_app']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/remove_app']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/app_installed']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/activate_app']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/terminate_app']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/app_state']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/shake']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/hide_keyboard']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/press_keycode']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/long_press_keycode']
• [ ] [HttpMethod.httpPost, 'session/:session_id/appium/device/keyevent'] # Only for Selendroid
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/push_file']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/pull_file']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/pull_folder']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/get_clipboard']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/set_clipboard']
• ❌ [HttpMethod.httpPost, 'session/:session_id/appium/device/finger_print']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/settings']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/settings']
• ❌ [HttpMethod.httpPost, 'session/:session_id/appium/stop_recording_screen']
• ❌ [HttpMethod.httpPost, 'session/:session_id/appium/start_recording_screen']
• ❌ [HttpMethod.httpPost, 'session/:session_id/appium/compare_images']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/device/is_keyboard_shown']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/open_notifications']
• ✅ [HttpMethod.httpPost, 'session/:session_id/appium/device/start_activity']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/device/current_activity']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/device/current_package']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/device/system_bars']
• ✅ [HttpMethod.httpGet, 'session/:session_id/appium/device/display_density']
• ❌ [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']
• ✅ [HttpMethod.httpGet, 'status']
• ✅ [HttpMethod.httpGet, 'session/:session_id/element/:id/displayed']
• [ ] [HtMethod.httpGet, 'session/:session_id/timeouts'] <= already has
• ✅ [HttpMethod.httpGet, 'session/:session_id']
• ❌ [HttpMethod.httpGet, 'session/:session_id/orientation']
• ❌ [HttpMethod.httpPost, 'session/:session_id/orientation']
• ✅ [HtMethod.httpGet, 'session/:session_id/location']
• ✅ [HttpMethod.httpPost, 'session/:session_id/location']
• ✅ [HttpMethod.httpGet, 'session/:session_id/ime/available_engines']
• ✅ [HttpMethod.httpGet, 'session/:session_id/ime/active_engine']
• ✅ [HttpMethod.httpGet, 'session/:session_id/ime/activated']
• ✅ [HttpMethod.httpPost, 'session/:session_id/ime/deactivate']
• ✅ [HttpMethod.httpPost, 'session/:session_id/ime/activate']
• [ ] [HttpMethod.httpPost, 'session/:session_id/keys'] <= will be deprecated in W3C. Use W3C actions instead.
• ✅ [HttpMethod.httpGet, 'session/:session_id/log/types']
• ✅ [HttpMethod.httpPost, 'session/:session_id/log']