org.jenkinsci.plugins.awsdevicefarm

Class AWSDeviceFarm

java.lang.Object

org.jenkinsci.plugins.awsdevicefarm.AWSDeviceFarm

public class AWSDeviceFarm
extends Object

AWS Device Farm API wrapper class.

Constructor Summary

Constructors

Constructor and Description
AWSDeviceFarm(com.amazonaws.auth.AWSCredentials creds) AWSDeviceFarm constructor.
AWSDeviceFarm(String roleArn) AWSDeviceFarm constructor.

Method Summary

Modifier and Type	Method and Description
com.amazonaws.services.devicefarm.model.GetRunResult	describeRun(String runArn)
com.amazonaws.services.devicefarm.model.DevicePool	getDevicePool(com.amazonaws.services.devicefarm.model.Project project, String devicePoolName) Get Device Farm device pool by Device Farm project and device pool name.
com.amazonaws.services.devicefarm.model.DevicePool	getDevicePool(String projectName, String devicePoolName) Get Device Farm device pool by Device Farm project and device pool name.
List<com.amazonaws.services.devicefarm.model.DevicePool>	getDevicePools(com.amazonaws.services.devicefarm.model.Project project) Get Device Farm device pools for a given Device Farm project.
List<com.amazonaws.services.devicefarm.model.DevicePool>	getDevicePools(String projectName) Get Device Farm device pools for a given Device Farm project.
com.amazonaws.services.devicefarm.model.Project	getProject(String projectName) Get Device Farm project by name.
List<com.amazonaws.services.devicefarm.model.Project>	getProjects() Get all Device Farm projects.
com.amazonaws.services.devicefarm.model.ListArtifactsResult	listArtifacts(String runArn, com.amazonaws.services.devicefarm.model.ArtifactCategory category)
com.amazonaws.services.devicefarm.model.ListJobsResult	listJobs(String runArn)
com.amazonaws.services.devicefarm.model.ListSuitesResult	listSuites(String runArn)
com.amazonaws.services.devicefarm.model.ScheduleRunResult	scheduleRun(String projectArn, String name, String appArn, String devicePoolArn, com.amazonaws.services.devicefarm.model.ScheduleRunTest test, com.amazonaws.services.devicefarm.model.ScheduleRunConfiguration configuration) Schedule a test run on Device Farm.
com.amazonaws.services.devicefarm.model.Upload	uploadApp(com.amazonaws.services.devicefarm.model.Project project, String appArtifact) Upload an app to Device Farm to be tested.
com.amazonaws.services.devicefarm.model.Upload	uploadTest(com.amazonaws.services.devicefarm.model.Project project, AppiumJavaJUnitTest test) Upload a test to Device Farm.
com.amazonaws.services.devicefarm.model.Upload	uploadTest(com.amazonaws.services.devicefarm.model.Project project, AppiumJavaTestNGTest test) Upload a test to Device Farm.
com.amazonaws.services.devicefarm.model.Upload	uploadTest(com.amazonaws.services.devicefarm.model.Project project, CalabashTest test) Upload a test to Device Farm.
com.amazonaws.services.devicefarm.model.Upload	uploadTest(com.amazonaws.services.devicefarm.model.Project project, InstrumentationTest test) Upload a test to Device Farm.
com.amazonaws.services.devicefarm.model.Upload	uploadTest(com.amazonaws.services.devicefarm.model.Project project, UIAutomatorTest test) Upload a test to Device Farm.
AWSDeviceFarm	withArtifactsDir(hudson.FilePath artifactsDir) Artifacts directory setter.
AWSDeviceFarm	withEnv(hudson.EnvVars env) Environment setter.
AWSDeviceFarm	withLogger(PrintStream logger) Logger setter.
AWSDeviceFarm	withWorkspace(hudson.FilePath workspace) Workspace setter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AWSDeviceFarm

public AWSDeviceFarm(String roleArn)

AWSDeviceFarm constructor.

Parameters:

roleArn - Role ARN to use for authentication.

AWSDeviceFarm

public AWSDeviceFarm(com.amazonaws.auth.AWSCredentials creds)

AWSDeviceFarm constructor.

Parameters:

creds - AWSCredentials to use for authentication.

Method Detail

withLogger

public AWSDeviceFarm withLogger(PrintStream logger)

Logger setter.

Parameters:

logger - The log print stream.

Returns:

The AWSDeviceFarm object.

withWorkspace

public AWSDeviceFarm withWorkspace(hudson.FilePath workspace)

Workspace setter.

Parameters:

workspace - The FilePath to the Jenkins workspace.

Returns:

The AWSDeviceFarm object.

withArtifactsDir

public AWSDeviceFarm withArtifactsDir(hudson.FilePath artifactsDir)

Artifacts directory setter.

Parameters:

artifactsDir - The FilePath to the Jenkins artifacts directory.

Returns:

The AWSDeviceFarm object.

withEnv

public AWSDeviceFarm withEnv(hudson.EnvVars env)

Environment setter.

Parameters:

env - The EnvVars Jenkins environment.

Returns:

The AWSDeviceFarm object.

getProjects

public List<com.amazonaws.services.devicefarm.model.Project> getProjects()

Get all Device Farm projects.

Returns:

A List of the Device Farm projects.

getProject

public com.amazonaws.services.devicefarm.model.Project getProject(String projectName)
                                                           throws AWSDeviceFarmException

Get Device Farm project by name.

Parameters:

projectName - String name of the Device Farm project.

Returns:

The Device Farm project.

Throws:

AWSDeviceFarmException

getDevicePools

