Add support for w3c session

Author: avinash-bharti

android/browserstack_sample.py

@@ -1,6 +1,6 @@
 from appium import webdriver
 from appium.options.android import UiAutomator2Options
-from appium.webdriver.common.mobileby import MobileBy
+from appium.webdriver.common.appiumby import AppiumBy
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
 import time
@@ -15,13 +15,13 @@
     "deviceName" : "Google Pixel 3",
 
     # Set URL of the application under test
-    "app" : "<bs://app-id>",
+    "app" : "bs://<app-id>",
 
     # Set other BrowserStack capabilities
     'bstack:options' : {
         "projectName" : "First Python project",
         "buildName" : "browserstack-build-1",
-        "sessionName" : "first_test",
+        "sessionName" : "BStack first_test",
 
         # Set your access credentials
         "userName" : "YOUR_USERNAME",
@@ -30,22 +30,22 @@
 })
 
 # Initialize the remote Webdriver using BrowserStack remote URL
-# and desired capabilities defined above
+# and options defined above
 driver = webdriver.Remote("http://hub-cloud.browserstack.com/wd/hub", options=options)
 
 # Test case for the BrowserStack sample Android app.
 # If you have uploaded your app, update the test case here.
 search_element = WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Search Wikipedia"))
+    EC.element_to_be_clickable((AppiumBy.ACCESSIBILITY_ID, "Search Wikipedia"))
 )
 search_element.click()
 search_input = WebDriverWait(driver, 30).until(
     EC.element_to_be_clickable(
-        (MobileBy.ID, "org.wikipedia.alpha:id/search_src_text"))
+        (AppiumBy.ID, "org.wikipedia.alpha:id/search_src_text"))
 )
 search_input.send_keys("BrowserStack")
 time.sleep(5)
-search_results = driver.find_elements_by_class_name("android.widget.TextView")
+search_results = driver.find_elements(AppiumBy.CLASS_NAME, "android.widget.TextView")
 assert (len(search_results) > 0)
 
 # Invoke driver.quit() after the test is done to indicate that the test is completed.

android/browserstack_sample_local.py

@@ -1,5 +1,6 @@
 from appium import webdriver
-from appium.webdriver.common.mobileby import MobileBy
+from appium.options.android import UiAutomator2Options
+from appium.webdriver.common.appiumby import AppiumBy
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
 from browserstack.local import Local
@@ -9,7 +10,10 @@
 userName = "YOUR_USERNAME"
 accessKey = "YOUR_ACCESS_KEY"
 
-desired_caps = {
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+options = UiAutomator2Options().load_capabilities({
     # Set URL of the application under test
     "app" : "bs://<app-id>",
 
@@ -18,21 +22,16 @@
     "platformName": "android",
     "platformVersion": "9.0",
 
-    # Set other BrowserStack capabilities
-    "project" : "First Python Local project", 
-    "build" : "browserstack-build-1",
-    "name" : "local_test",
-
     # Set other BrowserStack capabilities
     "bstack:options": {
         "userName" : userName,
         "accessKey" : accessKey,
         "projectName" : "First Python Local project",
         "buildName" : "browserstack-build-1",
-        "sessionName" : "local_test",
-        "local" : True
+        "sessionName" : "BStack local_test",
+        "local" : "true"
     }
-}
+})
 
 bs_local = None
 
@@ -50,23 +49,20 @@ def stop_local():
 start_local()
 
 # Initialize the remote Webdriver using BrowserStack remote URL
-# and desired capabilities defined above
-driver = webdriver.Remote(
-    command_executor="http://hub-cloud.browserstack.com/wd/hub", 
-    desired_capabilities=desired_caps
-)
+# and options defined above
+driver = webdriver.Remote("http://hub-cloud.browserstack.com/wd/hub", options=options)
 
 # Test case for the BrowserStack sample Android app. 
 # If you have uploaded your app, update the test case here. 
 test_button = WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.ID, "com.example.android.basicnetworking:id/test_action"))
+    EC.element_to_be_clickable((AppiumBy.ID, "com.example.android.basicnetworking:id/test_action"))
 )
 test_button.click()
 WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.CLASS_NAME, "android.widget.TextView"))
+    EC.element_to_be_clickable((AppiumBy.CLASS_NAME, "android.widget.TextView"))
 )
 test_element = None
-search_results = driver.find_elements_by_class_name("android.widget.TextView")
+search_results = driver.find_elements(AppiumBy.CLASS_NAME,"android.widget.TextView")
 for result in search_results:
     if result.text.__contains__("The active connection is"):
         test_element = result

ios/browserstack_sample.py

@@ -1,10 +1,14 @@
 from appium import webdriver
-from appium.webdriver.common.mobileby import MobileBy
+from appium.options.ios import XCUITestOptions
+from appium.webdriver.common.appiumby import AppiumBy
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
 import time
 
