Package io.jenkins.plugins.armorcode

Class ArmorCodeReleaseGateBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.armorcode.ArmorCodeReleaseGateBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class ArmorCodeReleaseGateBuilder
extends Builder
implements SimpleBuildStep

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArmorCodeReleaseGateBuilder.DescriptorImpl	Descriptor that tells Jenkins how to display and instantiate this step.

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ArmorCodeReleaseGateBuilder(String product, Object subProducts, String env)	Required constructor parameters.

Method Summary

Modifier and Type	Method	Description
String	getEnv()
int	getMaxRetries()
String	getMode()
String	getProduct()
BuildStepMonitor	getRequiredMonitorService()
int	getRetryDelay()
Object	getSubProducts()
String	getTargetUrl()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)	Executes the release gate check.
protected String	postArmorCodeRequest(TaskListener listener, String token, String buildNumber, String jobName, int current, int end, String apiUrl, String jobUrl)	Sends a POST request to ArmorCode's build validation endpoint with the given parameters, then returns the raw JSON response.
void	setMaxRetries(int maxRetries)	Optional parameter: how many times to retry the validation check.
void	setMode(String mode)	Optional parameter: "block" or "warn" mode.
void	setRetryDelay(int retryDelay)
void	setTargetUrl(String targetUrl)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

ArmorCodeReleaseGateBuilder

@DataBoundConstructor
public ArmorCodeReleaseGateBuilder(String product,
 Object subProducts,
 String env)

Required constructor parameters.

Parameters:

product - The ArmorCode product (group) ID.

subProducts - The ArmorCode sub-product (subgroup) ID.

env - The environment (e.g. "Production", "Staging").

Method Details

setTargetUrl

@DataBoundSetter
public void setTargetUrl(String targetUrl)

setMaxRetries

@DataBoundSetter
public void setMaxRetries(int maxRetries)

Optional parameter: how many times to retry the validation check.

Parameters:

maxRetries - The maximum number of retries (default 30).

setMode

@DataBoundSetter
public void setMode(String mode)

Optional parameter: "block" or "warn" mode. - "block" (default) fails the build on SLA failure. - "warn" marks the build UNSTABLE but continues.

Parameters:

mode - The validation mode ("block" or "warn").

getProduct

public String getProduct()

getSubProducts

public Object getSubProducts()

getEnv

public String getEnv()

getMaxRetries

public int getMaxRetries()

getMode

public String getMode()

getTargetUrl

public String getTargetUrl()

setRetryDelay

@DataBoundSetter
public void setRetryDelay(int retryDelay)

getRetryDelay

public int getRetryDelay()

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath workspace,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
AbortException

Executes the release gate check. Polls ArmorCode up to maxRetries times, parsing the status each time. Depending on the mode, the build either fails or continues if an SLA violation is found.

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

AbortException

postArmorCodeRequest

protected String postArmorCodeRequest(@NonNull
 TaskListener listener,
 String token,
 String buildNumber,
 String jobName,
 int current,
 int end,
 String apiUrl,
 String jobUrl)
                               throws Exception

Sends a POST request to ArmorCode's build validation endpoint with the given parameters, then returns the raw JSON response.

Throws:

Exception

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

Overrides:

getRequiredMonitorService in class Builder