public List<com.amazonaws.services.devicefarm.model.DevicePool> getDevicePools(String projectName)
                                                                        throws AWSDeviceFarmException

Get Device Farm device pools for a given Device Farm project.

Parameters:

projectName - String name of the Device Farm project.

Returns:

A List of the Device Farm device pools.

Throws:

AWSDeviceFarmException

getDevicePools

public List<com.amazonaws.services.devicefarm.model.DevicePool> getDevicePools(com.amazonaws.services.devicefarm.model.Project project)

Get Device Farm device pools for a given Device Farm project.

Parameters:

project - Device Farm Project.

Returns:

A List of the Device Farm device pools.

Throws:

AWSDeviceFarmException

getDevicePool

public com.amazonaws.services.devicefarm.model.DevicePool getDevicePool(String projectName,
                                                                        String devicePoolName)
                                                                 throws AWSDeviceFarmException

Get Device Farm device pool by Device Farm project and device pool name.

Parameters:

projectName - String name of the Device Farm project.

devicePoolName - String name of the device pool.

Returns:

The Device Farm device pool.

Throws:

AWSDeviceFarmException

getDevicePool

public com.amazonaws.services.devicefarm.model.DevicePool getDevicePool(com.amazonaws.services.devicefarm.model.Project project,
                                                                        String devicePoolName)
                                                                 throws AWSDeviceFarmException

Get Device Farm device pool by Device Farm project and device pool name.

Parameters:

project - The Device Farm project.

devicePoolName - String name of the device pool.

Returns:

The Device Farm device pool.

Throws:

AWSDeviceFarmException

uploadApp

public com.amazonaws.services.devicefarm.model.Upload uploadApp(com.amazonaws.services.devicefarm.model.Project project,
                                                                String appArtifact)
                                                         throws IOException,
                                                                AWSDeviceFarmException

Upload an app to Device Farm to be tested.

Parameters:

project - The Device Farm project to upload to.

appArtifact - String path to the app to be uploaded to Device Farm.

Returns:

The Device Farm Upload object.

Throws:

IOException

AWSDeviceFarmException

uploadTest

public com.amazonaws.services.devicefarm.model.Upload uploadTest(com.amazonaws.services.devicefarm.model.Project project,
                                                                 InstrumentationTest test)
                                                          throws IOException,
                                                                 AWSDeviceFarmException

Upload a test to Device Farm.

Parameters:

project - The Device Farm project to upload to.

test - Test object containing relevant test information.

Returns:

The Device Farm Upload object.

Throws:

IOException

AWSDeviceFarmException

uploadTest

public com.amazonaws.services.devicefarm.model.Upload uploadTest(com.amazonaws.services.devicefarm.model.Project project,
                                                                 CalabashTest test)
                                                          throws IOException,
                                                                 AWSDeviceFarmException

Upload a test to Device Farm.

Parameters:

project - The Device Farm project to upload to.

test - Test object containing relevant test information.

Returns:

The Device Farm Upload object.

Throws:

IOException

AWSDeviceFarmException

uploadTest

public com.amazonaws.services.devicefarm.model.Upload uploadTest(com.amazonaws.services.devicefarm.model.Project project,
                                                                 UIAutomatorTest test)
                                                          throws IOException,
                                                                 AWSDeviceFarmException

Upload a test to Device Farm.

Parameters:

project - The Device Farm project to upload to.

test - Test object containing relevant test information.

Returns:

The Device Farm Upload object.

Throws:

IOException

AWSDeviceFarmException

uploadTest

public com.amazonaws.services.devicefarm.model.Upload uploadTest(com.amazonaws.services.devicefarm.model.Project project,
                                                                 AppiumJavaTestNGTest test)
                                                          throws IOException,
                                                                 AWSDeviceFarmException

Upload a test to Device Farm.

Parameters:

project - The Device Farm project to upload to.

test - Test object containing relevant test information.

Returns:

The Device Farm Upload object.

Throws:

IOException

AWSDeviceFarmException

uploadTest

public com.amazonaws.services.devicefarm.model.Upload uploadTest(com.amazonaws.services.devicefarm.model.Project project,
                                                                 AppiumJavaJUnitTest test)
                                                          throws IOException,
                                                                 AWSDeviceFarmException

Upload a test to Device Farm.

Parameters:

project - The Device Farm project to upload to.

test - Test object containing relevant test information.

Returns:

The Device Farm Upload object.

Throws:

IOException

AWSDeviceFarmException

scheduleRun

public com.amazonaws.services.devicefarm.model.ScheduleRunResult scheduleRun(String projectArn,
                                                                             String name,
                                                                             String appArn,
                                                                             String devicePoolArn,
                                                                             com.amazonaws.services.devicefarm.model.ScheduleRunTest test,
                                                                             com.amazonaws.services.devicefarm.model.ScheduleRunConfiguration configuration)

Schedule a test run on Device Farm.

Parameters:

projectArn - The ARN of the Device Farm project to run the test on.

name - The name of the test run.

appArn - The ARN of the app to test.

devicePoolArn - The ARN of the device pool to test against.

test - The run test.

configuration - The run configuration.

Returns:

The result of the schedle run.

describeRun

public com.amazonaws.services.devicefarm.model.GetRunResult describeRun(String runArn)

listArtifacts

public com.amazonaws.services.devicefarm.model.ListArtifactsResult listArtifacts(String runArn,
                                                                                 com.amazonaws.services.devicefarm.model.ArtifactCategory category)

listJobs

public com.amazonaws.services.devicefarm.model.ListJobsResult listJobs(String runArn)

listSuites

public com.amazonaws.services.devicefarm.model.ListSuitesResult listSuites(String runArn)