org.jenkinsci.plugins.awsdevicefarm

Class AWSDeviceFarmRecorder.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

org.jenkinsci.plugins.awsdevicefarm.AWSDeviceFarmRecorder.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable, jenkins.util.io.OnMaster

Enclosing class:

AWSDeviceFarmRecorder

@Extension
 @Symbol(value="devicefarm")
public static final class AWSDeviceFarmRecorder.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

Descriptor for AWSDeviceFarmRecorder.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields

Modifier and Type	Field and Description
hudson.util.Secret	akid
String	roleArn
hudson.util.Secret	skid

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DescriptorImpl()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json) Bind descriptor object to capture global plugin settings from 'Manage Jenkins'.
hudson.util.FormValidation	doCheckAppArtifact(Boolean ifWebApp, String appArtifact) Validate the user entered artifact for the application.
hudson.util.FormValidation	doCheckAppiumJavaJUnitTest(String appiumJavaJUnitTest) Validate the user entered artifact for Appium Java jUnit test content.
hudson.util.FormValidation	doCheckAppiumJavaTestNGTest(String appiumJavaTestNGTest) Validate the user entered artifact for Appium Java TestNG test content.
hudson.util.FormValidation	doCheckAppiumNodeTest(String appiumNodeTest) Validate the user entered artifact for Appium Node test content.
hudson.util.FormValidation	doCheckAppiumPythonTest(String appiumPythonTest) Validate the user entered artifact for Appium Python test content.
hudson.util.FormValidation	doCheckAppiumRubyTest(String appiumRubyTest) Validate the user entered artifact for Appium Ruby test content.
hudson.util.FormValidation	doCheckCalabashFeatures(String calabashFeatures) Validate the user entered file path to local Calabash features.
hudson.util.FormValidation	doCheckDevicePoolName(String devicePoolName) Validate the user selected device pool.
hudson.util.FormValidation	doCheckIsRunUnmetered(Boolean isRunUnmetered, String appArtifact, Boolean ifWebApp) Validate if user account has unmetered devices
hudson.util.FormValidation	doCheckJobTimeoutMinutes(Integer jobTimeoutMinutes) Validate the user entered execution time.
hudson.util.FormValidation	doCheckJunitArtifact(String junitArtifact) Validate the user entered artifact for JUnit/Robotium test content.
hudson.util.FormValidation	doCheckProjectName(String projectName) Validate the user selected project.
hudson.util.FormValidation	doCheckUiautomatorArtifact(String uiautomatorArtifact) Validate the user entered artifact for uiautomator.
hudson.util.FormValidation	doCheckXctestArtifact(String xctestArtifact) Validate the user entered artifact for XCTest.
hudson.util.FormValidation	doCheckXctestUiArtifact(String xctestUiArtifact) Validate the user entered artifact for XCTest UI.
hudson.util.ListBoxModel	doFillAppiumVersionJunitItems(String currentAppiumVersion) Populate the project drop-down Appium Version.
hudson.util.ListBoxModel	doFillAppiumVersionPythonItems(String currentAppiumVersion) Populate the project drop-down Appium Version.
hudson.util.ListBoxModel	doFillAppiumVersionTestngItems(String currentAppiumVersion) Populate the project drop-down Appium Version.
hudson.util.ListBoxModel	doFillDevicePoolNameItems(String projectName, String currentDevicePoolName) Populate the device pool drop-down from AWS Device Farm API or local cache.
hudson.util.ListBoxModel	doFillProjectNameItems(String currentProjectName) Populate the project drop-down from the AWS Device Farm API or local cache.
hudson.util.ListBoxModel	doFillTestSpecNameItems(String projectName, String currentTestSpecName) Populate the TestSpec drop-down from AWS Device Farm API or local cache.
hudson.util.ListBoxModel	doFillVpceServiceNameItems(String currentVpceServiceName)
hudson.util.FormValidation	doRefresh() Refresh button clicked, clear the project and device pool caches so the next click on the drop-down will get fresh content from the API.
hudson.util.FormValidation	doValidateCredentials(String roleArn, String akid, String skid) Validates if the credentials provided for the verification are valid or not.
String	fetchSecurityGroupIdsFromProjectName(String projectName) Called from javascript as a proxy.
String	fetchSubnetIdsFromProjectName(String projectName) Called from javascript as a proxy.
String	fetchVpcIdFromProjectName(String projectName) Called from javascript as a proxy.
AWSDeviceFarm	getAWSDeviceFarm() Return configured instance of the AWS Device Farm client.
String	getDisplayName()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)
protected void	setAkid(String akidValue) akid Setter
protected void	setRoleArn(String roleArnValue) roleArn Setter
protected void	setSkid(String skidValue) skid Setter

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

