Merge pull request #5 from rhisav-25/AAP-15642-Add-gradle-config-support-for-JBehave

Added Gradle support for JBehave

Author: rajpatta

.github/workflows/maven-workflow-run.yml

@@ -82,6 +82,22 @@ jobs:
           cd ios
           mvn compile
           mvn test -P sample-test
+      - name: Run gradle task for android  
+        run: |
+          cd android
+          gradle clean sampleTest
+      - name: Run gradle task sample-local-test for android  
+        run: |
+          cd android
+          gradle clean sampleLocalTest -D"browserstack.app"="./LocalSample.apk"  
+      - name: Run gradle task for ios  
+        run: |
+          cd ios
+          gradle clean sampleTest
+      - name: Run gradle task sample-local-test for ios  
+        run: |
+          cd ios
+          gradle clean sampleLocalTest -D"browserstack.app"="./LocalSample.ipa"     
       - if: always()
         uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
         id: status-check-completed

.gitignore

@@ -5,3 +5,8 @@ local.log
 *.iml
 logs/
 browserstack.err
+bstack_*
+build
+.gradle
+gradle
+gradlew*

README.md

@@ -13,10 +13,14 @@ This repository demonstrates how to run Appium tests in [JBehave](https://github
         - 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
+2. Maven (Only required if using Maven as the build tool)
    - 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)
 
