/device-farm-catalogue

A Jenkins pipeline script that periodically updates the README.md file of this repo with a full catalogue of the AWS DeviceFarm devices and their ARN's.

Primary LanguageGroovy

AWS Device Farm Catalogue

This project is a Jenkins Pipeline script that lists the available devices in AWS DeviceFarm and creates a catalogue listing their most important characteristics and their ARN's. The idea is to make it easy for testers to find the ARN's of the devices they want to test on when using AWS DeviceFarm.

The resulting catalogue can be found here

Context

In order to run tests on AWS Device Farm, tester must first create Device Pools. If the tester has access to the AWS Console that seems easy enough. However in an environment where testers do not have that kind of access and/or if there's a need to automate the creation of the device pools, then using the AWS CLI command line utility is the alternative.

However, to create a device pools you'll need to configure selector rules in the payload of the create-device-pool service using the following syntax:

[
  {
    "attribute": "ARN"|"PLATFORM"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED",
    "operator": "EQUALS"|"LESS_THAN"|"GREATER_THAN"|"IN"|"NOT_IN",
    "value": "string"
  }
  ...
]

Creating a device pool with rules based on platform, form factor or manufacturer can potentially result in very large pools, which will also produce very long -and expensive- tests. Creating a device pool of just a few hand-picked devices is desireable and reasonable for small feature developments or on B2E apps where the device models used are well known. However, creating a device pool based on the an IN ARN rule...

[
  {
    "attribute": "ARN",
    "operator": "IN",
    "value": "[\"arn:aws:devicefarm:us-west-2::device:2DA046320998446B84407B50BFBD7757\",\"arn:aws:devicefarm:us-west-2::device:A4219155595B491287B7C959622A611C\"]"
  }
  ...
]

... can be cumbersome since there's no public AWS Device Catalogue which lists the ARN's.

The AWS Device Farm CLI command line utility does include a list-devices service which lists all available devices. Testers can then pick from the output the ARN's from the devices they want to test on and then must create payloads for the create-device-pool service by hand.

This script just makes finding those ARN's less painfull, by updating the catalogue periodically and listing it in alphabetical order by the device's name.

Implementation Notes

  1. The cript assumes you'll place it in a repository that's accessible to your Jenkins server.
  2. The script assumes you've made AWS credentials available by using the Jenkins Credentials Plugin
  3. Make sure your password for Github doesn't contain '@'. If it does, the script will have no option but to url-encode it and Jenkins will write it encoded, but unmasked, to the log.
  4. The script assumes you've generated SSH keys for the Jenkins user to access your github account.