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, jenkins.tasks.SimpleBuildStep

public class AWSDeviceFarmRecorder
extends hudson.tasks.Recorder
implements jenkins.tasks.SimpleBuildStep

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 jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	appArtifact
String	appiumJavaJUnitTest
String	appiumJavaTestNGTest
String	appiumNodeTest
String	appiumPythonTest
String	appiumRubyTest
String	appiumVersionJunit
String	appiumVersionPython
String	appiumVersionTestng
Boolean	archiveResults
String	calabashFeatures
String	calabashProfile
String	calabashTags
Double	deviceLatitude
Boolean	deviceLocation
Double	deviceLongitude
String	devicePoolName
String	deviceSelectionFilters
String	environmentToRun
String	eventCount
String	eventThrottle
Boolean	extraData
String	extraDataArtifact
Boolean	ifAppPerformanceMonitoring
Boolean	ifBluetooth
Boolean	ifGPS
Boolean	ifNfc
Boolean	ifSkipAppResigning
Boolean	ifVideoRecording
Boolean	ifVpce
Boolean	ifWebApp
Boolean	ifWifi
Boolean	ignoreRunError
Boolean	isRunUnmetered
Integer	jobTimeoutMinutes
String	junitArtifact
String	junitFilter
Integer	maxDevicesForDeviceFilters
String	password
String	projectName
Boolean	radioDetails
String	resultsPath
String	runName
String	seed
Boolean	storeResults
String	testSpecName
String	testToRun
String	uiautomationArtifact
String	uiautomatorArtifact
String	uiautomatorFilter
String	username
String	vpceServiceName
String	xctestArtifact
String	xctestFilter
String	xctestUiArtifact
String	xctestUiFilter

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

AWSDeviceFarmRecorder(String projectName, String devicePoolName, String testSpecName, String environmentToRun, String appArtifact, String runName, String testToRun, Boolean storeResults, String resultsPath, Boolean archiveResults, Boolean isRunUnmetered, String eventCount, String eventThrottle, String seed, String username, String password, String appiumJavaJUnitTest, String appiumJavaTestNGTest, String appiumPythonTest, String appiumRubyTest, String appiumNodeTest, String calabashFeatures, String calabashTags, String calabashProfile, String junitArtifact, String junitFilter, String uiautomatorArtifact, String uiautomatorFilter, String uiautomationArtifact, String xctestArtifact, String xctestFilter, String xctestUiArtifact, String xctestUiFilter, String appiumVersionJunit, String appiumVersionPython, String appiumVersionTestng, Boolean ifWebApp, Boolean extraData, String extraDataArtifact, Boolean deviceLocation, Double deviceLatitude, Double deviceLongitude, Boolean radioDetails, Boolean ifBluetooth, Boolean ifWifi, Boolean ifGPS, Boolean ifNfc, Integer jobTimeoutMinutes, Boolean ifVideoRecording, Boolean ifAppPerformanceMonitoring, Boolean ignoreRunError, Boolean ifVpce, Boolean ifSkipAppResigning, String vpceServiceName, String deviceSelectionFilters, Integer maxDevicesForDeviceFilters) The Device Farm recorder class for running post-build steps on Jenkins.

Method Summary

Modifier and Type	Method and Description
Boolean	accountHasVPC()
hudson.util.Secret	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	getSecurityGroupString() Gets string representing security groups for textbox
hudson.util.Secret	getSkid() Secret key ID getter.
String	getSubnetString() Gets string representing subnet ids for textbox
String	getVpcString() Gets vpcId for textbox
String	isCustomEnvironment(String environmentToRun) Test if the environment selected by Customer is 'Custom' (for marking the radio button).
String	isStandardEnvironment(String environmentToRun) Test if the environment selected by Customer is 'Standard' (for marking the radio button).
String	isTestType(String testTypeName) Test if the test type names match (for marking the radio button).
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Perform the post-build test action.
String	transformTestToRunForWebApp(String testToRun) Transform the test type parameter as the requirement for AWS devicefarm API for appium tests of web apps.

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, perform, 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, perform, prebuild

Field Detail

projectName

public String projectName

devicePoolName

public String devicePoolName

appArtifact

public String appArtifact

runName

public String runName

testToRun

public String testToRun

testSpecName

public String testSpecName

environmentToRun

public String environmentToRun

storeResults

public Boolean storeResults

