download specific artifacts

Author: jochen-testingbot

src/cli.ts

@@ -18,6 +18,7 @@ import MaestroOptions, {
   Orientation,
   ThrottleNetwork,
   ReportFormat,
+  ArtifactDownloadMode,
 } from './models/maestro_options';
 import Maestro from './providers/maestro';
 import Login from './providers/login';
@@ -297,8 +298,9 @@ const maestroCommand = program
   )
   // Artifact download
   .option(
-    '--download-artifacts',
-    'Download test artifacts (logs, screenshots, video) after completion.',
+    '--download-artifacts [mode]',
+    'Download test artifacts after completion. Mode: all (default) or failed.',
+    (val) => (val === 'failed' ? 'failed' : 'all') as ArtifactDownloadMode,
   )
   .option(
     '--artifacts-output-dir <path>',
@@ -367,7 +369,10 @@ const maestroCommand = program
         report: args.report,
         reportOutputDir: args.reportOutputDir,
         realDevice: args.realDevice,
-        downloadArtifacts: args.downloadArtifacts,
+        downloadArtifacts:
+          args.downloadArtifacts === true
+            ? 'all'
+            : (args.downloadArtifacts as ArtifactDownloadMode | undefined),
         artifactsOutputDir: args.artifactsOutputDir,
         ignoreChecksumCheck: args.ignoreChecksumCheck,
         shardSplit: args.shardSplit,

src/models/maestro_options.ts

@@ -8,6 +8,7 @@ export interface MaestroConfig {
 export type Orientation = 'PORTRAIT' | 'LANDSCAPE';
 export type ThrottleNetwork = '4G' | '3G' | 'Edge' | 'airplane' | 'disable';
 export type ReportFormat = 'html' | 'junit';
+export type ArtifactDownloadMode = 'all' | 'failed';
 
 export interface MaestroCapabilities {
   platformName?: 'Android' | 'iOS';
@@ -50,7 +51,7 @@ export default class MaestroOptions {
   private _report?: ReportFormat;
   private _reportOutputDir?: string;
   private _realDevice: boolean;
-  private _downloadArtifacts: boolean;
+  private _downloadArtifacts?: ArtifactDownloadMode;
   private _artifactsOutputDir?: string;
   private _ignoreChecksumCheck: boolean;
   private _shardSplit?: number;
@@ -77,7 +78,7 @@ export default class MaestroOptions {
       report?: ReportFormat;
       reportOutputDir?: string;
       realDevice?: boolean;
-      downloadArtifacts?: boolean;
+      downloadArtifacts?: ArtifactDownloadMode;
       artifactsOutputDir?: string;
       ignoreChecksumCheck?: boolean;
       shardSplit?: number;
@@ -103,7 +104,7 @@ export default class MaestroOptions {
     this._report = options?.report;
     this._reportOutputDir = options?.reportOutputDir;
     this._realDevice = options?.realDevice ?? false;
-    this._downloadArtifacts = options?.downloadArtifacts ?? false;
+    this._downloadArtifacts = options?.downloadArtifacts;
     this._artifactsOutputDir = options?.artifactsOutputDir;
     this._ignoreChecksumCheck = options?.ignoreChecksumCheck ?? false;
     this._shardSplit = options?.shardSplit;
@@ -189,7 +190,7 @@ export default class MaestroOptions {
     return this._realDevice;
   }
 
-  public get downloadArtifacts(): boolean {
+  public get downloadArtifacts(): ArtifactDownloadMode | undefined {
     return this._downloadArtifacts;
   }
 

src/providers/maestro.ts

@@ -1522,8 +1522,30 @@ export default class Maestro {
   private async downloadArtifacts(runs: MaestroRunInfo[]): Promise<void> {
     if (!this.options.downloadArtifacts) return;
 
+    // Filter runs based on download mode
+    const downloadMode = this.options.downloadArtifacts;
+    const runsToDownload =
+      downloadMode === 'failed'
+        ? runs.filter((run) => run.success !== 1)
+        : runs;
+
+    if (runsToDownload.length === 0) {
+      if (!this.options.quiet) {
+        if (downloadMode === 'failed') {
+          logger.info('No failed runs to download artifacts for.');
+        } else {
+          logger.info('No runs to download artifacts for.');
+        }
+      }
+      return;
+    }
+
     if (!this.options.quiet) {
-      logger.info('Downloading artifacts...');
+      if (downloadMode === 'failed') {
+        logger.info(`Downloading artifacts for ${runsToDownload.length} failed run(s)...`);
+      } else {
+        logger.info('Downloading artifacts...');
+      }
     }
 
     const outputDir = this.options.artifactsOutputDir || process.cwd();
@@ -1533,7 +1555,7 @@ export default class Maestro {
     );
 
     try {
-      for (const run of runs) {
+      for (const run of runsToDownload) {
         try {
           if (!this.options.quiet) {
             logger.info(`  Waiting for artifacts sync for run ${run.id}...`);

tests/providers/maestro.test.ts

@@ -1575,7 +1575,7 @@ describe('Maestro', () => {
         'path/to/app.apk',
         'path/to/flows',
         'Pixel 6',
-        { downloadArtifacts: true },
+        { downloadArtifacts: 'all' },
       );
       const maestroWithArtifacts = new Maestro(
         mockCredentials,
@@ -1596,7 +1596,7 @@ describe('Maestro', () => {
         'path/to/flows',
         'Pixel 6',
         {
-          downloadArtifacts: true,
+          downloadArtifacts: 'all',
           artifactsOutputDir: './artifacts',
         },
       );
@@ -1616,13 +1616,33 @@ describe('Maestro', () => {
       await expect(maestroWithArtifacts['validate']()).resolves.toBe(true);
     });
 
+    it('should pass validation when downloadArtifacts is set to failed mode', async () => {
+      const optionsWithArtifacts = new MaestroOptions(
+        'path/to/app.apk',
+        'path/to/flows',
+        'Pixel 6',
+        { downloadArtifacts: 'failed' },
+      );
+      const maestroWithArtifacts = new Maestro(
+        mockCredentials,
+        optionsWithArtifacts,
+      );
+
+      fs.promises.access = jest
+        .fn()
+        .mockResolvedValueOnce(undefined)
+        .mockResolvedValueOnce(undefined);
+
+      await expect(maestroWithArtifacts['validate']()).resolves.toBe(true);
+    });
+
     it('should generate zip filename from --name option', async () => {
       const optionsWithName = new MaestroOptions(
         'path/to/app.apk',
         'path/to/flows',
         'Pixel 6',
         {
-          downloadArtifacts: true,
+          downloadArtifacts: 'all',
           name: 'my-test-run',
         },
       );
@@ -1641,7 +1661,7 @@ describe('Maestro', () => {
         'path/to/flows',
         'Pixel 6',
         {
-          downloadArtifacts: true,
+          downloadArtifacts: 'all',
           name: 'my test/run:v1.0',
         },
       );
@@ -1659,7 +1679,7 @@ describe('Maestro', () => {
         'path/to/app.apk',
         'path/to/flows',
         'Pixel 6',
-        { downloadArtifacts: true },
+        { downloadArtifacts: 'all' },
       );
       const maestroWithoutName = new Maestro(
         mockCredentials,
@@ -1676,7 +1696,7 @@ describe('Maestro', () => {
         'path/to/flows',
         'Pixel 6',
         {
-          downloadArtifacts: true,
+          downloadArtifacts: 'all',
           name: 'existing-name',
         },
       );