io.plugins.perfecto

Class PerfectoBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<BuildWrapper>

hudson.tasks.BuildWrapper

io.plugins.perfecto.PerfectoBuildWrapper

All Implemented Interfaces:

ExtensionPoint, Describable<BuildWrapper>, Serializable

public class PerfectoBuildWrapper
extends BuildWrapper
implements Serializable

BuildWrapper that sets up the Perfecto connect tunnel and populates environment variable.

Author:

Dushyantan Satike, Genesis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PerfectoBuildWrapper.DescriptorImpl
static class	PerfectoBuildWrapper.ItemListenerImpl

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

BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	ENVIRONMENT_VARIABLE_PATTERN
static String	PERFECTO_CLOUD_NAME Environment variable key which contains the Perfecto Cloud name.
static String	PERFECTO_SECURITY_TOKEN Environment variable key which contains the Perfecto Security token.

Constructor Summary

Constructors

Constructor and Description
PerfectoBuildWrapper(org.jenkins_ci.plugins.run_condition.RunCondition condition, String credentialId, String tunnelIdCustomName, String pcParameters, String perfectoConnectLocation, String perfectoSecurityToken, String perfectoConnectFile, String reuseTunnelId) Constructs a new instance using data entered on the job configuration screen.

Method Summary

Modifier and Type	Method and Description
org.jenkins_ci.plugins.run_condition.RunCondition	getCondition()
String	getCredentialId()
String	getPcParameters()
String	getPerfectoConnectFile()
String	getPerfectoConnectLocation()
String	getSecurityToken()
String	getTunnelIdCustomName()
boolean	isEnablePerfectoConnect()
void	makeSensitiveBuildVariables(AbstractBuild build, Set<String> sensitiveVariables)
protected boolean	migrateCredentials(AbstractProject project)
void	setCredentialId(String credentialId)
void	setEnablePerfectoConnect(boolean enablePerfectoConnect)
void	setPcParameters(String pcParameters)
void	setPerfectoConnectFile(String perfectoConnectFile)
void	setPerfectoConnectLocation(String perfectoConnectLocation)
void	setSecurityToken(String perfectoSecurityToken)
void	setTunnelIdCustomName(String tunnelIdCustomName)
BuildWrapper.Environment	setUp(AbstractBuild build, Launcher launcher, BuildListener listener) Invoked prior to the running of a Jenkins build.

Methods inherited from class hudson.tasks.BuildWrapper

all, decorateLauncher, decorateLogger, getProjectAction, getProjectActions, makeBuildVariables, preCheckout, setUp

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

PERFECTO_SECURITY_TOKEN

public static final String PERFECTO_SECURITY_TOKEN

Environment variable key which contains the Perfecto Security token.

See Also:

Constant Field Values

PERFECTO_CLOUD_NAME

public static final String PERFECTO_CLOUD_NAME

Environment variable key which contains the Perfecto Cloud name.

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_PATTERN

public static final Pattern ENVIRONMENT_VARIABLE_PATTERN

Constructor Detail

PerfectoBuildWrapper

@DataBoundConstructor
public PerfectoBuildWrapper(org.jenkins_ci.plugins.run_condition.RunCondition condition,
                                                  String credentialId,
                                                  String tunnelIdCustomName,
                                                  String pcParameters,
                                                  String perfectoConnectLocation,
                                                  String perfectoSecurityToken,
                                                  String perfectoConnectFile,
                                                  String reuseTunnelId)

Constructs a new instance using data entered on the job configuration screen.

Parameters:

condition - allows users to define rules which enable Perfecto Connect

credentialId - Which credential a build should use

tunnelIdCustomName - Custom value for tunnel Id environment variable name.

pcParameters - Perfecto Connect parameters

perfectoConnectLocation - Perfecto connect location

perfectoSecurityToken - Perfecto Security token.

perfectoConnectFile - Perfecto connect file name.

reuseTunnelId - Tunnel ID to reuse.

Method Detail

makeSensitiveBuildVariables

public void makeSensitiveBuildVariables(AbstractBuild build,
                                        Set<String> sensitiveVariables)

Overrides:

makeSensitiveBuildVariables in class BuildWrapper

setUp

public BuildWrapper.Environment setUp(AbstractBuild build,
                                      Launcher launcher,
                                      BuildListener listener)
                               throws IOException,
                                      InterruptedException

Invoked prior to the running of a Jenkins build. Populates the Perfecto specific environment variables and launches Perfecto Connect.

Overrides:

setUp in class BuildWrapper

Returns:

a new Environment instance populated with the Perfecto environment variables

Throws:

IOException

InterruptedException

isEnablePerfectoConnect

public boolean isEnablePerfectoConnect()

setEnablePerfectoConnect

public void setEnablePerfectoConnect(boolean enablePerfectoConnect)

getTunnelIdCustomName

public String getTunnelIdCustomName()

setTunnelIdCustomName

public void setTunnelIdCustomName(String tunnelIdCustomName)

getPerfectoConnectFile

public String getPerfectoConnectFile()

setPerfectoConnectFile

public void setPerfectoConnectFile(String perfectoConnectFile)

getPerfectoConnectLocation

public String getPerfectoConnectLocation()

setPerfectoConnectLocation

public void setPerfectoConnectLocation(String perfectoConnectLocation)

getSecurityToken

public String getSecurityToken()

setSecurityToken

public void setSecurityToken(String perfectoSecurityToken)

getCondition

public org.jenkins_ci.plugins.run_condition.RunCondition getCondition()

getCredentialId

public String getCredentialId()

setCredentialId

public void setCredentialId(String credentialId)

getPcParameters

public String getPcParameters()

setPcParameters

public void setPcParameters(String pcParameters)

migrateCredentials

protected boolean migrateCredentials(AbstractProject project)