resultsPath

public String resultsPath

archiveResults

public Boolean archiveResults

isRunUnmetered

public Boolean isRunUnmetered

eventCount

public String eventCount

eventThrottle

public String eventThrottle

seed

public String seed

username

public String username

password

public String password

appiumJavaJUnitTest

public String appiumJavaJUnitTest

appiumJavaTestNGTest

public String appiumJavaTestNGTest

appiumPythonTest

public String appiumPythonTest

appiumRubyTest

public String appiumRubyTest

appiumNodeTest

public String appiumNodeTest

calabashFeatures

public String calabashFeatures

calabashTags

public String calabashTags

calabashProfile

public String calabashProfile

junitArtifact

public String junitArtifact

junitFilter

public String junitFilter

uiautomatorArtifact

public String uiautomatorArtifact

uiautomatorFilter

public String uiautomatorFilter

uiautomationArtifact

public String uiautomationArtifact

xctestArtifact

public String xctestArtifact

xctestFilter

public String xctestFilter

xctestUiArtifact

public String xctestUiArtifact

xctestUiFilter

public String xctestUiFilter

ignoreRunError

public Boolean ignoreRunError

ifWebApp

public Boolean ifWebApp

appiumVersionJunit

public String appiumVersionJunit

appiumVersionPython

public String appiumVersionPython

appiumVersionTestng

public String appiumVersionTestng

extraData

public Boolean extraData

extraDataArtifact

public String extraDataArtifact

vpceServiceName

public String vpceServiceName

ifVpce

public Boolean ifVpce

deviceLocation

public Boolean deviceLocation

deviceLatitude

public Double deviceLatitude

deviceLongitude

public Double deviceLongitude

radioDetails

public Boolean radioDetails

ifWifi

public Boolean ifWifi

ifGPS

public Boolean ifGPS

ifNfc

public Boolean ifNfc

ifBluetooth

public Boolean ifBluetooth

jobTimeoutMinutes

public Integer jobTimeoutMinutes

ifVideoRecording

public Boolean ifVideoRecording

ifAppPerformanceMonitoring

public Boolean ifAppPerformanceMonitoring

ifSkipAppResigning

public Boolean ifSkipAppResigning

deviceSelectionFilters

public String deviceSelectionFilters

maxDevicesForDeviceFilters

public Integer maxDevicesForDeviceFilters

Constructor Detail

AWSDeviceFarmRecorder

@DataBoundConstructor
public AWSDeviceFarmRecorder(String projectName,
                                                   String devicePoolName,
                                                   String testSpecName,
                                                   String environmentToRun,
                                                   String appArtifact,
                                                   String runName,
                                                   @Nonnull
                                                   String testToRun,
                                                   Boolean storeResults,
                                                   String resultsPath,
                                                   Boolean archiveResults,
                                                   Boolean isRunUnmetered,
                                                   String eventCount,
                                                   String eventThrottle,
                                                   String seed,
                                                   String username,
                                                   String password,
                                                   String appiumJavaJUnitTest,
                                                   String appiumJavaTestNGTest,
                                                   String appiumPythonTest,
                                                   String appiumRubyTest,
                                                   String appiumNodeTest,
                                                   String calabashFeatures,
                                                   String calabashTags,
                                                   String calabashProfile,
                                                   String junitArtifact,
                                                   String junitFilter,
                                                   String uiautomatorArtifact,
                                                   String uiautomatorFilter,
                                                   String uiautomationArtifact,
                                                   String xctestArtifact,
                                                   String xctestFilter,
                                                   String xctestUiArtifact,
                                                   String xctestUiFilter,
                                                   String appiumVersionJunit,
                                                   String appiumVersionPython,
                                                   String appiumVersionTestng,
                                                   Boolean ifWebApp,
                                                   Boolean extraData,
                                                   String extraDataArtifact,
                                                   Boolean deviceLocation,
                                                   Double deviceLatitude,
                                                   Double deviceLongitude,
                                                   Boolean radioDetails,
                                                   Boolean ifBluetooth,
                                                   Boolean ifWifi,
                                                   Boolean ifGPS,
                                                   Boolean ifNfc,
                                                   Integer jobTimeoutMinutes,
                                                   Boolean ifVideoRecording,
                                                   Boolean ifAppPerformanceMonitoring,
                                                   Boolean ignoreRunError,
                                                   Boolean ifVpce,
                                                   Boolean ifSkipAppResigning,
                                                   String vpceServiceName,
                                                   String deviceSelectionFilters,
                                                   Integer maxDevicesForDeviceFilters)

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.

