feat: enhance Java SDK setup instructions and update testing framework support

Author: ruturaj-browserstack

src/tools/sdk-utils/commands.ts

@@ -4,10 +4,24 @@ import { SDKSupportedLanguage } from "./types.js";
 // Framework mapping for Java Maven archetype generation
 const JAVA_FRAMEWORK_MAP: Record<string, string> = {
   testng: "testng",
-  junit: "junit5", // Map generic junit to junit5 as default
-  cucumber: "cucumber-testng", // Map generic cucumber to cucumber-testng as default
+  junit5: "junit5",
+  junit4: "junit4",
+  cucumber: "cucumber-testng",
 };
 
+// Common Gradle setup instructions (platform-independent)
+const GRADLE_SETUP_INSTRUCTIONS = `
+**For Gradle setup:**
+1. Add browserstack-java-sdk to dependencies:
+   compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'
+
+2. Add browserstackSDK path variable:
+   def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+
+3. Add javaagent to gradle tasks:
+   jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
+`;
+
 export function getSDKPrefixCommand(
   language: SDKSupportedLanguage,
   framework: string,
@@ -18,26 +32,25 @@ export function getSDKPrefixCommand(
 
     case "java": {
       const mavenFramework = getJavaFrameworkForMaven(framework);
-      return `Install BrowserStack Java SDK
+      const isWindows = process.platform === "win32";
 
-**Maven command for ${framework}:**
-Run the command, it is required to generate the browserstack-sdk-archetype-integrate project:
-mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \\
+      const mavenCommand = isWindows
+        ? `mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-integrate" -DarchetypeVersion="1.0" -DgroupId="com.browserstack" -DartifactId="browserstack-sdk-archetype-integrate" -Dversion="1.0" -DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" -DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" -DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`
+        : `mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \\
 -DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.0 \\
 -DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.0 \\
--DBROWSERSTACK_USERNAME=${process.env.BROWSERSTACK_USERNAME} -DBROWSERSTACK_ACCESS_KEY=${process.env.BROWSERSTACK_ACCESS_KEY} \\
--DBROWSERSTACK_FRAMEWORK=${mavenFramework}
+-DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" \\
+-DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" \\
+-DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`;
 
-**For Gradle setup:**
-1. Add browserstack-java-sdk to dependencies:
-   compileOnly 'com.browserstack:browserstack-java-sdk:latest.release'
+      const platformLabel = isWindows ? "Windows" : "macOS/Linux";
 
-2. Add browserstackSDK path variable:
-   def browserstackSDKArtifact = configurations.compileClasspath.resolvedConfiguration.resolvedArtifacts.find { it.name == 'browserstack-java-sdk' }
+      return `Install BrowserStack Java SDK
 
-3. Add javaagent to gradle tasks:
-   jvmArgs "-javaagent:\${browserstackSDKArtifact.file}"
-`;
+**Maven command for ${framework} (${platformLabel}):**
+Run the command, it is required to generate the browserstack-sdk-archetype-integrate project:
+${mavenCommand}
+${GRADLE_SETUP_INSTRUCTIONS}`;
     }
 
     // Add more languages as needed

src/tools/sdk-utils/constants.ts

@@ -268,7 +268,6 @@ const nodejsInstructions = `
  * ---------- EXPORT CONFIG ----------
  */
 
-=======
 const webdriverioInstructions = `
 To integrate your WebdriverIO test suite with BrowserStack, follow these steps. This process uses the @wdio/browserstack-service and does not require a browserstack.yml file.
 

src/tools/sdk-utils/percy/constants.ts

@@ -115,7 +115,8 @@ export const PERCY_INSTRUCTIONS: PercyConfigMapping = {
     selenium: {
       testng: { script_updates: javaSeleniumInstructions },
       cucumber: { script_updates: javaSeleniumInstructions },
-      junit: { script_updates: javaSeleniumInstructions },
+      junit4: { script_updates: javaSeleniumInstructions },
+      junit5: { script_updates: javaSeleniumInstructions },
     },
   },
   nodejs: {

src/tools/sdk-utils/types.ts

@@ -1,28 +1,8 @@
-export type SDKSupportedLanguage = "nodejs" | "python" | "java" | "csharp";
-export type SDKSupportedBrowserAutomationFramework = "playwright" | "selenium";
-export type SDKSupportedTestingFramework =
-  | "jest"
-  | "codeceptjs"
-  | "playwright"
-  | "pytest"
-  | "robot"
-  | "behave"
-  | "cucumber"
-  | "nightwatch"
-  | "webdriverio"
-  | "mocha"
-  | "junit4"
-  | "junit5"
-  | "testng"
-  | "xunit"
-  | "nunit"
-  | "mstest";
-
-
 export enum SDKSupportedLanguageEnum {
   nodejs = "nodejs",
   python = "python",
   java = "java",
+  csharp = "csharp",
 }
 export type SDKSupportedLanguage = keyof typeof SDKSupportedLanguageEnum;
 
@@ -45,17 +25,25 @@ export enum SDKSupportedTestingFrameworkEnum {
   nightwatch = "nightwatch",
   webdriverio = "webdriverio",
   mocha = "mocha",
-  junit = "junit",
+  junit4 = "junit4",
+  junit5 = "junit5",
   testng = "testng",
   cypress = "cypress",
+  nunit = "nunit",
+  mstest = "mstest",
+  xunit = "xunit",
 }
 export type SDKSupportedTestingFramework =
   keyof typeof SDKSupportedTestingFrameworkEnum;
 
 export type ConfigMapping = Record<
   SDKSupportedLanguageEnum,
-  Record<
-    SDKSupportedBrowserAutomationFrameworkEnum,
-    Partial<Record<SDKSupportedTestingFrameworkEnum, { instructions: string }>>
+  Partial<
+    Record<
+      SDKSupportedBrowserAutomationFrameworkEnum,
+      Partial<
+        Record<SDKSupportedTestingFrameworkEnum, { instructions: string }>
+      >
+    >
   >
 >;