Merge pull request #13 from browserstack/w3c

francisf · web-flow · commit ff0b2d8a5a64 · 2022-10-13T18:10:57.000+05:30
Add w3c support
diff --git a/README.md b/README.md
@@ -2,55 +2,53 @@
 
 This repository demonstrates how to run Appium Python tests on BrowserStack App Automate.
 
+## Based on
+
+These code samples are currently based on:
+
+- **Appium-Python-Client:** `2.6.1`
+- **Protocol:** `W3C`
+
 ## Setup
 
 ### Requirements
 
-1. Python 3.6+ or Python 2.7+
-    
-    - For Windows, download latest python version from [here](https://www.python.org/downloads/windows/) and run the installer executable
-    - For Mac and Linux, run `python --version` to see what python version is pre-installed. If you want a different version download from [here](https://www.python.org/downloads/)
+1. Python 3.7+
 
-2. Package Manager pip
+   > **_NOTE:_** Since v1.0.0, only Python 3.7+ is supported.
+
+   - For Windows, download latest python version from [here](https://www.python.org/downloads/windows/) and run the installer executable
+   - For Mac and Linux, run `python --version` to see what python version is pre-installed. If you want a different version download from [here](https://www.python.org/downloads/)
 
-    Note : `pip` comes installed with Python 2.7.9+ and python 3.4+
+2. Package Manager pip
 
-    - If `pip` is not installed, follow these instructions:
-        - Securely download get-pip.py by following this link: [get-pip.py](https://bootstrap.pypa.io/get-pip.py) or use following cURL command to download it:
+   Note : `pip` comes installed with python 3.4+
 
-        ```sh
-        curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
-        ```
+   - If `pip` is not installed, follow these instructions:
 
-        - After dowloading, run the file :
+     - Securely download get-pip.py by following this link: [get-pip.py](https://bootstrap.pypa.io/get-pip.py) or use following cURL command to download it:
 
-            - For Python 3
+     ```sh
+     curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
+     ```
 
-                ```sh
-                python3 get-pip.py
-                ```
+     - After dowloading, run the file :
 
-            - For Python 2
+       - For Python 3
 
-                ```sh
-                python2 get-pip.py
-                ```
+         ```sh
+         python3 get-pip.py
+         ```
 
 ### Install the dependencies
 
 To install the dependencies, run the following command in project's base directory:
 
 - For Python 3
 
-    ```sh
-    pip3 install -r requirements.txt
-    ```
-
-- For Python 2
-
-    ```sh
-    pip2 install -r requirements.txt
-    ```
+  ```sh
+  pip3 install -r requirements.txt
+  ```
 
 ## Getting Started
 
@@ -72,7 +70,6 @@ Ensure that @ symbol is prepended to the file path in the above request. Please
 
 **Note**: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our [sample Android app](https://www.browserstack.com/app-automate/sample-apps/android/WikipediaSample.apk) or [sample iOS app](https://www.browserstack.com/app-automate/sample-apps/ios/BStackSampleApp.ipa).
 
-
 **2. Configure and run your first test**
 
 Open `browserstack_sample.py` file in `Android` or `iOS` folder :
@@ -107,7 +104,6 @@ Ensure that @ symbol is prepended to the file path in the above request. Please
 
 **Note**: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our [sample Android Local app](https://www.browserstack.com/app-automate/sample-apps/android/LocalSample.apk) or [sample iOS Local app](https://www.browserstack.com/app-automate/sample-apps/ios/LocalSample.ipa).
 
-
 **2. Configure and run your local test**
 
 Open `browserstack_sample_local` file in `Android` or `iOS` folder :
@@ -118,7 +114,7 @@ Open `browserstack_sample_local` file in `Android` or `iOS` folder :
 
 - Set the device and OS version
 
-- Ensure that `browserstack.local` capability is set to `true`. Within the test script, there is code snippet that automatically establishes Local Testing connection to BrowserStack servers using Python binding for BrowserStack Local. 
+- Ensure that `local` capability is set to `true`. Within the test script, there is code snippet that automatically establishes Local Testing connection to BrowserStack servers using Python binding for BrowserStack Local.
 
 - If you have uploaded your own app update the test case
 
diff --git a/android/browserstack_sample.py b/android/browserstack_sample.py
@@ -1,47 +1,52 @@
 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
 import time
 
-desired_cap = {
-    # Set your access credentials
-    "browserstack.user" : "YOUR_USERNAME",
-    "browserstack.key" : "YOUR_ACCESS_KEY",
+# 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({
+    # Specify device and os_version for testing
+    "platformName" : "android",
+    "platformVersion" : "9.0",
+    "deviceName" : "Google Pixel 3",
 
     # Set URL of the application under test
     "app" : "bs://<app-id>",
 
-    # Specify device and os_version for testing
-    "device" : "Google Pixel 3",
-    "os_version" : "9.0",
-    
     # Set other BrowserStack capabilities
-    "project" : "First Python project", 
-    "build" : "browserstack-build-1",
-    "name" : "first_test"
-}
+    'bstack:options' : {
+        "projectName" : "First Python project",
+        "buildName" : "browserstack-build-1",
+        "sessionName" : "BStack first_test",
+
+        # Set your access credentials
+        "userName" : "YOUR_USERNAME",
+        "accessKey" : "YOUR_ACCESS_KEY"
+    }
+})
 
 # 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.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 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"))
+    EC.element_to_be_clickable(
+        (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")
-assert(len(search_results) > 0)
+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.
 driver.quit()
diff --git a/android/browserstack_sample_local.py b/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,25 +10,28 @@
 userName = "YOUR_USERNAME"
 accessKey = "YOUR_ACCESS_KEY"
 
-desired_caps = {
-    "browserstack.user" : userName,
-    "browserstack.key" : accessKey,
-
+# 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>",
+    "app" : "bs://<app-id>",
 
     # Specify device and os_version for testing
-    "device" : "Google Pixel 3",
-    "os_version" : "9.0",
-
-    #Set BrowserStack Local capability as True
-    "browserstack.local": True,
+    "deviceName": "Google Pixel 3",
+    "platformName": "android",
+    "platformVersion": "9.0",
 
     # Set other BrowserStack capabilities
-    "project" : "First Python Local project", 
-    "build" : "browserstack-build-1",
-    "name" : "local_test"
-}
+    "bstack:options": {
+        "userName" : userName,
+        "accessKey" : accessKey,
+        "projectName" : "First Python Local project",
+        "buildName" : "browserstack-build-1",
+        "sessionName" : "BStack local_test",
+        "local" : "true"
+    }
+})
 
 bs_local = None
 
@@ -45,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.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
diff --git a/ios/browserstack_sample.py b/ios/browserstack_sample.py
@@ -1,47 +1,49 @@
 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 = {
-    # Set your access credentials
-    "browserstack.user" : "YOUR_USERNAME",
-    "browserstack.key" : "YOUR_ACCESS_KEY",
-
+# 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
-    "device" : "iPhone 11 Pro",
-    "os_version" : "13",
-    
+    "deviceName": "iPhone 11 Pro",
+    "platformName": "ios",
+    "platformVersion": "13",
+
     # Set other BrowserStack capabilities
-    "project" : "First Python project", 
-    "build" : "browserstack-build-1",
-    "name" : "first_test"
-}
+    "bstack:options": {
+        "userName" : "YOUR_USERNAME",
+        "accessKey" : "YOUR_ACCESS_KEY",
+        "projectName" : "First Python project",
+        "buildName" : "browserstack-build-1",
+        "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.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
diff --git a/ios/browserstack_sample_local.py b/ios/browserstack_sample_local.py
diff --git a/requirements.txt b/requirements.txt
