Skip to content

feat: adding appium support for java #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 23, 2025
Merged

feat: adding appium support for java #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bca14ea
Adding initial frameworks
tech-sushant Sep 17, 2025
7566b37
Java Adjustments
tech-sushant Sep 17, 2025
cacc90d
Refactor Maven command construction in Java SDK utilities
tech-sushant Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 79 additions & 27 deletions src/tools/appautomate-utils/appium-sdk/languages/java.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,32 @@ export const MAVEN_ARCHETYPE_GROUP_ID = "com.browserstack";
export const MAVEN_ARCHETYPE_ARTIFACT_ID = "junit-archetype-integrate";
export const MAVEN_ARCHETYPE_VERSION = "1.0";

// Version mapping for different frameworks
export const JAVA_APP_FRAMEWORK_VERSION_MAP: Record<string, string> = {
testng: "1.4",
selenide: "1.4",
junit5: "1.0",
junit4: "1.0",
jbehave: "1.0",
cucumberTestng: "1.0",
cucumberJunit4: "1.0",
cucumberJunit5: "1.0",
cucumber: "1.0",
serenity: "1.0",
};

// Framework mapping for Java Maven archetype generation for App Automate
export const JAVA_APP_FRAMEWORK_MAP: Record<string, string> = {
testng: "browserstack-sdk-archetype-integrate",
testng: "testng-archetype-integrate",
junit5: "browserstack-sdk-archetype-integrate",
selenide: "selenide-archetype-integrate",
jbehave: "browserstack-sdk-archetype-integrate",
junit4: "browserstack-sdk-archetype-integrate",
cucumberTestng: "browserstack-sdk-archetype-integrate",
cucumberJunit4: "browserstack-sdk-archetype-integrate",
cucumberJunit5: "browserstack-sdk-archetype-integrate",
cucumber: "browserstack-sdk-archetype-integrate",
serenity: "browserstack-sdk-archetype-integrate",
};

// Common Gradle setup instructions for App Automate (platform-independent)
Expand Down Expand Up @@ -49,44 +66,72 @@ export function getJavaAppFrameworkForMaven(framework: string): string {
return JAVA_APP_FRAMEWORK_MAP[framework] || framework;
}

export function getJavaAppFrameworkVersion(framework: string): string {
return JAVA_APP_FRAMEWORK_VERSION_MAP[framework] || MAVEN_ARCHETYPE_VERSION;
}

function getMavenCommandForWindows(
framework: string,
mavenFramework: string,
version: string,
username: string,
accessKey: string,
appPath?: string,
): string {
return (
let command =
`mvn archetype:generate -B ` +
`-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
`-DarchetypeArtifactId="${mavenFramework}" ` +
`-DarchetypeVersion="${MAVEN_ARCHETYPE_VERSION}" ` +
`-DarchetypeVersion="${version}" ` +
`-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
`-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
`-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
`-DartifactId="${mavenFramework}" ` +
`-Dversion="${version}" ` +
`-DBROWSERSTACK_USERNAME="${username}" ` +
`-DBROWSERSTACK_ACCESS_KEY="${accessKey}" ` +
`-DBROWSERSTACK_FRAMEWORK="${framework}"`
);
`-DBROWSERSTACK_ACCESS_KEY="${accessKey}"`;

// Add framework parameter for browserstack-sdk-archetype-integrate
if (mavenFramework === "browserstack-sdk-archetype-integrate") {
command += ` -DBROWSERSTACK_FRAMEWORK="${framework}"`;
}

// Add app path if provided
if (appPath) {
command += ` -DBROWSERSTACK_APP="${appPath}"`;
}

return command;
}

