Merge pull request #1 from kn-neeraj/testng_code_samples_minor_updates

Testng code samples minor updates

Author: rishav-csenitjsr

README.md

@@ -1,9 +1,11 @@
 # testng-appium-app-browserstack
 
-[TestNG](http://testng.org) Integration with BrowserStack.
+This repository demonstrates how to run Appium tests in [TestNG](http://testng.org) on BrowserStack App Automate.
 
 ![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
 
+## Setup
+
 ### Requirements
 
 1. Java 8+
@@ -33,76 +35,24 @@ cd ios/testng-examples
 mvn clean
 ```
 
-### Update `username` and `access_key` keys in *.conf.json
-
-- Update *.conf.json files for `username`, `access_key` keys inside the [android/testng-examples/src/test/resources/](android/testng-examples/src/test/resources) for Android examples and inside [ios/testng-examples/src/test/resources](ios/testng-examples/src/test/resources) for iOS examples with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings). 
-
-- Note: You can also export the environment variables for the Username and Access Key of your BrowserStack account. 
-
-     ```
-     export BROWSERSTACK_USERNAME=<browserstack-username> &&
-     export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
-     ```      
-
-### Upload app and update `app` key in *.conf.json
-
-- Android
-   - Upload your Native App (.apk or .aab file) to BrowserStack servers using upload API:
-
-      ```
-      curl -u "username:access_key" -X POST "https://api-cloud.browserstack.com/app-automate/upload" -F "file=@/path/to/app/file/Application-debug.apk"
-      ```
-   -  If you do not have an .apk file and looking to simply try App Automate, [you can download our sample app and upload](https://www.browserstack.com/app-automate/sample-apps/android/WikipediaSample.apk)
-     to the BrowserStack servers using the above API.
-
-   - You can use public url as well to upload your app
-
-     ```
-     curl -u "username:access_key" \
-     -X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-     -F "url=https://www.browserstack.com/app-automate/sample-apps/android/WikipediaSample.apk"
-     ```   
-  - Please note the value of app_url in the API response (bs://f7c874f21852.... in the above examples). 
-
-  - Update *.conf.json with value of `app_url`(got from response) for `app` key
-
-    - Files inside the [android/testng-examples/src/test/resources/](android/testng-examples/src/test/resources) for Android examples and inside [ios/testng-examples/src/test/resources](ios/testng-examples/src/test/resources) for iOS examples.
-
-
 ## Getting Started
 
 Getting Started with Appium tests in TestNg on BrowserStack couldn't be easier!
 
 ### **Run first test :**
 
 - Switch to `run_first_test` directory under [Android examples](android/testng-examples) or [iOS examples](ios/testng-examples)
-- Then run
-    ```sh
-    mvn test -P first
-    ```
-- Alternatively, you can follow the steps outlined in the documentation - [Get Started with your first test on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/testng)
+- Follow the steps outlined in the documentation - [Get Started with your first test on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/testng)
 
 ### **Speed up test execution with parallel testing :**
 
 - Switch to `run_parallel_test` directory under [Android examples](android/testng-examples/) or [iOS examples](ios/testng-examples/)
-- Then run
-    ```sh
-    mvn test -P parallel
-    ```
-
-- Alternatively, you can follow the steps outlined in the documentation - [Get Started with your parallel test on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/testng/parallelize-tests)
+- Follow the steps outlined in the documentation - [Get Started with parallel testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/testng/parallelize-tests)
 
 ### **Use Local testing for apps that access resources hosted in development or testing environments :**
 
-- If you do not have an local .apk file and looking to simply try local for  App Automate, [you can download our sample local app and upload](https://www.browserstack.com/app-automate/sample-apps/android/LocalSample.apk)
-     to the BrowserStack servers using the same app upload API.
-
 - Switch to `run_local_test` directory under [Android examples](android/testng-examples/) or [iOS examples](ios/testng-examples/)
-- Then run
-    ```sh
-    mvn test -P local
-    ```
-- Alternatively, you can follow the steps outlined in the documentation - [Get Started with Local testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/testng/local-testing)
+- Follow the steps outlined in the documentation - [Get Started with Local testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/java/testng/local-testing)
 
 **Note**: If you are facing any issues, refer [Getting Help section](#Getting-Help)
 

android/testng-examples/src/test/java/com/browserstack/run_first_test/BrowserStackTestNGTest.java

@@ -64,6 +64,8 @@ public void setUp() throws Exception {
 
     @AfterMethod(alwaysRun=true)
     public void tearDown() throws Exception {
+        // Invoke driver.quit() to indicate that the test is completed. 
+        // Otherwise, it will appear as timed out on BrowserStack.
         driver.quit();
     }
 }

android/testng-examples/src/test/java/com/browserstack/run_local_test/BrowserStackTestNGTest.java

@@ -74,6 +74,8 @@ public void setUp() throws Exception {
 
     @AfterMethod(alwaysRun=true)
     public void tearDown() throws Exception {
+        // Invoke driver.quit() to indicate that the test is completed. 
+        // Otherwise, it will appear as timed out on BrowserStack.
         driver.quit();
         if(local != null) local.stop();
     }

android/testng-examples/src/test/java/com/browserstack/run_parallel_test/BrowserStackTestNGTest.java

@@ -66,6 +66,8 @@ public void setUp(String deviceIndex) throws Exception {
 
     @AfterMethod(alwaysRun=true)
     public void tearDown() throws Exception {
+        // Invoke driver.quit() to indicate that the test is completed. 
+        // Otherwise, it will appear as timed out on BrowserStack.
         driver.quit();
     }
 }

android/testng-examples/src/test/resources/com/browserstack/run_first_test/first.conf.json

@@ -8,7 +8,7 @@
     "build": "TestNg Android First",
     "name": "first_test",
     "browserstack.debug": true,
-    "app": "bs://<hashed app-id>"
+    "app": "bs://<app-id>"
   },
 
   "environments": [

android/testng-examples/src/test/resources/com/browserstack/run_local_test/local.conf.json

@@ -9,7 +9,7 @@
     "name": "local_test",
     "browserstack.debug": true,
     "browserstack.local": true,
-    "app": "bs://<hashed app-id>"
+    "app": "bs://<app-id>"
   },
 
   "environments": [

android/testng-examples/src/test/resources/com/browserstack/run_parallel_test/parallel.conf.json

@@ -8,7 +8,7 @@
     "build": "TestNg Android Parallel",
     "name": "parallel_test",
     "browserstack.debug": true,
-    "app": "bs://<hashed app-id>"
+    "app": "bs://<app-id>"
   },
 
   "environments": [

ios/testng-examples/src/test/java/com/browserstack/run_first_test/BrowserStackTestNGTest.java

@@ -65,6 +65,8 @@ public void setUp() throws Exception {
 
   @AfterMethod(alwaysRun=true)
   public void tearDown() throws Exception {
+    // Invoke driver.quit() to indicate that the test is completed. 
+    // Otherwise, it will appear as timed out on BrowserStack.
     driver.quit();
   }
 }

ios/testng-examples/src/test/java/com/browserstack/run_local_test/BrowserStackTestNGTest.java

@@ -74,6 +74,8 @@ public void setUp() throws Exception {
 
   @AfterMethod(alwaysRun=true)
   public void tearDown() throws Exception {
+    // Invoke driver.quit() to indicate that the test is completed. 
+    // Otherwise, it will appear as timed out on BrowserStack.
     driver.quit();
     if(local != null) local.stop();
   }

ios/testng-examples/src/test/java/com/browserstack/run_parallel_test/BrowserStackTestNGTest.java

@@ -66,6 +66,8 @@ public void setUp(String deviceIndex) throws Exception {
 
   @AfterMethod(alwaysRun=true)
   public void tearDown() throws Exception {
+    // Invoke driver.quit() to indicate that the test is completed. 
+    // Otherwise, it will appear as timed out on BrowserStack.
     driver.quit();
   }
 }

ios/testng-examples/src/test/resources/com/browserstack/run_first_test/first.conf.json

@@ -8,7 +8,7 @@
     "build": "TestNg iOS First",
     "name": "first_test",
     "browserstack.debug": true,
-    "app": "bs://<hashed app-id>"
+    "app": "bs://<app-id>"
   },
 
   "environments": [

ios/testng-examples/src/test/resources/com/browserstack/run_local_test/local.conf.json

@@ -9,7 +9,7 @@
     "name": "local_test",
     "browserstack.debug": true,
     "browserstack.local": true,
-    "app": "bs://<hashed app-id>"
+    "app": "bs://<app-id>"
   },
 
   "environments": [

ios/testng-examples/src/test/resources/com/browserstack/run_parallel_test/parallel.conf.json

@@ -8,7 +8,7 @@
     "build": "TestNg iOS Parallel",
     "name": "parallel_test",
     "browserstack.debug": true,
-    "app": "bs://<hashed app-id>"
+    "app": "bs://<app-id>"
   },
 
   "environments": [