Additional improvements

Author: tech-sushant

src/tools/appautomate-utils/appium-sdk/handler.ts

@@ -2,6 +2,14 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { BrowserStackConfig } from "../../../lib/types.js";
 import { getBrowserStackAuth } from "../../../lib/get-auth.js";
+import { getAppUploadInstruction, validateSupportforAppAutomate, SupportedFramework } from "./utils.js";
+import logger from "../../../logger.js";
+
+import {
+  getAppSDKPrefixCommand,
+  generateAppBrowserStackYMLInstructions,
+} from "./index.js";
+
 import {
   AppSDKSupportedLanguage,
   AppSDKSupportedTestingFramework,
@@ -10,17 +18,12 @@ import {
   getAppInstructionsForProjectConfiguration,
   SETUP_APP_AUTOMATE_SCHEMA,
 } from "./index.js";
-import {
-  getAppSDKPrefixCommand,
-  generateAppBrowserStackYMLInstructions,
-} from "./index.js";
-import { getAppUploadInstruction } from "./utils.js";
-import logger from "../../../logger.js";
 
 export async function setupAppAutomateHandler(
   rawInput: unknown,
   config: BrowserStackConfig,
 ): Promise<CallToolResult> {
+  
   const input = z.object(SETUP_APP_AUTOMATE_SCHEMA).parse(rawInput);
   const auth = getBrowserStackAuth(config);
   const [username, accessKey] = auth.split(":");
@@ -33,10 +36,10 @@ export async function setupAppAutomateHandler(
   const language = input.detectedLanguage as AppSDKSupportedLanguage;
   const platforms = (input.desiredPlatforms as string[]) ?? ["android"];
   const appPath = input.appPath as string;
-  const framework = input.detectedFramework as string;
+  const framework = input.detectedFramework as SupportedFramework;
 
-  logger.info("Generating SDK setup command...");
-  logger.debug(`Input: ${JSON.stringify(input)}`);
+  //Validating if supported framework or not
+  validateSupportforAppAutomate(framework, language, testingFramework);
 
   // Step 1: Generate SDK setup command
   const sdkCommand = getAppSDKPrefixCommand(

src/tools/appautomate-utils/appium-sdk/languages/ruby.ts

@@ -26,9 +26,9 @@ browser_caps:
   -
     "deviceName": "Google Pixel 3"
     "os_version": "9.0"
-    "app": "bs://<app-id>"
+    "app": "<replace with the APK path from the upload step>"
     "name": "first_test"
-\`\`\``,
+\`\`\``
   );
 
   const envStep = createStep(
@@ -46,7 +46,7 @@ password = "${accessKey}"
 desired_caps = {
   caps: caps,
   appium_lib: {
-    server_url = "https://#{username}:#{password}@#{caps['server']}/wd/hub"
+    server_url: "https://#{username}:#{password}@#{caps['server']}/wd/hub"
   }
 }
 
@@ -63,14 +63,14 @@ end
 at_exit do
   $driver.quit if $driver
 end
-\`\`\``,
+\`\`\``
   );
 
   const runStep = createStep(
     "Run the test:",
     `\`\`\`bash
 bundle exec cucumber
-\`\`\``,
+\`\`\``
   );
 
   return combineInstructions(configStep, envStep, runStep);
@@ -79,22 +79,21 @@ bundle exec cucumber
 export function getRubySDKCommand(
   framework: string,
   username: string,
-  accessKey: string,
+  accessKey: string
 ): string {
   const { isWindows, getPlatformLabel } = PLATFORM_UTILS;
 
-  if (framework === "cucumberRuby") {
-    const envStep = createEnvStep(
-      username,
-      accessKey,
-      isWindows,
-      getPlatformLabel(),
-      "Set your BrowserStack credentials as environment variables:",
-    );
-
-    const installStep = createStep(
-      "Install required Ruby gems:",
-      `\`\`\`bash
+  const envStep = createEnvStep(
+    username,
+    accessKey,
+    isWindows,
+    getPlatformLabel(),
+    "Set your BrowserStack credentials as environment variables:"
+  );
+
+  const installStep = createStep(
+    "Install required Ruby gems:",
+    `\`\`\`bash
 # Install Bundler if not already installed
 gem install bundler
 
@@ -103,12 +102,12 @@ gem install appium_lib
 
 # Install Cucumber
 gem install cucumber
-\`\`\``,
-    );
+\`\`\``
+  );
 
-    const gemfileStep = createStep(
-      "Create a Gemfile for dependency management:",
-      `\`\`\`ruby
+  const gemfileStep = createStep(
+    "Create a Gemfile for dependency management:",
+    `\`\`\`ruby
 # Gemfile
 source 'https://rubygems.org'
 
@@ -119,11 +118,8 @@ gem 'cucumber'
 Then run:
 \`\`\`bash
 bundle install
-\`\`\``,
-    );
-
-    return combineInstructions(envStep, installStep, gemfileStep);
-  }
+\`\`\``
+  );
 
-  return "";
+  return combineInstructions(envStep, installStep, gemfileStep);
 }

src/tools/appautomate-utils/appium-sdk/types.ts

@@ -9,15 +9,7 @@ export enum AppSDKSupportedLanguageEnum {
 export type AppSDKSupportedLanguage = keyof typeof AppSDKSupportedLanguageEnum;
 
 export enum AppSDKSupportedFrameworkEnum {
-  appium = "appium",
-  webdriverio = "webdriverio",
-  nightwatch = "nightwatch",
-  jest = "jest",
-  mocha = "mocha",
-  cucumberJs = "cucumberJs",
-  pytest = "pytest",
-  rspec = "rspec",
-  cucumberRuby = "cucumberRuby",
+  appium = "appium"
 }
 
 export type AppSDKSupportedFramework =
@@ -26,6 +18,7 @@ export type AppSDKSupportedFramework =
 export enum AppSDKSupportedTestingFrameworkEnum {
   testng = "testng",
   junit5 = "junit5",
+  junit4 = "junit4",
   selenide = "selenide",
   jbehave = "jbehave",
   cucumberTestng = "cucumberTestng",
@@ -58,23 +51,18 @@ export enum AppSDKSupportedPlatformEnum {
 }
 export type AppSDKSupportedPlatform = keyof typeof AppSDKSupportedPlatformEnum;
 
-export type AppConfigMapping = Record<
-  AppSDKSupportedLanguageEnum,
-  Partial<
-    Record<
-      AppSDKSupportedFrameworkEnum,
-      Partial<
-        Record<
-          AppSDKSupportedTestingFrameworkEnum,
-          { instructions: (username: string, accessKey: string) => string }
-        >
-      >
-    >
-  >
->;
-
 // App SDK instruction type
 export interface AppSDKInstruction {
   content: string;
   type: "config" | "run" | "setup";
 }
+
+export const SUPPORTED_CONFIGURATIONS = {
+  appium: {
+    ruby: ["cucumberRuby"],
+    java: ["junit5", "junit4", "testng", "cucumberTestng", "selenide", "jbehave"],
+    csharp: ["nunit", "xunit", "mstest", "specflow", "reqnroll"],
+    python: ["pytest", "robot", "behave", "lettuce"],
+    nodejs: ["jest", "mocha", "cucumberJs", "webdriverio", "nightwatch"],
+  },
+};

src/tools/appautomate-utils/appium-sdk/utils.ts

@@ -3,6 +3,7 @@ import {
   AppSDKSupportedTestingFrameworkEnum,
   createStep,
 } from "./index.js";
+import {SUPPORTED_CONFIGURATIONS} from "./types.js"
 
 export function isBrowserStackAppUrl(appPath: string): boolean {
   return appPath.startsWith("bs://");
@@ -50,7 +51,8 @@ export async function getAppUploadInstruction(
   if (
     detectedTestingFramework ===
       AppSDKSupportedTestingFrameworkEnum.nightwatch ||
-    detectedTestingFramework === AppSDKSupportedTestingFrameworkEnum.webdriverio
+    detectedTestingFramework === AppSDKSupportedTestingFrameworkEnum.webdriverio ||
+    detectedTestingFramework === AppSDKSupportedTestingFrameworkEnum.cucumberRuby
   ) {
     const app_url = "bs://ff4e358328a3e914fe4f0e46ec7af73f9c08cd55";
     if (app_url) {
@@ -62,3 +64,34 @@ export async function getAppUploadInstruction(
   }
   return "";
 }
+
+export type SupportedFramework = keyof typeof SUPPORTED_CONFIGURATIONS;
+type SupportedLanguage = keyof typeof SUPPORTED_CONFIGURATIONS[SupportedFramework];
+type SupportedTestingFramework = string;
+
+export function validateSupportforAppAutomate(
+  framework: SupportedFramework,
+  language: SupportedLanguage,
+  testingFramework: SupportedTestingFramework
+) {
+  const frameworks = Object.keys(SUPPORTED_CONFIGURATIONS) as SupportedFramework[];
+  if (!SUPPORTED_CONFIGURATIONS[framework]) {
+    throw new Error(
+      `Unsupported framework '${framework}'. Supported frameworks: ${frameworks.join(", ")}`
+    );
+  }
+
+  const languages = Object.keys(SUPPORTED_CONFIGURATIONS[framework]) as SupportedLanguage[];
+  if (!SUPPORTED_CONFIGURATIONS[framework][language]) {
+    throw new Error(
+      `Unsupported language '${language}' for framework '${framework}'. Supported languages: ${languages.join(", ")}`
+    );
+  }
+
+  const testingFrameworks = SUPPORTED_CONFIGURATIONS[framework][language];
+  if (!testingFrameworks.includes(testingFramework)) {
+    throw new Error(
+      `Unsupported testing framework '${testingFramework}' for language '${language}' and framework '${framework}'. Supported testing frameworks: ${testingFrameworks.join(", ")}`
+    );
+  }
+}

src/tools/appautomate.ts

@@ -393,11 +393,12 @@ export default function addAppAutomationTools(
       try {
         return await setupAppAutomateHandler(args, config);
       } catch (error) {
+        const error_message = error instanceof Error ? error.message : "Unknown error";
         return {
           content: [
             {
               type: "text",
-              text: `Failed to bootstrap project with BrowserStack App Automate SDK. Error: ${error}. Please open an issue on GitHub if the problem persists`,
+              text: `Failed to bootstrap project with BrowserStack App Automate SDK. Error: ${error_message}. Please open an issue on GitHub if the problem persists`,
               isError: true,
             },
           ],