json file support

Author: riglar

README.md

@@ -402,6 +402,40 @@ Available outputs:
 - `DEVICE_CLOUD_UPLOAD_STATUS`: Status of the test run (PENDING, RUNNING, PASSED, FAILED, CANCELLED)
 - `DEVICE_CLOUD_APP_BINARY_ID`: ID of the uploaded app binary in Device Cloud
 
+# JSON Output File
+
+You can write the test results to a JSON file for easier processing or archiving:
+
+```yaml
+- uses: devicecloud-dev/device-cloud-for-maestro@v1
+  with:
+    api-key: ${{ secrets.DCD_API_KEY }}
+    app-file: app.apk
+    json-file: true
+```
+
+This will create a file named `<run_name>_dcd.json` or `<upload_id>_dcd.json` if no name is provided, containing all test results and metadata.
+
+Example JSON file content:
+```json
+{
+  "uploadId": "abcd1234-5678-efgh-9012-ijklmnopqrst",
+  "consoleUrl": "https://console.devicecloud.dev/results?upload=abcd1234-5678-efgh-9012-ijklmnopqrst",
+  "appBinaryId": "app-binary-5678",
+  "status": "PASSED",
+  "flowResults": [
+    {
+      "name": "login_test",
+      "status": "PASSED"
+    },
+    {
+      "name": "checkout_flow",
+      "status": "PASSED"
+    }
+  ]
+}
+```
+
 # All Available Options
 
 Here's a complete example showing all available options:
@@ -452,7 +486,8 @@ Here's a complete example showing all available options:
     quiet: false
     ignore-sha-check: false
     download-artifacts: FAILED  # ALL|FAILED
+    json-file: true            # Write test results to a JSON file
     api-url: https://api.devicecloud.dev
     config: path/to/maestro-config.yaml
     runner-type: default   # Experimental: m1|m4
-```
+```

action.yml

@@ -38,6 +38,9 @@ inputs:
   env:
     description: 'One or more environment variables to inject into your flows'
     required: false
+  json-file:
+    description: 'Write JSON output to a file with name <run_name>_dcd.json or <upload_id>_dcd.json if no name is provided'
+    required: false
   exclude-flows:
     description: 'Sub directories to ignore when building the flow file list'
     required: false

package.json

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

src/index.ts

@@ -100,6 +100,7 @@ const run = async (): Promise<void> => {
       includeTags,
       iOSVersion,
       iosDevice,
+      jsonFile,
       maestroVersion,
       name,
       orientation,
@@ -138,6 +139,7 @@ const run = async (): Promise<void> => {
       retry,
       'x86-arch': x86Arch,
       'runner-type': runnerType,
+      'json-file': jsonFile,
     };
 
     let paramsString = Object.keys(params).reduce((acc, key) => {

src/methods/params.ts

@@ -30,6 +30,7 @@ export type Params = {
   x86Arch?: boolean;
   config?: string;
   runnerType?: string;
+  jsonFile?: boolean;
 };
 
 function getAndroidApiLevel(apiLevel?: string): number | undefined {
@@ -170,6 +171,7 @@ export async function getParameters(): Promise<Params> {
   const x86Arch = core.getInput('x86-arch', { required: false }) === 'true';
   const config = core.getInput('config', { required: false });
   const runnerType = core.getInput('runner-type', { required: false });
+  const jsonFile = core.getInput('json-file', { required: false }) === 'true';
 
   if (!(appFilePath !== '') !== (appBinaryId !== '')) {
     throw new Error('Either app-file or app-binary-id must be used');
@@ -212,5 +214,6 @@ export async function getParameters(): Promise<Params> {
     x86Arch,
     config,
     runnerType,
+    jsonFile,
   };
 }