SDK Integration (#23) (#24)

* added SDK changes

* fixed POM.xml errors

* fix for on-prem profiles

Co-authored-by: Abhi Singh <abhi.s@browserstack.com>

Author: samirans89

.gitignore

@@ -16,4 +16,5 @@ testng.out.xml
 settings.json
 local.log
 .gradle/
-src/test/resources/drivers/
+src/test/resources/drivers/
+browserstack.yml

README.md

@@ -15,24 +15,27 @@ buildscript {
 }
 
 dependencies {
-    implementation 'org.seleniumhq.selenium:selenium-java:3.141.59'
-    implementation 'com.browserstack:browserstack-local-java:1.0.6'
-    implementation 'io.percy:percy-java-selenium:1.0.0'
-    implementation 'com.deque.html.axe-core:selenium:4.3.1'
-    implementation 'org.testng:testng:7.1.0'
-    implementation 'io.qameta.allure:allure-testng:2.13.8'
-    implementation 'com.googlecode.json-simple:json-simple:1.1.1'
-    implementation 'org.assertj:assertj-core:3.18.0'
-    implementation 'com.opencsv:opencsv:5.4'
-    implementation 'org.slf4j:slf4j-api:1.7.30'
-    implementation 'org.slf4j:slf4j-simple:1.7.30'
+    testImplementation 'org.seleniumhq.selenium:selenium-java:4.1.4'
+    compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'
+    testImplementation 'io.percy:percy-java-selenium:1.1.0'
+    testImplementation 'com.deque.html.axe-core:selenium:4.3.1'
+    testImplementation 'org.testng:testng:7.4.0'
+    testImplementation 'io.qameta.allure:allure-testng:2.13.8'
+    testImplementation 'org.assertj:assertj-core:3.23.1'
+    testImplementation 'com.opencsv:opencsv:5.7.1'
+    testImplementation 'org.slf4j:slf4j-api:2.0.3'
+    testImplementation 'org.slf4j:slf4j-simple:2.0.3'
+    testImplementation 'org.apache.commons:commons-lang3:3.11'
+    testImplementation 'commons-io:commons-io:2.6'
 }
 
 group = 'com.browserstack'
 version = '1.0-SNAPSHOT'
 description = 'browserstack-examples-testng'
 sourceCompatibility = JavaVersion.VERSION_1_8
 
+def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+
 allure {
     autoconfigure = true
     version = '2.4.1'
@@ -46,68 +49,70 @@ tasks.register('on-prem', Test) {
     } else {
         include '**/OrderTest.class'
     }
+    systemProperty "on-prem", "true"
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
 
 tasks.register('on-prem-suite', Test) {
     useTestNG()
+    systemProperty "on-prem", "true"
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
 
-tasks.register('docker', Test) {
-    useTestNG()
+tasks.register('bstack-single', Test) {
+    useTestNG() {
+        dependsOn clean
+        useDefaultListeners = true
+        jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
+    }
     if (project.hasProperty('test-name')) {
         include '**/' + project.property('test-name') + '.class'
     } else {
         include '**/OrderTest.class'
     }
-    systemProperty "environment", "docker"
+    systemProperty "browserstack-local", "false"
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
 
-tasks.register('docker-parallel', Test) {
+tasks.register('bstack-parallel', Test) {
     useTestNG() {
-        parallel project.property('testngParallel')
-        threadCount Integer.parseInt(project.property('testngThreadCount'))
+        dependsOn clean
+        useDefaultListeners = true
+        suites 'src/test/resources/conf/runners/testng.xml'
+        jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
     }
-    systemProperty "environment", "docker"
+    systemProperty "browserstack-local", "false"
+    systemProperty "testType", "parallel"
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
 
-tasks.register('bstack-single', Test) {
-    useTestNG() {
-        listeners.add("com.browserstack.test.utils.BrowserstackTestStatusListener")
-    }
-    if (project.hasProperty('test-name')) {
-        include '**/' + project.property('test-name') + '.class'
-    } else {
-        include '**/OrderTest.class'
-    }
-    systemProperty "environment", "remote"
-    systemProperty "testType", "single"
-    testLogging {
-        events "PASSED", "FAILED", "SKIPPED"
-    }
-}
 
 tasks.register('percy', Test) {
-    useTestNG() {}
+    useTestNG() {
+        dependsOn clean
+        useDefaultListeners = true
+        jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
+    }
     include '**/LoginVisualTest.class'
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
 
 tasks.register('percy-ignore', Test) {
-    useTestNG() {}
+    useTestNG() {
+        dependsOn clean
+        useDefaultListeners = true
+        jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
+    }
     include '**/IgnoreRegionVisualTest.class'
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
@@ -116,70 +121,30 @@ tasks.register('percy-ignore', Test) {
 
 tasks.register('bstack-local', Test) {
     useTestNG() {
-        listeners.add("com.browserstack.test.utils.BrowserstackTestStatusListener")
+        dependsOn clean
+        useDefaultListeners = true
+        jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
     }
     if (project.hasProperty('test-name')) {
         include '**/' + project.property('test-name') + '.class'
     } else {
         include '**/OrderTest.class'
     }
-    systemProperty "environment", "remote"
-    systemProperty "testType", "local"
+    systemProperty "browserstack-local", "true"
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
 
 tasks.register('bstack-local-parallel', Test) {
     useTestNG() {
-        parallel project.property('testngParallel')
-        threadCount Integer.parseInt(project.property('testngThreadCount'))
-        listeners.add("com.browserstack.test.utils.BrowserstackTestStatusListener")
+        dependsOn clean
+        useDefaultListeners = true
+        suites 'src/test/resources/conf/runners/testng.xml'
+        jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
     }
-    systemProperty "environment", "remote"
-    systemProperty "testType", "local"
+    systemProperty "browserstack-local", "true"
     testLogging {
         events "PASSED", "FAILED", "SKIPPED"
     }
 }
-
-tasks.register('bstack-local-parallel-browsers', Test) {
-    useTestNG() {
-        suites 'src/test/resources/conf/runners/testng-browserstack-parallel.xml'
-        parallel project.property('testngParallel')
-        threadCount Integer.parseInt(project.property('testngThreadCount'))
-        listeners.add("com.browserstack.test.utils.BrowserstackTestStatusListener")
-    }
-    systemProperty "environment", "remote"
-    systemProperty "testType", "local"
-    testLogging {
-        events "PASSED", "FAILED", "SKIPPED"
-    }
-}
-
-tasks.register('bstack-parallel', Test) {
-    useTestNG() {
-        parallel project.property('testngParallel')
-        threadCount Integer.parseInt(project.property('testngThreadCount'))
-        listeners.add("com.browserstack.test.utils.BrowserstackTestStatusListener")
-    }
-    systemProperty "environment", "remote"
-    systemProperty "testType", "parallel"
-    testLogging {
-        events "PASSED", "FAILED", "SKIPPED"
-    }
-}
-
-tasks.register('bstack-parallel-browsers', Test) {
-    useTestNG() {
-        suites 'src/test/resources/conf/runners/testng-browserstack-parallel.xml'
-        parallel project.property('testngParallel')
-        threadCount Integer.parseInt(project.property('testngThreadCount'))
-        listeners.add("com.browserstack.test.utils.BrowserstackTestStatusListener")
-    }
-    systemProperty "environment", "remote"
-    systemProperty "testType", "parallel"
-    testLogging {
-        events "PASSED", "FAILED", "SKIPPED"
-    }
-}