maestro improvements

Author: jochen-testingbot

package.json

@@ -1,8 +1,11 @@
 {
   "name": "testingbotctl",
   "version": "1.0.0",
-  "description": "",
+  "description": "CLI tool to run Espresso, XCUITest, and Maestro tests on TestingBot's cloud infrastructure",
   "main": "dist/index.js",
+  "bin": {
+    "testingbot": "dist/index.js"
+  },
   "scripts": {
     "lint": "prettier --check '**/*.{js,ts}' && eslint --ext ts src/",
     "build": "tsc",
@@ -16,9 +19,31 @@
     "release:minor": "npm run release -- minor",
     "release:major": "npm run release -- major"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "testingbot",
+    "mobile-testing",
+    "espresso",
+    "xcuitest",
+    "maestro",
+    "android",
+    "ios",
+    "test-automation",
+    "cloud-testing",
+    "cli",
+    "real-devices",
+    "emulators",
+    "simulators"
+  ],
+  "author": "TestingBot",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/testingbot/testingbotctl.git"
+  },
+  "homepage": "https://testingbot.com",
+  "bugs": {
+    "url": "https://github.com/testingbot/testingbotctl/issues"
+  },
   "dependencies": {
     "@types/archiver": "^7.0.0",
     "@types/js-yaml": "^4.0.9",

src/cli.ts

@@ -9,15 +9,17 @@ import packageJson from '../package.json';
 import MaestroOptions, {
   Orientation,
   ThrottleNetwork,
+  ReportFormat,
 } from './models/maestro_options';
 import Maestro from './providers/maestro';
 
 const program = new Command();
 
 program
-  .version(packageJson.version)
+  .name('testingbot')
+  .version(packageJson.version, '-v, --version', 'Show version number')
   .description(
-    'TestingBotCTL is a CLI-tool to run Espresso, XCUITest and Maestro tests in the TestingBot cloud',
+    'CLI tool to run Espresso, XCUITest and Maestro tests on TestingBot cloud',
   );
 
 program
@@ -59,7 +61,7 @@ program
   })
   .showHelpAfterError(true);
 
-program
+const maestroCommand = program
   .command('maestro')
   .description('Run Maestro flows on TestingBot.')
   .argument(
@@ -72,30 +74,30 @@ program
   )
   // App and flows options
   .option(
-    '--app <string>',
+    '--app <path>',
     'Path to application under test (.apk, .ipa, .app, or .zip).',
   )
   .option(
-    '--flows <string>',
+    '--flows <path>',
     'Path to flow file (.yaml/.yml), directory of flows, .zip file or glob pattern.',
   )
   // Device configuration
   .option(
     '--device <device>',
-    'Device name to use for testing (e.g., "Pixel 8", "iPhone 15"). If not specified, uses "*" for any available device.',
+    'Device name to use for testing (e.g., "Pixel 9", "iPhone 17").',
   )
   .option(
     '--platform <platform>',
     'Platform name: Android or iOS.',
     (val) => val as 'Android' | 'iOS',
   )
-  .option('--version <version>', 'OS version (e.g., "14", "17.2").')
+  .option('--deviceVersion <version>', 'OS version (e.g., "14", "17.2").')
   .option(
     '--orientation <orientation>',
     'Screen orientation: PORTRAIT or LANDSCAPE.',
     (val) => val.toUpperCase() as Orientation,
   )
-  .option('--locale <locale>', 'Device locale (e.g., "en_US", "de_DE").')
+  .option('--device-locale <locale>', 'Device locale (e.g., "en_US", "de_DE").')
   .option(
     '--timezone <timezone>',
     'Device timezone (e.g., "America/New_York", "Europe/London").',
@@ -134,6 +136,30 @@ program
     },
     [] as string[],
   )
+  // Maestro configuration
+  .option(
+    '--maestro-version <version>',
+    'Maestro version to use (e.g., "2.0.10").',
+  )
+  // Execution mode
+  .option(
+    '-q, --quiet',
+    'Quieter console output without progress updates.',
+  )
+  .option(
+    '--async',
+    'Start tests and exit immediately without waiting for results.',
+  )
+  // Report options
+  .option(
+    '--report <format>',
+    'Download test report after completion: html or junit.',
+    (val) => val.toLowerCase() as ReportFormat,
+  )
+  .option(
+    '--report-output-dir <path>',
+    'Directory to save test reports (required when --report is used).',
+  )
   // Authentication
   .option('--api-key <key>', 'TestingBot API key.')
   .option('--api-secret <secret>', 'TestingBot API secret.')
@@ -143,15 +169,9 @@ program
       const app = appFileArg || args.app;
       const flows = flowsArg || args.flows;
 
