@devicecloud.dev/dcd 4.0.0 → 4.0.2

package/dist/commands/cloud.d.ts

@@ -18,6 +18,7 @@ export default class Cloud extends Command {
         'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'junit-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
@@ -53,11 +54,4 @@ export default class Cloud extends Command {
     };
     private versionCheck;
     run(): Promise<any>;
-    /**
-     * Generate the JSON output file path based on upload ID or custom filename
-     * @param uploadId - Upload ID to use if custom filename is not provided
-     * @param jsonFileName - Optional custom filename (can include relative path)
-     * @returns Path to the JSON output file
-     */
-    private getJsonOutputPath;
 }

package/dist/commands/cloud.js

@@ -64,7 +64,7 @@ class Cloud extends core_1.Command {
         let jsonFile = false;
         try {
             const { args, flags, raw } = await this.parse(Cloud);
-            let { 'additional-app-binary-ids': nonFlatAdditionalAppBinaryIds, 'additional-app-files': nonFlatAdditionalAppFiles, 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey: apiKeyFlag, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, 'artifacts-path': artifactsPath, async, config: configFile, debug, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, 'dry-run': dryRun, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'ignore-sha-check': ignoreShaCheck, 'include-tags': includeTags, 'ios-device': iOSDevice, 'ios-version': iOSVersion, json, 'json-file-name': jsonFileName, 'maestro-version': maestroVersion, metadata, mitmHost, mitmPath, 'moropo-v1-api-key': moropoApiKey, name, orientation, quiet, report, retry, 'runner-type': runnerType, 'x86-arch': x86Arch, ...rest } = flags;
+            let { 'additional-app-binary-ids': nonFlatAdditionalAppBinaryIds, 'additional-app-files': nonFlatAdditionalAppFiles, 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey: apiKeyFlag, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, 'artifacts-path': artifactsPath, 'junit-path': junitPath, async, config: configFile, debug, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, 'dry-run': dryRun, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'ignore-sha-check': ignoreShaCheck, 'include-tags': includeTags, 'ios-device': iOSDevice, 'ios-version': iOSVersion, json, 'json-file-name': jsonFileName, 'maestro-version': maestroVersion, metadata, mitmHost, mitmPath, 'moropo-v1-api-key': moropoApiKey, name, orientation, quiet, report, retry, 'runner-type': runnerType, 'x86-arch': x86Arch, ...rest } = flags;
             // Resolve "latest" maestro version to actual version
             const resolvedMaestroVersion = (0, constants_1.resolveMaestroVersion)(maestroVersion);
             // Store debug flag for use in catch block
@@ -228,6 +228,9 @@ class Cloud extends core_1.Command {
             if (runnerType === 'm1') {
                 this.log('Note: runnerType m1 is experimental and currently supports Android (Pixel 7, API Level 34) only.');
             }
+            if (runnerType === 'gpu1') {
+                this.log('Note: runnerType gpu1 is Android-only and requires contacting support to enable. Without support enablement, your runner type will revert to default.');
+            }
             const additionalAppBinaryIds = nonFlatAdditionalAppBinaryIds?.flat();
             const additionalAppFiles = nonFlatAdditionalAppFiles?.flat();
             const { firstFile, secondFile } = args;
@@ -320,7 +323,7 @@ class Cloud extends core_1.Command {
                 }
                 throw error;
             }
-            const { allExcludeTags, allIncludeTags, flowMetadata, flowsToRun: testFileNames, referencedFiles, sequence, workspaceConfig, } = executionPlan;
+            const { allExcludeTags, allIncludeTags, flowMetadata, flowOverrides, flowsToRun: testFileNames, referencedFiles, sequence, workspaceConfig, } = executionPlan;
             if (debug) {
                 this.log(`DEBUG: All include tags: ${allIncludeTags?.join(', ') || 'none'}`);
                 this.log(`DEBUG: All exclude tags: ${allExcludeTags?.join(', ') || 'none'}`);
@@ -370,6 +373,23 @@ class Cloud extends core_1.Command {
                     flagLogs.push(`${k}: ${v}`);
                 }
             }
+            // Format overrides information
+            const overridesEntries = Object.entries(flowOverrides);
+            const hasOverrides = overridesEntries.some(([, overrides]) => Object.keys(overrides).length > 0);
+            let overridesLog = '';
+            if (hasOverrides) {
+                overridesLog = '\n        With overrides';
+                for (const [flowPath, overrides] of overridesEntries) {
+                    if (Object.keys(overrides).length > 0) {
+                        const relativePath = flowPath.replace(process.cwd(), '.');
+                        overridesLog += `\n      → ${relativePath}:`;
+                        for (const [key, value] of Object.entries(overrides)) {
+                            overridesLog += `\n        ${key}: ${value}`;
+                        }
+                    }
+                }
+                overridesLog += '\n';
+            }
             this.log(`
 
         Submitting new job
@@ -381,7 +401,7 @@ class Cloud extends core_1.Command {
 
         With options
       → ${flagLogs.join(`
-      → `)}
+      → `)}${overridesLog}
 
       `);
             if (dryRun) {
@@ -478,6 +498,10 @@ class Cloud extends core_1.Command {
                 key.replaceAll(commonRoot, '.').split(path.sep).join('/'),
                 value,
             ]))));
+            testFormData.set('testFileOverrides', JSON.stringify(Object.fromEntries(Object.entries(flowOverrides).map(([key, value]) => [
+                key.replaceAll(commonRoot, '.').split(path.sep).join('/'),
+                value,
+            ]))));
             testFormData.set('sequentialFlows', JSON.stringify(sequentialFlows.map((t) => t.replaceAll(commonRoot, '.').split(path.sep).join('/'))));
             testFormData.set('env', JSON.stringify(envObject));
             testFormData.set('googlePlay', googlePlay ? 'true' : 'false');
@@ -568,7 +592,7 @@ class Cloud extends core_1.Command {
                     uploadId: results[0].test_upload_id,
                 };
                 if (flags['json-file']) {
-                    const jsonFilePath = this.getJsonOutputPath(results[0].test_upload_id, jsonFileName);
+                    const jsonFilePath = jsonFileName || `${results[0].test_upload_id}_dcd.json`;
                     (0, methods_1.writeJSONFile)(jsonFilePath, jsonOutput, this);
                 }
                 if (json) {
@@ -660,6 +684,34 @@ class Cloud extends core_1.Command {
                                     this.warn('Failed to download artifacts');
                                 }
                             }
+                            // Handle report download separately if --report junit is specified
+                            if (report === 'junit') {
+                                try {
+                                    if (debug) {
+                                        this.log('DEBUG: Downloading JUNIT report');
+                                    }
+                                    const reportPath = path.resolve(process.cwd(), junitPath || 'report.xml');
+                                    await api_gateway_1.ApiGateway.downloadReport(apiUrl, apiKey, results[0].test_upload_id, reportPath);
+                                    this.log('\n');
+                                    this.log(`JUNIT test report has been downloaded to ${reportPath}`);
+                                }
+                                catch (error) {
+                                    if (debug) {
+                                        this.log(`DEBUG: Error downloading JUNIT report: ${error}`);
+                                    }
+                                    const errorMessage = error instanceof Error ? error.message : String(error);
+                                    this.warn(`Failed to download JUNIT report: ${errorMessage}`);
+                                    if (errorMessage.includes('404')) {
+                                        this.warn('No JUNIT reports found for this upload. Make sure your tests were run with --report junit flag.');
+                                    }
+                                    else if (errorMessage.includes('EACCES') || errorMessage.includes('EPERM')) {
+                                        this.warn('Permission denied. Check write permissions for the current directory.');
+                                    }
+                                    else if (errorMessage.includes('ENOENT')) {
+                                        this.warn('Directory does not exist. Make sure you have write access to the current directory.');
+                                    }
+                                }
+                            }
                             const resultsWithoutEarlierTries = updatedResults.filter((result) => {
                                 const originalTryId = result.retry_of || result.id;
                                 const tries = updatedResults.filter((r) => r.retry_of === originalTryId || r.id === originalTryId);
@@ -683,7 +735,7 @@ class Cloud extends core_1.Command {
                                     uploadId: results[0].test_upload_id,
                                 };
                                 if (flags['json-file']) {
-                                    const jsonFilePath = this.getJsonOutputPath(results[0].test_upload_id, jsonFileName);
+                                    const jsonFilePath = jsonFileName || `${results[0].test_upload_id}_dcd.json`;
                                     (0, methods_1.writeJSONFile)(jsonFilePath, jsonOutput, this);
                                 }
                                 if (json) {
@@ -709,7 +761,7 @@ class Cloud extends core_1.Command {
                                     uploadId: results[0].test_upload_id,
                                 };
                                 if (flags['json-file']) {
-                                    const jsonFilePath = this.getJsonOutputPath(results[0].test_upload_id, jsonFileName);
+                                    const jsonFilePath = jsonFileName || `${results[0].test_upload_id}_dcd.json`;
                                     (0, methods_1.writeJSONFile)(jsonFilePath, jsonOutput, this);
                                 }
                                 if (json) {
@@ -759,17 +811,5 @@ class Cloud extends core_1.Command {
             }
         }
     }
-    /**
-     * Generate the JSON output file path based on upload ID or custom filename
-     * @param uploadId - Upload ID to use if custom filename is not provided
-     * @param jsonFileName - Optional custom filename (can include relative path)
-     * @returns Path to the JSON output file
-     */
-    getJsonOutputPath(uploadId, jsonFileName) {
-        if (jsonFileName) {
-            return jsonFileName;
-        }
-        return `${uploadId}_dcd.json`;
-    }
 }
 exports.default = Cloud;

package/dist/constants.d.ts

@@ -12,6 +12,7 @@ export declare const flags: {
     'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'junit-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;

package/dist/constants.js

@@ -73,6 +73,10 @@ exports.flags = {
         dependsOn: ['download-artifacts'],
         description: 'Custom file path for downloaded artifacts (default: ./artifacts.zip)',
     }),
+    'junit-path': core_1.Flags.string({
+        dependsOn: ['report'],
+        description: 'Custom file path for downloaded JUnit report (default: ./report.xml)',
+    }),
     async: core_1.Flags.boolean({
         description: 'Immediately return (exit code 0) from the command without waiting for the results of the run (useful for saving CI minutes)',
     }),
@@ -87,7 +91,7 @@ exports.flags = {
         description: 'Locale that will be set to a device, ISO-639-1 code and uppercase ISO-3166-1 code e.g. "de_DE" for Germany',
     }),
     'download-artifacts': core_1.Flags.string({
-        description: 'Download a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use --download-artifacts=FAILED for failures only or --download-artifacts=ALL for every result.',
+        description: 'Download a zip containing the logs, screenshots and videos for each result in this run. You will be debited a $0.01 egress fee for each result. Options: ALL (everything), FAILED (failures only).',
         options: ['ALL', 'FAILED'],
     }),
     'dry-run': core_1.Flags.boolean({
@@ -198,8 +202,8 @@ exports.flags = {
     }),
     'runner-type': core_1.Flags.string({
         default: 'default',
-        description: '[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers, see https://docs.devicecloud.dev/reference/runner-type for more information',
-        options: ['default', 'm4', 'm1'],
+        description: '[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers, see https://docs.devicecloud.dev/reference/runner-type for more information. gpu1 is Android-only and requires contacting support to enable, otherwise reverts to default.',
+        options: ['default', 'm4', 'm1', 'gpu1'],
     }),
     'show-crosshairs': core_1.Flags.boolean({
         default: false,

package/dist/gateways/api-gateway.d.ts

@@ -4,17 +4,18 @@ export declare const ApiGateway: {
         appBinaryId: string;
         exists: boolean;
     }>;
+    downloadReport(baseUrl: string, apiKey: string, uploadId: string, reportPath?: string): Promise<void>;
     downloadArtifactsZip(baseUrl: string, apiKey: string, uploadId: string, results: "ALL" | "FAILED", artifactsPath?: string): Promise<void>;
     finaliseUpload(baseUrl: string, apiKey: string, id: string, metadata: TAppMetadata, path: string, sha: string): Promise<Record<string, never>>;
     getBinaryUploadUrl(baseUrl: string, apiKey: string, platform: "android" | "ios"): Promise<{
-        id: string;
         message: string;
         path: string;
         token: string;
+        id: string;
     }>;
     getResultsForUpload(baseUrl: string, apiKey: string, uploadId: string): Promise<{
-        results?: import("../types/schema.types").components["schemas"]["TResultResponse"][];
         statusCode?: number;
+        results?: import("../types/schema.types").components["schemas"]["TResultResponse"][];
     }>;
     getUploadStatus(baseUrl: string, apiKey: string, options: {
         name?: string;

package/dist/gateways/api-gateway.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiGateway = void 0;
+const fs = require("node:fs/promises");
+const path = require("node:path");
 exports.ApiGateway = {
     async checkForExistingUpload(baseUrl, apiKey, sha) {
         const res = await fetch(`${baseUrl}/uploads/checkForExistingUpload`, {
@@ -13,6 +15,25 @@ exports.ApiGateway = {
         });
         return res.json();
     },
+    async downloadReport(baseUrl, apiKey, uploadId, reportPath) {
+        const finalReportPath = reportPath || path.resolve(process.cwd(), `report-${uploadId}.xml`);
+        const url = `${baseUrl}/results/${uploadId}/report`;
+        const res = await fetch(url, {
+            headers: {
+                'x-app-api-key': apiKey,
+            },
+            method: 'GET',
+        });
+        if (!res.ok) {
+            const errorText = await res.text();
+            if (res.status === 404) {
+                throw new Error(`Upload ID '${uploadId}' not found or no results available for this upload`);
+            }
+            throw new Error(`Failed to download report: ${res.status} ${errorText}`);
+        }
+        const buffer = await res.arrayBuffer();
+        await fs.writeFile(finalReportPath, Buffer.from(buffer));
+    },
     async downloadArtifactsZip(baseUrl, apiKey, uploadId, results, artifactsPath = './artifacts.zip') {
         const res = await fetch(`${baseUrl}/results/${uploadId}/download`, {
             body: JSON.stringify({ results }),

package/dist/methods.js

@@ -251,9 +251,18 @@ const writeJSONFile = (filePath, data, logger) => {
         logger.log(`JSON output written to: ${path.resolve(filePath)}`);
     }
     catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        const isPermissionError = errorMessage.includes('EACCES') || errorMessage.includes('EPERM');
+        const isNoSuchFileError = errorMessage.includes('ENOENT');
         logger.warn(`Failed to write JSON output to file: ${filePath}`);
-        // Use console.debug instead of logger.debug since debug is protected in Command
-        logger.warn(`Error details: ${error instanceof Error ? error.message : String(error)}`);
+        if (isPermissionError) {
+            logger.warn('Permission denied - check file/directory write permissions');
+            logger.warn('Try running with appropriate permissions or choose a different output location');
+        }
+        else if (isNoSuchFileError) {
+            logger.warn('Directory does not exist - create the directory first or choose an existing path');
+        }
+        logger.warn(`Error details: ${errorMessage}`);
     }
 };
 exports.writeJSONFile = writeJSONFile;

package/dist/plan.d.ts

@@ -16,6 +16,7 @@ interface IExecutionPlan {
     allExcludeTags?: null | string[];
     allIncludeTags?: null | string[];
     flowMetadata: Record<string, Record<string, unknown>>;
+    flowOverrides: Record<string, Record<string, unknown>>;
     flowsToRun: string[];
     referencedFiles: string[];
     sequence?: IFlowSequence | null;

package/dist/plan.js

@@ -42,16 +42,28 @@ function filterFlowFiles(unfilteredFlowFiles, excludeFlows) {
     return unfilteredFlowFiles;
 }
 function getWorkspaceConfig(input, unfilteredFlowFiles) {
-    const possibleConfigPaths = new Set([
-        path.join(input, 'config.yaml'),
-        path.join(input, 'config.yml'),
-    ].map((p) => path.normalize(p)));
+    const possibleConfigPaths = new Set([path.join(input, 'config.yaml'), path.join(input, 'config.yml')].map((p) => path.normalize(p)));
     const configFilePath = unfilteredFlowFiles.find((file) => possibleConfigPaths.has(path.normalize(file)));
     const config = configFilePath
         ? (0, planMethods_1.readYamlFileAsJson)(configFilePath)
         : {};
     return config;
 }
+function extractDeviceCloudOverrides(config) {
+    if (!config || !config.env || typeof config.env !== 'object') {
+        return {};
+    }
+    const overrides = {};
+    const envVars = config.env;
+    for (const [key, value] of Object.entries(envVars)) {
+        if (key.startsWith('DEVICECLOUD_OVERRIDE_')) {
+            // Remove the DEVICECLOUD_OVERRIDE_ prefix and use the rest as the override key
+            const overrideKey = key.replace('DEVICECLOUD_OVERRIDE_', '');
+            overrides[overrideKey] = value;
+        }
+    }
+    return overrides;
+}
 async function plan(input, includeTags, excludeTags, excludeFlows, configFile) {
     const normalizedInput = path.normalize(input);
     const flowMetadata = {};
@@ -64,12 +76,15 @@ async function plan(input, includeTags, excludeTags, excludeFlows, configFile) {
             throw new Error('If using config.yaml, pass the workspace folder path, not the config file or a custom path via --config');
         }
         const { config } = (0, planMethods_1.readTestYamlFileAsJson)(normalizedInput);
+        const flowOverrides = {};
         if (config) {
             flowMetadata[normalizedInput] = config;
+            flowOverrides[normalizedInput] = extractDeviceCloudOverrides(config);
         }
         const checkedDependancies = await checkDependencies(normalizedInput);
         return {
             flowMetadata,
+            flowOverrides,
             flowsToRun: [normalizedInput],
             referencedFiles: [...new Set(checkedDependancies)],
             totalFlowFiles: 1,
@@ -151,11 +166,13 @@ async function plan(input, includeTags, excludeTags, excludeFlows, configFile) {
         ...excludeTags,
         ...(workspaceConfig.excludeTags || []),
     ];
+    const flowOverrides = {};
     const allFlows = unfilteredFlowFiles.filter((filePath) => {
         const config = configPerFlowFile[filePath];
         const tags = config?.tags || [];
         if (config) {
             flowMetadata[filePath] = config;
+            flowOverrides[filePath] = extractDeviceCloudOverrides(config);
         }
         return ((allIncludeTags.length === 0 ||
             tags.some((tag) => allIncludeTags.includes(tag))) &&
@@ -185,6 +202,7 @@ async function plan(input, includeTags, excludeTags, excludeFlows, configFile) {
         allExcludeTags,
         allIncludeTags,
         flowMetadata,
+        flowOverrides,
         flowsToRun: normalFlows,
         referencedFiles: [...new Set(allFiles)],
         sequence: {