add groups cli argument

Author: jochen-testingbot

README.md

@@ -110,6 +110,7 @@ testingbot maestro <app> <flows...> [options]
 |--------|-------------|
 | `--name <name>` | Test name for dashboard identification |
 | `--build <build>` | Build identifier for grouping test runs |
+| `--groups <names>` | Tag the test session with one or more groups (comma-separated). Groups appear on the test in the TestingBot dashboard |
 | `--include-tags <tags>` | Only run flows with these tags (comma-separated) |
 | `--exclude-tags <tags>` | Exclude flows with these tags (comma-separated) |
 | `-e, --env <KEY=VALUE>` | Environment variable for flows (can be repeated) |
@@ -172,6 +173,9 @@ testingbot maestro app.apk ./flows --device "Pixel 8" --deviceVersion "14"
 # Android app on real device with tags
 testingbot maestro app.apk ./flows --device "Samsung Galaxy S24" --real-device --include-tags "smoke,regression"
 
+# Tag the test session with groups (visible in the dashboard)
+testingbot maestro app.apk ./flows --groups "smoke,critical"
+
 # With environment variables
 testingbot maestro app.apk ./flows -e API_URL=https://staging.example.com -e API_KEY=secret
 

src/cli.ts

@@ -285,6 +285,11 @@ program
   )
   // Test metadata
   .option('--name <name>', 'Name for this Maestro run.')
+  .option(
+    '--groups <names>',
+    'Tag the test session with one or more groups (comma-separated).',
+    (val) => val.split(',').map((g) => g.trim()).filter((g) => g.length > 0),
+  )
   // Network and geo
   .option(
     '--throttle-network <speed>',
@@ -479,6 +484,7 @@ program
         shardSplit: args.shardSplit,
         debug: args.debug,
         configFile: args.config,
+        groups: args.groups,
         metadata,
       });
       if (args.debug) {

src/models/maestro_options.ts

@@ -31,6 +31,7 @@ export interface MaestroCapabilities {
   'testingbot.geoCountryCode'?: string;
   tunnelIdentifier?: string;
   realDevice?: string;
+  groups?: string[];
 }
 
 export interface MaestroRunOptions {
@@ -75,6 +76,7 @@ export default class MaestroOptions {
   private _shardSplit?: number;
   private _debug: boolean;
   private _configFile?: string;
+  private _groups?: string[];
   // Metadata
   private _metadata?: RunMetadata;
 
@@ -109,6 +111,7 @@ export default class MaestroOptions {
       shardSplit?: number;
       debug?: boolean;
       configFile?: string;
+      groups?: string[];
       metadata?: RunMetadata;
     },
   ) {
@@ -147,6 +150,7 @@ export default class MaestroOptions {
     this._shardSplit = options?.shardSplit;
     this._debug = options?.debug ?? false;
     this._configFile = options?.configFile;
+    this._groups = options?.groups;
     this._metadata = options?.metadata;
   }
 
@@ -270,6 +274,10 @@ export default class MaestroOptions {
     return this._metadata;
   }
 
+  public get groups(): string[] | undefined {
+    return this._groups;
+  }
+
   public getMaestroOptions(): MaestroRunOptions | undefined {
     const opts: MaestroRunOptions = {};
 
@@ -323,6 +331,7 @@ export default class MaestroOptions {
       caps['testingbot.geoCountryCode'] = this._geoCountryCode;
     if (this._tunnelIdentifier) caps.tunnelIdentifier = this._tunnelIdentifier;
     if (this._realDevice) caps.realDevice = 'true';
+    if (this._groups && this._groups.length > 0) caps.groups = this._groups;
 
     return caps;
   }

tests/cli.test.ts

@@ -364,6 +364,27 @@ describe('TestingBotCTL CLI', () => {
     expect(opts.excludeTags).toEqual(['flaky']);
   });
 
+  test('maestro command should accept --groups (parsed into array, surfaces in capabilities)', async () => {
+    mockGetCredentials.mockResolvedValue({ apiKey: 'test-api-key' });
+
+    await program.parseAsync([
+      'node',
+      'cli',
+      'maestro',
+      'app.apk',
+      './flows',
+      '--device',
+      'device-1',
+      '--groups',
+      'smoke, critical , ,regression',
+    ]);
+
+    expect(mockMaestroRun).toHaveBeenCalledTimes(1);
+    const opts = lastConstructorOptions<{ groups?: string[] }>(Maestro);
+    // Empty entries from "a, ,b" and surrounding whitespace are stripped.
+    expect(opts.groups).toEqual(['smoke', 'critical', 'regression']);
+  });
+
   test('maestro command should work without --device (optional)', async () => {
     mockGetCredentials.mockResolvedValue({ apiKey: 'test-api-key' });
 

tests/models/maestro_options.test.ts

@@ -36,6 +36,7 @@ describe('MaestroOptions', () => {
         geoCountryCode: 'DE',
         env: { API_URL: 'https://api.example.com', API_KEY: 'secret' },
         maestroVersion: '2.0.10',
+        groups: ['smoke', 'critical'],
         quiet: true,
         async: true,
       });
@@ -58,6 +59,7 @@ describe('MaestroOptions', () => {
         API_KEY: 'secret',
       });
       expect(options.maestroVersion).toBe('2.0.10');
+      expect(options.groups).toEqual(['smoke', 'critical']);
       expect(options.quiet).toBe(true);
       expect(options.async).toBe(true);
     });
@@ -232,6 +234,32 @@ describe('MaestroOptions', () => {
       expect(caps.tunnelIdentifier).toBe('my-tunnel');
     });
 
+    it('should include groups in capabilities when set', () => {
+      const options = new MaestroOptions('app.apk', './flows', 'Pixel 6', {
+        platformName: 'Android',
+        groups: ['smoke', 'critical'],
+      });
+      const caps = options.getCapabilities();
+      expect(caps.groups).toEqual(['smoke', 'critical']);
+    });
+
+    it('should omit groups from capabilities when not set', () => {
+      const options = new MaestroOptions('app.apk', './flows', 'Pixel 6', {
+        platformName: 'Android',
+      });
+      const caps = options.getCapabilities();
+      expect(caps).not.toHaveProperty('groups');
+    });
+
+    it('should omit groups from capabilities when empty array', () => {
+      const options = new MaestroOptions('app.apk', './flows', 'Pixel 6', {
+        platformName: 'Android',
+        groups: [],
+      });
+      const caps = options.getCapabilities();
+      expect(caps).not.toHaveProperty('groups');
+    });
+
     it('should not include includeTags and excludeTags in capabilities', () => {
       const options = new MaestroOptions('app.apk', './flows', 'Pixel 8', {
         includeTags: ['smoke', 'regression'],