Support set_gsm_signal (#357)

* Support set_gsm_signal

* Fix: NONE_OR_UNKNOWN doesn't work

* Add set_gsm_signal unittest

* Use int for signal strength const

* Raise exception when signal strength is out of range

* Fix: wrong class name

* Removed args validation

Since arg validation already done by server side

* Show warning log when arg is out of range

* Some changes for less maintenance

Author: ki4070ma

appium/webdriver/extensions/gsm.py

@@ -0,0 +1,54 @@
+#!/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
+
+from appium.common.logger import logger
+
+
+class Gsm(webdriver.Remote):
+
+    (
+        NONE_OR_UNKNOWN,
+        POOR,
+        MODERATE,
+        GOOD,
+        GREAT
+    ) = range(5)
+
+    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
+
+        :Usage:
+            self.driver.set_gsm_signal(Gsm.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())))
+        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.SET_GSM_SIGNAL] = \
+            ('POST', '/session/$sessionId/appium/device/gsm_signal')

appium/webdriver/mobilecommand.py

@@ -79,3 +79,4 @@ class MobileCommand(object):
     SEND_SMS = 'sendSms'
     SET_POWER_CAPACITY = 'setPowerCapacity'
     SET_POWER_AC = 'setPowerAc'
+    SET_GSM_SIGNAL = 'setGsmSignal'

appium/webdriver/webdriver.py

@@ -32,6 +32,7 @@
 from .extensions.clipboard import Clipboard
 from .extensions.context import Context
 from .extensions.device_time import DeviceTime
+from .extensions.gsm import Gsm
 from .extensions.images_comparison import ImagesComparison
 from .extensions.ime import IME
 from .extensions.keyboard import Keyboard
@@ -112,6 +113,7 @@ class WebDriver(
     Clipboard,
     Context,
     DeviceTime,
+    Gsm,
     HardwareActions,
     ImagesComparison,
     IME,

test/unit/webdriver/device/device_time_test.py

@@ -21,7 +21,7 @@
 import httpretty
 
 
-class TestWebDriverDeviceLock(object):
+class TestWebDriverDeviceTime(object):
 
     @httpretty.activate
     def test_device_time(self):

test/unit/webdriver/device/gsm_test.py

@@ -0,0 +1,47 @@
+#!/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
+
+from appium.webdriver.webdriver import WebDriver
+from appium.webdriver.extensions.gsm import Gsm
+
+
+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_set_gsm_signal(self):
+        driver = android_w3c_driver()
+        httpretty.register_uri(
+            httpretty.POST,
+            appium_command('/session/1234567890/appium/device/gsm_signal'),
+        )
+        assert isinstance(driver.set_gsm_signal(Gsm.GREAT), WebDriver)
+
+        d = get_httpretty_request_body(httpretty.last_request())
+        assert d['signalStrength'] == Gsm.GREAT
+        assert d['signalStrengh'] == Gsm.GREAT