@devicecloud.dev/dcd 0.0.1-alpha.6 → 0.0.1-alpha.8

package/dist/commands/cloud.d.ts

@@ -7,17 +7,20 @@ export default class Cloud extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        androidApiLevel: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        apiUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        appBinaryId: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        appFile: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'android-api-level': import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'api-key': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'api-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        arm64: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        async: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         env: import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        excludeTags: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+        'exclude-tags': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
         flows: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        iOSVersion: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        includeTags: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+        'google-play': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'include-tags': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+        'ios-version': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        orientation: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/commands/cloud.js

@@ -96,36 +96,44 @@ class Cloud extends core_1.Command {
     static description = `Test a Flow or set of Flows on devicecloud.dev (https://devicecloud.dev)\nProvide your application file and a folder with Maestro flows to run them in parallel on multiple devices in devicecloud.dev\nThe command will block until all analyses have completed`;
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = {
-        androidApiLevel: core_1.Flags.integer({
+        'android-api-level': core_1.Flags.integer({
             aliases: ['android-api-level'],
-            description: 'Android API level to run your flow against',
+            description: '[Android only] Android API level to run your flow against',
             options: ['32', '33', '34'],
         }),
-        apiKey: core_1.Flags.string({ aliases: ['api-key'], description: 'API key' }),
-        apiUrl: core_1.Flags.string({
+        'api-key': core_1.Flags.string({
+            aliases: ['api-key'],
+            description: 'API key',
+        }),
+        'api-url': core_1.Flags.string({
             aliases: ['api-url'],
             default: 'https://api.devicecloud.dev',
             description: 'API base URL',
             hidden: true,
         }),
-        appBinaryId: core_1.Flags.string({
+        'app-binary-id': core_1.Flags.string({
             aliases: ['app-binary-id'],
             description: 'The ID of the app binary previously uploaded to Maestro Cloud',
         }),
-        appFile: core_1.Flags.file({
+        'app-file': core_1.Flags.file({
             aliases: ['app-file'],
             description: 'App binary to run your flows against',
         }),
-        async: core_1.Flags.boolean({
-            default: true,
+        arm64: core_1.Flags.boolean({
+            default: false,
+            description: '[Android only] Run your flow against arm64 devices',
+        }),
+        async: core_1.Flags.string({
+            default: 'true',
             description: 'Wait for the results of the run',
+            options: ['true', 'false'],
         }),
         env: core_1.Flags.file({
             char: 'e',
             description: 'One or more environment variables to inject into your flows',
             multiple: true,
         }),
-        excludeTags: core_1.Flags.string({
+        'exclude-tags': core_1.Flags.string({
             aliases: ['exclude-tags'],
             default: [],
             description: 'Flows which have these tags will be excluded from the run',
@@ -135,22 +143,35 @@ class Cloud extends core_1.Command {
         flows: core_1.Flags.string({
             description: 'The path to the flow file or folder containing your flows',
         }),
-        iOSVersion: core_1.Flags.string({
-            aliases: ['ios-version'],
-            description: 'iOS version to run your flow against',
-            options: ['16.4', '17.2'],
+        'google-play': core_1.Flags.boolean({
+            aliases: ['google-play'],
+            default: false,
+            description: '[Android only] Run your flow against Google Play devices',
         }),
-        includeTags: core_1.Flags.string({
+        'include-tags': core_1.Flags.string({
             aliases: ['include-tags'],
             default: [],
             description: 'Only flows which have these tags will be included in the run',
             multiple: true,
             parse: (input) => input.split(','),
         }),
+        'ios-version': core_1.Flags.string({
+            aliases: ['ios-version'],
+            description: '[iOS only] iOS version to run your flow against',
+            options: ['16.4', '17.2'],
+        }),
+        orientation: core_1.Flags.string({
+            description: '[Android only] The orientation of the device to run your flow against in degrees',
+            options: ['0', '90', '180', '270'],
+        }),
     };
     async run() {
         const { args, flags } = await this.parse(Cloud);
-        const { apiKey, apiUrl, appBinaryId, appFile, async, env, excludeTags, flows, includeTags, ...rest } = flags;
+        const { 'api-key': apiKey, 'api-url': apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, arm64, async, env, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'include-tags': includeTags, orientation, ...rest } = flags;
+        if (arm64) {
+            (0, cli_ux_1.info)('Contact hello@devicecloud.dev to enquire about arm64 devices');
+            (0, cli_ux_1.exit)();
+        }
         const { firstFile, secondFile } = args;
         let finalBinaryId = appBinaryId;
         const finalAppFile = appFile ?? firstFile;
@@ -160,25 +181,38 @@ class Cloud extends core_1.Command {
                 throw new Error('You cannot provide both an appBinaryId and a binary file');
             }
             flowFile = flows ?? firstFile;
-            // this.log(
-            //   `you want to run the flow(s) ${flowFile} against the binary with id ${appBinaryId} with the following flags: ${JSON.stringify(
-            //     flags,
-            //   )}`,
-            // );
         }
-        else {
+        if (!flowFile) {
+            throw new Error('You must provide a flow file');
+        }
+        let testFileNames = [];
+        let continueOnFailure = true;
+        let sequentialFlows = [];
+        if (!flowFile?.endsWith('.yaml') &&
+            !flowFile?.endsWith('.yml') &&
+            !flowFile?.endsWith('/')) {
+            flowFile += '/';
+        }
+        try {
+            const executionPlan = await (0, plan_1.plan)(flowFile, includeTags.flat(), excludeTags.flat());
+            testFileNames = executionPlan.flowsToRun;
+            continueOnFailure = executionPlan.sequence?.continueOnFailure ?? true;
+            sequentialFlows = executionPlan.sequence?.flows ?? [];
+        }
+        catch (error) {
+            console.error(error);
+        }
+        if (!appBinaryId) {
             if (!(flowFile && finalAppFile)) {
                 throw new Error('You must provide a flow file and an app binary id');
             }
             if (!finalAppFile.endsWith('.apk') && !finalAppFile.endsWith('.zip')) {
                 throw new Error('App file must be a .apk or .zip file');
             }
-            this.log(`you want to run the flow(s) ${flowFile} against the app ${finalAppFile} with the following flags: ${JSON.stringify(flags)}`);
-        }
-        if (!flowFile) {
-            throw new Error('You must provide a flow file');
+            this.log(`you want to run the flow(s) ${flowFile} against the app ${finalAppFile} with the following flags: ${JSON.stringify(flags)}\n`);
         }
         if (!finalBinaryId) {
+            core_1.ux.action.start('Uploading binary', 'Initializing', { stdout: true });
             const binaryFormData = new FormData();
             const binaryBlob = new Blob([await (0, promises_1.readFile)(finalAppFile)], {
                 type: mimeTypeLookupByExtension[finalAppFile.split('.').pop()],
@@ -188,34 +222,13 @@ class Cloud extends core_1.Command {
                 body: binaryFormData,
                 headers: { 'x-app-api-key': apiKey },
             };
+            core_1.ux.action.status = `Uploading`;
             const { binaryId, message } = await typeSafePost(apiUrl, '/uploads/binary', options);
             if (!binaryId)
                 throw new Error(message);
-            this.log(message);
+            core_1.ux.action.stop(`\nBinary uploaded with id: ${binaryId}`);
             finalBinaryId = binaryId;
         }
-        const testFileNames = [];
-        let flowFileDirectory = flowFile;
-        if (!flowFile?.endsWith('.yaml') && !flowFile?.endsWith('.yml')) {
-            try {
-                const executionPlan = await (0, plan_1.plan)(flowFile, includeTags.flat(), excludeTags.flat());
-                for (const file of executionPlan.flowsToRun) {
-                    testFileNames.push(file);
-                }
-                for (const file of executionPlan.sequence?.flows ?? []) {
-                    // todo: handle continueOnFailure and other sequence properties
-                    testFileNames.push(file);
-                }
-            }
-            catch (error) {
-                console.error(error);
-            }
-        }
-        else {
-            // we are working with a single file
-            flowFileDirectory = flowFile.split('/').slice(0, -1).join('/');
-            testFileNames.push(flowFile.split('/').pop());
-        }
         const testFormData = new FormData();
         // eslint-disable-next-line unicorn/no-array-reduce
         const envObject = (env ?? []).reduce((acc, cur) => {
@@ -223,8 +236,8 @@ class Cloud extends core_1.Command {
             acc[key] = value;
             return acc;
         }, {});
-        const buffer = flowFileDirectory?.length
-            ? await compressDir(flowFileDirectory)
+        const buffer = testFileNames?.length > 1
+            ? await compressDir(flowFile.split('/').slice(0, -1).join('/'))
             : await compressFile(flowFile);
         const blob = new Blob([buffer], {
             type: mimeTypeLookupByExtension.zip,
@@ -232,7 +245,10 @@ class Cloud extends core_1.Command {
         testFormData.set('file', blob, 'flowFile.zip');
         testFormData.set('appBinaryId', finalBinaryId);
         testFormData.set('testFileNames', JSON.stringify(testFileNames));
+        testFormData.set('sequentialFlows', JSON.stringify(sequentialFlows));
         testFormData.set('env', JSON.stringify(envObject));
+        testFormData.set('googlePlay', googlePlay ? 'true' : 'false');
+        testFormData.set('config', JSON.stringify({ continueOnFailure, orientation }));
         for (const [key, value] of Object.entries(rest)) {
             if (value) {
                 testFormData.set(key, value);
@@ -250,37 +266,37 @@ class Cloud extends core_1.Command {
             .join(', ')}\n`);
         (0, cli_ux_1.info)('Run triggered, you can access the results at:');
         (0, cli_ux_1.info)(`https://console.devicecloud.dev/results/${results[0].test_upload_id}/${results[0].id}/\n`);
-        if (!async) {
-            (0, cli_ux_1.info)('completed');
+        if (async === 'false') {
+            (0, cli_ux_1.info)('Not waiting for results as async flag is set to false');
             (0, cli_ux_1.exit)(0);
         }
-        if (async) {
-            // poll for the run status every 5 seconds
-            core_1.ux.action.start('Waiting for results', 'Initializing', { stdout: true });
-            (0, cli_ux_1.info)(' ');
-            const intervalId = setInterval(async () => {
-                const { results: updatedResults } = await typeSafeGet(apiUrl, `/results/${results[0].test_upload_id}`, {
-                    headers: { 'x-app-api-key': apiKey },
-                });
-                if (!updatedResults) {
-                    clearInterval(intervalId);
-                    (0, errors_1.error)('No results found');
-                }
-                core_1.ux.action.status = `\nStatus     | Test        
-──────────  ─────────── `;
-                for (const { status, test_file_name: test } of updatedResults) {
-                    core_1.ux.action.status += `\n${status.padEnd(10, ' ')} | ${test}`;
-                }
-                if (updatedResults.every((result) => !['PENDING', 'RUNNING'].includes(result.status))) {
-                    (0, cli_ux_1.info)('\nRun completed\n');
-                    (0, cli_ux_1.table)(updatedResults, {
-                        status: { get: (row) => row.status },
-                        test: { get: (row) => row.test_file_name },
-                    }, { printLine: this.log.bind(this) });
-                    clearInterval(intervalId);
-                }
-            }, 5000);
-        }
+        // poll for the run status every 5 seconds
+        core_1.ux.action.start('Waiting for results', 'Initializing', { stdout: true });
+        (0, cli_ux_1.info)('You can safely close this terminal and the tests will continue\n');
+        const intervalId = setInterval(async () => {
+            const { results: updatedResults } = await typeSafeGet(apiUrl, `/results/${results[0].test_upload_id}`, {
+                headers: { 'x-app-api-key': apiKey },
+            });
+            if (!updatedResults) {
+                clearInterval(intervalId);
+                (0, errors_1.error)('No results found');
+            }
+            core_1.ux.action.status = `\nStatus     | Test
+    ──────────  ─────────── `;
+            for (const { status, test_file_name: test } of updatedResults) {
+                core_1.ux.action.status += `\n${status.padEnd(10, ' ')} | ${test}`;
+            }
+            if (updatedResults.every((result) => !['PENDING', 'RUNNING'].includes(result.status))) {
+                core_1.ux.action.stop('completed');
+                (0, cli_ux_1.info)('\n');
+                (0, cli_ux_1.table)(updatedResults, {
+                    status: { get: (row) => row.status },
+                    test: { get: (row) => row.test_file_name },
+                }, { printLine: this.log.bind(this) });
+                (0, cli_ux_1.info)('\n');
+                clearInterval(intervalId);
+            }
+        }, 5000);
     }
 }
 exports.default = Cloud;

package/oclif.manifest.json

@@ -19,12 +19,12 @@
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
-        "androidApiLevel": {
+        "android-api-level": {
           "aliases": [
             "android-api-level"
           ],
-          "description": "Android API level to run your flow against",
-          "name": "androidApiLevel",
+          "description": "[Android only] Android API level to run your flow against",
+          "name": "android-api-level",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
@@ -34,53 +34,65 @@
           ],
           "type": "option"
         },
-        "apiKey": {
+        "api-key": {
           "aliases": [
             "api-key"
           ],
           "description": "API key",
-          "name": "apiKey",
+          "name": "api-key",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "apiUrl": {
+        "api-url": {
           "aliases": [
             "api-url"
           ],
           "description": "API base URL",
           "hidden": true,
-          "name": "apiUrl",
+          "name": "api-url",
           "default": "https://api.devicecloud.dev",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "appBinaryId": {
+        "app-binary-id": {
           "aliases": [
             "app-binary-id"
           ],
           "description": "The ID of the app binary previously uploaded to Maestro Cloud",
-          "name": "appBinaryId",
+          "name": "app-binary-id",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "appFile": {
+        "app-file": {
           "aliases": [
             "app-file"
           ],
           "description": "App binary to run your flows against",
-          "name": "appFile",
+          "name": "app-file",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
+        "arm64": {
+          "description": "[Android only] Run your flow against arm64 devices",
+          "name": "arm64",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "async": {
           "description": "Wait for the results of the run",
           "name": "async",
-          "allowNo": false,
-          "type": "boolean"
+          "default": "true",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "type": "option"
         },
         "env": {
           "char": "e",
@@ -90,12 +102,12 @@
           "multiple": true,
           "type": "option"
         },
-        "excludeTags": {
+        "exclude-tags": {
           "aliases": [
             "exclude-tags"
           ],
           "description": "Flows which have these tags will be excluded from the run",
-          "name": "excludeTags",
+          "name": "exclude-tags",
           "default": [],
           "hasDynamicHelp": false,
           "multiple": true,
@@ -108,12 +120,32 @@
           "multiple": false,
           "type": "option"
         },
-        "iOSVersion": {
+        "google-play": {
+          "aliases": [
+            "google-play"
+          ],
+          "description": "[Android only] Run your flow against Google Play devices",
+          "name": "google-play",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "include-tags": {
+          "aliases": [
+            "include-tags"
+          ],
+          "description": "Only flows which have these tags will be included in the run",
+          "name": "include-tags",
+          "default": [],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "ios-version": {
           "aliases": [
             "ios-version"
           ],
-          "description": "iOS version to run your flow against",
-          "name": "iOSVersion",
+          "description": "[iOS only] iOS version to run your flow against",
+          "name": "ios-version",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
@@ -122,15 +154,17 @@
           ],
           "type": "option"
         },
-        "includeTags": {
-          "aliases": [
-            "include-tags"
-          ],
-          "description": "Only flows which have these tags will be included in the run",
-          "name": "includeTags",
-          "default": [],
+        "orientation": {
+          "description": "[Android only] The orientation of the device to run your flow against in degrees",
+          "name": "orientation",
           "hasDynamicHelp": false,
-          "multiple": true,
+          "multiple": false,
+          "options": [
+            "0",
+            "90",
+            "180",
+            "270"
+          ],
           "type": "option"
         }
       },
@@ -150,5 +184,5 @@
       ]
     }
   },
-  "version": "0.0.1-alpha.6"
+  "version": "0.0.1-alpha.8"
 }

package/package.json

@@ -65,6 +65,7 @@
     "url": "@devicecloud.dev/dcd"
   },
   "scripts": {
+    "dcd": "./bin/dev.js",
     "build": "shx rm -rf dist && tsc -b",
     "lint": "eslint . --ext .ts",
     "postpack": "shx rm -f oclif.manifest.json",
@@ -74,7 +75,7 @@
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },
-  "version": "0.0.1-alpha.6",
+  "version": "0.0.1-alpha.8",
   "bugs": {
     "url": "https://discord.gg/GzZBHcUJ"
   },