org.jenkinsci.plugins.awsdevicefarm

Class AWSDeviceFarmRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.jenkinsci.plugins.awsdevicefarm.AWSDeviceFarmRecorder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class AWSDeviceFarmRecorder
extends hudson.tasks.Recorder

Post-build step for running tests on AWS Device Farm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWSDeviceFarmRecorder.DescriptorImpl Descriptor for AWSDeviceFarmRecorder.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
String	appArtifact
String	appiumJavaJUnitTest
String	appiumJavaTestNGTest
String	calabashFeatures
String	calabashTags
String	devicePoolName
String	eventCount
String	eventThrottle
String	junitArtifact
String	junitFilter
PrintStream	log
String	projectName
String	seed
Boolean	storeResults
String	testToRun
String	uiautomatorArtifact
String	uiautomatorFilter

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

AWSDeviceFarmRecorder(String projectName, String devicePoolName, String appArtifact, String testToRun, Boolean storeResults, String eventCount, String eventThrottle, String seed, String appiumJavaJUnitTest, String appiumJavaTestNGTest, String calabashFeatures, String calabashTags, String junitArtifact, String junitFilter, String uiautomatorArtifact, String uiautomatorFilter) The Device Farm recorder class for running post-build steps on Jenkins.

Method Summary

Modifier and Type	Method and Description
String	getAkid() Access key ID getter.
AWSDeviceFarm	getAWSDeviceFarm() Getter for the Device Farm API.
AWSDeviceFarmRecorder.DescriptorImpl	getDescriptor() Getter for the Device Farm descriptor.
Collection<hudson.model.Action>	getProjectActions(hudson.model.AbstractProject<?,?> project) Return collection of all Jenkins actions to be attached to this project.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() In a concurrent environment, this MUST run after the has completed.
String	getRoleArn() Role ARN getter.
String	getSkid() Secret key ID getter.
String	isTestType(String testTypeName) Test if the test type names match (for marking the radio button).
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) Perform the post-build test action.

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, prebuild

Field Detail

projectName

public String projectName

devicePoolName

public String devicePoolName

appArtifact

public String appArtifact

testToRun

public String testToRun

storeResults

public Boolean storeResults

eventCount

public String eventCount

eventThrottle

public String eventThrottle

seed

public String seed

appiumJavaJUnitTest

public String appiumJavaJUnitTest

appiumJavaTestNGTest

public String appiumJavaTestNGTest

calabashFeatures

public String calabashFeatures

calabashTags

public String calabashTags

junitArtifact

public String junitArtifact

junitFilter

public String junitFilter

uiautomatorArtifact

public String uiautomatorArtifact

uiautomatorFilter

public String uiautomatorFilter

log

public PrintStream log

Constructor Detail

AWSDeviceFarmRecorder

@DataBoundConstructor
public AWSDeviceFarmRecorder(String projectName,
                                                   String devicePoolName,
                                                   String appArtifact,
                                                   String testToRun,
                                                   Boolean storeResults,
                                                   String eventCount,
                                                   String eventThrottle,
                                                   String seed,
                                                   String appiumJavaJUnitTest,
                                                   String appiumJavaTestNGTest,
                                                   String calabashFeatures,
                                                   String calabashTags,
                                                   String junitArtifact,
                                                   String junitFilter,
                                                   String uiautomatorArtifact,
                                                   String uiautomatorFilter)

The Device Farm recorder class for running post-build steps on Jenkins.

Parameters:

projectName - The name of the Device Farm project.

devicePoolName - The name of the Device Farm device pool.

appArtifact - The path to the app to be tested.

testToRun - The type of test to be run.

storeResults - Download the results to a local archive.

eventCount - The number of fuzz events to run.

eventThrottle - The the fuzz event throttle count.

seed - The initial seed of fuzz events.

appiumJavaJUnitTest -

appiumJavaTestNGTest -

calabashFeatures - The path to the Calabash tests to be run.

calabashTags - Calabash tags to attach to the test.

junitArtifact - The path to the Instrumentation JUnit tests.

junitFilter - The filter to apply to the Instrumentation JUnit tests.

uiautomatorArtifact - The path to the UI Automator tests to be run.

uiautomatorFilter -

Method Detail

isTestType

public String isTestType(String testTypeName)

Test if the test type names match (for marking the radio button).

Parameters:

testTypeName - The String representation of the test type.

Returns:

Whether or not the test type string matches.

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws IOException,
                       InterruptedException

Perform the post-build test action.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build - The build to follow.

launcher - The launcher.

listener - The build launcher.

Returns:

Whether or not the post-build action succeeded.

Throws:

IOException

InterruptedException

getRoleArn

public String getRoleArn()

Role ARN getter.

Returns:

The role ARN.

getAkid

public String getAkid()

Access key ID getter.

Returns:

The access key ID.

getSkid

public String getSkid()

Secret key ID getter.

Returns:

The secret key ID.

getAWSDeviceFarm

public AWSDeviceFarm getAWSDeviceFarm()

Getter for the Device Farm API.

Returns:

The Device Farm API.

getDescriptor

public AWSDeviceFarmRecorder.DescriptorImpl getDescriptor()

Getter for the Device Farm descriptor.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Recorder

Returns:

The Device Farm descriptor.

getProjectActions

public Collection<hudson.model.Action> getProjectActions(hudson.model.AbstractProject<?,?> project)

Return collection of all Jenkins actions to be attached to this project.

Specified by:

getProjectActions in interface hudson.tasks.BuildStep

Overrides:

getProjectActions in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

project - The AWS Device Farm Jenkins project.

Returns:

The AWS Device Farm project action collection.

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

In a concurrent environment, this MUST run after the has completed.

Returns:

The BuildStepMonitor.