@devicecloud.dev/dcd 0.0.1-alpha.0

package/README.md

@@ -0,0 +1,18 @@
+devicecloud.dev CLI
+=================
+
+One line swap out for Maestro Cloud
+
+Install:
+```sh-session
+$ npm install -g @devicecloud/dcd
+```
+
+Use:
+```sh
+# maestro cloud --apiKey <apiKey> <appFile> .myFlows/
+
+dcd cloud --apiKey <apiKey> <appFile> .myFlows/
+```
+
+See full documentation: [Docs](https://docs.devicecloud.dev)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node_modules/.bin/ts-node
+// eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
+;(async () => {
+  const oclif = await import('@oclif/core')
+  await oclif.execute({development: true, dir: __dirname})
+})()

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+// eslint-disable-next-line unicorn/prefer-top-level-await
+(async () => {
+  const oclif = await import('@oclif/core');
+  await oclif.execute({ development: false, dir: __dirname });
+})();

package/dist/commands/cloud.d.ts

@@ -0,0 +1,19 @@
+import { Command } from '@oclif/core';
+export default class Cloud extends Command {
+    static args: {
+        firstFile: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+        secondFile: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    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>;
+        env: 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>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/cloud.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const promises_1 = require("node:fs/promises");
+const mimeTypeLookupByExtension = {
+    apk: 'application/vnd.android.package-archive',
+    yaml: 'application/x-yaml',
+    zip: 'application/zip',
+};
+const typeSafeFetch = async (baseUrl, path, init) => {
+    const res = await fetch(baseUrl + path, init);
+    if (!res.ok) {
+        throw new Error(await res.text());
+    }
+    return res.json();
+};
+class Cloud extends core_1.Command {
+    static args = {
+        firstFile: core_1.Args.string({
+            description: 'The binary file of the app to run your flow against, e.g. app.apk for android or app.zip for ios',
+            hidden: true,
+            name: 'App file',
+            required: true,
+        }),
+        secondFile: core_1.Args.string({
+            description: 'The flow file to run against the app, e.g. test.yaml',
+            hidden: true,
+            name: 'Flow file',
+        }),
+    };
+    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({
+            aliases: ['android-api-level'],
+            description: 'Android API level to run your flow against',
+        }),
+        apiKey: core_1.Flags.string({ aliases: ['api-key'], description: 'API key' }),
+        apiUrl: core_1.Flags.string({
+            aliases: ['api-url'],
+            default: 'https://api.devicecloud.dev',
+            description: 'API base URL',
+        }),
+        appBinaryId: 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({
+            aliases: ['app-file'],
+            description: 'App binary to run your Flows against',
+        }),
+        env: core_1.Flags.file({
+            aliases: ['env'],
+            char: 'e',
+            description: 'One or more environment variables to inject into your Flows',
+            multiple: true,
+        }),
+        iOSVersion: core_1.Flags.string({
+            aliases: ['ios-version'],
+            description: 'iOS version to run your flow against',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Cloud);
+        const { apiKey, apiUrl, appBinaryId, ...rest } = flags;
+        console.log({ args });
+        const { firstFile, secondFile } = args;
+        let finalBinaryId = appBinaryId;
+        const appFile = firstFile;
+        let flowFile = secondFile;
+        if (appBinaryId) {
+            if (secondFile) {
+                throw new Error('You cannot provide both an appBinaryId and a binary file');
+            }
+            flowFile = firstFile;
+            this.log(`you want to run the flow ${flowFile} against the binary with id ${appBinaryId} with the following flags: ${JSON.stringify(flags)}`);
+        }
+        else {
+            if (!appFile.endsWith('.apk') && !appFile.endsWith('.zip')) {
+                throw new Error('App file must be a .apk or .zip file');
+            }
+            if (!(flowFile && appFile)) {
+                throw new Error('You must provide a flow file and an app binary id');
+            }
+            this.log(`you want to run the flow ${flowFile} against the app ${appFile} with the following flags: ${JSON.stringify(flags)}`);
+        }
+        if (!finalBinaryId) {
+            const binaryFormData = new FormData();
+            const binaryBlob = new Blob([await (0, promises_1.readFile)(appFile)], {
+                type: mimeTypeLookupByExtension[appFile.split('.').pop()],
+            });
+            console.log(mimeTypeLookupByExtension[appFile.split('.').pop()]);
+            binaryFormData.set('file', binaryBlob, appFile);
+            const options = {
+                body: binaryFormData,
+                headers: { 'x-app-api-key': apiKey },
+                method: 'POST',
+            };
+            const { binaryId, message } = await typeSafeFetch(apiUrl, '/uploads/binary', options);
+            if (!binaryId)
+                throw new Error(message);
+            this.log(message);
+            finalBinaryId = binaryId;
+        }
+        const testFormData = new FormData();
+        const blob = new Blob([await (0, promises_1.readFile)(flowFile)], {
+            type: mimeTypeLookupByExtension[flowFile.split('.').pop()],
+        });
+        testFormData.set('file', blob, flowFile);
+        testFormData.set('appBinaryId', finalBinaryId);
+        testFormData.set('testFileName', flowFile);
+        for (const [key, value] of Object.entries(rest)) {
+            if (value) {
+                testFormData.set(key, value);
+            }
+        }
+        const options = {
+            body: testFormData,
+            headers: { 'x-app-api-key': apiKey },
+            method: 'POST',
+        };
+        const { message } = await typeSafeFetch(apiUrl, '/uploads/flow', options);
+        console.log(message);
+    }
+}
+exports.default = Cloud;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/oclif.manifest.json

@@ -0,0 +1,113 @@
+{
+  "commands": {
+    "cloud": {
+      "aliases": [],
+      "args": {
+        "firstFile": {
+          "description": "The binary file of the app to run your flow against, e.g. app.apk for android or app.zip for ios",
+          "hidden": true,
+          "name": "firstFile",
+          "required": true
+        },
+        "secondFile": {
+          "description": "The flow file to run against the app, e.g. test.yaml",
+          "hidden": true,
+          "name": "secondFile"
+        }
+      },
+      "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",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "androidApiLevel": {
+          "aliases": [
+            "android-api-level"
+          ],
+          "description": "Android API level to run your flow against",
+          "name": "androidApiLevel",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "apiKey": {
+          "aliases": [
+            "api-key"
+          ],
+          "description": "API key",
+          "name": "apiKey",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "apiUrl": {
+          "aliases": [
+            "api-url"
+          ],
+          "description": "API base URL",
+          "name": "apiUrl",
+          "default": "https://api.devicecloud.dev",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "appBinaryId": {
+          "aliases": [
+            "app-binary-id"
+          ],
+          "description": "The ID of the app binary previously uploaded to Maestro Cloud",
+          "name": "appBinaryId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "appFile": {
+          "aliases": [
+            "app-file"
+          ],
+          "description": "App binary to run your Flows against",
+          "name": "appFile",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "env": {
+          "aliases": [
+            "env"
+          ],
+          "char": "e",
+          "description": "One or more environment variables to inject into your Flows",
+          "name": "env",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "iOSVersion": {
+          "aliases": [
+            "ios-version"
+          ],
+          "description": "iOS version to run your flow against",
+          "name": "iOSVersion",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cloud",
+      "pluginAlias": "@devicecloud.dev/dcd",
+      "pluginName": "@devicecloud.dev/dcd",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "cloud.js"
+      ]
+    }
+  },
+  "version": "0.0.1-alpha.0"
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "author": "devicecloud.dev",
+  "bin": {
+    "dcd": "bin/run.js"
+  },
+  "dependencies": {
+    "@oclif/core": "^3",
+    "@oclif/plugin-autocomplete": "^3.0.8",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-not-found": "^3.0.10",
+    "@oclif/plugin-plugins": "^4",
+    "@oclif/plugin-update": "^4.1.11",
+    "@oclif/plugin-warn-if-update-available": "^3.0.10"
+  },
+  "description": "Better cloud maestro testing",
+  "devDependencies": {
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3",
+    "@types/chai": "^4",
+    "@types/mocha": "^9.0.0",
+    "chai": "^4",
+    "eslint": "^8.56.0",
+    "eslint-config-oclif": "^5",
+    "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.1.0",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=21.0.0"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://devicecloud.dev",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "name": "@devicecloud.dev/dcd",
+  "oclif": {
+    "bin": "dcd",
+    "dirname": "dcd",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-not-found",
+      "@oclif/plugin-update",
+      "@oclif/plugin-warn-if-update-available",
+      "@oclif/plugin-autocomplete"
+    ]
+  },
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "@devicecloud.dev/dcd"
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest",
+    "prepare": "yarn build",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "version": "0.0.1-alpha.0",
+  "bugs": {
+    "url": "https://discord.gg/GzZBHcUJ"
+  },
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts",
+  "directories": {
+    "test": "test"
+  }
+}