Deploys app to device farm and starts a test run with a preconfigured test package and device pool.
:warning: This step requires a fair amount of configuration in order to work properly. Please read the wiki for setup instructions.
Can be run directly with the bitrise CLI,
just git clone
this repository, cd
into it's folder in your Terminal/Command Line
and call bitrise run test
.
Check the bitrise.yml
file for required inputs which have to be
added to your .bitrise.secrets.yml
file!
Step by step:
git clone
the repositorycd
into the directory of the step (the one you just git clone
d).bitrise.secrets.yml
file in the same directory of bitrise.yml
- the .bitrise.secrets.yml
is a git ignored file, you can store your secrets inbitrise.yml
file for any secret you should set in .bitrise.secrets.yml
# define these in your .bitrise.secrets.yml
, in the app:envs
section..bitrise.secrets.yml
you can just run this step with the bitrise CLI: bitrise run test
An example .bitrise.secrets.yml
file:
---
# These environments should NOT be checked into source control, they are used
# to populate your tests when running this step locally.
envs:
- AWS_ACCESS_KEY: ""
- AWS_SECRET_KEY: ""
- DEVICE_FARM_PROJECT: ""
- TEST_PACKAGE_NAME: "test_bundle.zip"
- TEST_TYPE: "APPIUM_PYTHON"
- PLATFORM: "ios+android"
- IOS_POOL: ""
- ANDROID_POOL: ""
- RUN_NAME_PREFIX: "testscript"
- AWS_REGION: "us-west-2"
- BITRISE_IPA_PATH: ""
- BITRISE_SIGNED_APK_PATH: ""
- BITRISE_BUILD_NUMBER: 0
bitrise run test
AWS_ACCESS_KEY
and AWS_SECRET_KEY
must be set in .bitrise.secrets.yml
device_farm_project
inputplatform
input is...ios
, then ios_pool
must be set to the ARN of an iOS device pool and ipa_path
or envvar BITRISE_IPA_PATH
must be setandroid
, then android_pool
must be set to the ARN of an Android device pool and apk_path
or envvar BITRISE_SIGNED_APK_PATH
must be setios+android
, then all of the above inputs must be setstep.yml
for more info on obtaining ARNsstep.sh
with your functionalitystep.yml
(inputs
section)step.yml
toobitrise.yml
bitrise run test
- if it works, you're readyFor Step development guidelines & best practices check this documentation: https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md.
NOTE:
If you want to use your step in your project's bitrise.yml
:
bitrise.yml
with the git::PUBLIC-GIT-CLONE-URL@BRANCH
step reference style:- git::https://github.com/user/my-step.git@branch:
title: My step
inputs:
- my_input_1: "my value 1"
- my_input_2: "my value 2"
You can find more examples of step reference styles in the bitrise CLI repository.
git clone
itbitrise
project, either on your Mac or on bitrise.iobitrise.yml
with either a relative path, or with a git URL format- original-step-id:
use - path::./relative/path/of/script/on/your/Mac:
- original-step-id:
use - git::https://github.com/user/step.git@branch:
You can share your Step or step version with the bitrise CLI. Just run bitrise share
and follow the guide it prints.