lim 0.21.3 → 0.22.0

package/README.md

@@ -309,6 +309,23 @@ lim ios sync ./MyApp.app --watch --launch-mode RelaunchIfRunning
 lim ios sync ./MyApp.app --basis-cache-dir ./.limsync-cache
 ```
 
+#### Maestro (iOS only)
+
+Run the locally installed [Maestro](https://docs.maestro.dev) CLI against a remote
+Limrun simulator. The command installs and launches the Maestro XCTest runner on
+the instance when needed, then wires `maestro test` to it transparently.
+
+```bash
+lim ios maestro test flow.yaml
+lim ios maestro test flows/
+
+# Extra maestro flags go after --
+lim ios maestro -- test flow.yaml --include-tags smoke --test-output-dir artifacts
+
+# Creating the instance with the runner preinstalled skips the install step
+lim ios create --install-asset appstore/maestro-ios-runner-2.5.1.tar.gz
+```
+
 ---
 
 ### Android

package/dist/commands/ios/maestro.d.ts

@@ -0,0 +1,18 @@
+import { BaseCommand } from '../../base-command';
+export default class IosMaestro extends BaseCommand {
+    static summary: string;
+    static description: string;
+    static examples: string[];
+    static strict: boolean;
+    static args: {};
+    static flags: {
+        id: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'api-key': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        quiet: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        create: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        workspace: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=maestro.d.ts.map

package/dist/commands/ios/maestro.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maestro.d.ts","sourceRoot":"","sources":["../../../src/commands/ios/maestro.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,MAAM,CAAC,OAAO,SAAsD;IACpE,MAAM,CAAC,WAAW,SAI2F;IAC7G,MAAM,CAAC,QAAQ,WAIb;IAEF,MAAM,CAAC,MAAM,UAAS;IAEtB,MAAM,CAAC,IAAI,KAAM;IAEjB,MAAM,CAAC,KAAK;;;;;;;MAKV;IAEI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CA8F3B"}

package/dist/commands/ios/maestro.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_child_process_1 = require("node:child_process");
+const core_1 = require("@oclif/core");
+const api_1 = require("@limrun/api");
+const base_command_1 = require("../../base-command");
+const instance_client_factory_1 = require("../../lib/instance-client-factory");
+const maestro_1 = require("../../lib/maestro");
+class IosMaestro extends base_command_1.BaseCommand {
+    async run() {
+        const parsed = await this.parse(IosMaestro);
+        const flags = parsed.flags;
+        const rawArgs = parsed.argv ?? [];
+        this.setParsedFlags(flags);
+        await this.withAuth(async () => {
+            if (rawArgs[0] !== 'test') {
+                this.error('Provide a maestro test invocation, for example `lim ios maestro test flow.yaml`. ' +
+                    'Only the `test` subcommand is supported.');
+            }
+            const passthroughArgs = rawArgs.slice(1);
+            for (const arg of passthroughArgs) {
+                const flagName = arg.split('=')[0];
+                if (flagName && maestro_1.INJECTED_MAESTRO_FLAGS.includes(flagName)) {
+                    this.error(`${flagName} is set by lim automatically, remove it from the maestro arguments.`);
+                }
+            }
+            const resolvedInstance = this.resolveIosInstance(flags.id);
+            const id = resolvedInstance.id;
+            let { targetHttpPortUrlPrefix, token } = resolvedInstance;
+            if (!targetHttpPortUrlPrefix || !token) {
+                const instance = await this.client.iosInstances.get(id);
+                targetHttpPortUrlPrefix = instance.status.targetHttpPortUrlPrefix;
+                token = instance.status.token;
+                // Forward the fresh endpoints so getIosInstanceClient connects directly
+                // instead of fetching the instance a second time.
+                resolvedInstance.apiUrl = instance.status.apiUrl;
+                resolvedInstance.token = token;
+            }
+            if (!targetHttpPortUrlPrefix || !token) {
+                this.error(`Instance ${id} does not expose the HTTP port URL required for Maestro.`);
+            }
+            const runnerUrl = targetHttpPortUrlPrefix + String(api_1.MAESTRO_RUNNER_PORT);
+            // A responding runner proves it is installed, so the common path skips
+            // the listApps round trip entirely.
+            const [{ client, disconnect }, runnerRunning] = await Promise.all([
+                (0, instance_client_factory_1.getIosInstanceClient)(this.client, resolvedInstance),
+                (0, api_1.isMaestroRunnerRunning)(runnerUrl, token),
+            ]);
+            try {
+                if (!runnerRunning) {
+                    const apps = await client.listApps();
+                    if (!apps.some((app) => app.bundleId === api_1.MAESTRO_RUNNER_BUNDLE_ID)) {
+                        this.info('Installing the Maestro runner on the instance...');
+                        const assets = await this.client.assets.list({
+                            nameFilter: maestro_1.MAESTRO_RUNNER_ASSET_NAME,
+                            includeAppStore: true,
+                            includeDownloadUrl: true,
+                        });
+                        const runnerAsset = assets.find((asset) => asset.name === maestro_1.MAESTRO_RUNNER_ASSET_NAME);
+                        if (!runnerAsset?.signedDownloadUrl) {
+                            this.error(`Maestro runner asset ${maestro_1.MAESTRO_RUNNER_ASSET_NAME} is not available.`);
+                        }
+                        await client.installApp(runnerAsset.signedDownloadUrl);
+                    }
+                    this.info('Launching the Maestro runner...');
+                    const launch = await client
+                        .simctl(['launch', '--terminate-running-process', 'booted', api_1.MAESTRO_RUNNER_BUNDLE_ID])
+                        .wait();
+                    if (launch.code !== 0) {
+                        this.error(`Failed to launch the Maestro runner (exit code ${launch.code}): ${launch.stderr}`);
+                    }
+                    if (!(await (0, api_1.waitForMaestroRunner)(runnerUrl, token))) {
+                        this.error('The Maestro runner did not become ready in time.');
+                    }
+                }
+                const run = await (0, api_1.prepareMaestroRun)(client, { runnerUrl });
+                this.info(`Running maestro ${run.maestroVersion} against ${id}...`);
+                const exitCode = await new Promise((resolve, reject) => {
+                    const proc = (0, node_child_process_1.spawn)('maestro', ['test', ...run.args, ...passthroughArgs], {
+                        ...api_1.maestroSpawnOptions,
+                        env: { ...process.env, ...run.env },
+                        stdio: 'inherit',
+                    });
+                    proc.once('error', reject);
+                    // Maestro already reported to the inherited stdio; a signal death
+                    // simply becomes a nonzero exit.
+                    proc.once('close', (code, signal) => resolve(signal ? 1 : code ?? 1));
+                });
+                if (exitCode !== 0) {
+                    this.exit(exitCode);
+                }
+            }
+            finally {
+                disconnect();
+            }
+        });
+    }
+}
+IosMaestro.summary = 'Run Maestro flows against a running iOS instance';
+IosMaestro.description = 'Run the locally installed Maestro CLI against a remote Limrun iOS simulator. ' +
+    'Ensures the Maestro XCTest runner is installed and running on the instance, then wires ' +
+    'the local `maestro test` invocation to it transparently. Pass Maestro arguments after `--`. ' +
+    `Creating the instance with \`--install-asset ${maestro_1.MAESTRO_RUNNER_ASSET_NAME}\` skips the install step here.`;
+IosMaestro.examples = [
+    '<%= config.bin %> ios maestro test flow.yaml',
+    '<%= config.bin %> ios maestro test flows/',
+    '<%= config.bin %> ios maestro -- test flow.yaml --include-tags smoke --test-output-dir artifacts',
+];
+IosMaestro.strict = false;
+IosMaestro.args = {};
+IosMaestro.flags = {
+    ...base_command_1.BaseCommand.baseFlags,
+    id: core_1.Flags.string({
+        description: 'iOS instance ID to target. Defaults to the last created iOS instance.',
+    }),
+};
+exports.default = IosMaestro;
+//# sourceMappingURL=maestro.js.map

