README.md

AWS Device Farm Jenkins Plugin

AWS Device Farm integration with Jenkins CI

This plugin provides AWS Device Farm functionality from your own Jenkins CI server:

It also provides the device state details specification if the checkboxs are checked. Otherwise, the default settings will be used:

It also can pull down all of the test artifacts (logs, screenshots, etc.) locally:

Usage

Building the plugin:

1. Clone the GitHub repository.
2. Import the Maven project into your favorite IDE (Eclipse, IntelliJ, etc.).
3. Build the plugin using the Makefile (make clean compile).
4. The plugin is created at target/aws-device-farm.hpi.

Installing the plugin:

Manual install:

1. Copy the hpi file to your Jenkins build server and place it in the Jenkins plugin directory (usually /var/lib/jenkins/plugins).
2. Ensure that the plugin is owned by the jenkins user.
3. Restart Jenkins.

Web UI install:

1. Log into your Jenkins web UI.
2. On the left-hand side of the screen, click “Manage Jenkins”.
3. Click “Manage Plugins”.
4. Near the top of the screen, click on the “Advanced” tab.
5. Under the “Upload Plugin”, click “Choose File” and select the AWS Device Farm Jenkins plugin that you previously downloaded.
6. Click “Upload”.
7. Check the “Restart Jenkins when installation is complete and no jobs are running” checkbox.
8. Wait for Jenkins to restart.

Generating a proper IAM user:

1. Log into your AWS web console UI.
2. Click “Identity & Access Management”.
3. On the left-hand side of the screen, click “Users”.
4. Click “Create New Users”.
5. Enter a user name of your choice.
6. Leave the “Generate an access key for each user” checkbox checked.
7. Click “Create”.
8. View or optionally download the User security credentials that were created; you will them them later.
9. Click “Close” to return to the IAM screen.
10. Click your user name in the list.
11. Under the Inline Policies header, click the “click here” link to create a new inline policy.
12. Select the “Custom Policy” radio button.
13. Click “Select”.
14. Give your policy a name under “Policy Name”.
15. Copy/paste the following policy into “Policy Document”:

    {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Sid": "DeviceFarmAll",
                "Effect": "Allow",
                "Action": [ "devicefarm:*" ],
                "Resource": [ "*" ]
            }
        ]
    }

16. Click “Apply Policy”.

First-time configuration instructions:

1. Log into your Jenkins web UI.
2. On the left-hand side of the screen, click “Manage Jenkins”
3. Click “Configure System”.
4. Scroll down to the “AWS Device Farm” header.
5. Copy/paste your AKID and SKID you created previously into their respective boxes.
6. Click “Save”.

Using the plugin in Jenkins job:

1. Log into your Jenkins web UI.
2. Click on the job you wish to edit.
3. On the left-hand side of the screen, click “Configure”.
4. Scroll down to the “Post-build Actions” header.
5. Click “Add post-build action” and select “Run Tests on AWS Device Farm”.
6. Select the project you would like to use.
7. Select the device pool you would like to use.
8. Select if you'd like to have the test artifacts (such as the logs and screenshots) archived locally.
9. In “Application”, fill in the path to your compiled application for testing native or hybrid app. Check "It is a web application." for testing web app.
10. Choose the test framework, provide the path to your test package location and other relavent details.
11. Configure device state parameters like radio details, extra data and device locations.
12. Configure the maximum execution timeout. The default execution timeout is 60 minutes.
13. Set the execution configuration parameters: video recording and app performance monitoring.
14. Click “Save”.

Dependencies

• AWS SDK 1.11.126 or later.