step.yml

title: "Device Cloud for Maestro"
summary: "Uses devicecloud.dev to execute Maestro mobile tests"
description: "Executes Maestro mobile tests on devicecloud.dev with configurable parameters"
website: "https://devicecloud.dev"
source_code_url: "https://github.com/devicecloud-dev/bitrise-integration"

host_os_tags:
  - osx-10.10
  - ubuntu-16.04

project_type_tags:
  - ios
  - android
  - xamarin
  - react-native
  - cordova
  - ionic
  - flutter

type_tags:
  - test

is_always_run: false
is_skippable: false
run_if: ""

deps:
  brew:
    - name: git
    - name: node
  apt_get:
    - name: git
    - name: node

toolkit:
  bash:
    entry_file: step.sh

inputs:
  - api_key: ""
    opts:
      title: "Device Cloud API Key"
      summary: "devicecloud.dev API Key from your app settings"
      is_expand: true
      is_required: true
      is_sensitive: true

  - app_file: ""
    opts:
      title: "App File Path"
      summary: "Path to the build artifact to upload"
      is_expand: true
      is_required: false

  - app_binary_id: ""
    opts:
      title: "App Binary ID"
      summary: "The app binary already uploaded to devicecloud.dev"
      is_expand: true
      is_required: false

  - android_device: ""
    opts:
      title: "Android Device"
      summary: "Android device to run your flow against"
      is_expand: true
      is_required: false

  - ios_device: ""
    opts:
      title: "iOS Device"
      summary: "iOS device to run your flow against"
      is_expand: true
      is_required: false

  - workspace: ""
    opts:
      title: "Workspace Folder"
      summary: "Path to the workspace folder containing Maestro flows"
      is_expand: true
      is_required: false

  - env_list: ""
    opts:
      title: "Environment Variables"
      summary: "List of environment variables to pass to the test separated by newlines (e.g. MY_VAR=my_value <newline> MY_OTHER_VAR=other_value)"
      is_expand: true
      is_required: false

  - metadata: ""
    opts:
      title: "Metadata"
      summary: "Arbitrary key-value metadata to include with your test run, separated by newlines (format: key=value)"
      is_expand: true
      is_required: false

  - async: "false"
    opts:
      title: "Async Execution"
      summary: "Run tests asynchronously (exit immediately without waiting for results)"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - dry_run: "false"
    opts:
      title: "Dry Run"
      summary: "Simulate the run without actually triggering the upload/test, useful for debugging workflow issues"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - android_api_level: ""
    opts:
      title: "Android API Level"
      summary: "Android API level to use for testing"
      is_expand: true
      is_required: false

  - android_no_snapshot: "false"
    opts:
      title: "Android No Snapshot"
      summary: "[Android only] Force cold boot instead of using snapshot boot. Automatically enabled for API 35+ but can be used to force cold boot on older API levels."
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - ios_version: ""
    opts:
      title: "iOS Version"
      summary: "iOS version to use for testing"
      is_expand: true
      is_required: false

  - include_tags: ""
    opts:
      title: "Include Tags"
      summary: "Comma-separated list of tags to include in test execution"
      is_expand: true
      is_required: false

  - exclude_tags: ""
    opts:
      title: "Exclude Tags"
      summary: "Comma-separated list of tags to exclude from test execution"
      is_expand: true
      is_required: false

  - exclude_flows: ""
    opts:
      title: "Exclude Flows"
      summary: "Flows to exclude from test execution"
      is_expand: true
      is_required: false

  - google_play: "false"
    opts:
      title: "Google Play"
      summary: "Whether to use Google Play services"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - name: ""
    opts:
      title: "Test Run Name"
      summary: "Custom name for the test run"
      is_expand: true
      is_required: false

  - device_locale: ""
    opts:
      title: "Device Locale"
      summary: "Locale to use on the device"
      is_expand: true
      is_required: false

  - download_artifacts: ""
    opts:
      title: "Download Artifacts"
      summary: "Which artifacts to download (ALL or FAILED)"
      is_expand: true
      is_required: false

  - maestro_version: ""
    opts:
      title: "Maestro Version"
      summary: "Specific version of Maestro to use"
      is_expand: true
      is_required: false

  - orientation: ""
    opts:
      title: "Device Orientation"
      summary: "[Android only] Device orientation (0 = portrait, 90 = landscape)"
      is_expand: true
      is_required: false

  - show_crosshairs: "false"
    opts:
      title: "Show Crosshairs"
      summary: "[Android only] Display crosshairs for screen interactions during test execution"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - maestro_chrome_onboarding: "false"
    opts:
      title: "Maestro Chrome Onboarding"
      summary: "[Android only] Force Maestro-based Chrome onboarding - note: this will slow your tests but can fix browser related crashes"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - retry: ""
    opts:
      title: "Retry Count"
      summary: "Number of times to retry failed tests"
      is_expand: true
      is_required: false

  - runner_type: ""
    opts:
      title: "Runner Type"
      summary: "[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers"
      is_expand: true
      is_required: false

  - report: ""
    opts:
      title: "Report Format"
      summary: "Generate and download test reports in the specified format (allure, junit, or html)"
      is_expand: true
      is_required: false

  - junit_path: ""
    opts:
      title: "JUnit Report Path"
      summary: "Custom file path for downloaded JUnit report (requires report=junit, default: ./report.xml)"
      is_expand: true
      is_required: false

  - allure_path: ""
    opts:
      title: "Allure Report Path"
      summary: "Custom file path for downloaded Allure report (requires report=allure, default: ./report.html)"
      is_expand: true
      is_required: false

  - html_path: ""
    opts:
      title: "HTML Report Path"
      summary: "Custom file path for downloaded HTML report (requires report=html, default: ./report.html)"
      is_expand: true
      is_required: false

  - ignore_sha_check: "false"
    opts:
      title: "Ignore SHA Check"
      summary: "Ignore the SHA hash check and upload the binary regardless of whether it already exists (not recommended)"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - api_url: ""
    opts:
      title: "API URL"
      summary: "Custom API URL for devicecloud.dev (optional)"
      is_expand: true
      is_required: false

  - debug: "false"
    opts:
      title: "Debug Mode"
      summary: "Enable detailed debug logging for troubleshooting issues"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - json: "false"
    opts:
      title: "JSON Output"
      summary: "Output results in JSON format - note: will always provide exit code 0"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - json_file: "false"
    opts:
      title: "JSON File Output"
      summary: "Write JSON output to a file with name <run_name>_dcd.json or <upload_id>_dcd.json if no name is provided"
      is_expand: true
      is_required: false
      default_value: "false"
      value_options:
        - "true"
        - "false"

  - json_file_name: ""
    opts:
      title: "JSON File Name"
      summary: "Custom name for the JSON file (can also include relative path). Requires json_file to be true."
      is_expand: true
      is_required: false

  - config: ""
    opts:
      title: "Config File"
      summary: "Path to custom config.yaml file. If not provided, defaults to config.yaml in root flows folders."
      is_expand: true
      is_required: false

  - artifacts_path: ""
    opts:
      title: "Artifacts Path"
      summary: "Custom file path for downloaded artifacts (default: ./artifacts.zip)"
      is_expand: true
      is_required: false

outputs:
  - DEVICE_CLOUD_CONSOLE_URL:
    opts:
      title: "Device Cloud Console URL"
      summary: "URL to view the test results in the Device Cloud console"
  - DEVICE_CLOUD_FLOW_RESULTS:
    opts:
      title: "Flow Results"
      summary: "JSON array containing results for each flow, including name, status, and any errors"
  - DEVICE_CLOUD_UPLOAD_STATUS:
    opts:
      title: "Test Run Status"
      summary: "Status of the test run (PENDING, RUNNING, PASSED, FAILED, CANCELLED)"
  - DEVICE_CLOUD_APP_BINARY_ID:
    opts:
      title: "App Binary ID"
      summary: "ID of the uploaded app binary in Device Cloud"