Support make_gsm_call (appium#360)

ki4070ma · web-flow · commit a31a205a1ff7 · 2019-05-03T20:15:23.000+09:00
* Move const to gsm_signal_strength

* Support make_gsm_call

* Add make_gsm_call unittest

* Move const to gsm class

* Move get_dict_const to common.helper

* Rename func

* Use OrderedDict to keep defined order
diff --git a/appium/common/helper.py b/appium/common/helper.py
@@ -12,8 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import io
-import os
+from collections import OrderedDict
 
 from appium import version as appium_version
 
@@ -38,6 +37,20 @@ def appium_bytes(value, encoding):
         return value  # Python 2
 
 
+def extract_const_attributes(cls):
+    """
+    Return dict with constants attributes and values in the class (e.g. {'VAL1': 1, 'VAL2': 2})
+
+    :param cls: Class to be extracted constants
+    :type cls: type
+
+    :return: dict with constants attributes and values in the class
+    :rtype: OrderedDict
+    """
+    return OrderedDict(
+        [(attr, value) for attr, value in vars(cls).items() if not callable(getattr(cls, attr)) and attr.isupper()])
+
+
 def library_version():
     """
     Return a version of this python library
diff --git a/appium/webdriver/extensions/gsm.py b/appium/webdriver/extensions/gsm.py
@@ -16,39 +16,63 @@
 from ..mobilecommand import MobileCommand as Command
 
 from appium.common.logger import logger
+from appium.common.helper import extract_const_attributes
+
+
+class GsmCallActions(object):
+    CALL = 'call'
+    ACCEPT = 'accept'
+    CANCEL = 'cancel'
+    HOLD = 'hold'
+
+
+class GsmSignalStrength(object):
+    NONE_OR_UNKNOWN = 0
+    POOR = 1
+    MODERATE = 2
+    GOOD = 3
+    GREAT = 4
 
 
 class Gsm(webdriver.Remote):
 
-    (
-        NONE_OR_UNKNOWN,
-        POOR,
-        MODERATE,
-        GOOD,
-        GREAT
-    ) = range(5)
+    def make_gsm_call(self, phone_number, action):
+        """Make GSM call (Emulator only)
+
+        :Args:
+         - phone_number (str): The phone number to call to.
+         - action (str): The call action - GsmCallActions.CALL/ACCEPT/CANCEL/HOLD
+
+        :Usage:
+            self.driver.make_gsm_call('5551234567', GsmCallActions.CALL)
+        """
+        constants = extract_const_attributes(GsmCallActions)
+        if action not in constants.values():
+            logger.warning('{} is unknown. Consider using one of {} constants. (e.g. {}.CALL)'.format(
+                action, list(constants.keys()), GsmCallActions.__name__))
+        self.execute(Command.MAKE_GSM_CALL, {'phoneNumber': phone_number, 'action': action})
+        return self
 
     def set_gsm_signal(self, strength):
         """Set GSM signal strength (Emulator only)
 
         :Args:
-         - strength: Signal strength. Can be set Gsm.NONE_OR_UNKNOWN/POOR/MODERATE/GOOD/GREAT
+         - strength (int): Signal strength - GsmSignalStrength.NONE_OR_UNKNOWN/POOR/MODERATE/GOOD/GREAT
 
         :Usage:
-            self.driver.set_gsm_signal(Gsm.GOOD)
+            self.driver.set_gsm_signal(GsmSignalStrength.GOOD)
         """
-        if strength not in self._dict_signal_strength().values():
-            logger.warning('{} is out of range. Use the value in {}.'.format(
-                strength, list(self._dict_signal_strength().keys())))
+        constants = extract_const_attributes(GsmSignalStrength)
+        if strength not in constants.values():
+            logger.warning('{} is out of range. Consider using one of {} constants. (e.g. {}.GOOD)'.format(
+                strength, list(constants.keys()), GsmSignalStrength.__name__))
         self.execute(Command.SET_GSM_SIGNAL, {'signalStrength': strength, 'signalStrengh': strength})
         return self
 
-    def _dict_signal_strength(self):
-        return {'{}.{}'.format(Gsm.__name__, attr): value for attr, value in vars(Gsm).items()
-                if not callable(getattr(Gsm, attr)) and attr.isupper()}
-
     # pylint: disable=protected-access
 
     def _addCommands(self):
+        self.command_executor._commands[Command.MAKE_GSM_CALL] = \
+            ('POST', '/session/$sessionId/appium/device/gsm_call')
         self.command_executor._commands[Command.SET_GSM_SIGNAL] = \
             ('POST', '/session/$sessionId/appium/device/gsm_signal')
diff --git a/appium/webdriver/mobilecommand.py b/appium/webdriver/mobilecommand.py
@@ -80,3 +80,4 @@ class MobileCommand(object):
     SET_POWER_CAPACITY = 'setPowerCapacity'
     SET_POWER_AC = 'setPowerAc'
     SET_GSM_SIGNAL = 'setGsmSignal'
+    MAKE_GSM_CALL = 'makeGsmCall'
diff --git a/test/unit/webdriver/device/gsm_test.py b/test/unit/webdriver/device/gsm_test.py
@@ -21,17 +21,23 @@
 import httpretty
 
 from appium.webdriver.webdriver import WebDriver
-from appium.webdriver.extensions.gsm import Gsm
+from appium.webdriver.extensions.gsm import GsmCallActions, GsmSignalStrength
 
 
 class TestWebDriveGsm(object):
 
-    def test_gsm_signal_strength(self):
-        assert Gsm.NONE_OR_UNKNOWN == 0
-        assert Gsm.POOR == 1
-        assert Gsm.MODERATE == 2
-        assert Gsm.GOOD == 3
-        assert Gsm.GREAT == 4
+    @httpretty.activate
+    def test_make_gsm_call(self):
+        driver = android_w3c_driver()
+        httpretty.register_uri(
+            httpretty.POST,
+            appium_command('/session/1234567890/appium/device/gsm_call'),
+        )
+        assert isinstance(driver.make_gsm_call('5551234567', GsmCallActions.CALL), WebDriver)
+
+        d = get_httpretty_request_body(httpretty.last_request())
+        assert d['phoneNumber'] == '5551234567'
+        assert d['action'] == GsmCallActions.CALL
 
     @httpretty.activate
     def test_set_gsm_signal(self):
@@ -40,8 +46,8 @@ def test_set_gsm_signal(self):
             httpretty.POST,
             appium_command('/session/1234567890/appium/device/gsm_signal'),
         )
-        assert isinstance(driver.set_gsm_signal(Gsm.GREAT), WebDriver)
+        assert isinstance(driver.set_gsm_signal(GsmSignalStrength.GREAT), WebDriver)
 
         d = get_httpretty_request_body(httpretty.last_request())
-        assert d['signalStrength'] == Gsm.GREAT
-        assert d['signalStrengh'] == Gsm.GREAT
+        assert d['signalStrength'] == GsmSignalStrength.GREAT
+        assert d['signalStrengh'] == GsmSignalStrength.GREAT