+3. Gradle (Only required if using Gradle as the build tool)
+  - If Gradle is not downloaded, download it from [here](https://gradle.org/releases/)  
+  - For installation, follow the instructions [here](https://gradle.org/install/) 
+
 ### Install the dependencies
 
 To install the dependencies for Android tests, run :
@@ -41,16 +45,30 @@ Getting Started with Appium tests in JBehave on BrowserStack couldn't be easier!
 ### **Run Sample test :**
 
 - Switch to one of the following directories: [Android examples](android) or [iOS examples](ios)
-- Run the following maven command `mvn test -P sample-test`
+- **For Maven:** Run the following command to execute tests in the Maven environment:  
+    ```sh
+    mvn test -P sample-test
+    ```
+- **For Gradle:** Run the following command to execute tests in the Gradle environment:  
+    ```sh
+    gradle clean sampleTest
+    ```
 
 ### **Use Local testing for apps that access resources hosted in development or testing environments :**
 
 - Simply configure the `browserstackLocal` parameter in the `browserstack.yml` file accordingly in [Android examples](android) or [iOS examples](ios).
   ```
   browserstackLocal: true
   ```
-- You can use the `LocalSample` app provided in both folder [Android examples](android) or [iOS examples](ios) to run your test. Change the app parameter in the `browserstack.yml` file and run the tests with the following command: `mvn test -P sample-local-test`
-
+- You can use the `LocalSample` app provided in both folder [Android examples](android) or [iOS examples](ios) to run your test. Change the app parameter in the `browserstack.yml` file.
+- **For Maven:** Run the following command to execute tests in the Maven environment:  
+    ```sh
+    mvn test -P sample-local-test
+    ```
+- **For Gradle:** Run the following command to execute tests in the Gradle environment:  
+    ```sh
+    gradle clean sampleLocalTest
+    ```
 
 **Note**: If you are facing any issues, refer [Getting Help section](#Getting-Help)
 

android/build.gradle

@@ -0,0 +1,55 @@
+plugins {
+    id 'java'
+    id 'com.browserstack.gradle-sdk' version "1.1.2" // sdk plugin
+}
+
+repositories { mavenCentral() }
+
+dependencies {
+    implementation 'org.seleniumhq.selenium:selenium-java:4.13.0'
+    implementation 'io.appium:java-client:8.6.0'
+    implementation 'org.jbehave:jbehave-core:5.0'
+    implementation 'org.yaml:snakeyaml:2.0'
+    implementation 'com.browserstack:browserstack-java-sdk:latest.release'
+}
+
+group = 'com.browserstack'
+version = '1.0-SNAPSHOT'
+description = 'jbehave-browserstack'
+sourceCompatibility = '1.8'
+
+def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+}
+
+tasks.withType(Test) {
+    systemProperties = System.properties
+    jvmArgs += "-javaagent:${browserstackSDKArtifact.file}"
+}
+
+task sampleTest(type: Test) {
+    dependsOn cleanTest
+    useJUnitPlatform()
+
+    include 'com/browserstack/BrowserStackJBehaveRunner*'
+
+    systemProperty 'embedder', 'com.browserstack.single.SampleEmbedder'
+    systemProperty 'stories', 'stories/sample.story'
+
+    jvmArgs "-javaagent:${configurations.testRuntimeClasspath.find { it.name.contains('browserstack-java-sdk') }}"
+}
+
+
+task sampleLocalTest(type: Test) {
+    dependsOn cleanTest
+    useJUnitPlatform()
+
+    include 'com/browserstack/BrowserStackJBehaveRunner*'
+
+    systemProperty 'embedder', 'com.browserstack.local.LocalEmbedder'
+    systemProperty 'stories', 'stories/local.story'
+
+    jvmArgs "-javaagent:${configurations.testRuntimeClasspath.find { it.name.contains('browserstack-java-sdk') }}"
+}

android/settings.gradle

@@ -0,0 +1,15 @@
+pluginManagement {
+    repositories {
+        mavenCentral()
+        mavenLocal()
+        gradlePluginPortal()
+    }
+
+    resolutionStrategy {
+        eachPlugin {
+            if (requested.id.id == "com.browserstack.gradle-sdk") {
+                useModule("com.browserstack:gradle-sdk:1.1.2")
+            }
+        }
+    }
+}

ios/build.gradle

@@ -0,0 +1,55 @@
+plugins {
+    id 'java'
+    id 'com.browserstack.gradle-sdk' version "1.1.2" // sdk plugin
+}
+
+repositories { mavenCentral() }
+
+dependencies {
+    implementation 'org.seleniumhq.selenium:selenium-java:4.13.0'
+    implementation 'io.appium:java-client:8.6.0'
+    implementation 'org.jbehave:jbehave-core:5.0'
+    implementation 'org.yaml:snakeyaml:2.0'
+    implementation 'com.browserstack:browserstack-java-sdk:latest.release'
+}
+
+group = 'com.browserstack'
+version = '1.0-SNAPSHOT'
+description = 'jbehave-browserstack'
+sourceCompatibility = '1.8'
+
+def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+}
+
+tasks.withType(Test) {
+    systemProperties = System.properties
+    jvmArgs += "-javaagent:${browserstackSDKArtifact.file}"
+}
+
+task sampleTest(type: Test) {
+    dependsOn cleanTest
+    useJUnitPlatform()
+
+    include 'com/browserstack/BrowserStackJBehaveRunner*'
+
+    systemProperty 'embedder', 'com.browserstack.single.SampleEmbedder'
+    systemProperty 'stories', 'stories/sample.story'
+
+    jvmArgs "-javaagent:${configurations.testRuntimeClasspath.find { it.name.contains('browserstack-java-sdk') }}"
+}
+
+
+task sampleLocalTest(type: Test) {
+    dependsOn cleanTest
+    useJUnitPlatform()
+
+    include 'com/browserstack/BrowserStackJBehaveRunner*'
+
+    systemProperty 'embedder', 'com.browserstack.local.LocalEmbedder'
+    systemProperty 'stories', 'stories/local.story'
+
+    jvmArgs "-javaagent:${configurations.testRuntimeClasspath.find { it.name.contains('browserstack-java-sdk') }}"
+}

ios/settings.gradle

@@ -0,0 +1,15 @@
+pluginManagement {
+    repositories {
+        mavenCentral()
+        mavenLocal()
+        gradlePluginPortal()
+    }
+
+    resolutionStrategy {
+        eachPlugin {
+            if (requested.id.id == "com.browserstack.gradle-sdk") {
+                useModule("com.browserstack:gradle-sdk:1.1.2")
+            }
+        }
+    }
+}