com.ibm.devops.dra

Class EvaluateGate

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.ibm.devops.dra.AbstractDevOpsAction

com.ibm.devops.dra.EvaluateGate

All Implemented Interfaces:

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

public class EvaluateGate
extends AbstractDevOpsAction
implements jenkins.tasks.SimpleBuildStep

Customized build step to get a gate decision from DRA backend

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvaluateGate.EvaluateGateImpl Descriptor for EvaluateGate.
static class	EvaluateGate.OptionalBuildInfo

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 inherited from class com.ibm.devops.dra.AbstractDevOpsAction

API_KEY, APP_NAME, CONTROL_CENTER, DEFAULT_ENV, DLMS, ENV, GATE_SERVICE, LOGGER, PASSWORD, RESULT_FAIL, RESULT_SUCCESS, TOOLCHAIN_ID, USERNAME

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
EvaluateGate(HashMap<String,String> envVarsMap, String policyName, String environmentName, boolean willDisrupt)
EvaluateGate(String policyName, String applicationName, String toolchainName, String buildJobName, String credentialsId, boolean willDisrupt, EnvironmentScope scope, EvaluateGate.OptionalBuildInfo additionalBuildInfo)

Method Summary

Modifier and Type	Method and Description
String	getApplicationName()
String	getBuildJobName()
String	getBuildNumber()
String	getCredentialsId()
EvaluateGate.EvaluateGateImpl	getDescriptor()
String	getEnvName()
String	getPolicyName() We'll use this from the config.jelly.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
EnvironmentScope	getScope()
String	getToolchainName()
boolean	isDeploy()
boolean	isWillDisrupt()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath filePath, hudson.Launcher launcher, hudson.model.TaskListener listener) Override this method to get your operation done in the build step.
void	setApplicationName(String applicationName)
void	setBuildNumber(String buildNumber)

Methods inherited from class com.ibm.devops.dra.AbstractDevOpsAction

chooseAppsUrl, chooseIAMAPI, chooseOrganizationsUrl, chooseSpacesUrl, chooseTargetAPI, constructBuildNumber, expandVariable, getAllEndpoints, getAppId, getBluemixToken, getBuildNumber, getDecisionFromDRA, getDeploymentRiskUrl, getIAMToken, getIBMCloudToken, getOrgId, getOTCBrokerServer, getPolicyList, getReportUrl, getSpaceId, getTokenForFreeStyleJob, passEnvToNextBuildStep, printDebugLog, publishDecision, setDLMSUrl, setGateServiceUrl, setRequiredEnvVars

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

Constructor Detail

EvaluateGate

@DataBoundConstructor
public EvaluateGate(String policyName,
                                          String applicationName,
                                          String toolchainName,
                                          String buildJobName,
                                          String credentialsId,
                                          boolean willDisrupt,
                                          EnvironmentScope scope,
                                          EvaluateGate.OptionalBuildInfo additionalBuildInfo)

EvaluateGate

public EvaluateGate(HashMap<String,String> envVarsMap,
                    String policyName,
                    String environmentName,
                    boolean willDisrupt)

Method Detail

setBuildNumber

public void setBuildNumber(String buildNumber)

setApplicationName

@DataBoundSetter
public void setApplicationName(String applicationName)

getPolicyName

public String getPolicyName()

We'll use this from the config.jelly.

getBuildJobName

public String getBuildJobName()

getApplicationName

public String getApplicationName()

getToolchainName

public String getToolchainName()

getCredentialsId

public String getCredentialsId()

isWillDisrupt

public boolean isWillDisrupt()

getScope

public EnvironmentScope getScope()

getBuildNumber

public String getBuildNumber()

getEnvName

public String getEnvName()

isDeploy

public boolean isDeploy()

perform

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

Override this method to get your operation done in the build step. When invoked, it is up to you, as a plugin developer to add your actions, and/or perform the operations required by your plugin in this build step. Equally, it is up to the developer to make the code run on the slave(master or an actual remote). This must be done given the builds workspace, as in build.getWorkspace(). The workspace is the link to the slave, as it is the representation of the remote file system. Build steps as you add them to your job configuration are executed sequentially, and the return value for your builder should indicate whether to execute the next build step in the list.

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Parameters:

build - - the current build

launcher - - the launcher

listener - - the build listener

Throws:

hudson.AbortException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getDescriptor

public EvaluateGate.EvaluateGateImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Recorder