refactor: rename browserstack_app_url to browserstackAppUrl for consistency

Author: ruturaj-browserstack

src/tools/appautomate-utils/appautomate.ts

@@ -92,14 +92,14 @@ export function validateArgs(args: {
   desiredPlatformVersion: string;
   appPath?: string;
   desiredPhone: string;
-  browserstack_app_url?: string;
+  browserstackAppUrl?: string;
 }): void {
   const {
     desiredPlatform,
     desiredPlatformVersion,
     appPath,
     desiredPhone,
-    browserstack_app_url,
+    browserstackAppUrl,
   } = args;
 
   if (!desiredPlatform || !desiredPhone) {
@@ -114,8 +114,8 @@ export function validateArgs(args: {
     );
   }
 
-  if (!appPath && !browserstack_app_url) {
-    throw new Error("Either appPath or browserstack_app_url must be provided");
+  if (!appPath && !browserstackAppUrl) {
+    throw new Error("Either appPath or browserstackAppUrl must be provided");
   }
 
   // Only validate app path format if appPath is provided

src/tools/appautomate.ts

@@ -55,7 +55,7 @@ async function takeAppScreenshot(args: {
   desiredPlatformVersion: string;
   appPath?: string;
   desiredPhone: string;
-  browserstack_app_url?: string;
+  browserstackAppUrl?: string;
   config: BrowserStackConfig;
 }): Promise<CallToolResult> {
   let driver;
@@ -65,7 +65,7 @@ async function takeAppScreenshot(args: {
       desiredPlatform,
       desiredPhone,
       appPath,
-      browserstack_app_url,
+      browserstackAppUrl,
       config,
     } = args;
     let { desiredPlatformVersion } = args;
@@ -106,13 +106,13 @@ async function takeAppScreenshot(args: {
     const [username, password] = authString.split(":");
 
     let app_url: string;
-    if (browserstack_app_url) {
-      app_url = browserstack_app_url;
+    if (browserstackAppUrl) {
+      app_url = browserstackAppUrl;
       logger.info(`Using provided BrowserStack app URL: ${app_url}`);
     } else {
       if (!appPath) {
         throw new Error(
-          "appPath is required when browserstack_app_url is not provided",
+          "appPath is required when browserstackAppUrl is not provided",
         );
       }
       app_url = await uploadApp(appPath, username, password);
@@ -177,7 +177,7 @@ async function runAppTestsOnBrowserStack(
   args: {
     appPath?: string;
     testSuitePath?: string;
-    browserstack_app_url?: string;
+    browserstackAppUrl?: string;
     browserstack_test_suite_url?: string;
     devices: string[];
     project: string;
@@ -186,9 +186,9 @@ async function runAppTestsOnBrowserStack(
   config: BrowserStackConfig,
 ): Promise<CallToolResult> {
   // Validate that either paths or URLs are provided for both app and test suite
-  if (!args.browserstack_app_url && !args.appPath) {
+  if (!args.browserstackAppUrl && !args.appPath) {
     throw new Error(
-      "appPath is required when browserstack_app_url is not provided",
+      "appPath is required when browserstackAppUrl is not provided",
     );
   }
   if (!args.browserstack_test_suite_url && !args.testSuitePath) {
@@ -201,8 +201,8 @@ async function runAppTestsOnBrowserStack(
     case AppTestPlatform.ESPRESSO: {
       try {
         let app_url: string;
-        if (args.browserstack_app_url) {
-          app_url = args.browserstack_app_url;
+        if (args.browserstackAppUrl) {
+          app_url = args.browserstackAppUrl;
           logger.info(`Using provided BrowserStack app URL: ${app_url}`);
         } else {
           app_url = await uploadEspressoApp(args.appPath!, config);
@@ -246,8 +246,8 @@ async function runAppTestsOnBrowserStack(
     case AppTestPlatform.XCUITEST: {
       try {
         let app_url: string;
-        if (args.browserstack_app_url) {
-          app_url = args.browserstack_app_url;
+        if (args.browserstackAppUrl) {
+          app_url = args.browserstackAppUrl;
           logger.info(`Using provided BrowserStack app URL: ${app_url}`);
         } else {
           app_url = await uploadXcuiApp(args.appPath!, config);

src/tools/applive-utils/start-session.ts

@@ -18,7 +18,7 @@ interface StartSessionArgs {
   desiredPlatform: "android" | "ios";
   desiredPhone: string;
   desiredPlatformVersion: string;
-  browserstack_app_url?: string;
+  browserstackAppUrl?: string;
 }
 
 interface StartSessionOptions {
@@ -37,7 +37,7 @@ export async function startSession(
     desiredPlatform,
     desiredPhone,
     desiredPlatformVersion,
-    browserstack_app_url,
+    browserstackAppUrl,
   } = args;
   const { config } = options;
 
@@ -79,13 +79,13 @@ export async function startSession(
 
   // 6) Upload app or use provided URL
   let app_url: string;
-  if (browserstack_app_url) {
-    app_url = browserstack_app_url;
+  if (browserstackAppUrl) {
+    app_url = browserstackAppUrl;
     logger.info(`Using provided BrowserStack app URL: ${app_url}`);
   } else {
     if (!appPath) {
       throw new Error(
-        "appPath is required when browserstack_app_url is not provided",
+        "appPath is required when browserstackAppUrl is not provided",
       );
     }
     const authString = getBrowserStackAuth(config);

src/tools/applive.ts

@@ -16,23 +16,23 @@ export async function startAppLiveSession(
     desiredPlatformVersion: string;
     appPath?: string;
     desiredPhone: string;
-    browserstack_app_url?: string;
+    browserstackAppUrl?: string;
   },
   config: BrowserStackConfig,
 ): Promise<CallToolResult> {
   if (!args.desiredPlatform) {
     throw new Error("You must provide a desiredPlatform.");
   }
 
-  if (!args.appPath && !args.browserstack_app_url) {
-    throw new Error("You must provide either appPath or browserstack_app_url.");
+  if (!args.appPath && !args.browserstackAppUrl) {
+    throw new Error("You must provide either appPath or browserstackAppUrl.");
   }
 
   if (!args.desiredPhone) {
     throw new Error("You must provide a desiredPhone.");
   }
 
-  // Only validate app path if it's provided (not using browserstack_app_url)
+  // Only validate app path if it's provided (not using browserstackAppUrl)
   if (args.appPath) {
     if (args.desiredPlatform === "android" && !args.appPath.endsWith(".apk")) {
       throw new Error("You must provide a valid Android app path.");
@@ -60,7 +60,7 @@ export async function startAppLiveSession(
       desiredPlatform: args.desiredPlatform as "android" | "ios",
       desiredPhone: args.desiredPhone,
       desiredPlatformVersion: args.desiredPlatformVersion,
-      browserstack_app_url: args.browserstack_app_url,
+      browserstackAppUrl: args.browserstackAppUrl,
     },
     { config },
   );

tests/tools/appautomate.test.ts

@@ -66,7 +66,7 @@ describe('appautomate utils', () => {
 
     it('should fail if app path is not provided', () => {
       const args = { ...validAndroidArgs, appPath: '' };
-      expect(() => validateArgs(args)).toThrow('Either appPath or browserstack_app_url must be provided');
+      expect(() => validateArgs(args)).toThrow('Either appPath or browserstackAppUrl must be provided');
     });
 
     it('should fail if phone is not provided', () => {

tests/tools/applive.test.ts

@@ -89,7 +89,7 @@ describe('startAppLiveSession', () => {
 
   it('should fail if app path is not provided', async () => {
     const args = { ...validAndroidArgs, appPath: '' };
-    await expect(startAppLiveSession(args, mockConfig)).rejects.toThrow('You must provide either appPath or browserstack_app_url.');
+    await expect(startAppLiveSession(args, mockConfig)).rejects.toThrow('You must provide either appPath or browserstackAppUrl.');
   });
 
   it('should fail if phone is not provided', async () => {