testSpecName - The Name of the Device Farm TestSpec Upload.

environmentToRun - The type of environment used to run the tests.

appArtifact - The path to the app to be tested.

runName - The name of the run.

testToRun - The type of test to be run.

storeResults - Download the results to a local archive.

resultsPath - Path to where the results will be saved to.

archiveResults - Whether to save results directly to the artifacts folder, saving them as build artifacts, or use the workspace folder.

eventCount - The number of fuzz events to run.

eventThrottle - The fuzz event throttle count.

seed - The initial seed of fuzz events.

username - Username to use if explorer encounters a login form.

password - Password to use if explorer encounters a login form.

appiumJavaJUnitTest - The path to the Appium Java Junit tests.

appiumJavaTestNGTest - The path to the Appium Java tests.

appiumPythonTest - The path to the Appium python tests.

appiumRubyTest - The path to the Appium Ruby tests.

appiumNodeTest - The path to the Appium Node tests.

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

calabashTags - Calabash tags to attach to the test.

calabashProfile - Calabash Profile 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 - The filter to apply to the UI Automator tests.

uiautomationArtifact - The path to the UI Automation tests to be run.

xctestArtifact - The path to the XCTest tests to be run.

xctestFilter - The filter to apply to the XCTest tests.

xctestUiArtifact - The path to the XCTest UI tests to be run.

xctestUiFilter - The filter to apply to the XCTest UI tests.

appiumVersionJunit - The version of the Appium used for Appium Junit tests.

appiumVersionPython - The version of the Appium used for Appium Python tests.

appiumVersionTestng - The version of the Appium used for Appium Testing tests.

ifWebApp - Whether it is a web app.

extraData - Whether it has extra data.

extraDataArtifact - The path to the extra data.

vpceServiceName - The name of the VPCE configuration.

deviceLocation - True when device location is specified.

deviceLatitude - The specified device latitude.

deviceLongitude - The specified device longitude.

ifVpce - Checked if VPCE config is enabled.

radioDetails - Whether the radio details would be specified.

ifWifi -

ifNfc -

ifGPS -

ifBluetooth -

jobTimeoutMinutes - The max execution time per job.

ifAppPerformanceMonitoring - Whether the performance would be monitored.

ifVideoRecording - Whether the video would be recorded.

deviceSelectionFilters - The device selection filter.

maxDevicesForDeviceFilters - The max number of devices to be selected.

Method Detail

transformTestToRunForWebApp

public String transformTestToRunForWebApp(@Nonnull
                                          String testToRun)

Transform the test type parameter as the requirement for AWS devicefarm API for appium tests of web apps.

Parameters:

testToRun - The String representation of the test type.

Returns:

The String should bu input as the parameter of the devicefarm API.

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.

isStandardEnvironment

public String isStandardEnvironment(String environmentToRun)

Test if the environment selected by Customer is 'Standard' (for marking the radio button).

Parameters:

environmentToRun - The String representation of the environment.

Returns:

Whether or not the test type string matches.

isCustomEnvironment

public String isCustomEnvironment(String environmentToRun)

Test if the environment selected by Customer is 'Custom' (for marking the radio button).

Parameters:

environmentToRun - The String representation of the environment.

Returns:

Whether or not the test type string matches.

accountHasVPC

public Boolean accountHasVPC()

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> build,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws IOException,
                    InterruptedException

Perform the post-build test action.

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Parameters:

build - The build to follow.

launcher - The launcher.

listener - The build launcher.

Throws:

IOException

InterruptedException

getRoleArn

public String getRoleArn()

Role ARN getter.

Returns:

The role ARN.

getVpcString

public String getVpcString()

Gets vpcId for textbox

Returns:

The role ARN.

getSubnetString

public String getSubnetString()

Gets string representing subnet ids for textbox

Returns:

The role ARN.

getSecurityGroupString

public String getSecurityGroupString()

Gets string representing security groups for textbox

Returns:

The role ARN.

getAkid

public hudson.util.Secret getAkid()

Access key ID getter.

Returns:

The access key ID.

getSkid

public hudson.util.Secret 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.

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

Returns:

The BuildStepMonitor.