Add send sms support (appium#351)

ki4070ma · KazuCocoa · commit b70abb640c09 · 2019-04-21T14:59:59.000+09:00
* Support sendSms function

* Added api doc

* Add sms unittest

* Revert unexpected changes

* Update api doc
diff --git a/appium/webdriver/extensions/sms.py b/appium/webdriver/extensions/sms.py
@@ -0,0 +1,35 @@
+#!/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 Sms(webdriver.Remote):
+
+    def send_sms(self, phone_number, message):
+        """Emulate send SMS event on the connected emulator.
+
+        :Args:
+         - phone_number: The phone number of message sender
+         - message: message: The message to send
+
+        :Usage:
+            self.driver.send_sms('555-123-4567', 'Hey lol')
+        """
+        self.execute(Command.SEND_SMS, {'phoneNumber': phone_number, 'message': message})
+
+    def _addCommands(self):
+        self.command_executor._commands[Command.SEND_SMS] = \
+            ('POST', '/session/$sessionId/appium/device/send_sms')
diff --git a/appium/webdriver/mobilecommand.py b/appium/webdriver/mobilecommand.py
@@ -76,3 +76,4 @@ class MobileCommand(object):
     GET_CLIPBOARD = 'getClipboard'
     COMPARE_IMAGES = 'compareImages'
     FINGER_PRINT = 'fingerPrint'
+    SEND_SMS = 'sendSms'
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -42,6 +42,7 @@
 from .extensions.screen_record import ScreenRecord
 from .extensions.search_context import AppiumSearchContext
 from .extensions.settings import Settings
+from .extensions.sms import Sms
 from .mobilecommand import MobileCommand as Command
 from .switch_to import MobileSwitchTo
 from .webelement import WebElement as MobileWebElement
@@ -118,7 +119,8 @@ class WebDriver(
     Network,
     RemoteFS,
     ScreenRecord,
-    Settings
+    Settings,
+    Sms
 ):
 
     def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
diff --git a/test/unit/webdriver/device/sms_test.py b/test/unit/webdriver/device/sms_test.py
@@ -0,0 +1,37 @@
+#!/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 TestWebDriverSms(object):
+
+    @httpretty.activate
+    def test_send_sms(self):
+        driver = android_w3c_driver()
+        httpretty.register_uri(
+            httpretty.POST,
+            appium_command('/session/1234567890/appium/device/send_sms'),
+        )
+        assert driver.send_sms('555-123-4567', 'Hey lol') is None
+
+        d = get_httpretty_request_body(httpretty.last_request())
+        assert d['phoneNumber'] == '555-123-4567'
+        assert d['message'] == 'Hey lol'
