hudson.plugins.cmake

Class AbstractToolStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

hudson.plugins.cmake.AbstractStep

hudson.plugins.cmake.AbstractToolStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable

Direct Known Subclasses:

CMakeStep, CPackStep, CTestStep

public class AbstractToolStep
extends AbstractStep

Provides a pipeline build step that allows to invoke selected tools of the cmake-suite (cmake, cpack and ctest) with arbitrary arguments.
Similar to CToolBuilder, but pipeline compatible.
NOTE: Actually, this class is NOT abstract, but we want to re-use the @DataBoundSetter methods defined here.

Author:

Martin Weber

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractToolStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AbstractToolStep(String installation) Minimal constructor.

Method Summary

Modifier and Type	Method and Description
String	getArguments()
String	getIgnoredExitCodes() Gets the exit codes of the tool that indicate a failure but should be ignored, thus causing the build to proceed.
String	getWorkingDir()
void	setArguments(String toolArgs)
void	setIgnoredExitCodes(String ignoredExitCodes)
void	setWorkingDir(String workingDir)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context) Implemented to just add the label string to the build log.

Methods inherited from class hudson.plugins.cmake.AbstractStep

getCommandBasename, getInstallation, getLabel, getSelectedInstallation, setLabel

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractToolStep

@DataBoundConstructor
public AbstractToolStep(String installation)

Minimal constructor.

Parameters:

installation - the name of the cmake tool installation from the global config page.

Method Detail

getIgnoredExitCodes

public String getIgnoredExitCodes()

Gets the exit codes of the tool that indicate a failure but should be ignored, thus causing the build to proceed.

Returns:

the ignoredExitCodes property value or null

setIgnoredExitCodes

@DataBoundSetter
public void setIgnoredExitCodes(String ignoredExitCodes)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Description copied from class: AbstractStep

Implemented to just add the label string to the build log.
Sub-classes should override and call super.

Overrides:

start in class AbstractStep

Returns:

always null

Throws:

Exception

setWorkingDir

@DataBoundSetter
public void setWorkingDir(String workingDir)

getWorkingDir

public String getWorkingDir()

setArguments

@DataBoundSetter
public void setArguments(String toolArgs)

getArguments

public String getArguments()