package/dist/commands/ios/maestro.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maestro.js","sourceRoot":"","sources":["../../../src/commands/ios/maestro.ts"],"names":[],"mappings":";;AAAA,2DAA2C;AAE3C,sCAAoC;AACpC,qCAOqB;AACrB,qDAAiD;AACjD,+EAAyE;AACzE,+CAAsF;AAEtF,MAAqB,UAAW,SAAQ,0BAAW;IAwBjD,KAAK,CAAC,GAAG;QACP,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAiB,CAAC,CAAC;QACnD,MAAM,KAAK,GAAG,MAAM,CAAC,KAA4B,CAAC;QAClD,MAAM,OAAO,GAAI,MAAM,CAAC,IAAiB,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE3B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC7B,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;gBAC1B,IAAI,CAAC,KAAK,CACR,mFAAmF;oBACjF,0CAA0C,CAC7C,CAAC;YACJ,CAAC;YACD,MAAM,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACzC,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,QAAQ,IAAI,gCAAsB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1D,IAAI,CAAC,KAAK,CAAC,GAAG,QAAQ,qEAAqE,CAAC,CAAC;gBAC/F,CAAC;YACH,CAAC;YAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC3D,MAAM,EAAE,GAAG,gBAAgB,CAAC,EAAE,CAAC;YAE/B,IAAI,EAAE,uBAAuB,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAAC;YAC1D,IAAI,CAAC,uBAAuB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACxD,uBAAuB,GAAG,QAAQ,CAAC,MAAM,CAAC,uBAAuB,CAAC;gBAClE,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC;gBAC9B,wEAAwE;gBACxE,kDAAkD;gBAClD,gBAAgB,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;gBACjD,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;YACjC,CAAC;YACD,IAAI,CAAC,uBAAuB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,0DAA0D,CAAC,CAAC;YACvF,CAAC;YACD,MAAM,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAAC,yBAAmB,CAAC,CAAC;YAExE,uEAAuE;YACvE,oCAAoC;YACpC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,aAAa,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChE,IAAA,8CAAoB,EAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC;gBACnD,IAAA,4BAAsB,EAAC,SAAS,EAAE,KAAK,CAAC;aACzC,CAAC,CAAC;YACH,IAAI,CAAC;gBACH,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;oBACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,8BAAwB,CAAC,EAAE,CAAC;wBACnE,IAAI,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;wBAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;4BAC3C,UAAU,EAAE,mCAAyB;4BACrC,eAAe,EAAE,IAAI;4BACrB,kBAAkB,EAAE,IAAI;yBACzB,CAAC,CAAC;wBACH,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,mCAAyB,CAAC,CAAC;wBACrF,IAAI,CAAC,WAAW,EAAE,iBAAiB,EAAE,CAAC;4BACpC,IAAI,CAAC,KAAK,CAAC,wBAAwB,mCAAyB,oBAAoB,CAAC,CAAC;wBACpF,CAAC;wBACD,MAAM,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;oBACzD,CAAC;oBACD,IAAI,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;oBAC7C,MAAM,MAAM,GAAG,MAAM,MAAM;yBACxB,MAAM,CAAC,CAAC,QAAQ,EAAE,6BAA6B,EAAE,QAAQ,EAAE,8BAAwB,CAAC,CAAC;yBACrF,IAAI,EAAE,CAAC;oBACV,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;wBACtB,IAAI,CAAC,KAAK,CAAC,kDAAkD,MAAM,CAAC,IAAI,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;oBACjG,CAAC;oBACD,IAAI,CAAC,CAAC,MAAM,IAAA,0BAAoB,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;wBACpD,IAAI,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;oBACjE,CAAC;gBACH,CAAC;gBAED,MAAM,GAAG,GAAG,MAAM,IAAA,uBAAiB,EAAC,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC3D,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,CAAC,cAAc,YAAY,EAAE,KAAK,CAAC,CAAC;gBACpE,MAAM,QAAQ,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC7D,MAAM,IAAI,GAAG,IAAA,0BAAK,EAAC,SAAS,EAAE,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,eAAe,CAAC,EAAE;wBACvE,GAAG,yBAAmB;wBACtB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE;wBACnC,KAAK,EAAE,SAAS;qBACjB,CAAC,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBAC3B,kEAAkE;oBAClE,iCAAiC;oBACjC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;gBACxE,CAAC,CAAC,CAAC;gBACH,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACnB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,UAAU,EAAE,CAAC;YACf,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;;AApHM,kBAAO,GAAG,kDAAkD,CAAC;AAC7D,sBAAW,GAChB,+EAA+E;IAC/E,yFAAyF;IACzF,8FAA8F;IAC9F,gDAAgD,mCAAyB,iCAAiC,CAAC;AACtG,mBAAQ,GAAG;IAChB,8CAA8C;IAC9C,2CAA2C;IAC3C,kGAAkG;CACnG,CAAC;AAEK,iBAAM,GAAG,KAAK,CAAC;AAEf,eAAI,GAAG,EAAE,CAAC;AAEV,gBAAK,GAAG;IACb,GAAG,0BAAW,CAAC,SAAS;IACxB,EAAE,EAAE,YAAK,CAAC,MAAM,CAAC;QACf,WAAW,EAAE,uEAAuE;KACrF,CAAC;CACH,CAAC;kBAtBiB,UAAU"}

