maestro: when passing an ipa file, assume --real-device

Author: jochen-testingbot

src/models/maestro_options.ts

@@ -38,6 +38,10 @@ export interface MaestroRunOptions {
 }
 
 export default class MaestroOptions {
+  private static isIpaFile(app?: string): boolean {
+    return app?.toLowerCase().endsWith('.ipa') ?? false;
+  }
+
   private _app: string;
   private _flows: string[];
   private _device?: string;
@@ -113,7 +117,8 @@ export default class MaestroOptions {
     this._async = options?.async ?? false;
     this._report = options?.report;
     this._reportOutputDir = options?.reportOutputDir;
-    this._realDevice = options?.realDevice ?? false;
+    // IPA files can only be tested on real iOS devices, so automatically enable realDevice
+    this._realDevice = MaestroOptions.isIpaFile(app) || (options?.realDevice ?? false);
     this._downloadArtifacts = options?.downloadArtifacts;
     this._artifactsOutputDir = options?.artifactsOutputDir;
     this._ignoreChecksumCheck = options?.ignoreChecksumCheck ?? false;

tests/models/maestro_options.test.ts

@@ -116,6 +116,7 @@ describe('MaestroOptions', () => {
       expect(caps).toEqual({
         deviceName: '*',
         platformName: 'iOS',
+        realDevice: 'true', // IPA files require real devices
       });
     });
 
@@ -196,6 +197,7 @@ describe('MaestroOptions', () => {
         timeZone: 'Europe/London',
         throttleNetwork: 'Edge',
         geoCountryCode: 'GB',
+        realDevice: 'true', // IPA files require real devices
       });
     });
 
@@ -454,12 +456,28 @@ describe('MaestroOptions', () => {
   });
 
   describe('realDevice option', () => {
-    it('should have realDevice as false by default', () => {
+    it('should have realDevice as false by default for APK files', () => {
       const options = new MaestroOptions('app.apk', './flows', 'Pixel 8');
 
       expect(options.realDevice).toBe(false);
     });
 
+    it('should automatically enable realDevice for IPA files', () => {
+      const options = new MaestroOptions('app.ipa', './flows', 'iPhone 15');
+
+      // IPA files can only be tested on real iOS devices
+      expect(options.realDevice).toBe(true);
+    });
+
+    it('should automatically enable realDevice for IPA files even without explicit option', () => {
+      const options = new MaestroOptions('app.ipa', './flows', 'iPhone 15', {
+        platformName: 'iOS',
+        realDevice: false, // Even when explicitly set to false, IPA should force it to true
+      });
+
+      expect(options.realDevice).toBe(true);
+    });
+
     it('should store realDevice when set to true', () => {
       const options = new MaestroOptions('app.apk', './flows', 'Pixel 8', {
         realDevice: true,

tests/providers/maestro.test.ts

@@ -449,6 +449,7 @@ describe('Maestro', () => {
             {
               deviceName: '*',
               platformName: 'iOS',
+              realDevice: 'true', // IPA files require real devices
             },
           ],
         }),