com.lookout.jenkins

Class EnvironmentScript

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

hudson.tasks.BuildWrapper

com.lookout.jenkins.EnvironmentScript

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.matrix.MatrixAggregatable, hudson.model.Describable<hudson.tasks.BuildWrapper>

public class EnvironmentScript
extends hudson.tasks.BuildWrapper
implements hudson.matrix.MatrixAggregatable

Runs a specific chunk of code before each build, parsing output for new environment variables.

Author:

Jørgen P. Tjernø, dawidmalina@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentScript.EnvironmentScriptDescriptor Descriptor for EnvironmentScript.

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

hudson.tasks.BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
EnvironmentScript(String script, String scriptType, boolean runOnlyOnParent, boolean hideEnvironmentVariablesValues)

Method Summary

Modifier and Type	Method and Description
String[]	buildCommandLine(hudson.FilePath scriptFile)
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) Create an aggregator that will calculate the environment once if onlyRunOnParent is true.
hudson.model.Descriptor<hudson.tasks.BuildWrapper>	getDescriptor()
String	getScript() We'll use this from the config.jelly.
String	getScriptType() We will use this from the config.jelly.
boolean	isHideEnvironmentVariablesValues()
boolean	isRunOnlyOnParent()
hudson.tasks.BuildWrapper.Environment	setUp(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.BuildWrapper

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentScript

@DataBoundConstructor
public EnvironmentScript(String script,
                                               String scriptType,
                                               boolean runOnlyOnParent,
                                               boolean hideEnvironmentVariablesValues)

Method Detail

getScript

public String getScript()

We'll use this from the config.jelly.

getScriptType

public String getScriptType()

We will use this from the config.jelly.

Returns:

isRunOnlyOnParent

public boolean isRunOnlyOnParent()

Returns:

Whether or not we only run this on the MatrixBuild parent, or on the individual MatrixRun s.

isHideEnvironmentVariablesValues

public boolean isHideEnvironmentVariablesValues()

setUp

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

Overrides:

setUp in class hudson.tasks.BuildWrapper

Throws:

IOException

InterruptedException

buildCommandLine

public String[] buildCommandLine(hudson.FilePath scriptFile)

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                                       hudson.Launcher launcher,
                                                       hudson.model.BuildListener listener)

Create an aggregator that will calculate the environment once if onlyRunOnParent is true. The aggregator we return is called on the parent job for matrix jobs. In it we generate the environment once and persist it in an Action (of type PersistedEnvironment) if the job has onlyRunOnParent enabled. The subjobs ("configuration runs") will retrieve this and apply it to their environment, without performing the calculation.

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable

getDescriptor

public hudson.model.Descriptor<hudson.tasks.BuildWrapper> getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>