package/dist/lib/maestro.d.ts

@@ -0,0 +1,3 @@
+export declare const MAESTRO_RUNNER_ASSET_NAME = "appstore/maestro-ios-runner-2.5.1.tar.gz";
+export declare const INJECTED_MAESTRO_FLAGS: string[];
+//# sourceMappingURL=maestro.d.ts.map

package/dist/lib/maestro.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maestro.d.ts","sourceRoot":"","sources":["../../src/lib/maestro.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,yBAAyB,6CAA6C,CAAC;AAIpF,eAAO,MAAM,sBAAsB,UAOlC,CAAC"}

package/dist/lib/maestro.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INJECTED_MAESTRO_FLAGS = exports.MAESTRO_RUNNER_ASSET_NAME = void 0;
+// The patched runner has proven version-agnostic so far: Maestro CLI 2.7.0
+// drives this 2.5.1-built runner including the newer endpoints (swipeV2,
+// isScreenStatic, setOrientation). Bump only when a CLI release actually
+// requires a newer runner.
+exports.MAESTRO_RUNNER_ASSET_NAME = 'appstore/maestro-ios-runner-2.5.1.tar.gz';
+// Flags `lim ios maestro` injects itself; user-provided duplicates would make
+// maestro's picocli parser fail with a confusing error.
+exports.INJECTED_MAESTRO_FLAGS = [
+    '--platform',
+    '-p',
+    '--device',
+    '--udid',
+    '--no-reinstall-driver',
+    '--driver-host-port',
+];
+//# sourceMappingURL=maestro.js.map

package/dist/lib/maestro.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maestro.js","sourceRoot":"","sources":["../../src/lib/maestro.ts"],"names":[],"mappings":";;;AAAA,2EAA2E;AAC3E,yEAAyE;AACzE,yEAAyE;AACzE,2BAA2B;AACd,QAAA,yBAAyB,GAAG,0CAA0C,CAAC;AAEpF,8EAA8E;AAC9E,wDAAwD;AAC3C,QAAA,sBAAsB,GAAG;IACpC,YAAY;IACZ,IAAI;IACJ,UAAU;IACV,QAAQ;IACR,uBAAuB;IACvB,oBAAoB;CACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lim",
-  "version": "0.21.3",
+  "version": "0.22.0",
   "description": "Use remote XCode, Gradle, iOS Simulator, Android Emulator and more to build and test apps from Linux, Windows or macOS.",
   "bin": {
     "lim": "./bin/run.js"
@@ -25,7 +25,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@limrun/api": "0.45.2",
+    "@limrun/api": "0.45.3",
     "@oclif/core": "^4",
     "cli-progress": "^3.12.0",
     "cli-table3": "^0.6.5",