Project

fastlane-plugin-aws_device_farm

0.08
Low commit activity in last 3 years
There's a lot of open issues
No release in over a year
fastlane-plugin-aws_device_farmhjanuschka/fastlane-plugin-aws_device_farmHomepageDocumentationSource CodeBug Tracker
Run UI Tests on AWS Devicefarm
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
492,863
Stars
86
Forks
34
Watchers
6
 Releases
Current version
0.3.26
Total releases
85
First release
2016-10-10
Latest release
2023-05-19
 Issues
Open Issues
5
Closed Issues
10
Total Issues
15
Issue Closure Rate
66%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
6
Merged Pull Requests
34
Pull Request Acceptance Rate
82%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-12-22
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
fastlane
>= 1.105.0
pry
>= 0
rake
>= 0
rspec
>= 0
rubocop
>= 0

Runtime

aws-sdk
>= 0
 Project Readme

AWS Device Farm Plugin for Fastlane

fastlane Plugin Badge

About

This Plugin allows tests run on AWS device Farm

iOS Android Fail
Screenshot Screenshot Screenshot

Setup

Add Plugin

fastlane add_plugin aws_device_farm

Create Device Pools

Open your AWS dashboard and under AWS-Device Farm - configure your Device Pools. Select the devices you want to run the tests on.

Create a project on AWS

in this example we called this fastlane

Example iOS

lane :aws_device_run_ios do
  ENV['AWS_ACCESS_KEY_ID']     = 'xxxxx'
  ENV['AWS_SECRET_ACCESS_KEY'] = 'xxxxx'
  ENV['AWS_REGION']            = 'us-west-2'
  #Build For Testing
  xcodebuild(
    scheme: 'UITests',
    destination: 'generic/platform=iOS',
    configuration: 'Release',
    derivedDataPath: 'aws',
    xcargs: "GCC_PREPROCESSOR_DEFINITIONS='AWS_UI_TEST' ENABLE_BITCODE=NO CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO build-for-testing"
  )
  # Transform .app into AWS compatible IPA
  aws_device_farm_package(
    derrived_data_path: "aws",
    configuration: "Release"
  )
  # RUN tests on AWS Device Farm
  aws_device_farm
end

Example Android

lane :aws_device_run_android do
  ENV['AWS_ACCESS_KEY_ID']     = 'xxxxx'
  ENV['AWS_SECRET_ACCESS_KEY'] = 'xxxxx'
  ENV['AWS_REGION']            = 'us-west-2'

  #Build Debug App + Instrumentation Apk
  gradle(task: 'assembleDebug')
  gradle(task: 'assembleAndroidTest')

  # RUN tests on AWS Device Farm
  aws_device_farm(
    binary_path:         'app/build/outputs/apk/app-debug.apk',
    test_binary_path:    'app/build/outputs/apk/app-debug-androidTest-unaligned.apk'
  )
end

The plugin also exposes two ENV variables in case you want to make additional calls after the action is finished. ENV["AWS_DEVICE_FARM_RUN_ARN"] containing the arn of the run
ENV["AWS_DEVICE_FARM_PROJECT_ARN"] containing the arn of the project
ENV["AWS_DEVICE_FARM_WEB_URL_OF_RUN"] containg the web url of the run

Options

  • aws_device_farm
Option Default Description Type Required
name fastlane AWS Device Farm Project Name String ✅
run_name Define the name of the device farm run String
binary_path Path to App Binary String ✅
test_binary_path Path to test bundle String
test_package_type Type of test package String
test_type Type of test String
path Define the path of the application binary (apk or ipa) to upload to the device farm project String ✅
device_pool IOS AWS Device Farm Device Pool String ✅
network_profile_arn Network profile arn you want to use for running the applications String
wait_for_completion true Wait for Test-Run to be completed Boolean
allow_device_errors false Do you want to allow device booting errors? Boolean
allow_failed_tests false Do you want to allow failing tests? Boolean
filter Define a filter for your test run and only run the tests in the filter (note that using test_spec overrides the filter option) String
billing_method METERED Specify the billing method for the run String
locale en_US Specify the locale for the run String
test_spec Define the device farm custom TestSpec ARN to use (can be obtained using the AWS CLI devicefarm list-uploads command) String
print_web_url_of_run false Do you want to print the web url of run in the messages? Boolean
print_waiting_periods true Do you want to print . while waiting for a run? Boolean
junit_xml_output_path junit.xml JUnit xml output path String
junit_xml false Do you want to create JUnit.xml? Boolean
artifact false Do you want to download Artifact? Boolean
artifact_output_dir ./test_outputs Artifact output directory String
artifact_types [] Specify the artifact types one wants to download Array
test_parameters The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings. Hash

Possible types see: http://docs.aws.amazon.com/sdkforruby/api/Aws/DeviceFarm/Client.html#create_upload-instance_method

  • aws_device_farm_package
Option Default Description Type
derrived_data_path Derrived Data Path, containing a build-for-testing derrived-data folder String
derrived_data_path Development Specify the Build-Configuration that was used e.g.: Development String

Credit

it is based on a custom action by @icapps (https://github.com/icapps/fastlane-configuration) added the following:

  • iOS Support for XCUITests
  • support current fastlane version
  • improve output
  • make it available as a fastlane plugin

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting doc in the main fastlane repo.

About fastlane

fastlane is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out fastlane.tools.