roleArn

public String roleArn

akid

public hudson.util.Secret akid

skid

public hudson.util.Secret skid

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Method Detail

setRoleArn

protected final void setRoleArn(String roleArnValue)

roleArn Setter

Parameters:

roleArnValue -

setAkid

protected final void setAkid(String akidValue)

akid Setter

Parameters:

akidValue -

setSkid

protected final void setSkid(String skidValue)

skid Setter

Parameters:

skidValue -

getAWSDeviceFarm

public AWSDeviceFarm getAWSDeviceFarm()

Return configured instance of the AWS Device Farm client.

Returns:

The AWS Device Farm API object.

doValidateCredentials

public hudson.util.FormValidation doValidateCredentials(@QueryParameter
                                                        String roleArn,
                                                        @QueryParameter
                                                        String akid,
                                                        @QueryParameter
                                                        String skid)

Validates if the credentials provided for the verification are valid or not.

Parameters:

roleArn - the role arn

akid - the access key

skid - the secret key

Returns:

result of the validation

doCheckProjectName

public hudson.util.FormValidation doCheckProjectName(@QueryParameter
                                                     String projectName)

Validate the user selected project.

Parameters:

projectName - The currently selected project name.

Returns:

Whether or not the form was ok.

doCheckDevicePoolName

public hudson.util.FormValidation doCheckDevicePoolName(@QueryParameter
                                                        String devicePoolName)

Validate the user selected device pool.

Parameters:

devicePoolName - The currently selected device pool name.

Returns:

Whether or not the form was ok.

doCheckAppArtifact

public hudson.util.FormValidation doCheckAppArtifact(@QueryParameter
                                                     Boolean ifWebApp,
                                                     @QueryParameter
                                                     String appArtifact)

Validate the user entered artifact for the application.

Parameters:

appArtifact - The String of the application artifact.

Returns:

Whether or not the form was ok.

doCheckAppiumJavaJUnitTest

public hudson.util.FormValidation doCheckAppiumJavaJUnitTest(@QueryParameter
                                                             String appiumJavaJUnitTest)

Validate the user entered artifact for Appium Java jUnit test content.

Parameters:

appiumJavaJUnitTest - The path to the test file.

Returns:

Whether or not the form was ok.

doCheckAppiumJavaTestNGTest

public hudson.util.FormValidation doCheckAppiumJavaTestNGTest(@QueryParameter
                                                              String appiumJavaTestNGTest)

Validate the user entered artifact for Appium Java TestNG test content.

Parameters:

appiumJavaTestNGTest - The path to the test file.

Returns:

Whether or not the form was ok.

doCheckAppiumPythonTest

public hudson.util.FormValidation doCheckAppiumPythonTest(@QueryParameter
                                                          String appiumPythonTest)

Validate the user entered artifact for Appium Python test content.

Parameters:

appiumPythonTest - The path to the test file.

Returns:

Whether or not the form was ok.

doCheckAppiumRubyTest

public hudson.util.FormValidation doCheckAppiumRubyTest(@QueryParameter
                                                        String appiumRubyTest)

Validate the user entered artifact for Appium Ruby test content.

Parameters:

appiumRubyTest - The path to the test file.

Returns:

Whether or not the form was ok.

doCheckAppiumNodeTest

public hudson.util.FormValidation doCheckAppiumNodeTest(@QueryParameter
                                                        String appiumNodeTest)

Validate the user entered artifact for Appium Node test content.

Parameters:

appiumNodeTest - The path to the test file.

Returns:

Whether or not the form was ok.

doCheckCalabashFeatures

public hudson.util.FormValidation doCheckCalabashFeatures(@QueryParameter
                                                          String calabashFeatures)

Validate the user entered file path to local Calabash features.

Parameters:

calabashFeatures - The String of the Calabash features.

Returns:

Whether or not the form was ok.

doCheckJunitArtifact

public hudson.util.FormValidation doCheckJunitArtifact(@QueryParameter
                                                       String junitArtifact)

Validate the user entered artifact for JUnit/Robotium test content.

Parameters:

junitArtifact - The String of the jUnit artifact.

Returns:

Whether or not the form was ok.

doCheckUiautomatorArtifact

public hudson.util.FormValidation doCheckUiautomatorArtifact(@QueryParameter
                                                             String uiautomatorArtifact)

Validate the user entered artifact for uiautomator.

Parameters:

uiautomatorArtifact - The String of the MonkeyTalk artifact.

Returns:

Whether or not the form was ok.

doCheckXctestArtifact

public hudson.util.FormValidation doCheckXctestArtifact(@QueryParameter
                                                        String xctestArtifact)

