Merge pull request #1 from kn-neeraj/junit_code_samples_minor_updates

Junit code samples minor updates and Readme update

Author: darshilgada24

README.md

@@ -1,9 +1,8 @@
 # junit-appium-app-browserstack
-[JUnit4](http://junit.org/junit4/) and [Junit5](https://junit.org/junit5/) Integration with BrowserStack.
 
-![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780) 
+This repository demonstrates how to run Appium tests in [JUnit4](http://junit.org/junit4/) and [Junit5](https://junit.org/junit5/) on BrowserStack App Automate.
 
-![JUnit](http://junit.org/junit4/images/junit-logo.png)
+![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
 
 ## Setup
 
@@ -17,7 +16,8 @@
 
 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))
+   - For installation, follow the instructions [here](https://maven.apache.org/install.html)
+
 ### Install the dependencies
 
 To install the dependencies for Android tests, run :
@@ -54,109 +54,39 @@ To install the dependencies for iOS tests, run :
     mvn clean
     ```
 
-### Update `username` and `access_key` keys in *.conf.json
-
-- Junit4
-
-   - Update *.conf.json files for `username`, `access_key` keys inside the [android/junit4-examples/src/test/resources/](android/junit4-examples/src/test/resources) for Android examples and inside [ios/junit4-examples/src/test/resources](ios/junit4-examples/src/test/resources) for iOS examples with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings). 
-
-- Junit5
-   
-   - Update *.conf.json files for `username`, `access_key` inside the [android/junit5-examples/src/test/resources](android/junit5-examples/src/test/resources) for Android examples and inside [ios/junit5-examples/src/test/resources](ios/junit5-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 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
-  
-    - Junit4
-  
-       - Files inside the [android/junit4-examples/src/test/resources/](android/junit4-examples/src/test/resources) for Android examples and inside [ios/junit4-examples/src/test/resources](ios/junit4-examples/src/test/resources) for iOS examples. 
-  
-    - Junit5
-     
-       - Files inside the [android/junit5-examples/src/test/resources](android/junit5-examples/src/test/resources) for Android examples and inside [ios/junit5-examples/src/test/resources](ios/junit5-examples/src/test/resources) for iOS examples . 
-
-  
 ## Getting Started
 
 Getting Started with Appium tests in Junit4 and Junit5 on BrowserStack couldn't be easier!
 
 ### **Run first test :**
 
 - Junit4
-   - Switch to `run_first_test` directory under [Android examples](android/junit4-examples) or [iOS examples](ios/junit4-examples)
-   - Then run
-        ```sh
-         mvn test -P first
-       ```
+  - Switch to `run_first_test` directory under [Android Junit4 examples](android/junit4-examples) or [iOS Junit4 examples](ios/junit4-examples)
+  - 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/junit)
+
 - Junit5
-    - Switch to `run_first_test` directory under [Android examples](android/junit5-examples) or [iOS examples](ios/junit5-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/junit)
+  - Switch to `run_first_test` directory under [Android Junit5 examples](android/junit5-examples) or [iOS Junit5 examples](ios/junit5-examples)
+  - 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/junit)
 
 ### **Speed up test execution with parallel testing :**
 
 - Junit4
-   - Switch to `run_parallel_test` directory under [Android examples](android/junit4-examples/) or [iOS examples](ios/junit4-examples/)
-   - Then run
-        ```sh
-         mvn test -P parallel
-       ```
+  - Switch to `run_parallel_test` directory under [Android Junit4 examples](android/junit4-examples/) or [iOS Junit4 examples](ios/junit4-examples/)
+  - 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/junit/parallelize-tests)
+  
 - Junit5
-    - Switch to `run_parallel_test` directory under [Android examples](android/junit5-examples/) or [iOS examples](ios/junit5-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/junit/parallelize-tests)
+  - Switch to `run_parallel_test` directory under [Android Junit5 examples](android/junit5-examples/) or [iOS Junit5 examples](ios/junit5-examples/)
+  - 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/junit/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.
-     
 - Junit4
-   - Switch to `run_local_test` directory under [Android examples](android/junit4-examples/) or [iOS examples](ios/junit4-examples/)
-   - Then run
-        ```sh
-         mvn test -P local
-       ```
+  - Switch to `run_local_test` directory under [Android Junit4 examples](android/junit4-examples/) or [iOS Junit4 examples](ios/junit4-examples/)
+  - 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/junit/local-testing)
+
 - Junit5
-    - Switch to `run_local_test` directory under [Android examples](android/junit5-examples/) or [iOS examples](ios/junit5-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/junit/local-testing)
+  - Switch to `run_local_test` directory under [Android Junit5 examples](android/junit5-examples/) or [iOS Junit5 examples](ios/junit5-examples/)
+  - 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/junit/local-testing)
 
 **Note**: If you are facing any issues, refer [Getting Help section](#Getting-Help)
 

android/junit4-examples/src/test/java/com/browserstack/run_first_test/BrowserStackJUnitTest.java

@@ -89,6 +89,8 @@ public void setUp() throws Exception {
 
     @After
     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/junit4-examples/src/test/java/com/browserstack/run_local_test/BrowserStackJUnitTest.java

@@ -100,6 +100,8 @@ public void setUp() throws Exception {
 
     @After
     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/junit4-examples/src/test/java/com/browserstack/run_parallel_test/BrowserStackJUnitTest.java

@@ -89,6 +89,8 @@ public void setUp() throws Exception {
 
     @After
     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/junit4-examples/src/test/resources/com/browserstack/run_first_test/first.conf.json

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

android/junit4-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/junit4-examples/src/test/resources/com/browserstack/run_parallel_test/parallel.conf.json

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

android/junit5-examples/src/test/java/com/browserstack/run_first_test/BrowserStackJUnitTest.java

@@ -91,6 +91,8 @@ public void setup() {
 
     @AfterEach
     public void tearDown() {
+        // Invoke driver.quit() to indicate that the test is completed. 
+        // Otherwise, it will appear as timed out on BrowserStack.
         driver.quit();
     }
 }

android/junit5-examples/src/test/java/com/browserstack/run_local_test/BrowserStackJUnitTest.java

@@ -97,8 +97,9 @@ public void setup() throws Exception {
 
     @AfterEach
     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/junit5-examples/src/test/java/com/browserstack/run_parallel_test/BrowserStackJUnitTest.java

@@ -88,6 +88,8 @@ public void setup() {
 
     @AfterEach
     public void tearDown() {
+        // Invoke driver.quit() to indicate that the test is completed. 
+        // Otherwise, it will appear as timed out on BrowserStack.
         driver.quit();
     }
 }