add support for XCUITest on BrowserStack

Author: tech-sushant

src/tools/appautomate-utils/appautomate.ts

@@ -200,6 +200,26 @@ export async function uploadEspressoTestSuite(
   );
 }
 
+//Uploads an iOS app (.ipa) to BrowserStack XCUITest endpoint and returns the app_url
+export async function uploadXcuiApp(appPath: string): Promise<string> {
+  return uploadFileToBrowserStack(
+    appPath,
+    "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/app",
+    "app_url",
+  );
+}
+
+//Uploads an XCUITest test suite (.zip) to BrowserStack and returns the test_suite_url
+export async function uploadXcuiTestSuite(
+  testSuitePath: string,
+): Promise<string> {
+  return uploadFileToBrowserStack(
+    testSuitePath,
+    "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/test-suite",
+    "test_suite_url",
+  );
+}
+
 // Triggers an Espresso test run on BrowserStack and returns the build_id
 export async function triggerEspressoBuild(
   app_url: string,
@@ -228,3 +248,32 @@ export async function triggerEspressoBuild(
     `Failed to trigger Espresso build: ${JSON.stringify(response.data)}`,
   );
 }
+
+// Triggers an XCUITest run on BrowserStack and returns the build_id
+export async function triggerXcuiBuild(
+  app_url: string,
+  test_suite_url: string,
+  devices: string[],
+  project: string,
+): Promise<string> {
+  const response = await axios.post(
+    "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build",
+    {
+      app: app_url,
+      testSuite: test_suite_url,
+      devices,
+      project,
+    },
+    {
+      auth,
+    },
+  );
+
+  if (response.data.build_id) {
+    return response.data.build_id;
+  }
+
+  throw new Error(
+    `Failed to trigger XCUITest build: ${JSON.stringify(response.data)}`,
+  );
+}

src/tools/appautomate.ts

@@ -22,6 +22,9 @@ import {
   uploadEspressoApp,
   uploadEspressoTestSuite,
   triggerEspressoBuild,
+  uploadXcuiApp,
+  uploadXcuiTestSuite,
+  triggerXcuiBuild,
 } from "./appautomate-utils/appautomate.js";
 
 // Types
@@ -166,7 +169,7 @@ async function runAppTestsOnBrowserStack(args: {
           content: [
             {
               type: "text",
-              text: `✅ Test run started successfully!\n\n🔧 Build ID: ${build_id}\n🔗 View your build: https://app-automate.browserstack.com/builds/${build_id}`,
+              text: `✅ Espresso run started successfully!\n\n🔧 Build ID: ${build_id}\n🔗 View your build: https://app-automate.browserstack.com/builds/${build_id}`,
             },
           ],
         };
@@ -175,10 +178,32 @@ async function runAppTestsOnBrowserStack(args: {
         throw err;
       }
     }
-
+    case AppTestPlatform.XCUITEST: {
+      try {
+        const app_url = await uploadXcuiApp(args.appPath);
+        const test_suite_url = await uploadXcuiTestSuite(args.testSuitePath);
+        const build_id = await triggerXcuiBuild(
+          app_url,
+          test_suite_url,
+          args.devices,
+          args.project,
+        );
+        return {
+          content: [
+            {
+              type: "text",
+              text: `✅ XCUITest run started successfully!\n\n🔧 Build ID: ${build_id}\n🔗 View your build: https://app-automate.browserstack.com/builds/${build_id}`,
+            },
+          ],
+        };
+      } catch (err) {
+        logger.error("Error running XCUITest App Automate test", err);
+        throw err;
+      }
+    }
     default:
       throw new Error(
-        `Unsupported automation framework: ${args.detectedAutomationFramework}`,
+        `Unsupported automation framework: ${args.detectedAutomationFramework}. If you need support for this framework, please open an issue at Github`,
       );
   }
 }
@@ -230,18 +255,22 @@ export default function addAppAutomationTools(server: McpServer) {
 
   server.tool(
     "runAppTestsOnBrowserStack",
-    "Run AppAutomate tests on BrowserStack by uploading app and test suite, then triggering a test run.",
+    "Run AppAutomate tests on BrowserStack by uploading app and test suite, then triggering a test run. Supports both Espresso (Android) and XCUITest (iOS).",
     {
       appPath: z
         .string()
-        .describe("Path to the .apk or .aab file for your app."),
+        .describe(
+          "Path to the .apk/.aab (Espresso) or .ipa (XCUITest) file for your app. Export on your own in local IDEs.",
+        ),
       testSuitePath: z
         .string()
-        .describe("Path to the Espresso test suite .apk file."),
+        .describe(
+          "Path to the Espresso test suite .apk or XCUITest .zip file. Export on your own in local IDEs.",
+        ),
       devices: z
         .array(z.string())
         .describe(
-          "List of devices to run the test on, e.g., ['Samsung Galaxy S20-10.0', 'Google Pixel 3-9.0'].",
+          "List of devices to run the test on, e.g., ['Samsung Galaxy S20-10.0', 'iPhone 12 Pro-16.0'].",
         ),
       project: z
         .string()
@@ -251,7 +280,7 @@ export default function addAppAutomationTools(server: McpServer) {
       detectedAutomationFramework: z
         .string()
         .describe(
-          "The automation framework used in the project, such as 'espresso' or 'appium'.",
+          "The automation framework used in the project, such as 'espresso' (Android) or 'xcuitest' (iOS).",
         ),
     },
     async (args) => {
@@ -273,7 +302,7 @@ export default function addAppAutomationTools(server: McpServer) {
           content: [
             {
               type: "text",
-              text: `Error running App Automate test: ${errorMessage}`
+              text: `Error running App Automate test: ${errorMessage}`,
             },
           ],
           isError: true,