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

package/dist/commands/cloud.d.ts

@@ -12,9 +12,12 @@ 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>;
+        async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         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>;
         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>;
     };
     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());
@@ -105,28 +114,43 @@ 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',
+        }),
+        async: core_1.Flags.boolean({
+            default: true,
+            description: 'Wait for the results of the run',
         }),
         env: core_1.Flags.file({
-            aliases: ['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',
+            multiple: true,
+        }),
+        excludeTags: core_1.Flags.string({
+            aliases: ['exclude-tags'],
+            default: [],
+            description: 'Flows which have these tags will be excluded from the run',
             multiple: true,
+            parse: (input) => input.split(','),
         }),
         flows: core_1.Flags.string({
-            aliases: ['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',
         }),
         iOSVersion: core_1.Flags.string({
             aliases: ['ios-version'],
             description: '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',
+            multiple: true,
+            parse: (input) => input.split(','),
+        }),
     };
     async run() {
         const { args, flags } = await this.parse(Cloud);
-        const { apiKey, apiUrl, appBinaryId, appFile, env, flows, ...rest } = flags;
-        console.log({ args });
+        const { apiKey, apiUrl, appBinaryId, appFile, async, env, excludeTags, flows, includeTags, ...rest } = flags;
         const { firstFile, secondFile } = args;
         let finalBinaryId = appBinaryId;
         const finalAppFile = appFile ?? firstFile;
@@ -136,7 +160,11 @@ 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)}`);
+            // 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 && finalAppFile)) {
@@ -155,14 +183,12 @@ class Cloud extends core_1.Command {
             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);
+            const { binaryId, message } = await typeSafePost(apiUrl, '/uploads/binary', options);
             if (!binaryId)
                 throw new Error(message);
             this.log(message);
@@ -172,7 +198,7 @@ class Cloud extends core_1.Command {
         let flowFileDirectory = flowFile;
         if (!flowFile?.endsWith('.yaml') && !flowFile?.endsWith('.yml')) {
             try {
-                const executionPlan = await (0, plan_1.plan)(flowFile, [], []);
+                const executionPlan = await (0, plan_1.plan)(flowFile, includeTags.flat(), excludeTags.flat());
                 for (const file of executionPlan.flowsToRun) {
                     testFileNames.push(file);
                 }
@@ -180,7 +206,6 @@ class Cloud extends core_1.Command {
                     // todo: handle continueOnFailure and other sequence properties
                     testFileNames.push(file);
                 }
-                console.log(executionPlan);
             }
             catch (error) {
                 console.error(error);
@@ -216,10 +241,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) {
+            (0, cli_ux_1.info)('completed');
+            (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);
+        }
     }
 }
 exports.default = Cloud;

package/dist/plan.js

@@ -39,7 +39,7 @@ const readConfigFromYamlFileAsJson = (filePath) => {
     if (yamlText.includes('\n---\n')) {
         const yamlTexts = yamlText.split('\n---\n');
         const config = yaml.load(yamlTexts[0]);
-        if (Object.keys(config).filter((key) => key === 'appId').length > 1) {
+        if (Object.keys(config).length > 0) {
             return config;
         }
     }

package/oclif.manifest.json

@@ -70,28 +70,39 @@
           "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"
         },
+        "async": {
+          "description": "Wait for the results of the run",
+          "name": "async",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "env": {
-          "aliases": [
-            "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,
           "type": "option"
         },
-        "flows": {
+        "excludeTags": {
           "aliases": [
-            "flows"
+            "exclude-tags"
           ],
-          "description": "The path to the flow file or folder containing your Flows",
+          "description": "Flows which have these tags will be excluded from the run",
+          "name": "excludeTags",
+          "default": [],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "flows": {
+          "description": "The path to the flow file or folder containing your flows",
           "name": "flows",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -110,6 +121,17 @@
             "17.2"
           ],
           "type": "option"
+        },
+        "includeTags": {
+          "aliases": [
+            "include-tags"
+          ],
+          "description": "Only flows which have these tags will be included in the run",
+          "name": "includeTags",
+          "default": [],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -128,5 +150,5 @@
       ]
     }
   },
-  "version": "0.0.1-alpha.4"
+  "version": "0.0.1-alpha.6"
 }

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.4",
+  "version": "0.0.1-alpha.6",
   "bugs": {
     "url": "https://discord.gg/GzZBHcUJ"
   },