Merge pull request #51 from Baaryan/master

APS 13484 Add gradle config with updated gradle-sdk plugin for serenity

Author: karanshah-browserstack

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

@@ -19,6 +19,9 @@ jobs:
       matrix:
         java: [ '8', '11', '17' ]
         os: [ 'macos-latest', 'windows-latest', 'ubuntu-latest' ]
+        exclude:
+          - java: '8'
+            os: 'macos-latest'
     name: Serenity Repo ${{ matrix.Java }} - ${{ matrix.os }} Sample
     env:
       BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
@@ -64,6 +67,12 @@ jobs:
         run: |
           mvn compile
           mvn verify -P sample-test
+      - name: Run gradle task sampleTest
+        run: |
+          gradle clean sampleTest
+      - name: Run gradle task sampleLocalTest
+        run: |
+          gradle clean sampleLocalTest
       - if: always()
         uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
         id: status-check-completed

.gitignore

@@ -18,6 +18,14 @@ pom.xml.versionsBackup
 pom.xml.next
 release.properties
 
+##########################
+## Gradle
+##########################
+.Gradle
+gradle
+gradlew*
+bstack_*
+
 ##########################
 ## IntelliJ
 ##########################

README.md

@@ -6,7 +6,7 @@
 
 <img src="https://serenity-bdd.info/wp-content/uploads/elementor/thumbs/serenity-bdd-pac9onzlqv9ebi90cpg4zsqnp28x4trd1adftgkwbq.png" height = "100">
 
-## Run Sample build
+## Using Maven
 ### Setup
 * Clone the repo
 * Replace YOUR_USERNAME and YOUR_ACCESS_KEY with your BrowserStack access credentials in browserstack.yml.
@@ -70,6 +70,54 @@ This repository uses the BrowserStack SDK to run tests on BrowserStack. Follow t
 ```
 * Install dependencies `mvn compile`
 
+## Using Gradle
+
+### Prerequisites
+- If using Gradle, Java v9+ is required.
+
+### Setup
+* Clone the repo
+* Replace YOUR_USERNAME and YOUR_ACCESS_KEY with your BrowserStack access credentials in browserstack.yml.
+
+### Running your tests
+
+- Clone the repository
+- To run the test suite having cross-platform with parallelization, run `gradle sampleTest`
+- To run local tests, run `gradle sampleLocalTest`
+
+Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
+
+### Integrate your test suite
+
+This repository uses the BrowserStack SDK to run tests on BrowserStack. Follow the steps below to install the SDK in your test suite and run tests on BrowserStack:
+
+* Following are the changes required in `build.gradle` -
+  * Add `id 'com.browserstack.gradle-sdk' version "1.1.2"` in plugins
+  * Add `implementation 'com.browserstack:browserstack-java-sdk:latest.release'` in dependencies
+  * Fetch Artifact Information and add `jvmArgs` property in tasks *SampleTest* and *SampleLocalTest* :
+  ```
+  def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+  
+  task sampleTest(type: Test) {
+    dependsOn cleanTest
+    include '**/SampleTest.**'
+    jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
+    useJUnitPlatform()
+  }
+  ```
+* Following are the changes required in `settings.gradle` -
+  * Add `resolutionStrategy` inside `pluginManagement`
+  * Inside `resolutionStrategy` add the plugin `id` as `com.browserstack.gradle-sdk` along with module `version`
+  ```
+  eachPlugin {
+            if (requested.id.id == "com.browserstack.gradle-sdk") {
+                useModule("com.browserstack:gradle-sdk:1.1.2")
+            }
+        }
+  ```
+
+* Install dependencies and run test `gradle sampleTest`
+
 ## Notes
 * You can view your test results on the [BrowserStack Automate dashboard](https://www.browserstack.com/automate)
 * You can export the environment variables for the Username and Access Key of your BrowserStack account

build.gradle

@@ -0,0 +1,41 @@
+plugins {
+    id 'java'
+    id 'com.browserstack.gradle-sdk' version "1.1.2" // sdk plugin
+}
+
+repositories { mavenCentral() }
+
+dependencies {
+    implementation 'org.junit.vintage:junit-vintage-engine:5.8.2'
+    implementation 'net.serenity-bdd:serenity-core:3.3.4'
+    implementation 'net.serenity-bdd:serenity-cucumber:3.3.4'
+    implementation 'com.browserstack:browserstack-java-sdk:latest.release'
+}
+
+group = 'com.browserstack'
+version = '1.0-SNAPSHOT'
+description = 'serenity-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
+    include '**/SampleTest.**'
+    useJUnitPlatform()
+}
+
+task sampleLocalTest(type: Test) {
+    dependsOn cleanTest
+    include '**/LocalTest.**'
+    useJUnitPlatform()
+}

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")
+            }
+        }
+    }
+}