@devicecloud.dev/dcd 0.0.1-alpha.5 → 0.0.1-alpha.7

package/dist/commands/cloud.d.ts

@@ -12,11 +12,15 @@ export default class Cloud extends Command {
         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>;
+        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>;
         flows: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        googlePlay: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         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>;
+        orientation: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/commands/cloud.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable complexity */
 const core_1 = require("@oclif/core");
+const cli_ux_1 = require("@oclif/core/lib/cli-ux");
+const errors_1 = require("@oclif/core/lib/errors");
 const archiver = require("archiver");
 const promises_1 = require("node:fs/promises");
 const node_stream_1 = require("node:stream");
@@ -21,7 +23,14 @@ const PERMITTED_EXTENSIONS = new Set([
     'mp4',
     'js',
 ]);
-const typeSafeFetch = async (baseUrl, path, init) => {
+const typeSafePost = async (baseUrl, path, init) => {
+    const res = await fetch(baseUrl + path, { ...init, method: 'POST' });
+    if (!res.ok) {
+        throw new Error(await res.text());
+    }
+    return res.json();
+};
+const typeSafeGet = async (baseUrl, path, init) => {
     const res = await fetch(baseUrl + path, init);
     if (!res.ok) {
         throw new Error(await res.text());
@@ -89,7 +98,7 @@ class Cloud extends core_1.Command {
     static flags = {
         androidApiLevel: 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' }),
@@ -105,11 +114,20 @@ class Cloud extends core_1.Command {
         }),
         appFile: core_1.Flags.file({
             aliases: ['app-file'],
-            description: 'App binary to run your Flows against',
+            description: 'App binary to run your flows against',
+        }),
+        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',
+            description: 'One or more environment variables to inject into your flows',
             multiple: true,
         }),
         excludeTags: core_1.Flags.string({
@@ -120,25 +138,37 @@ class Cloud extends core_1.Command {
             parse: (input) => input.split(','),
         }),
         flows: core_1.Flags.string({
-            description: 'The path to the flow file or folder containing your Flows',
+            description: 'The path to the flow file or folder containing your flows',
+        }),
+        googlePlay: core_1.Flags.boolean({
+            aliases: ['google-play'],
+            default: false,
+            description: '[Android only] Run your flow against Google Play devices',
         }),
         iOSVersion: core_1.Flags.string({
             aliases: ['ios-version'],
-            description: 'iOS version to run your flow against',
+            description: '[iOS only] iOS version to run your flow against',
             options: ['16.4', '17.2'],
         }),
         includeTags: core_1.Flags.string({
             aliases: ['include-tags'],
             default: [],
-            description: 'Only Flows which have these tags will be included in the run',
+            description: 'Only flows which have these tags will be included in the run',
             multiple: true,
             parse: (input) => input.split(','),
         }),
+        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, env, excludeTags, flows, includeTags, ...rest } = flags;
-        console.log({ args });
+        const { apiKey, apiUrl, appBinaryId, appFile, arm64, async, env, excludeTags, flows, googlePlay, includeTags, ...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;
@@ -148,61 +178,56 @@ 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');
+        }
+        const testFileNames = [];
+        if (!flowFile?.endsWith('.yaml') &&
+            !flowFile?.endsWith('.yml') &&
+            !flowFile?.endsWith('/')) {
+            flowFile += '/';
+        }
+        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);
+        }
+        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()],
             });
-            console.log(mimeTypeLookupByExtension[finalAppFile.split('.').pop()]);
             binaryFormData.set('file', binaryBlob, finalAppFile);
             const options = {
                 body: binaryFormData,
                 headers: { 'x-app-api-key': apiKey },
-                method: 'POST',
             };
-            const { binaryId, message } = await typeSafeFetch(apiUrl, '/uploads/binary', options);
+            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);
-                }
-                console.log(executionPlan);
-            }
-            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) => {
@@ -210,8 +235,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,
@@ -220,6 +245,7 @@ class Cloud extends core_1.Command {
         testFormData.set('appBinaryId', finalBinaryId);
         testFormData.set('testFileNames', JSON.stringify(testFileNames));
         testFormData.set('env', JSON.stringify(envObject));
+        testFormData.set('googlePlay', googlePlay ? 'true' : 'false');
         for (const [key, value] of Object.entries(rest)) {
             if (value) {
                 testFormData.set(key, value);
@@ -228,10 +254,46 @@ class Cloud extends core_1.Command {
         const options = {
             body: testFormData,
             headers: { 'x-app-api-key': apiKey },
-            method: 'POST',
         };
-        const { message } = await typeSafeFetch(apiUrl, '/uploads/flow', options);
-        console.log(message);
+        const { message, results } = await typeSafePost(apiUrl, '/uploads/flow', options);
+        if (!results?.length)
+            (0, errors_1.error)('No tests created: ' + message);
+        (0, cli_ux_1.info)(`\nCreated ${results.length} tests: ${results
+            .map((r) => r.test_file_name)
+            .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 === 'false') {
+            (0, cli_ux_1.info)('Not waiting for results as async flag is set to false');
+            (0, cli_ux_1.exit)(0);
+        }
+        // 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

@@ -23,7 +23,7 @@
           "aliases": [
             "android-api-level"
           ],
-          "description": "Android API level to run your flow against",
+          "description": "[Android only] Android API level to run your flow against",
           "name": "androidApiLevel",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -70,15 +70,33 @@
           "aliases": [
             "app-file"
           ],
-          "description": "App binary to run your Flows against",
+          "description": "App binary to run your flows against",
           "name": "appFile",
           "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",
+          "default": "true",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "type": "option"
+        },
         "env": {
           "char": "e",
-          "description": "One or more environment variables to inject into your Flows",
+          "description": "One or more environment variables to inject into your flows",
           "name": "env",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -96,17 +114,26 @@
           "type": "option"
         },
         "flows": {
-          "description": "The path to the flow file or folder containing your Flows",
+          "description": "The path to the flow file or folder containing your flows",
           "name": "flows",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
+        "googlePlay": {
+          "aliases": [
+            "google-play"
+          ],
+          "description": "[Android only] Run your flow against Google Play devices",
+          "name": "googlePlay",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "iOSVersion": {
           "aliases": [
             "ios-version"
           ],
-          "description": "iOS version to run your flow against",
+          "description": "[iOS only] iOS version to run your flow against",
           "name": "iOSVersion",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -120,12 +147,25 @@
           "aliases": [
             "include-tags"
           ],
-          "description": "Only Flows which have these tags will be included in the run",
+          "description": "Only flows which have these tags will be included in the run",
           "name": "includeTags",
           "default": [],
           "hasDynamicHelp": false,
           "multiple": true,
           "type": "option"
+        },
+        "orientation": {
+          "description": "[Android only] The orientation of the device to run your flow against in degrees",
+          "name": "orientation",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "0",
+            "90",
+            "180",
+            "270"
+          ],
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -144,5 +184,5 @@
       ]
     }
   },
-  "version": "0.0.1-alpha.5"
+  "version": "0.0.1-alpha.7"
 }

package/package.json

@@ -74,7 +74,7 @@
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },
-  "version": "0.0.1-alpha.5",
+  "version": "0.0.1-alpha.7",
   "bugs": {
     "url": "https://discord.gg/GzZBHcUJ"
   },