add getting performance command (#480)

* add getting performance command

* remove pry

* fix lint

* rename get_performance_data_types

* insert spaces

Author: KazuCocoa

android_tests/lib/android/specs/common/command.rb

@@ -18,6 +18,8 @@ def before_first
     Selenium::WebDriver::Remote::Bridge.method_defined?(:toggle_airplane_mode).must_equal true
     Selenium::WebDriver::Remote::Bridge.method_defined?(:current_activity).must_equal true
     Selenium::WebDriver::Remote::Bridge.method_defined?(:get_network_connection).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:get_performance_data_types).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:get_performance_data).must_equal true
   end
 
   t 'check all command with arg' do

android_tests/lib/android/specs/common/device.rb

@@ -11,6 +11,14 @@
     # install ENV['APP_PATH']
   end
 
+  t 'get_performance_data_types' do
+    expected = %w(cpuinfo batteryinfo networkinfo memoryinfo)
+    get_performance_data_types.must_equal expected
+
+    get_performance_data(package_name: 'io.appium.android.apis',
+                         data_type: 'cpuinfo').must_equal [%w(user kernel), %w(0 0)]
+  end
+
   t 'device_time' do
     Date.parse(device_time)
   end
@@ -21,7 +29,8 @@
 
   t 'start_activity' do
     wait { current_activity.must_equal '.ApiDemos' }
-    start_activity app_package: 'io.appium.android.apis', app_activity: '.accessibility.AccessibilityNodeProviderActivity'
+    start_activity app_package: 'io.appium.android.apis',
+                   app_activity: '.accessibility.AccessibilityNodeProviderActivity'
     wait { current_activity.include?('Node').must_equal true }
     start_activity app_package:      'com.android.settings', app_activity:      '.Settings',
                    app_wait_package: 'com.android.settings', app_wait_activity: '.Settings'

appium_lib.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rubocop', '~> 0.46.0'
   s.add_development_dependency 'rainbow', '>= 2.1.0', '< 2.2.0' # workaround for Gem::Ext::BuildError: ERROR: Failed to build gem native extension.
+  s.add_development_dependency 'pry'
 
   s.files = `git ls-files`.split "\n"
 end

lib/appium_lib/common/command.rb

