Continuous Testing and Bitrise

이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

GitHub Release Build Status License

Overview

With the synthetics-test-automation-bitrise-step-upload-application step, you can upload a new version of your application to Datadog to run Synthetic tests against during your Bitrise CI, ensuring that all your teams using Bitrise can benefit from Synthetic tests at every stage of the software lifecycle.

This step requires that your application already exists in Datadog.

For more information on the available configuration, see the datadog-ci upload-application documentation.

Setup

This step is not available on the official Bitrise Step Library. To get started:

  1. Add the following git URL to your workflow. See the official Bitrise documentation on how to do that though the Bitrise app. You can also configure it locally by referencing the git URL in your bitrise.yml file.
- git::https://github.com/DataDog/synthetics-test-automation-bitrise-step-upload-application.git@v2.0.0:
  1. Add your API and application keys to your secrets in Bitrise.
  2. Configure your step inputs. You can also configure them in your bitrise.yml file. The only required inputs are the two secrets you configured earlier. For a comprehensive list of inputs, see the Inputs section.

When running the step locally with the Bitrise CLI, the secrets should be stored in a .bitrise.secrets.yml file. See Managing secrets locally.

Usage

Example task using a global configuration override with configPath

This task overrides the path to the global datadog-ci.config.json file.

- git::https://github.com/DataDog/synthetics-test-automation-bitrise-step-upload-application.git@v2.0.0:
   inputs:
   - api_key: <DATADOG_API_KEY>
   - app_key: <DATADOG_APP_KEY>
   - config_path: './synthetics-config.json'

Example including all possible configurations

For reference, this is an example of a complete configuration:

- git::https://github.com/DataDog/synthetics-test-automation-bitrise-step-upload-application.git@v2.0.0:
   inputs:
   - api_key: <DATADOG_API_KEY>
   - app_key: <DATADOG_APP_KEY>
   - config_path: './global.config.json'
   - datadog_site: 'datadoghq.com'
   - latest: true
   - mobile_application_id: '123-123-123'
   - mobile_application_version_file_path: 'path/to/application.apk'
   - version_name: 'example 1.0'

Inputs

For more information on the available configuration, see the datadog-ci upload-application documentation.

NameDescription
api_key(Required) Your Datadog API key. This key is created in your Datadog organization and should be stored as a secret.
app_key(Required) Your Datadog application key. This key is created in your Datadog organization and should be stored as a secret.
config_pathThe path to the global configuration file that configures datadog-ci.
Default: datadog-ci.json
datadog_siteYour Datadog site. The possible values are listed in this table.
Default: datadoghq.com

Set it to (ensure the correct SITE is selected on the right).
latestMark the new version as latest. Any tests that run on the latest version will use this version on their next run.
Default: false
mobile_application_id(Required) The ID of the application you want to upload the new version to.
mobile_application_version_file_path(Required) The path to the new version of your mobile application (.apk or .ipa). You may use $BITRISE_IPA_PATH or $BITRISE_APK_PATH from your previous build steps.
version_name(Required) The name of the new version. It has to be unique.

Outputs

NameDescription
DATADOG_UPLOADED_APPLICATION_VERSION_IDThe version ID of the application that was just uploaded. Pass it to the Bitrise step to run tests with the mobile_application_version input to test this version of the application.

Further reading

Additional helpful documentation, links, and articles:

PREVIEWING: domalessi/docs-10584