fix docstring, add getting available port number (appium#448)

KazuCocoa · web-flow · commit 947a943c698a · 2019-10-18T13:08:56.000+09:00
* fix docstring, add getting available port number

* add WebDriverWait

* define custom wait

* move get available port in another module

* follow python wait condition name
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -705,7 +705,7 @@ def session(self):
     def all_sessions(self):
         """ Retrieves all sessions that are open
         Usage:
-            sessions = driver.allSessions
+            sessions = driver.all_sessions
         Returns:
             `dict containing all open sessions`
         """
diff --git a/test/functional/ios/helper/desired_capabilities.py b/test/functional/ios/helper/desired_capabilities.py
@@ -63,10 +63,11 @@ def wda_port():
 
     return 8100
 
+
 # Before running tests, you must have iOS simulators named 'iPhone 6s - 8100' and 'iPhone 6s - 8101'
 
 
-def iphone_device_name():
+def iphone_device_name(port=None):
     if PytestXdistWorker.NUMBER == PytestXdistWorker.gw(0):
         return 'iPhone 8 - 8100'
     elif PytestXdistWorker.NUMBER == PytestXdistWorker.gw(1):
diff --git a/test/functional/ios/webdriver_tests.py b/test/functional/ios/webdriver_tests.py
@@ -14,8 +14,11 @@
 
 import unittest
 
+from selenium.webdriver.support.ui import WebDriverWait
+
 from appium import webdriver
 from appium.webdriver.applicationstate import ApplicationState
+from test.functional.test_helper import get_available_from_port_range
 
 from .helper import desired_capabilities
 
@@ -24,20 +27,31 @@ class WebDriverTests(unittest.TestCase):
     def setUp(self):
         desired_caps = desired_capabilities.get_desired_capabilities('UICatalog.app.zip')
         self.driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
-        desired_caps['deviceName'] = 'iPhone Xs Max'
-        desired_caps['wdaLocalPort'] = '8102'
 
     def tearDown(self):
         self.driver.quit()
 
-    def testAllSessions(self):
+    def test_all_sessions(self):
+        port = get_available_from_port_range(8200, 8300)
         desired_caps = desired_capabilities.get_desired_capabilities('UICatalog.app.zip')
         desired_caps['deviceName'] = 'iPhone Xs Max'
-        desired_caps['wdaLocalPort'] = '8102'
-        self.driver1 = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
-        self.assertEqual(2, len(self.driver.all_sessions))
-        if self.driver1:
-            self.driver1.quit()
+        desired_caps['wdaLocalPort'] = port
+
+        class session_counts_is_two(object):
+            TIMEOUT = 10
+
+            def __call__(self, driver):
+                return len(driver.all_sessions) == 2
+
+        driver2 = None
+        try:
+            driver2 = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
+            WebDriverWait(
+                driver2, session_counts_is_two.TIMEOUT).until(session_counts_is_two())
+            self.assertEqual(2, len(self.driver.all_sessions))
+        finally:
+            if driver2 is not None:
+                driver2.quit()
 
     def test_app_management(self):
         # this only works in Xcode9+
diff --git a/test/functional/test_helper.py b/test/functional/test_helper.py
@@ -0,0 +1,23 @@
+import socket
+
+
+class NoAvailablePortError(Exception):
+    pass
+
+
+def get_available_from_port_range(from_port, to_port):
+    """Returns available local port number.
+    """
+    r = range(from_port, to_port)
+
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+
+    for port in r:
+        try:
+            if sock.connect_ex(('localhost', port)) != 0:
+                return port
+        finally:
+            sock.close()
+
+    raise NoAvailablePortError('No available port between {} and {}'.format(
+        from_port, to_port))