@@ -3,52 +3,54 @@ class Driver
     module Commands
       COMMAND_NO_ARG = {
         # common
-        shake:                  [:post, 'session/:session_id/appium/device/shake'.freeze],
-        launch_app:             [:post, 'session/:session_id/appium/app/launch'.freeze],
-        close_app:              [:post, 'session/:session_id/appium/app/close'.freeze],
-        reset:                  [:post, 'session/:session_id/appium/app/reset'.freeze],
-        device_locked?:         [:post, 'session/:session_id/appium/device/is_locked'.freeze],
+        shake:                      [:post, 'session/:session_id/appium/device/shake'.freeze],
+        launch_app:                 [:post, 'session/:session_id/appium/app/launch'.freeze],
+        close_app:                  [:post, 'session/:session_id/appium/app/close'.freeze],
+        reset:                      [:post, 'session/:session_id/appium/app/reset'.freeze],
+        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'.freeze],
 
         # Android
-        open_notifications:     [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
-        toggle_airplane_mode:   [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
-        current_activity:       [:get,  'session/:session_id/appium/device/current_activity'.freeze],
-        get_network_connection: [:get,  'session/:session_id/network_connection'.freeze],
+        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
+        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
+        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'.freeze],
+        get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze],
+        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
 
         # iOS
-        device_time:            [:get,  'session/:session_id/appium/device/system_time'.freeze],
-        current_context:        [:get,  'session/:session_id/context'.freeze]
+        device_time:                [:get,  'session/:session_id/appium/device/system_time'.freeze],
+        current_context:            [:get,  'session/:session_id/context'.freeze]
       }.freeze
 
       COMMAND = {
         # common
-        available_contexts:     [:get,  'session/:session_id/contexts'.freeze],
-        set_context:            [:post, 'session/:session_id/context'.freeze],
-        app_strings:            [:post, 'session/:session_id/appium/app/strings'.freeze],
-        lock:                   [:post, 'session/:session_id/appium/device/lock'.freeze],
-        install_app:            [:post, 'session/:session_id/appium/device/install_app'.freeze],
-        remove_app:             [:post, 'session/:session_id/appium/device/remove_app'.freeze],
-        app_installed?:         [:post, 'session/:session_id/appium/device/app_installed'.freeze],
-        background_app:         [:post, 'session/:session_id/appium/app/background'.freeze],
-        hide_keyboard:          [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
-        press_keycode:          [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
-        long_press_keycode:     [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
-        set_immediate_value:    [:post, 'session/:session_id/appium/element/:id/value'.freeze],
-        push_file:              [:post, 'session/:session_id/appium/device/push_file'.freeze],
-        pull_file:              [:post, 'session/:session_id/appium/device/pull_file'.freeze],
-        pull_folder:            [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
-        get_settings:           [:get,  'session/:session_id/appium/settings'.freeze],
-        update_settings:        [:post, 'session/:session_id/appium/settings'.freeze],
-        touch_actions:          [:post, 'session/:session_id/touch/perform'.freeze],
-        multi_touch:            [:post, 'session/:session_id/touch/multi/perform'.freeze],
+        available_contexts:         [:get,  'session/:session_id/contexts'.freeze],
+        set_context:                [:post, 'session/:session_id/context'.freeze],
+        app_strings:                [:post, 'session/:session_id/appium/app/strings'.freeze],
+        lock:                       [:post, 'session/:session_id/appium/device/lock'.freeze],
+        install_app:                [:post, 'session/:session_id/appium/device/install_app'.freeze],
+        remove_app:                 [:post, 'session/:session_id/appium/device/remove_app'.freeze],
+        app_installed?:             [:post, 'session/:session_id/appium/device/app_installed'.freeze],
+        background_app:             [:post, 'session/:session_id/appium/app/background'.freeze],
+        hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
+        press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
+        long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
+        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
+        push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],
+        pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'.freeze],
+        pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
+        get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
+        update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
+        touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],
+        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.freeze],
 
         # Android
-        start_activity:         [:post, 'session/:session_id/appium/device/start_activity'.freeze],
-        end_coverage:           [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
-        set_network_connection: [:post, 'session/:session_id/network_connection'.freeze],
+        start_activity:             [:post, 'session/:session_id/appium/device/start_activity'.freeze],
+        end_coverage:               [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
+        set_network_connection:     [:post, 'session/:session_id/network_connection'.freeze],
+        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze],
 
         # iOS
-        touch_id:               [:post, 'session/:session_id/appium/simulator/touch_id'.freeze]
+        touch_id:                   [:post, 'session/:session_id/appium/simulator/touch_id'.freeze]
       }.merge(COMMAND_NO_ARG).merge(::Selenium::WebDriver::Remote::Bridge::COMMANDS).freeze
     end
   end

lib/appium_lib/device/device.rb

@@ -135,6 +135,26 @@ module Device
     #   ```ruby
     #   set_immediate_value element, 'hello'
     #   ```
+
+    # @!method get_performance_data_types
+    #   Get the information type of the system state which is supported to read such as
+    #   cpu, memory, network, battery via adb commands.
+    #   https://github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L300
+    #
+    #   ```ruby
+    #   get_performance_data_types #=> ["cpuinfo", "batteryinfo", "networkinfo", "memoryinfo"]
+    #   ```
+
+    # @!method get_performance_data
+    #   Get the resource usage information of the application.
+    #   https://github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L303
+    #   @param [String] package_name Package name
+    #   @param [String] data_type Data type get with `get_performance_data_types`
+    #   @param [String] data_read_timeout Command timeout. Default is 2.
+    #
+    #   ```ruby
+    #   get_performance_data package_name: package_name, data_type: data_type, data_read_timeout: 2
+    #   ```
     class << self
       def extended(_mod)
         extend_webdriver_with_forwardable
@@ -308,6 +328,14 @@ def set_network_connection(mode)
           end
         end
 
+        add_endpoint_method(:get_performance_data) do
+          def get_performance_data(package_name:, data_type:, data_read_timeout: 1000)
+            execute :get_performance_data, {}, packageName: package_name,
+                                               dataType: data_type,
+                                               dataReadTimeout: data_read_timeout
+          end
+        end
+
         add_touch_actions
         add_ime_actions
         extend_search_contexts