diff --git a/README.md b/README.md index ef3660d..46b0c6b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,140 @@ -| [Using Java 7 client with MJSONWP protocol](./java_7) | [Using Java 8 client with w3c protocol](./java_8) | -|------------------------------------------------------ | ------------------------------------------------- | \ No newline at end of file +# java-appium-app-browserstack + +This repository demonstrates how to run Appium Java tests on BrowserStack App Automate. + +## Based on + +These code samples are currently based on: + +- **Appium-Java-Client:** `8.1.1` +- **Protocol:** `W3C` + +## Setup + +### Requirements + +1. Java 8+ (JDK) + +- If Java is not installed, follow these instructions: + - For Windows, download latest java version from [here](https://java.com/en/download/) and run the installer executable + - For Mac and Linux, run `java -version` to see what java version is pre-installed. If you want a different version download from [here](https://java.com/en/download/) + +2. Maven + + - If Maven is not downloaded, download it from [here](https://maven.apache.org/download.cgi) + - For installation, follow the instructions [here](https://maven.apache.org/install.html) + +### Install the dependencies + +To install the dependencies, run the following command in the project's base folder + +```cmd +mvn clean install +``` + +## Getting Started + +Getting Started with Appium tests in Java on BrowserStack couldn't be easier! + +### Run your first test : + +**1. Upload your Android or iOS App** + +Upload your Android app (.apk or .aab file) or iOS app (.ipa file) to BrowserStack servers using our REST API. Here is an example cURL request : + +``` +curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ +-X POST "https://api-cloud.browserstack.com/app-automate/upload" \ +-F "file=@/path/to/apk/file" +``` + +Ensure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on. + +**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 `BrowserStackSample.java` file in the `android` directory or `ios` directory : + +- Replace `YOUR_USERNAME` & `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings) + +- Replace `bs://` with the URL obtained from app upload step + +- Set the device and OS version + +- If you have uploaded your own app update the test case + +- To run the test, use the following command in the base directory : + + - For Android test, run + + ```cmd + mvn test -P android-first-test + ``` + + - For iOS test, run + + ```cmd + mvn test -P ios-first-test + ``` + +- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard) + +--- + +### Use Local testing for apps that access resources hosted in development or testing environments : + +**1. Upoad your Android or iOS App** + +Upload your Android app (.apk or .aab file) or iOS app (.ipa file) that access resources hosted on your internal or test environments to BrowserStack servers using our REST API. Here is an example cURL request : + +``` +curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ +-X POST "https://api-cloud.browserstack.com/app-automate/upload" \ +-F "file=@/path/to/apk/file" +``` + +Ensure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on. + +**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** + +Local Testing is a BrowserStack feature that helps you test mobile apps that access resources hosted in development or testing environments during automated test execution + +Open `BrowserStackSampleLocal.java` file in the `android` or `ios` directory : + +- Replace `YOUR_USERNAME` & `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings) + +- Replace `bs://` with the URL obtained from app upload step + +- Set the device and OS version + +- 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 Java binding for BrowserStack Local. + +- If you have uploaded your own app update the test case + +- To run the test, use the following command in the base directory : + + - For Android test, run + + ```cmd + mvn test -P android-local-test + ``` + + - For iOS test, run + + ```cmd + mvn test -P ios-local-test + ``` + +- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard) + +## Integration with other Java frameworks + +- [JUnit](https://github.com/browserstack/junit-appium-app-browserstack) +- [TestNg](https://github.com/browserstack/testng-appium-app-browserstack) + +## Getting Help + +If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help). diff --git a/java_7/README.md b/java_7/README.md deleted file mode 100644 index 91d90d7..0000000 --- a/java_7/README.md +++ /dev/null @@ -1,135 +0,0 @@ -| Using Java 7 client with MJSONWP protocol | [Using Java 8 client with w3c protocol](../java_8) | -|------------------------------------------ | -------------------------------------------------- | - -# java-appium-app-browserstack - -This repository demonstrates how to run Appium Java tests on BrowserStack App Automate. - -## Setup - -### Requirements - -1. Java 8+ (JDK) - -- If Java is not installed, follow these instructions: - - For Windows, download latest java version from [here](https://java.com/en/download/) and run the installer executable - - For Mac and Linux, run `java -version` to see what java version is pre-installed. If you want a different version download from [here](https://java.com/en/download/) - -2. Maven - - - If Maven is not downloaded, download it from [here](https://maven.apache.org/download.cgi) - - For installation, follow the instructions [here](https://maven.apache.org/install.html) - -### Install the dependencies - -To install the dependencies, run the following command in the project's base folder - -```cmd -mvn clean install -``` - -## Getting Started - -Getting Started with Appium tests in Java on BrowserStack couldn't be easier! - -### Run your first test : - -**1. Upload your Android or iOS App** - -Upload your Android app (.apk or .aab file) or iOS app (.ipa file) to BrowserStack servers using our REST API. Here is an example cURL request : - -``` -curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ --X POST "https://api-cloud.browserstack.com/app-automate/upload" \ --F "file=@/path/to/apk/file" -``` - -Ensure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on. - -**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 `BrowserStackSample.java` file in the `android` directory or `ios` directory : - -- Replace `YOUR_USERNAME` & `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings) - -- Replace `bs://` with the URL obtained from app upload step - -- Set the device and OS version - -- If you have uploaded your own app update the test case - -- To run the test, use the following command in the base directory : - - - For Android test, run - - ```cmd - mvn test -P android-first-test - ``` - - - For iOS test, run - - ```cmd - mvn test -P ios-first-test - ``` - -- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard) - ---- - -### Use Local testing for apps that access resources hosted in development or testing environments : - -**1. Upoad your Android or iOS App** - -Upload your Android app (.apk or .aab file) or iOS app (.ipa file) that access resources hosted on your internal or test environments to BrowserStack servers using our REST API. Here is an example cURL request : - -``` -curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ --X POST "https://api-cloud.browserstack.com/app-automate/upload" \ --F "file=@/path/to/apk/file" -``` - -Ensure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on. - -**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 `BrowserStackSampleLocal.java` file in the `android` or `ios` directory : - -- Replace `YOUR_USERNAME` & `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings) - -- Replace `bs://` with the URL obtained from app upload step - -- 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 Java binding for BrowserStack Local. - -- If you have uploaded your own app update the test case - -- To run the test, use the following command in the base directory : - - - For Android test, run - - ```cmd - mvn test -P android-local-test - ``` - - - For iOS test, run - - ```cmd - mvn test -P ios-local-test - ``` - -- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard) - - -## Integration with other Java frameworks - -- [JUnit](https://github.com/browserstack/junit-appium-app-browserstack) -- [TestNg](https://github.com/browserstack/testng-appium-app-browserstack) - -## Getting Help - -If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help). diff --git a/java_7/pom.xml b/java_7/pom.xml deleted file mode 100644 index 74fc8bd..0000000 --- a/java_7/pom.xml +++ /dev/null @@ -1,160 +0,0 @@ - - 4.0.0 - com.browserstack - java-browserstack - 0.0.1-SNAPSHOT - java-browserstack - Java appium app browserstack - - - UTF-8 - 2.19.1 - - default - - - - - - commons-io - commons-io - 1.3.2 - - - io.appium - java-client - 7.0.0 - - - com.browserstack - browserstack-local-java - 1.0.3 - - - com.googlecode.json-simple - json-simple - 1.1.1 - - - - - - - org.apache.maven.plugins - maven-surefire-plugin - 2.22.2 - - - org.apache.maven.plugins - maven-compiler-plugin - 3.8.1 - - 1.8 - 1.8 - - - - - - - - android-first-test - - - - org.codehaus.mojo - exec-maven-plugin - 1.1.1 - - - test - - java - - - android.BrowserStackSample - test - - - - - - - - - android-local-test - - - - org.codehaus.mojo - exec-maven-plugin - 1.1.1 - - - test - - java - - - android.BrowserStackSampleLocal - test - - - - - - - - - ios-first-test - - - - org.codehaus.mojo - exec-maven-plugin - 1.1.1 - - - test - - java - - - ios.BrowserStackSample - test - - - - - - - - - ios-local-test - - - - org.codehaus.mojo - exec-maven-plugin - 1.1.1 - - - test - - java - - - ios.BrowserStackSampleLocal - test - - - - - - - - - - \ No newline at end of file diff --git a/java_7/src/test/java/android/BrowserStackSample.java b/java_7/src/test/java/android/BrowserStackSample.java deleted file mode 100644 index 136ee81..0000000 --- a/java_7/src/test/java/android/BrowserStackSample.java +++ /dev/null @@ -1,68 +0,0 @@ -package android; - -import java.net.URL; -import java.util.List; -import java.util.function.Function; -import java.net.MalformedURLException; - -import io.appium.java_client.MobileBy; -import io.appium.java_client.android.AndroidDriver; -import io.appium.java_client.android.AndroidElement; - -import org.openqa.selenium.support.ui.ExpectedConditions; -import org.openqa.selenium.support.ui.WebDriverWait; -import org.openqa.selenium.WebDriver; -import org.openqa.selenium.remote.DesiredCapabilities; - - -public class BrowserStackSample { - - public static void main(String[] args) throws MalformedURLException, InterruptedException { - - DesiredCapabilities caps = new DesiredCapabilities(); - - // Set your access credentials - caps.setCapability("browserstack.user", "YOUR_USERNAME"); - caps.setCapability("browserstack.key", "YOUR_ACCESS_KEY"); - - // Set URL of the application under test - caps.setCapability("app", "bs://"); - - // Specify device and os_version for testing - caps.setCapability("device", "Google Pixel 3"); - caps.setCapability("os_version", "9.0"); - - // Set other BrowserStack capabilities - caps.setCapability("project", "First Java Project"); - caps.setCapability("build", "browserstack-build-1"); - caps.setCapability("name", "first_test"); - - - // Initialise the remote Webdriver using BrowserStack remote URL - // and desired capabilities defined above - AndroidDriver driver = new AndroidDriver( - new URL("http://hub.browserstack.com/wd/hub"), caps); - - - // Test case for the BrowserStack sample Android app. - // If you have uploaded your app, update the test case here. - AndroidElement searchElement = (AndroidElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable( - MobileBy.AccessibilityId("Search Wikipedia"))); - searchElement.click(); - AndroidElement insertTextElement = (AndroidElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable( - MobileBy.id("org.wikipedia.alpha:id/search_src_text"))); - insertTextElement.sendKeys("BrowserStack"); - Thread.sleep(5000); - List allProductsName = driver.findElementsByClassName( - "android.widget.TextView"); - assert(allProductsName.size() > 0); - - - // Invoke driver.quit() after the test is done to indicate that the test is completed. - driver.quit(); - - } - -} diff --git a/java_7/src/test/java/android/BrowserStackSampleLocal.java b/java_7/src/test/java/android/BrowserStackSampleLocal.java deleted file mode 100644 index 0854db1..0000000 --- a/java_7/src/test/java/android/BrowserStackSampleLocal.java +++ /dev/null @@ -1,90 +0,0 @@ -package android; - -import com.browserstack.local.Local; -import java.net.URL; import java.util.*; -import io.appium.java_client.MobileBy; import io.appium.java_client.android.*; -import org.openqa.selenium.support.ui.*;import org.openqa.selenium.remote.*; - -public class BrowserStackSampleLocal { - - private static Local localInstance; - public static String userName = "YOUR_USERNAME"; - public static String accessKey = "YOUR_ACCESS_KEY"; - - - public static void setupLocal() throws Exception { - localInstance = new Local(); - Map options = new HashMap(); - options.put("key", accessKey); - localInstance.start(options); - } - - public static void tearDownLocal() throws Exception { - localInstance.stop(); - } - - public static void main(String[] args) throws Exception { - // Start the BrowserStack Local binary - setupLocal(); - - DesiredCapabilities capabilities = new DesiredCapabilities(); - - // Set your access credentials - capabilities.setCapability("browserstack.user", userName); - capabilities.setCapability("browserstack.key", accessKey); - - // Set URL of the application under test - capabilities.setCapability("app", "bs://"); - - // Specify device and os_version for testing - capabilities.setCapability("device", "Google Pixel 3"); - capabilities.setCapability("os_version", "9.0"); - - // Set the browserstack.local capability to true - capabilities.setCapability("browserstack.local", true); - - // Set other BrowserStack capabilities - capabilities.setCapability("project", "First Java Project"); - capabilities.setCapability("build", "browserstack-build-1"); - capabilities.setCapability("name", "local_test"); - - - // Initialise the remote Webdriver using BrowserStack remote URL - // and desired capabilities defined above - AndroidDriver driver = new AndroidDriver( - new URL("http://hub.browserstack.com/wd/hub"), capabilities); - - // Test case for the BrowserStack sample Android Local app. - // If you have uploaded your app, update the test case here. - AndroidElement searchElement = (AndroidElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable(MobileBy.id("com.example.android.basicnetworking:id/test_action"))); - searchElement.click(); - AndroidElement insertTextElement = (AndroidElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable(MobileBy.className("android.widget.TextView"))); - - AndroidElement testElement = null; - List allTextViewElements = driver.findElementsByClassName("android.widget.TextView"); - Thread.sleep(10); - for(AndroidElement textElement : allTextViewElements) { - if(textElement.getText().contains("The active connection is")) { - testElement = textElement; - } - } - - if(testElement == null) { - throw new Error("Cannot find the needed TextView element from app"); - } - String matchedString = testElement.getText(); - System.out.println(matchedString); - assert(matchedString.contains("The active connection is wifi")); - assert(matchedString.contains("Up and running")); - - // Invoke driver.quit() after the test is done to indicate that the test is completed. - driver.quit(); - - // Stop the BrowserStack Local binary - tearDownLocal(); - - } - -} diff --git a/java_7/src/test/java/ios/BrowserStackSample.java b/java_7/src/test/java/ios/BrowserStackSample.java deleted file mode 100644 index ce5ab08..0000000 --- a/java_7/src/test/java/ios/BrowserStackSample.java +++ /dev/null @@ -1,64 +0,0 @@ -package ios; - -import java.net.URL; -import java.util.List; -import java.net.MalformedURLException; - -import org.openqa.selenium.support.ui.WebDriverWait; -import org.openqa.selenium.remote.DesiredCapabilities; -import org.openqa.selenium.support.ui.ExpectedConditions; - -import io.appium.java_client.MobileBy; -import io.appium.java_client.ios.IOSDriver; -import io.appium.java_client.ios.IOSElement; - -public class BrowserStackSample { - - public static void main(String[] args) throws MalformedURLException, InterruptedException { - DesiredCapabilities caps = new DesiredCapabilities(); - - // Set your access credentials - caps.setCapability("browserstack.user", "YOUR_USERNAME"); - caps.setCapability("browserstack.key", "YOUR_ACCESS_KEY"); - - // Set URL of the application under test - caps.setCapability("app", "bs://"); - - // Specify device and os_version for testing - caps.setCapability("device", "iPhone 12"); - caps.setCapability("os_version", "13"); - - // Set other BrowserStack capabilities - caps.setCapability("project", "First Java Project"); - caps.setCapability("build", "browserstack-build-1"); - caps.setCapability("name", "first_test"); - - - // Initialise the remote Webdriver using BrowserStack remote URL - // and desired capabilities defined above - IOSDriver driver = new IOSDriver( - new URL("http://hub-cloud.browserstack.com/wd/hub"), caps); - - - // Test case for the BrowserStack sample iOS app. - // If you have uploaded your app, update the test case here. - IOSElement textButton = (IOSElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable(MobileBy.AccessibilityId("Text Button"))); - textButton.click(); - IOSElement textInput = (IOSElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable(MobileBy.AccessibilityId("Text Input"))); - textInput.sendKeys("hello@browserstack.com"); - Thread.sleep(5000); - IOSElement textOutput = (IOSElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable(MobileBy.AccessibilityId("Text Output"))); - if(textOutput != null && textOutput.getText().equals("hello@browserstack.com")) - assert(true); - else - assert(false); - - // Invoke driver.quit() after the test is done to indicate that the test is completed. - driver.quit(); - - } - -} diff --git a/java_7/src/test/java/ios/BrowserStackSampleLocal.java b/java_7/src/test/java/ios/BrowserStackSampleLocal.java deleted file mode 100644 index a4af409..0000000 --- a/java_7/src/test/java/ios/BrowserStackSampleLocal.java +++ /dev/null @@ -1,95 +0,0 @@ -package ios; - -import com.browserstack.local.Local; -import java.net.URL; import java.io.File; import java.util.*; -import org.apache.commons.io.FileUtils; -import io.appium.java_client.MobileBy; import io.appium.java_client.ios.*; -import org.openqa.selenium.*; -import org.openqa.selenium.support.ui.*;import org.openqa.selenium.remote.*; - -public class BrowserStackSampleLocal { - - private static Local localInstance; - public static String userName = "YOUR_USERNAME"; - public static String accessKey = "YOUR_ACCESS_KEY"; - - - public static void setupLocal() throws Exception { - localInstance = new Local(); - Map options = new HashMap(); - options.put("key", accessKey); - localInstance.start(options); - } - - public static void tearDownLocal() throws Exception { - localInstance.stop(); - } - - - public static void main(String[] args) throws Exception { - // Start the BrowserStack Local binary - setupLocal(); - - DesiredCapabilities capabilities = new DesiredCapabilities(); - - // Set your access credentials - capabilities.setCapability("browserstack.user", userName); - capabilities.setCapability("browserstack.key", accessKey); - - // Set URL of the application under test - capabilities.setCapability("app", "bs://"); - - // Specify device and os_version for testing - capabilities.setCapability("device", "iPhone 12"); - capabilities.setCapability("os_version", "13"); - - // Set the browserstack.local capability to true - capabilities.setCapability("browserstack.local", true); - - // Set other BrowserStack capabilities - capabilities.setCapability("project", "First Java Project"); - capabilities.setCapability("build", "browserstack-build-1"); - capabilities.setCapability("name", "local_test"); - - // Initialise the remote Webdriver using BrowserStack remote URL - // and desired capabilities defined above - IOSDriver driver = new IOSDriver( - new URL("http://hub.browserstack.com/wd/hub"), capabilities); - - // Test case for the BrowserStack sample iOS Local app. - // If you have uploaded your app, update the test case here. - IOSElement testButton = (IOSElement) new WebDriverWait(driver, 30).until( - ExpectedConditions.elementToBeClickable(MobileBy.AccessibilityId("TestBrowserStackLocal"))); - testButton.click(); - - WebDriverWait wait = new WebDriverWait(driver, 30); - wait.until(new ExpectedCondition() { - @Override - public Boolean apply(WebDriver d) { - String result = d.findElement(MobileBy.AccessibilityId("ResultBrowserStackLocal")).getAttribute("value"); - return result != null && result.length() > 0; - } - }); - IOSElement resultElement = (IOSElement) driver.findElement(MobileBy.AccessibilityId("ResultBrowserStackLocal")); - - String resultString = resultElement.getText().toLowerCase(); - System.out.println(resultString); - if(resultString.contains("not working")) { - File scrFile = (File) ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE); - FileUtils.copyFile(scrFile, new File(System.getProperty("user.dir") + "/screenshot.png")); - System.out.println("Screenshot stored at " + System.getProperty("user.dir") + "/screenshot.png"); - throw new Error("Unexpected BrowserStackLocal test result"); - } - - String expectedString = "Up and running"; - assert(resultString.contains(expectedString.toLowerCase())); - - // Invoke driver.quit() after the test is done to indicate that the test is completed. - driver.quit(); - - // Stop the BrowserStack Local binary - tearDownLocal(); - - } - -} diff --git a/java_8/README.md b/java_8/README.md deleted file mode 100644 index 4afdc79..0000000 --- a/java_8/README.md +++ /dev/null @@ -1,175 +0,0 @@ -| [Using Java 7 client with MJSONWP protocol](../java_7) | Using Java 8 client with w3c protocol | -|------------------------------------------------------- | ------------------------------------- | - -# java-appium-app-browserstack - -This repository demonstrates how to run Appium Java tests on BrowserStack App Automate. - -## Setup - -### Requirements - -1. Java 8+ (JDK) - -- If Java is not installed, follow these instructions: - - For Windows, download latest java version from [here](https://java.com/en/download/) and run the installer executable - - For Mac and Linux, run `java -version` to see what java version is pre-installed. If you want a different version download from [here](https://java.com/en/download/) - -2. Maven - - - If Maven is not downloaded, download it from [here](https://maven.apache.org/download.cgi) - - For installation, follow the instructions [here](https://maven.apache.org/install.html) - -### Install the dependencies - -To install the dependencies, run the following command in the project's base folder - -```cmd -mvn clean install -``` - -## Getting Started - -Getting Started with Appium tests in Java on BrowserStack couldn't be easier! - -### For java-client 8.0.0 and above - -- Any BrowserStack capability passed outside bstack:options will not be honoured \ -[Browserstack Capability Builder](https://www.browserstack.com/app-automate/capabilities?tag=w3c) - -- AppiumBy is available with java-client 8.0.0 as MobileBy is depreceated . For java-client < 8.0.0, MobileBy can be used. - -- DefaultGenericMobileElement class has been removed completely together with its descendants (MobileElement, IOSElement, AndroidElement etc.). Use WebElement instead. - -- WebDriverWait constructor requires time to be passed as a type Duration. So with java-client 8.0.0, pass wait time as a new Duration - **java-client v-7.0.0** - ``` - WebElement searchElement = (WebElement) new WebDriverWait(driver, 30) - ``` - - **java-client v-8.0.0** - ``` - import java.time.Duration; - WebElement searchElement = (WebElement) new WebDriverWait(driver, Duration.ofSeconds(30)) - ``` - - Refer this for tracking changes in java-client 8.0.0 documentation - [v7-to-v8-migration-guide](https://github.com/appium/java-client/blob/master/docs/v7-to-v8-migration-guide.md#mobileelement) - -### Run your first test : - -**1. Upload your Android or iOS App** - -Upload your Android app (.apk or .aab file) or iOS app (.ipa file) to BrowserStack servers using our REST API. Here is an example cURL request : - -``` -curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ --X POST "https://api-cloud.browserstack.com/app-automate/upload" \ --F "file=@/path/to/apk/file" -``` - -Ensure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on. - -**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 `BrowserStackSample.java` file in the `android` directory or `ios` directory : - -- Replace `YOUR_USERNAME` & `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings) - -- Replace `bs://` with the URL obtained from app upload step - -- Set the device and OS version - -- If you have uploaded your own app update the test case - -- To run the test, use the following command in the base directory : - - - For Android test, run - - ```cmd - mvn test -P android-first-test - ``` - - - For iOS test, run - - ```cmd - mvn test -P ios-first-test - ``` - -- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard) - ---- - -### Use Local testing for apps that access resources hosted in development or testing environments : - -**1. Upoad your Android or iOS App** - -Upload your Android app (.apk or .aab file) or iOS app (.ipa file) that access resources hosted on your internal or test environments to BrowserStack servers using our REST API. Here is an example cURL request : - -``` -curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \ --X POST "https://api-cloud.browserstack.com/app-automate/upload" \ --F "file=@/path/to/apk/file" -``` - -Ensure that @ symbol is prepended to the file path in the above request. Please note the `app_url` value returned in the API response. We will use this to set the application under test while configuring the test later on. - -**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** - -Local Testing is a BrowserStack feature that helps you test mobile apps that access resources hosted in development or testing environments during automated test execution - -**i. Setup Browserstack Local Testing connection :** - -Check the releases page to download the binary / native application [Browserstack Local Releases](https://www.browserstack.com/docs/local-testing/releases-and-downloads) - -- Option 1 - - Use Browserstack Local Binary - [Local Binary](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/local-testing) -- Option 2 - - Use Browserstack native application - [Local Native App](https://www.browserstack.com/docs/local-testing/local-app-upgrade-guide) - - -NOTE : If you're unable to run the LocalTesting Binary / Native application due to Apple permission issues, go to \ - ``` - System preferences -> Security and privacy -> General -> Allow app - ``` - -**ii. Open `BrowserStackSampleLocal.java` file in the `android` or `ios` directory :** - -- Replace `YOUR_USERNAME` & `YOUR_ACCESS_KEY` with your BrowserStack access credentials. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings) - -- Replace `bs://` with the URL obtained from app upload step - -- 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 Java binding for BrowserStack Local. - -- If you have uploaded your own app update the test case - -- To run the test, use the following command in the base directory : - - - For Android test, run - - ```cmd - mvn test -P android-local-test - ``` - - - For iOS test, run - - ```cmd - mvn test -P ios-local-test - ``` - -- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard) - - -## Integration with other Java frameworks - -- [JUnit](https://github.com/browserstack/junit-appium-app-browserstack) -- [TestNg](https://github.com/browserstack/testng-appium-app-browserstack) - -## Getting Help - -If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help). diff --git a/java_8/pom.xml b/pom.xml similarity index 99% rename from java_8/pom.xml rename to pom.xml index 300166e..2918641 100644 --- a/java_8/pom.xml +++ b/pom.xml @@ -25,7 +25,7 @@ io.appium java-client - 8.0.0 + 8.1.1 com.browserstack diff --git a/java_8/src/test/java/android/BrowserStackSample.java b/src/test/java/android/BrowserStackSample.java similarity index 62% rename from java_8/src/test/java/android/BrowserStackSample.java rename to src/test/java/android/BrowserStackSample.java index c923568..27f8b8a 100644 --- a/java_8/src/test/java/android/BrowserStackSample.java +++ b/src/test/java/android/BrowserStackSample.java @@ -2,21 +2,21 @@ import io.appium.java_client.AppiumBy; import io.appium.java_client.android.AndroidDriver; +import io.appium.java_client.android.options.UiAutomator2Options; import java.net.MalformedURLException; import java.net.URL; import java.time.Duration; import java.util.HashMap; import java.util.List; import org.openqa.selenium.WebElement; -import org.openqa.selenium.remote.DesiredCapabilities; import org.openqa.selenium.support.ui.ExpectedConditions; import org.openqa.selenium.support.ui.WebDriverWait; public class BrowserStackSample { public static void main(String[] args) - throws MalformedURLException, InterruptedException { - DesiredCapabilities caps = new DesiredCapabilities(); + throws MalformedURLException, InterruptedException { + UiAutomator2Options options = new UiAutomator2Options(); HashMap browserstackOptions = new HashMap(); // Set your access credentials @@ -27,57 +27,50 @@ public static void main(String[] args) browserstackOptions.put("appiumVersion", "1.22.0"); browserstackOptions.put("projectName", "First Java Project"); browserstackOptions.put("buildName", "browserstack-build-1"); - browserstackOptions.put("sessionName", "first_test"); + browserstackOptions.put("sessionName", "BStack first_test"); // Passing browserstack capabilities inside bstack:options - caps.setCapability("bstack:options", browserstackOptions); + options.setCapability("bstack:options", browserstackOptions); // Set URL of the application under test - caps.setCapability("app", "bs://"); + options.setCapability("app", "bs://"); // Specify deviceName and platformName for testing - caps.setCapability("deviceName", "Google Pixel 3"); - caps.setCapability("platformName", "android"); - caps.setCapability("platformVersion", "9.0"); + options.setCapability("deviceName", "Google Pixel 3"); + options.setCapability("platformName", "android"); + options.setCapability("platformVersion", "9.0"); // Initialise the remote Webdriver using BrowserStack remote URL // and desired capabilities defined above AndroidDriver driver = new AndroidDriver( - new URL("http://hub.browserstack.com/wd/hub"), - caps - ); + new URL("http://hub.browserstack.com/wd/hub"), + options); // Test case for the BrowserStack sample Android app. // If you have uploaded your app, update the test case here. WebElement searchElement = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.accessibilityId("Search Wikipedia") - ) - ); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.accessibilityId("Search Wikipedia"))); searchElement.click(); WebElement insertTextElement = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.id("org.wikipedia.alpha:id/search_src_text") - ) - ); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.id("org.wikipedia.alpha:id/search_src_text"))); insertTextElement.sendKeys("BrowserStack"); Thread.sleep(5000); List allProductsName = driver.findElements( - AppiumBy.className("android.widget.TextView") - ); + AppiumBy.className("android.widget.TextView")); assert (allProductsName.size() > 0); - // Invoke driver.quit() after the test is done to indicate that the test is completed. + // Invoke driver.quit() after the test is done to indicate that the test is + // completed. driver.quit(); } } diff --git a/java_8/src/test/java/android/BrowserStackSampleLocal.java b/src/test/java/android/BrowserStackSampleLocal.java similarity index 73% rename from java_8/src/test/java/android/BrowserStackSampleLocal.java rename to src/test/java/android/BrowserStackSampleLocal.java index e765543..10d8f45 100644 --- a/java_8/src/test/java/android/BrowserStackSampleLocal.java +++ b/src/test/java/android/BrowserStackSampleLocal.java @@ -3,11 +3,11 @@ import com.browserstack.local.Local; import io.appium.java_client.AppiumBy; import io.appium.java_client.android.AndroidDriver; +import io.appium.java_client.android.options.UiAutomator2Options; import java.net.URL; import java.time.Duration; import java.util.*; import org.openqa.selenium.WebElement; -import org.openqa.selenium.remote.*; import org.openqa.selenium.support.ui.*; public class BrowserStackSampleLocal { @@ -18,7 +18,7 @@ public class BrowserStackSampleLocal { public static void setupLocal() throws Exception { localInstance = new Local(); - Map options = new HashMap(); + HashMap options = new HashMap(); options.put("key", accessKey); options.put("local", "true"); localInstance.start(options); @@ -32,7 +32,7 @@ public static void main(String[] args) throws Exception { // Start the BrowserStack Local binary setupLocal(); - DesiredCapabilities capabilities = new DesiredCapabilities(); + UiAutomator2Options options = new UiAutomator2Options(); HashMap browserstackOptions = new HashMap(); // Set your access credentials @@ -43,53 +43,46 @@ public static void main(String[] args) throws Exception { browserstackOptions.put("appiumVersion", "1.22.0"); browserstackOptions.put("projectName", "First Java Project"); browserstackOptions.put("buildName", "browserstack-build-1"); - browserstackOptions.put("sessionName", "local_test"); + browserstackOptions.put("sessionName", "BStack local_test"); // Set the browserstack.local capability to true browserstackOptions.put("local", "true"); // Passing browserstack capabilities inside bstack:options - capabilities.setCapability("bstack:options", browserstackOptions); + options.setCapability("bstack:options", browserstackOptions); // Set URL of the application under test - capabilities.setCapability("app", "bs://"); + options.setCapability("app", "bs://"); // Specify device and os_version for testing - capabilities.setCapability("deviceName", "Google Pixel 3"); - capabilities.setCapability("platformName", "android"); - capabilities.setCapability("platformVersion", "9.0"); + options.setCapability("deviceName", "Google Pixel 3"); + options.setCapability("platformName", "android"); + options.setCapability("platformVersion", "9.0"); // Initialise the remote Webdriver using BrowserStack remote URL // and desired capabilities defined above AndroidDriver driver = new AndroidDriver( - new URL("http://hub.browserstack.com/wd/hub"), - capabilities - ); + new URL("http://hub.browserstack.com/wd/hub"), + options); // Test case for the BrowserStack sample Android Local app. // If you have uploaded your app, update the test case here. WebElement searchElement = new WebDriverWait(driver, Duration.ofSeconds(30)) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.id("com.example.android.basicnetworking:id/test_action") - ) - ); + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.id("com.example.android.basicnetworking:id/test_action"))); searchElement.click(); WebElement insertTextElement = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.className("android.widget.TextView") - ) - ); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.className("android.widget.TextView"))); WebElement testElement = null; List allTextViewElements = driver.findElements( - AppiumBy.className("android.widget.TextView") - ); + AppiumBy.className("android.widget.TextView")); Thread.sleep(10); for (WebElement textElement : allTextViewElements) { if (textElement.getText().contains("The active connection is")) { @@ -105,7 +98,8 @@ public static void main(String[] args) throws Exception { assert (matchedString.contains("The active connection is wifi")); assert (matchedString.contains("Up and running")); - // Invoke driver.quit() after the test is done to indicate that the test is completed. + // Invoke driver.quit() after the test is done to indicate that the test is + // completed. driver.quit(); // Stop the BrowserStack Local binary diff --git a/java_8/src/test/java/ios/BrowserStackSample.java b/src/test/java/ios/BrowserStackSample.java similarity index 56% rename from java_8/src/test/java/ios/BrowserStackSample.java rename to src/test/java/ios/BrowserStackSample.java index 09d2013..476afea 100644 --- a/java_8/src/test/java/ios/BrowserStackSample.java +++ b/src/test/java/ios/BrowserStackSample.java @@ -2,20 +2,20 @@ import io.appium.java_client.AppiumBy; import io.appium.java_client.ios.IOSDriver; +import io.appium.java_client.ios.options.XCUITestOptions; import java.net.MalformedURLException; import java.net.URL; import java.time.Duration; import java.util.HashMap; import org.openqa.selenium.WebElement; -import org.openqa.selenium.remote.DesiredCapabilities; import org.openqa.selenium.support.ui.ExpectedConditions; import org.openqa.selenium.support.ui.WebDriverWait; public class BrowserStackSample { public static void main(String[] args) - throws MalformedURLException, InterruptedException { - DesiredCapabilities caps = new DesiredCapabilities(); + throws MalformedURLException, InterruptedException { + XCUITestOptions options = new XCUITestOptions(); HashMap browserstackOptions = new HashMap(); // Set your access credentials @@ -26,66 +26,58 @@ public static void main(String[] args) browserstackOptions.put("appiumVersion", "1.22.0"); browserstackOptions.put("projectName", "First Java Project"); browserstackOptions.put("buildName", "browserstack-build-1"); - browserstackOptions.put("sessionName", "first_test"); + browserstackOptions.put("sessionName", "BStack first_test"); // Passing browserstack capabilities inside bstack:options - caps.setCapability("bstack:options", browserstackOptions); + options.setCapability("bstack:options", browserstackOptions); // Set URL of the application under test - caps.setCapability("app", "bs://"); + options.setCapability("app", "bs://"); // Specify device and os_version for testing - caps.setCapability("deviceName", "iPhone 12"); - caps.setCapability("platformName", "ios"); - caps.setCapability("platformVersion", "13"); + options.setCapability("deviceName", "iPhone 11 Pro"); + options.setCapability("platformName", "ios"); + options.setCapability("platformVersion", "13"); // Initialise the remote Webdriver using BrowserStack remote URL // and desired capabilities defined above IOSDriver driver = new IOSDriver( - new URL("http://hub.browserstack.com/wd/hub"), - caps - ); + new URL("http://hub.browserstack.com/wd/hub"), + options); // Test case for the BrowserStack sample iOS app. // If you have uploaded your app, update the test case here. WebElement textButton = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.accessibilityId("Text Button") - ) - ); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.accessibilityId("Text Button"))); textButton.click(); WebElement textInput = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.accessibilityId("Text Input") - ) - ); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.accessibilityId("Text Input"))); textInput.sendKeys("hello@browserstack.com"); Thread.sleep(5000); WebElement textOutput = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.accessibilityId("Text Output") - ) - ); - if ( - textOutput != null && - textOutput.getText().equals("hello@browserstack.com") - ) assert (true); else assert (false); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.accessibilityId("Text Output"))); + if (textOutput != null && + textOutput.getText().equals("hello@browserstack.com")) + assert (true); + else + assert (false); - // Invoke driver.quit() after the test is done to indicate that the test is completed. + // Invoke driver.quit() after the test is done to indicate that the test is + // completed. driver.quit(); } } diff --git a/java_8/src/test/java/ios/BrowserStackSampleLocal.java b/src/test/java/ios/BrowserStackSampleLocal.java similarity index 65% rename from java_8/src/test/java/ios/BrowserStackSampleLocal.java rename to src/test/java/ios/BrowserStackSampleLocal.java index 0493d13..b89b213 100644 --- a/java_8/src/test/java/ios/BrowserStackSampleLocal.java +++ b/src/test/java/ios/BrowserStackSampleLocal.java @@ -3,6 +3,7 @@ import com.browserstack.local.Local; import io.appium.java_client.AppiumBy; import io.appium.java_client.ios.IOSDriver; +import io.appium.java_client.ios.options.XCUITestOptions; import java.io.File; import java.net.URL; import java.time.Duration; @@ -11,7 +12,6 @@ import org.openqa.selenium.*; import org.openqa.selenium.WebDriver; import org.openqa.selenium.WebElement; -import org.openqa.selenium.remote.*; import org.openqa.selenium.support.ui.*; public class BrowserStackSampleLocal { @@ -22,9 +22,8 @@ public class BrowserStackSampleLocal { public static void setupLocal() throws Exception { localInstance = new Local(); - Map options = new HashMap(); + HashMap options = new HashMap(); options.put("key", accessKey); - options.put("local", "true"); localInstance.start(options); } @@ -36,7 +35,7 @@ public static void main(String[] args) throws Exception { // Start the BrowserStack Local binary setupLocal(); - DesiredCapabilities capabilities = new DesiredCapabilities(); + XCUITestOptions options = new XCUITestOptions(); HashMap browserstackOptions = new HashMap(); // Set your access credentials @@ -47,80 +46,72 @@ public static void main(String[] args) throws Exception { browserstackOptions.put("appiumVersion", "1.22.0"); browserstackOptions.put("projectName", "First Java Project"); browserstackOptions.put("buildName", "browserstack-build-1"); - browserstackOptions.put("sessionName", "local_test"); + browserstackOptions.put("sessionName", "BStack local_test"); // Set the browserstack.local capability to true browserstackOptions.put("local", "true"); // Passing browserstack capabilities inside bstack:options - capabilities.setCapability("bstack:options", browserstackOptions); + options.setCapability("bstack:options", browserstackOptions); // Set URL of the application under test - capabilities.setCapability("app", "bs://"); + options.setCapability("app", "bs://"); // Specify device and os_version for testing - capabilities.setCapability("deviceName", "iPhone 12"); - capabilities.setCapability("platformName", "ios"); - capabilities.setCapability("platformVersion", "13"); + options.setCapability("deviceName", "iPhone XS"); + options.setCapability("platformName", "ios"); + options.setCapability("platformVersion", "12"); // Initialise the remote Webdriver using BrowserStack remote URL // and desired capabilities defined above IOSDriver driver = new IOSDriver( - new URL("http://hub.browserstack.com/wd/hub"), - capabilities - ); + new URL("http://hub.browserstack.com/wd/hub"), + options); // Test case for the BrowserStack sample iOS Local app. // If you have uploaded your app, update the test case here. WebElement testButton = (WebElement) new WebDriverWait( - driver, - Duration.ofSeconds(30) - ) - .until( - ExpectedConditions.elementToBeClickable( - AppiumBy.accessibilityId("TestBrowserStackLocal") - ) - ); + driver, + Duration.ofSeconds(30)) + .until( + ExpectedConditions.elementToBeClickable( + AppiumBy.accessibilityId("TestBrowserStackLocal"))); testButton.click(); WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(30)); wait.until( - new ExpectedCondition() { - @Override - public Boolean apply(WebDriver d) { - String result = d - .findElement(AppiumBy.accessibilityId("ResultBrowserStackLocal")) - .getAttribute("value"); - return result != null && result.length() > 0; - } - } - ); + new ExpectedCondition() { + @Override + public Boolean apply(WebDriver d) { + String result = d + .findElement(AppiumBy.accessibilityId("ResultBrowserStackLocal")) + .getAttribute("value"); + return result != null && result.length() > 0; + } + }); WebElement resultElement = (WebElement) driver.findElement( - AppiumBy.accessibilityId("ResultBrowserStackLocal") - ); + AppiumBy.accessibilityId("ResultBrowserStackLocal")); String resultString = resultElement.getText().toLowerCase(); System.out.println(resultString); if (resultString.contains("not working")) { File scrFile = (File) ((TakesScreenshot) driver).getScreenshotAs( - OutputType.FILE - ); + OutputType.FILE); FileUtils.copyFile( - scrFile, - new File(System.getProperty("user.dir") + "/screenshot.png") - ); + scrFile, + new File(System.getProperty("user.dir") + "/screenshot.png")); System.out.println( - "Screenshot stored at " + - System.getProperty("user.dir") + - "/screenshot.png" - ); + "Screenshot stored at " + + System.getProperty("user.dir") + + "/screenshot.png"); throw new Error("Unexpected BrowserStackLocal test result"); } String expectedString = "Up and running"; assert (resultString.contains(expectedString.toLowerCase())); - // Invoke driver.quit() after the test is done to indicate that the test is completed. + // Invoke driver.quit() after the test is done to indicate that the test is + // completed. driver.quit(); // Stop the BrowserStack Local binary