Merge pull request #4 from devicecloud-dev/add-additional-flags

support all CLI params

Author: riglar

README.md

@@ -172,3 +172,70 @@ You can use an already uploaded App binary in devicecloud.dev using the `app-bin
     api-key: ${{ secrets.DCD_API_KEY }}
     app-binary-id: <your-app-binary-id>
 ```
+
+# Specifying device orientation
+
+You can specify the orientation of Android devices in degrees using the `orientation` parameter:
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    orientation: 90 # Options: 0|90|180|270
+```
+
+# Setting device locale
+
+You can set the device locale using ISO codes:
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    device-locale: de_DE # Format: ISO-639-1_ISO-3166-1
+```
+
+# Additional app binaries
+
+You can include additional app binaries either by file or by previously uploaded binary ID:
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    additional-app-files: |
+      second-app.apk
+      third-app.apk
+    additional-app-binary-ids: |
+      binary-id-1
+      binary-id-2
+```
+
+# Downloading artifacts
+
+You can download logs, screenshots and videos for test results (BETA feature):
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    download-artifacts: FAILED # Options: ALL|FAILED
+```
+
+Note: There is a $0.01 egress fee per result when using this feature.
+
+# Specifying Maestro version
+
+You can specify which version of Maestro to use (ALPHA feature):
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    maestro-version: 1.39.0
+```

action.yml

@@ -2,55 +2,73 @@ name: 'Device Cloud Action'
 author: 'devicecloud.dev'
 description: 'Uses devicecloud.dev to execute Maestro mobile tests'
 inputs:
+  additional-app-binary-ids:
+    description: 'The ID of the additional app binary(s) previously uploaded to devicecloud.dev to install before execution'
+    required: false
+  additional-app-files:
+    description: 'Additional app binary(s) to install before execution'
+    required: false
+  android-api-level:
+    description: 'Android API level to run your flow against'
+    required: false
+  android-device:
+    description: 'Android device to run your flow against'
+    required: false
   api-key:
     description: 'devicecloud.dev API Key - find this in your app settings in the devicecloud.dev dashboard'
     required: true
-  app-file:
-    description: 'Path to the build artifact to upload to devicecloud.dev before running the test'
+  api-url:
+    description: 'The API URL to use for the devicecloud.dev service'
     required: false
   app-binary-id:
     description: 'The app binary already uploaded to devicecloud.dev'
     required: false
-  workspace:
-    description: 'Path to a folder that contains your test flows'
-    required: false
-    default: './.maestro/'
-  env:
-    description: 'Set of key=value entries to pass as an input to Maestro flows'
+  app-file:
+    description: 'Path to the build artifact to upload to devicecloud.dev before running the test'
     required: false
   async:
     description: 'Whether to run Upload in async fashion and not block until completed'
     required: false
-  android-api-level:
-    description: 'Android API level to run your flow against'
+  device-locale:
+    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'
     required: false
-  ios-version:
-    description: 'iOS version to run your flow against'
+  download-artifacts:
+    description: 'BETA (API may change) - download a zip containing the logs, screenshots and videos for each result in this run. Options: ALL|FAILED'
     required: false
-  include-tags:
-    description: 'List of tags that will remove flows that does not have the provided tags'
+  env:
+    description: 'Set of key=value entries to pass as an input to Maestro flows'
+    required: false
+  exclude-flows:
+    description: 'Subdirectories to ignore when building the flow file list'
     required: false
   exclude-tags:
     description: 'List of tags that will remove flows containing the provided tags'
     required: false
-  name:
-    description: 'A custom name for your upload (useful for tagging commits etc)'
-    required: false
-  api-url:
-    description: 'The API URL to use for the devicecloud.dev service'
+  google-play:
+    description: 'Run your flow against Google Play devices'
     required: false
-  android-device:
-    description: 'Android device to run your flow against'
+  include-tags:
+    description: 'List of tags that will remove flows that does not have the provided tags'
     required: false
   ios-device:
     description: 'iOS device to run your flow against'
     required: false
-  exclude-flows:
-    description: 'Subdirectories to ignore when building the flow file list'
+  ios-version:
+    description: 'iOS version to run your flow against'
     required: false
-  google-play:
-    description: 'Run your flow against Google Play devices'
+  maestro-version:
+    description: 'ALPHA pre-release - Maestro version to run your flow against'
+    required: false
+  name:
+    description: 'A custom name for your upload (useful for tagging commits etc)'
     required: false
+  orientation:
+    description: 'Android only - The orientation of the device to run your flow against in degrees (0|90|180|270)'
+    required: false
+  workspace:
+    description: 'Path to a folder that contains your test flows'
+    required: false
+    default: './.maestro/'
 
 runs:
   using: 'node20'

dist/index.js

@@ -32535,24 +32535,30 @@ const params_1 = __nccwpck_require__(5966);
 const child_process_1 = __nccwpck_require__(2081);
 const run = () => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const { apiKey, apiUrl, appFilePath, workspaceFolder, env, async, androidApiLevel, iOSVersion, includeTags, excludeTags, appBinaryId, androidDevice, iosDevice, excludeFlows, googlePlay, name, } = yield (0, params_1.getParameters)();
+        const { additionalAppBinaryIds, additionalAppFiles, androidApiLevel, androidDevice, apiKey, apiUrl, appBinaryId, appFilePath, async, deviceLocale, downloadArtifacts, env, excludeFlows, excludeTags, googlePlay, includeTags, iOSVersion, iosDevice, maestroVersion, name, orientation, workspaceFolder, } = yield (0, params_1.getParameters)();
         const params = {
-            'app-file': appFilePath,
-            flows: workspaceFolder,
+            'additional-app-binary-ids': additionalAppBinaryIds,
+            'additional-app-files': additionalAppFiles,
+            'android-api-level': androidApiLevel,
+            'android-device': androidDevice,
             'api-key': apiKey,
-            'app-binary-id': appBinaryId,
-            'include-tags': includeTags,
-            'exclude-tags': excludeTags,
-            env,
             'api-url': apiUrl,
+            'app-binary-id': appBinaryId,
+            'app-file': appFilePath,
             async,
-            'android-api-level': androidApiLevel,
-            'ios-version': iOSVersion,
-            'android-device': androidDevice,
-            'ios-device': iosDevice,
+            'device-locale': deviceLocale,
+            'download-artifacts': downloadArtifacts,
+            env,
             'exclude-flows': excludeFlows,
+            'exclude-tags': excludeTags,
+            flows: workspaceFolder,
             'google-play': googlePlay,
+            'include-tags': includeTags,
+            'ios-device': iosDevice,
+            'ios-version': iOSVersion,
+            'maestro-version': maestroVersion,
             name,
+            orientation,
         };
         const paramsString = Object.keys(params).reduce((acc, key) => {
             return params[key] ? `${acc} --${key} "${params[key]}"` : acc;
@@ -32693,6 +32699,23 @@ function getInferredName() {
     }
     return github.context.sha;
 }
+function parseOrientation(orientation) {
+    if (!orientation)
+        return undefined;
+    const value = parseInt(orientation);
+    if ([0, 90, 180, 270].includes(value)) {
+        return value;
+    }
+    throw new Error(`Invalid orientation: ${orientation}. Must be 0, 90, 180, or 270`);
+}
+function parseDownloadArtifacts(value) {
+    if (!value)
+        return undefined;
+    if (value !== 'ALL' && value !== 'FAILED') {
+        throw new Error(`Invalid download-artifacts value: ${value}. Must be ALL or FAILED`);
+    }
+    return value;
+}
 function getParameters() {
     return __awaiter(this, void 0, void 0, function* () {
         const apiUrl = core.getInput('api-url', { required: false }) ||
@@ -32713,6 +32736,12 @@ function getParameters() {
         const iosDevice = parseIOSDevice(core.getInput('ios-device', { required: false }));
         const excludeFlows = core.getInput('exclude-flows', { required: false });
         const googlePlay = core.getInput('google-play', { required: false }) === 'true';
+        const additionalAppBinaryIds = parseTags(core.getInput('additional-app-binary-ids', { required: false }));
+        const additionalAppFiles = parseTags(core.getInput('additional-app-files', { required: false }));
+        const deviceLocale = core.getInput('device-locale', { required: false });
+        const downloadArtifacts = parseDownloadArtifacts(core.getInput('download-artifacts', { required: false }));
+        const maestroVersion = core.getInput('maestro-version', { required: false });
+        const orientation = parseOrientation(core.getInput('orientation', { required: false }));
         if (!(appFilePath !== '') !== (appBinaryId !== '')) {
             throw new Error('Either app-file or app-binary-id must be used');
         }
@@ -32738,6 +32767,12 @@ function getParameters() {
             iosDevice,
             excludeFlows,
             googlePlay,
+            additionalAppBinaryIds,
+            additionalAppFiles,
+            deviceLocale,
+            downloadArtifacts,
+            maestroVersion,
+            orientation,
         };
     });
 }

package.json

@@ -2,7 +2,7 @@
   "name": "dcd-github-action",
   "description": "run maestro tests on devicecloud.dev",
   "author": "devicecloud.dev",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "src/index.ts",
   "license": "MIT",
   "engines": {

src/index.ts

@@ -5,41 +5,53 @@ import { execSync } from 'child_process';
 const run = async (): Promise<void> => {
   try {
     const {
+      additionalAppBinaryIds,
+      additionalAppFiles,
+      androidApiLevel,
+      androidDevice,
       apiKey,
       apiUrl,
+      appBinaryId,
       appFilePath,
-      workspaceFolder,
-      env,
       async,
-      androidApiLevel,
-      iOSVersion,
-      includeTags,
-      excludeTags,
-      appBinaryId,
-      androidDevice,
-      iosDevice,
+      deviceLocale,
+      downloadArtifacts,
+      env,
       excludeFlows,
+      excludeTags,
       googlePlay,
+      includeTags,
+      iOSVersion,
+      iosDevice,
+      maestroVersion,
       name,
+      orientation,
+      workspaceFolder,
     } = await getParameters();
 
     const params: Record<string, any> = {
-      'app-file': appFilePath,
-      flows: workspaceFolder,
+      'additional-app-binary-ids': additionalAppBinaryIds,
+      'additional-app-files': additionalAppFiles,
+      'android-api-level': androidApiLevel,
+      'android-device': androidDevice,
       'api-key': apiKey,
-      'app-binary-id': appBinaryId,
-      'include-tags': includeTags,
-      'exclude-tags': excludeTags,
-      env,
       'api-url': apiUrl,
+      'app-binary-id': appBinaryId,
+      'app-file': appFilePath,
       async,
-      'android-api-level': androidApiLevel,
-      'ios-version': iOSVersion,
-      'android-device': androidDevice,
-      'ios-device': iosDevice,
+      'device-locale': deviceLocale,
+      'download-artifacts': downloadArtifacts,
+      env,
       'exclude-flows': excludeFlows,
+      'exclude-tags': excludeTags,
+      flows: workspaceFolder,
       'google-play': googlePlay,
+      'include-tags': includeTags,
+      'ios-device': iosDevice,
+      'ios-version': iOSVersion,
+      'maestro-version': maestroVersion,
       name,
+      orientation,
     };
 
     const paramsString = Object.keys(params).reduce((acc, key) => {