function getMavenCommandForUnix(
framework: string,
mavenFramework: string,
version: string,
username: string,
accessKey: string,
appPath?: string,
): string {
return (
let command =
`mvn archetype:generate -B ` +
`-DarchetypeGroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
`-DarchetypeArtifactId="${mavenFramework}" ` +
`-DarchetypeVersion="${MAVEN_ARCHETYPE_VERSION}" ` +
`-DarchetypeVersion="${version}" ` +
`-DgroupId="${MAVEN_ARCHETYPE_GROUP_ID}" ` +
`-DartifactId="${MAVEN_ARCHETYPE_ARTIFACT_ID}" ` +
`-Dversion="${MAVEN_ARCHETYPE_VERSION}" ` +
`-DartifactId="${mavenFramework}" ` +
`-Dversion="${version}" ` +
`-DBROWSERSTACK_USERNAME="${username}" ` +
`-DBROWSERSTACK_ACCESS_KEY="${accessKey}" ` +
`-DBROWSERSTACK_FRAMEWORK="${framework}"`
);
`-DBROWSERSTACK_ACCESS_KEY="${accessKey}"`;

// Add framework parameter for browserstack-sdk-archetype-integrate
if (mavenFramework === "browserstack-sdk-archetype-integrate") {
command += ` -DBROWSERSTACK_FRAMEWORK="${framework}"`;
}

// Add app path if provided
if (appPath) {
command += ` -DBROWSERSTACK_APP="${appPath}"`;
}

return command;
}

export function getJavaSDKCommand(
Expand All @@ -98,29 +143,28 @@ export function getJavaSDKCommand(
const { isWindows = false, getPlatformLabel } = PLATFORM_UTILS || {};

const mavenFramework = getJavaAppFrameworkForMaven(framework);
const version = getJavaAppFrameworkVersion(framework);

let mavenCommand: string;

if (isWindows) {
mavenCommand = getMavenCommandForWindows(
framework,
mavenFramework,
version,
username,
accessKey,
appPath,
);
if (appPath) {
mavenCommand += ` -DBROWSERSTACK_APP="${appPath}"`;
}
} else {
mavenCommand = getMavenCommandForUnix(
framework,
mavenFramework,
version,
username,
accessKey,
appPath,
);
if (appPath) {
mavenCommand += ` -DBROWSERSTACK_APP="${appPath}"`;
}
}

const envStep = createEnvStep(
Expand All @@ -133,13 +177,21 @@ export function getJavaSDKCommand(
const mavenStep = createStep(
"Install BrowserStack SDK using Maven Archetype for App Automate",
`Maven command for ${framework} (${getPlatformLabel()}):
\`\`\`bash
${mavenCommand}
\`\`\`
\`\`\`bash
${mavenCommand}
\`\`\`

Alternative setup for Gradle users:
${GRADLE_APP_SETUP_INSTRUCTIONS}`,
);

Alternative setup for Gradle users:
${GRADLE_APP_SETUP_INSTRUCTIONS}`,
const argsLineStep = createStep(
"Verifying dependency and argsLine",
`Verify browserstack-java-sdk with LATEST is added as dependency and add this line in pom.xml if not added:
\`\`\`xml
<argLine>-javaagent:"\${com.browserstack:browserstack-java-sdk:jar}"</argLine>
\`\`\``,
);

return combineInstructions(envStep, mavenStep);
return combineInstructions(envStep, mavenStep, argsLineStep);
}
11 changes: 10 additions & 1 deletion src/tools/appautomate-utils/appium-sdk/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export enum AppSDKSupportedTestingFrameworkEnum {
junit4 = "junit4",
selenide = "selenide",
jbehave = "jbehave",
serenity = "serenity",
cucumberTestng = "cucumberTestng",
cucumberJunit4 = "cucumberJunit4",
cucumberJunit5 = "cucumberJunit5",
Expand Down Expand Up @@ -60,7 +61,15 @@ export interface AppSDKInstruction {
export const SUPPORTED_CONFIGURATIONS = {
appium: {
ruby: ["cucumberRuby"],
java: [],
java: [
"testng",
"cucumber",
"junit4",
"junit5",
"jbehave",
"selenide",
"serenity",
],
csharp: [],
python: ["pytest", "robot", "behave", "lettuce"],
nodejs: ["jest", "mocha", "cucumberJs", "webdriverio", "nightwatch"],
Expand Down