Enhance App SDK support for additional testing frameworks

Author: tech-sushant

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

@@ -15,7 +15,8 @@ export function generateAppBrowserStackYMLInstructions(
 ): string {
   if (
     testingFramework === AppSDKSupportedTestingFrameworkEnum.nightwatch ||
-    testingFramework === AppSDKSupportedTestingFrameworkEnum.webdriverio
+    testingFramework === AppSDKSupportedTestingFrameworkEnum.webdriverio ||
+    testingFramework === AppSDKSupportedTestingFrameworkEnum.cucumberRuby
   ) {
     return "";
   }

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

@@ -34,7 +34,7 @@ export function getAppInstructionsForProjectConfiguration(
     case "python":
       return getPythonAppInstructions(testingFramework);
     case "ruby":
-      return getRubyAppInstructions(testingFramework);
+      return getRubyAppInstructions();
     case "csharp":
       return getCSharpAppInstructions();
     default:

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

@@ -145,7 +145,7 @@ exports.config = {
 }
 
 function getNightwatchCommand(username: string, accessKey: string): string {
-    const prerequisiteStep = createStep(
+  const prerequisiteStep = createStep(
     "Prerequisite Setup:",
     ` a. Ensure you do not modify or replace any existing local driver code, 
       as it will be automatically managed and overwritten by the BrowserStack SDK/Driver.
@@ -155,15 +155,15 @@ function getNightwatchCommand(username: string, accessKey: string): string {
 
   const envStep = createStep(
     "Set your BrowserStack credentials as environment variables:",
-`\`\`\`bash 
+    `\`\`\`bash 
 export BROWSERSTACK_USERNAME=${username}
 export BROWSERSTACK_ACCESS_KEY=${accessKey}
 \`\`\``,
   );
 
   const installStep = createStep(
     "Install Nightwatch and BrowserStack integration:",
-`\`\`\`bash
+    `\`\`\`bash
 npm install --save-dev @nightwatch/browserstack
 \`\`\``,
   );
@@ -232,7 +232,12 @@ npm install --save-dev @nightwatch/browserstack
 \`\`\``,
   );
 
-  return combineInstructions(prerequisiteStep, envStep, installStep, configStep);
+  return combineInstructions(
+    prerequisiteStep,
+    envStep,
+    installStep,
+    configStep,
+  );
 }
 
 function getJestCommand(username: string, accessKey: string): string {

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

@@ -1,41 +1,30 @@
 // Ruby instructions and commands for App SDK utilities
 import {
-  AppSDKSupportedTestingFramework,
-  AppSDKSupportedTestingFrameworkEnum,
   createStep,
   combineInstructions,
   createEnvStep,
   PLATFORM_UTILS,
 } from "../index.js";
 
-export function getRubyAppInstructions(
-  testingFramework: AppSDKSupportedTestingFramework,
-): string {
-  if (testingFramework === AppSDKSupportedTestingFrameworkEnum.cucumberRuby) {
-    return getCucumberRubyInstructions();
-  }
-
-  if (testingFramework === AppSDKSupportedTestingFrameworkEnum.rspec) {
-    return getRSpecInstructions();
-  }
+const username = "${process.env.BROWSERSTACK_USERNAME}";
+const accessKey = "${process.env.BROWSERSTACK_ACCESS_KEY}";
 
-  return "";
-}
-
-function getCucumberRubyInstructions(): string {
+export function getRubyAppInstructions(): string {
   const configStep = createStep(
     "Create/Update the config file (config.yml) as follows:",
     `\`\`\`yaml
 server: "hub-cloud.browserstack.com"
 
 common_caps:
+  "browserstack.user": "${username}"
+  "browserstack.key": "${accessKey}"
   "project": "First Cucumber Android Project"
   "build": "Cucumber Android"
   "browserstack.debug": true
 
 browser_caps:
   -
-    "device": "Google Pixel 3"
+    "deviceName": "Google Pixel 3"
     "os_version": "9.0"
     "app": "bs://<app-id>"
     "name": "first_test"
@@ -50,12 +39,14 @@ require 'appium_lib'
 
 # Load configuration from config.yml
 caps = Appium.load_appium_txt file: File.expand_path('./../config.yml', __FILE__)
+username = "${username}"
+password = "${accessKey}"
 
 # Create desired capabilities
 desired_caps = {
   caps: caps,
   appium_lib: {
-    server_url: "https://hub-cloud.browserstack.com/wd/hub"
+    server_url = "https://#{username}:#{password}@#{caps['server']}/wd/hub"
   }
 }
 
@@ -85,81 +76,14 @@ bundle exec cucumber
   return combineInstructions(configStep, envStep, runStep);
 }
 
-function getRSpecInstructions(): string {
-  const specHelperStep = createStep(
-    "Create/Update your spec_helper.rb file:",
-    `\`\`\`ruby
-require 'rubygems'
-require 'appium_lib'
-
-RSpec.configure do |config|
-  config.before(:all) do
-    # Define desired capabilities
-    desired_caps = {
-      'platformName' => 'Android',
-      'platformVersion' => '9.0',
-      'deviceName' => 'Google Pixel 3',
-      'app' => 'bs://<app-id>',
-      'project' => 'First RSpec Android Project',
-      'build' => 'RSpec Android',
-      'name' => 'first_test',
-      'browserstack.debug' => true
-    }
-
-    # Initialize Appium driver
-    begin
-      $appium_driver = Appium::Driver.new({
-        caps: desired_caps,
-        appium_lib: {
-          server_url: "https://hub-cloud.browserstack.com/wd/hub"
-        }
-      }, true)
-      $driver = $appium_driver.start_driver
-    rescue Exception => e
-      puts e.message
-      Process.exit(0)
-    end
-  end
-
-  config.after(:all) do
-    $driver.quit if $driver
-  end
-end
-\`\`\``,
-  );
-
-  const testFileStep = createStep(
-    "Create your test file (e.g., spec/app_spec.rb):",
-    `\`\`\`ruby
-require 'spec_helper'
-
-describe 'App Test' do
-  it 'should launch the app successfully' do
-    # Your test code here
-    expect($driver).not_to be_nil
-  end
-end
-\`\`\``,
-  );
-
-  const runStep = createStep(
-    "Run the test:",
-    `\`\`\`bash
-bundle exec rspec
-\`\`\``,
-  );
-
-  return combineInstructions(specHelperStep, testFileStep, runStep);
-}
-
 export function getRubySDKCommand(
   framework: string,
   username: string,
   accessKey: string,
 ): string {
   const { isWindows, getPlatformLabel } = PLATFORM_UTILS;
 
-  if (framework === "rspec" || framework === "cucumberRuby") {
+  if (framework === "cucumberRuby") {
     const envStep = createEnvStep(
       username,
       accessKey,
@@ -177,11 +101,8 @@ gem install bundler
 # Install Appium Ruby client library
 gem install appium_lib
 
-# For Cucumber projects, also install cucumber
-${framework === "cucumberRuby" ? "gem install cucumber" : ""}
-
-# For RSpec projects, also install rspec
-${framework === "rspec" ? "gem install rspec" : ""}
+# Install Cucumber
+gem install cucumber
 \`\`\``,
     );
 
@@ -192,8 +113,7 @@ ${framework === "rspec" ? "gem install rspec" : ""}
 source 'https://rubygems.org'
 
 gem 'appium_lib'
-${framework === "cucumberRuby" ? "gem 'cucumber'" : ""}
-${framework === "rspec" ? "gem 'rspec'" : ""}
+gem 'cucumber'
 \`\`\`
 
 Then run:

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

@@ -48,7 +48,8 @@ export async function getAppUploadInstruction(
   detectedTestingFramework: AppSDKSupportedTestingFramework,
 ): Promise<string> {
   if (
-    detectedTestingFramework === AppSDKSupportedTestingFrameworkEnum.nightwatch ||
+    detectedTestingFramework ===
+      AppSDKSupportedTestingFrameworkEnum.nightwatch ||
     detectedTestingFramework === AppSDKSupportedTestingFrameworkEnum.webdriverio
   ) {
     const app_url = "bs://ff4e358328a3e914fe4f0e46ec7af73f9c08cd55";