-      if (!app) {
-        throw new Error(
-          'App file is required. Provide it as first argument or use --app option.',
-        );
-      }
-      if (!flows) {
-        throw new Error(
-          'Flows path is required. Provide it as second argument or use --flows option.',
-        );
+      if (!app || !flows) {
+        maestroCommand.help();
+        return;
       }
 
       // Parse environment variables from -e KEY=VALUE format
@@ -169,15 +189,20 @@ program
         includeTags: args.includeTags,
         excludeTags: args.excludeTags,
         platformName: args.platform,
-        version: args.version,
+        version: args.deviceVersion,
         name: args.name,
         build: args.build,
         orientation: args.orientation,
-        locale: args.locale,
+        locale: args.deviceLocale,
         timeZone: args.timezone,
         throttleNetwork: args.throttleNetwork,
         geoCountryCode: args.geoCountryCode,
         env: Object.keys(env).length > 0 ? env : undefined,
+        maestroVersion: args.maestroVersion,
+        quiet: args.quiet,
+        async: args.async,
+        report: args.report,
+        reportOutputDir: args.reportOutputDir,
       });
       const credentials = await Auth.getCredentials({
         apiKey: args.apiKey,
@@ -189,11 +214,15 @@ program
         );
       }
       const maestro = new Maestro(credentials, options);
-      await maestro.run();
+      const result = await maestro.run();
+      if (!result.success) {
+        process.exitCode = 1;
+      }
     } catch (err) {
       logger.error(
         `Maestro error: ${err instanceof Error ? err.message : err}`,
       );
+      process.exitCode = 1;
     }
   })
   .showHelpAfterError(true);

src/index.ts

@@ -1,2 +1,3 @@
+#!/usr/bin/env node
 import program from './cli';
 program.parse(process.argv);

src/models/maestro_options.ts

@@ -7,6 +7,7 @@ export interface MaestroConfig {
 
 export type Orientation = 'PORTRAIT' | 'LANDSCAPE';
 export type ThrottleNetwork = '4G' | '3G' | 'Edge' | 'airplane' | 'disable';
+export type ReportFormat = 'html' | 'junit';
 
 export interface MaestroCapabilities {
   platformName?: 'Android' | 'iOS';
@@ -25,6 +26,7 @@ export interface MaestroRunOptions {
   includeTags?: string[];
   excludeTags?: string[];
   env?: Record<string, string>;
+  version?: string;
 }
 
 export default class MaestroOptions {
@@ -43,6 +45,11 @@ export default class MaestroOptions {
   private _throttleNetwork?: ThrottleNetwork;
   private _geoCountryCode?: string;
   private _env?: Record<string, string>;
+  private _maestroVersion?: string;
+  private _quiet: boolean;
+  private _async: boolean;
+  private _report?: ReportFormat;
+  private _reportOutputDir?: string;
 
   public constructor(
     app: string,
@@ -61,6 +68,11 @@ export default class MaestroOptions {
       throttleNetwork?: ThrottleNetwork;
       geoCountryCode?: string;
       env?: Record<string, string>;
+      maestroVersion?: string;
+      quiet?: boolean;
+      async?: boolean;
+      report?: ReportFormat;
+      reportOutputDir?: string;
     },
   ) {
     this._app = app;
@@ -78,6 +90,11 @@ export default class MaestroOptions {
     this._throttleNetwork = options?.throttleNetwork;
     this._geoCountryCode = options?.geoCountryCode;
     this._env = options?.env;
+    this._maestroVersion = options?.maestroVersion;
+    this._quiet = options?.quiet ?? false;
+    this._async = options?.async ?? false;
+    this._report = options?.report;
+    this._reportOutputDir = options?.reportOutputDir;
   }
 
   public get app(): string {
@@ -140,6 +157,26 @@ export default class MaestroOptions {
     return this._env;
   }
 
+  public get maestroVersion(): string | undefined {
+    return this._maestroVersion;
+  }
+
+  public get quiet(): boolean {
+    return this._quiet;
+  }
+
+  public get async(): boolean {
+    return this._async;
+  }
+
+  public get report(): ReportFormat | undefined {
+    return this._report;
+  }
+
+  public get reportOutputDir(): string | undefined {
+    return this._reportOutputDir;
+  }
+
   public getMaestroOptions(): MaestroRunOptions | undefined {
     const opts: MaestroRunOptions = {};
 
@@ -152,6 +189,9 @@ export default class MaestroOptions {
     if (this._env && Object.keys(this._env).length > 0) {
       opts.env = this._env;
     }
+    if (this._maestroVersion) {
+      opts.version = this._maestroVersion;
+    }
 
     return Object.keys(opts).length > 0 ? opts : undefined;
   }