Validate the user entered artifact for XCTest.

Parameters:

xctestArtifact - The String of the XCTest artifact.

Returns:

Whether or not the form was ok.

doCheckXctestUiArtifact

public hudson.util.FormValidation doCheckXctestUiArtifact(@QueryParameter
                                                          String xctestUiArtifact)

Validate the user entered artifact for XCTest UI.

Parameters:

xctestUiArtifact - The String of the XCTest UI artifact.

Returns:

Whether or not the form was ok.

doCheckIsRunUnmetered

public hudson.util.FormValidation doCheckIsRunUnmetered(@QueryParameter
                                                        Boolean isRunUnmetered,
                                                        @QueryParameter
                                                        String appArtifact,
                                                        @QueryParameter
                                                        Boolean ifWebApp)

Validate if user account has unmetered devices

Parameters:

isRunUnmetered -

appArtifact -

Returns:

Returns whether form validation passed

doCheckJobTimeoutMinutes

public hudson.util.FormValidation doCheckJobTimeoutMinutes(@QueryParameter
                                                           Integer jobTimeoutMinutes)

Validate the user entered execution time.

Parameters:

jobTimeoutMinutes - The Int of the limit execute time the user typed.

Returns:

Whether or not the form was ok.

doRefresh

public hudson.util.FormValidation doRefresh()

Refresh button clicked, clear the project and device pool caches so the next click on the drop-down will get fresh content from the API.

Returns:

Whether or not the form was ok.

doFillProjectNameItems

public hudson.util.ListBoxModel doFillProjectNameItems(@QueryParameter
                                                       String currentProjectName)

Populate the project drop-down from the AWS Device Farm API or local cache.

Returns:

The ListBoxModel for the UI.

doFillVpceServiceNameItems

public hudson.util.ListBoxModel doFillVpceServiceNameItems(@QueryParameter
                                                           String currentVpceServiceName)

doFillDevicePoolNameItems

public hudson.util.ListBoxModel doFillDevicePoolNameItems(@QueryParameter
                                                          String projectName,
                                                          @QueryParameter
                                                          String currentDevicePoolName)

Populate the device pool drop-down from AWS Device Farm API or local cache. based on the selected project.

Parameters:

projectName - Name of the project selected.

currentDevicePoolName - Name of the device pool selected.

Returns:

The ListBoxModel for the UI.

doFillTestSpecNameItems

public hudson.util.ListBoxModel doFillTestSpecNameItems(@QueryParameter
                                                        String projectName,
                                                        @QueryParameter
                                                        String currentTestSpecName)

Populate the TestSpec drop-down from AWS Device Farm API or local cache. based on the selected project.

Parameters:

projectName - Name of the project selected.

currentTestSpecName - Name of the TestSpec selected.

Returns:

The ListBoxModel for the UI.

doFillAppiumVersionJunitItems

public hudson.util.ListBoxModel doFillAppiumVersionJunitItems(@QueryParameter
                                                              String currentAppiumVersion)

Populate the project drop-down Appium Version.

Returns:

The ListBoxModel for the UI.

doFillAppiumVersionTestngItems

public hudson.util.ListBoxModel doFillAppiumVersionTestngItems(@QueryParameter
                                                               String currentAppiumVersion)

Populate the project drop-down Appium Version.

Returns:

The ListBoxModel for the UI.

doFillAppiumVersionPythonItems

public hudson.util.ListBoxModel doFillAppiumVersionPythonItems(@QueryParameter
                                                               String currentAppiumVersion)

Populate the project drop-down Appium Version.

Returns:

The ListBoxModel for the UI.

fetchVpcIdFromProjectName

@JavaScriptMethod
public String fetchVpcIdFromProjectName(String projectName)

Called from javascript as a proxy. Gets vpcId of a project

Returns:

vpcId associated with a project.

fetchSubnetIdsFromProjectName

@JavaScriptMethod
public String fetchSubnetIdsFromProjectName(String projectName)

Called from javascript as a proxy. Gets subnetIds of a project

Returns:

subnetIds associated with a project.

fetchSecurityGroupIdsFromProjectName

@JavaScriptMethod
public String fetchSecurityGroupIdsFromProjectName(String projectName)

Called from javascript as a proxy. Gets securityGroupIds of a project

Returns:

securityGroupIds associated with a project.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)

Bind descriptor object to capture global plugin settings from 'Manage Jenkins'.

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Publisher>

Parameters:

req - The StaplerRequest.

json - The JSON to bind this to.

Returns:

Always true, for whatever reason.

isApplicable

public boolean isApplicable(Class<? extends hudson.model.AbstractProject> jobType)

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Publisher>