-desired_cap = {
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+options = XCUITestOptions().load_capabilities({
     # Set URL of the application under test
     "app" : "bs://<app-id>",
 
@@ -19,30 +23,27 @@
         "accessKey" : "YOUR_ACCESS_KEY",
         "projectName" : "First Python project",
         "buildName" : "browserstack-build-1",
-        "sessionName" : "first_test"
+        "sessionName" : "BStack first_test"
     }
-}
+})
 
 # Initialize the remote Webdriver using BrowserStack remote URL
-# and desired capabilities defined above
-driver = webdriver.Remote(
-    command_executor="http://hub-cloud.browserstack.com/wd/hub", 
-    desired_capabilities=desired_cap
-)
+# and options defined above
+driver = webdriver.Remote("http://hub-cloud.browserstack.com/wd/hub", options=options)
 
-# Test case for the BrowserStack sample Android app. 
+# Test case for the BrowserStack sample iOS app.
 # If you have uploaded your app, update the test case here. 
 text_button = WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Text Button"))
+    EC.element_to_be_clickable((AppiumBy.ACCESSIBILITY_ID, "Text Button"))
 )
 text_button.click()
 text_input = WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Text Input"))
+    EC.element_to_be_clickable((AppiumBy.ACCESSIBILITY_ID, "Text Input"))
 )
 text_input.send_keys("hello@browserstack.com"+"\n")
 time.sleep(5)
 text_output = WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "Text Output"))
+    EC.element_to_be_clickable((AppiumBy.ACCESSIBILITY_ID, "Text Output"))
 )
 if text_output!=None and text_output.text=="hello@browserstack.com":
 	assert True

ios/browserstack_sample_local.py

@@ -1,5 +1,6 @@
 from appium import webdriver
-from appium.webdriver.common.mobileby import MobileBy
+from appium.options.ios import XCUITestOptions
+from appium.webdriver.common.appiumby import AppiumBy
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
 from browserstack.local import Local
@@ -9,30 +10,28 @@
 userName = "YOUR_USERNAME"
 accessKey = "YOUR_ACCESS_KEY"
 
-desired_caps = {
+# Options are only available since client version 2.3.0
+# If you use an older client then switch to desired_capabilities
+# instead: https://github.com/appium/python-client/pull/720
+options = XCUITestOptions().load_capabilities({
     # Set URL of the application under test
     "app" : "bs://<app-id>",
 
     # Specify device and os_version for testing
-    "deviceName": "iPhone 11 Pro",
+    "deviceName": "iPhone XS",
     "platformName": "ios",
-    "platformVersion": "13",
-
-    # Set other BrowserStack capabilities
-    "project" : "First Python Local project", 
-    "build" : "browserstack-build-1",
-    "name" : "local_test",
+    "platformVersion": "12",
 
     # Set other BrowserStack capabilities
     "bstack:options": {
         "userName" : userName,
         "accessKey" : accessKey,
         "projectName" : "First Python Local project",
         "buildName" : "browserstack-build-1",
-        "sessionName" : "local_test",
-        "local" : True
+        "sessionName" : "BStack first_test",
+        "local" : "true"
     }
-}
+})
 
 bs_local = None
 
@@ -47,27 +46,24 @@ def stop_local():
     bs_local.stop()
 
 def existence_lambda(s):
-    result = s.find_element_by_accessibility_id("ResultBrowserStackLocal").get_attribute("value")
+    result = s.find_element(AppiumBy.ACCESSIBILITY_ID, "ResultBrowserStackLocal").get_attribute("value")
     return result and len(result) > 0
 
 # Start BrowserStack local binary
 start_local()
 
 # Initialize the remote Webdriver using BrowserStack remote URL
-# and desired capabilities defined above
-driver = webdriver.Remote(
-    command_executor="http://hub-cloud.browserstack.com/wd/hub", 
-    desired_capabilities=desired_caps
-)
+# and options defined above
+driver = webdriver.Remote("http://hub-cloud.browserstack.com/wd/hub", options=options)
 
 # Test case for the BrowserStack sample iOS app. 
 # If you have uploaded your app, update the test case here. 
 test_button = WebDriverWait(driver, 30).until(
-    EC.element_to_be_clickable((MobileBy.ACCESSIBILITY_ID, "TestBrowserStackLocal"))
+    EC.element_to_be_clickable((AppiumBy.ACCESSIBILITY_ID, "TestBrowserStackLocal"))
 )
 test_button.click()
 WebDriverWait(driver, 30).until(existence_lambda)
-result_element = driver.find_element_by_accessibility_id("ResultBrowserStackLocal")
+result_element = driver.find_element(AppiumBy.ACCESSIBILITY_ID, "ResultBrowserStackLocal")
 result_string = result_element.text.lower()
 if result_string.__contains__("not working"):
     screenshot_file = "%s/screenshot.png" % os.getcwd()