Support get_performance_data, get_performance_data_types (appium#368)

* Support get_performance_data, get_performance_data_types * Add api doc * Add performance unittest * Tweak * Update api doc

Author: ki4070ma

appium/webdriver/extensions/device_time.py

@@ -25,7 +25,7 @@ def device_time(self):
  return self.execute(Command.GET_DEVICE_TIME_GET, {})['value']
 
  def get_device_time(self, format=None):
- """Returns the date and time from the device. (Only available since Appium 1.11.0)
+ """Returns the date and time from the device.
 
  :Args:
  - format - (optional) The set of format specifiers. Read https://momentjs.com/docs/

appium/webdriver/extensions/gsm.py

@@ -48,6 +48,7 @@ class Gsm(webdriver.Remote):
 
  def make_gsm_call(self, phone_number, action):
  """Make GSM call (Emulator only)
+ Android only.
 
  :Args:
  - phone_number (str): The phone number to call to.
@@ -65,6 +66,7 @@ def make_gsm_call(self, phone_number, action):
 
  def set_gsm_signal(self, strength):
  """Set GSM signal strength (Emulator only)
+ Android only.
 
  :Args:
  - strength (int): Signal strength - GsmSignalStrength.NONE_OR_UNKNOWN/POOR/MODERATE/GOOD/GREAT
@@ -81,6 +83,7 @@ def set_gsm_signal(self, strength):
 
  def set_gsm_voice(self, state):
  """Set GSM voice state (Emulator only)
+ Android only.
 
  :Args:
  - state(str): State of GSM voice - GsmVoiceState.UNREGISTERED/HOME/ROAMING/SEARCHING/DENIED/OFF/ON

appium/webdriver/extensions/performance.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from selenium import webdriver
+from ..mobilecommand import MobileCommand as Command
+
+
+class Performance(webdriver.Remote):
+
+ def get_performance_data(self, package_name, data_type, data_read_timeout=None):
+ """Returns the information of the system state
+ which is supported to read as like cpu, memory, network traffic, and battery.
+ Android only.
+
+ :Args:
+ - package_name: The package name of the application
+ - data_type: The type of system state which wants to read.
+ It should be one of the supported performance data types.
+ Check :func:`.get_performance_data_types` for supported types
+ - data_read_timeout: (optional) The number of attempts to read
+
+ :Usage:
+ self.driver.get_performance_data('my.app.package', 'cpuinfo', 5)
+ """
+ data = {'packageName': package_name, 'dataType': data_type}
+ if data_read_timeout is not None:
+ data['dataReadTimeout'] = data_read_timeout
+ return self.execute(Command.GET_PERFORMANCE_DATA, data)['value']
+
+ def get_performance_data_types(self):
+ """Returns the information types of the system state
+ which is supported to read as like cpu, memory, network traffic, and battery.
+ Android only.
+
+ :Usage:
+ self.driver.get_performance_data_types()
+ """
+ return self.execute(Command.GET_PERFORMANCE_DATA_TYPES)['value']
+
+ # pylint: disable=protected-access
+
+ def _addCommands(self):
+ self.command_executor._commands[Command.GET_PERFORMANCE_DATA] = \
+ ('POST', '/session/$sessionId/appium/getPerformanceData')
+ self.command_executor._commands[Command.GET_PERFORMANCE_DATA_TYPES] = \
+ ('POST', '/session/$sessionId/appium/performanceData/types')

appium/webdriver/extensions/power.py

@@ -22,6 +22,7 @@ class Power(webdriver.Remote):
 
  def set_power_capacity(self, percent):
  """Emulate power capacity change on the connected emulator.
+ Android only.
 
  :Args:
  - percent: The power capacity to be set. Can be set int from 0 to 100
@@ -34,6 +35,7 @@ def set_power_capacity(self, percent):
 
  def set_power_ac(self, ac_state):
  """Emulate power state change on the connected emulator.
+ Android only.
 
  :Args:
  - ac_state: The power ac state to be set

appium/webdriver/extensions/sms.py

@@ -20,10 +20,11 @@ class Sms(webdriver.Remote):
 
  def send_sms(self, phone_number, message):
  """Emulate send SMS event on the connected emulator.
+ Android only.
 
  :Args:
  - phone_number: The phone number of message sender
- - message: message: The message to send
+ - message: The message to send
 
  :Usage:
  self.driver.send_sms('555-123-4567', 'Hey lol')

appium/webdriver/extensions/system_bars.py

@@ -19,7 +19,8 @@
 class SystemBars(webdriver.Remote):
 
  def get_system_bars(self):
- """Retrieve visibility and bounds information of the status and navigation bars
+ """Retrieve visibility and bounds information of the status and navigation bars.
+ Android only.
 
  :return:
  A dictionary whose keys are

appium/webdriver/mobilecommand.py

@@ -83,3 +83,5 @@ class MobileCommand(object):
  MAKE_GSM_CALL = 'makeGsmCall'
  GET_SYSTEM_BARS = 'getSystemBars'
  SET_GSM_VOICE = 'setGsmVoice'
+ GET_PERFORMANCE_DATA = 'getPerformanceData'
+ GET_PERFORMANCE_DATA_TYPES = 'getPerformanceDataTypes'

appium/webdriver/webdriver.py

@@ -39,6 +39,7 @@
 from .extensions.hw_actions import HardwareActions
 from .extensions.location import Location
 from .extensions.network import Network
+from .extensions.performance import Performance
 from .extensions.power import Power
 from .extensions.remote_fs import RemoteFS
 from .extensions.screen_record import ScreenRecord
@@ -121,6 +122,7 @@ class WebDriver(
  Keyboard,
  Location,
  Network,
+ Performance,
  Power,
  RemoteFS,
  ScreenRecord,

test/unit/webdriver/device/performance_test.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from test.unit.helper.test_helper import (
+ appium_command,
+ android_w3c_driver,
+ get_httpretty_request_body
+)
+
+import httpretty
+
+
+class TestWebDriverPerformance(object):
+
+ @httpretty.activate
+ def test_get_performance_data(self):
+ driver = android_w3c_driver()
+ httpretty.register_uri(
+ httpretty.POST,
+ appium_command('/session/1234567890/appium/getPerformanceData'),
+ body='{"value": [["user", "kernel"], ["2.5", "1.3"]]}'
+ )
+ assert driver.get_performance_data('my.app.package', 'cpuinfo', 5) == [['user', 'kernel'], ['2.5', '1.3']]
+
+ d = get_httpretty_request_body(httpretty.last_request())
+ assert d['packageName'] == 'my.app.package'
+ assert d['dataType'] == 'cpuinfo'
+ assert d['dataReadTimeout'] == 5
+
+ @httpretty.activate
+ def test_get_performance_data_types(self):
+ driver = android_w3c_driver()
+ httpretty.register_uri(
+ httpretty.POST,
+ appium_command('/session/1234567890/appium/performanceData/types'),
+ body='{"value": ["cpuinfo", "memoryinfo", "batteryinfo", "networkinfo"]}'
+ )
+ assert driver.get_performance_data_types() == ['cpuinfo', 'memoryinfo', 'batteryinfo', 'networkinfo']