step.yml

#
# A couple of useful guides & docs:
#
# - Main Bitrise CLI docs: https://github.com/bitrise-io/bitrise/tree/master/_docs
# - Step Development Guideline: https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
# - Bitrise.yml format spec: https://github.com/bitrise-io/bitrise/blob/master/_docs/bitrise-yml-format-spec.md
# - Bitrise docs: http://devcenter.bitrise.io/
# - Bitrise CLI guides: http://devcenter.bitrise.io/bitrise-cli/

title: |-
  MagicPod
summary: |
  MagicPod UI test step
description: |
  You can execute E2E testing of iOS/Android apps on MagicPod (https://magicpod.com).
website: https://github.com/magic-Pod/bitrise-step-magic-pod
source_code_url: https://github.com/magic-Pod/bitrise-step-magic-pod
support_url: https://github.com/magic-Pod/bitrise-step-magic-pod/issues

# If this step should be available only for certain project types
# just uncomment this `project_type_tags` section and include all the
# project types supported by the step. If the step can be used for all
# project types then you can just remove this section.
# If no `project_type_tags` specified (or specified as an empty array)
# that means the step can be used for any project type.
# You can find more information about project type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
#
project_type_tags:
  - ios
  - android

# Type tags are used for categorizing steps, for easier step discovery in Step Libraries.
# You can find more information about type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
type_tags:
  - test

is_requires_admin_user: false
is_always_run: false
is_skippable: false
run_if: ""

toolkit:
  go:
    package_name: github.com/magic-Pod/bitrise-step-magic-pod


inputs:
  - magic_pod_api_token:
    opts:
      title: "MagicPod API token"
      description: |-
        Access token to use MagicPod Web API.
        
        * Key: Arbitrary new Secret Env name like `MAGIC_POD_API_TOKEN`
        * Value: API token copied from https://app.magicpod.com/accounts/api-token/. 
      is_required: true
      is_expand: true
      is_sensitive: true
  - organization_name:
    opts:
      title: "Organization name"
      description : |-
        Organization name in MagicPod.
        Please be sure to use **organization name**, not **display name**.
      is_required: true
      is_expand: true
  - project_name:
    opts:
      title: "Project name"
      description : |-
        Project name in MagicPod.
        Please be sure to use **project name**, not **display name**.
      is_required: true
      is_expand: true
  - test_settings_number: "1"
    opts:
      title: "Test settings number"
      description: |-
        Test settings number specified on MagicPod project batch run page.
      is_required: false
  - test_settings:
    opts:
      title: "Test settings"
      description: |-
        If you would like to define test settings from scratch or overwrite pre-defined test settings, please specify this parameter.
        You can generate an example JSON on your project's batch run page (Setting -> menu -> Advanced -> Copy as magicpod-api-client (detailed settings))
      category: "detail"
      is_required: false
  - app_path: "$BITRISE_APP_DIR_PATH"
    opts:
      title: "App path"
      description: |-
        Path to app (apk/app/ipa) file you want to test.
        Note that you need to select _App file (cloud upload)_ for _App Type_ on MagicPod project batch run page.
        * *Warning: The file of the specified path is uploaded to MagicPod cloud and can be seen by project members.*
        * For iOS simulator testing, specify the directory _xx.app_ so that included files are automatically ziped into one file before uploading. 
      is_expand: true
  - wait_for_result: "true"
    opts:
      title: "Wait for result"
      description: |-
        If set to true, this step waits until MagicPod testing is completed and succeeds only when the test is successful.
        Otherwise this step immediately exits with success.
  - wait_limit: "0"
    opts:
      title: "Wait limit"
      description: |-
        Wait limit in seconds. If 0 is specified, the value is test count x 10 minutes.
  - delete_app_after_test: "Not delete"
    opts:
      title: "Delete app after test"
      description: |-
        Define how to treat the uploaded app file after the test.
        This option is valid only when you specify _App path_.
      value_options: ["Not delete", "Always delete", "Delete only when tests succeeded"]
  - base_url: "https://app.magicpod.com"
    opts:
      title: "MagicPod web API URL"
      description: |-
        Cannot be changed
      is_dont_change_value: true
      category: "debug"


outputs:
  - MAGIC_POD_TEST_SUCCEEDED:
    opts:
      title: "MAGIC_POD_TEST_SUCCEEDED"
      summary: |-
        This variable becomes 'true' only when all batch runs succeeded, otherwise 'false'.
  - MAGIC_POD_TEST_RESULT:
    opts:
      title: "MAGIC_POD_TEST_RESULT"
      summary: |-
        Array which contains status/URL information of all batch runs.  The format is like
        [{"Url":"https://app.magicpod.com/ORG_NAME/PRJ_NAME/batch-run/10/","Status":"failed","Batch_Run_Number":10,"Test_Cases":{"Succeeded":3,"Failed":1,"Aborted":0,"Unresolved":0,"Total":4}}]