hudson.plugins.brakeman

Class BrakemanPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.analysis.core.HealthAwareRecorder

hudson.plugins.analysis.core.HealthAwarePublisher

hudson.plugins.brakeman.BrakemanPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.matrix.MatrixAggregatable, hudson.model.Describable<hudson.tasks.Publisher>, hudson.plugins.analysis.core.HealthDescriptor, hudson.tasks.BuildStep, Serializable, jenkins.tasks.SimpleBuildStep

public class BrakemanPublisher
extends hudson.plugins.analysis.core.HealthAwarePublisher

Publishes the results of the warnings analysis (freestyle project type).

Author:

Maximilian Odendahl

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrakemanPublisher.FileType Enum for possible file types for brakeman output

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

Field Summary

Fields

Modifier and Type	Field and Description
static BrakemanDescriptor	BRAKEMAN_DESCRIPTOR Descriptor of this publisher.
String	outputFile

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
BrakemanPublisher(String outputFile) Creates a new instance of BrakemanPublisher
BrakemanPublisher(String healthy, String unHealthy, String thresholdLimit, boolean useDeltaValues, String unstableTotalAll, String unstableTotalHigh, String unstableTotalNormal, String unstableTotalLow, String unstableNewAll, String unstableNewHigh, String unstableNewNormal, String unstableNewLow, String failedTotalAll, String failedTotalHigh, String failedTotalNormal, String failedTotalLow, String failedNewAll, String failedNewHigh, String failedNewNormal, String failedNewLow, boolean canRunOnFailed, boolean shouldDetectModules, boolean canComputeNew, String outputFile) Deprecated. prefer setters from the base class

Method Summary

Modifier and Type	Method and Description
protected boolean	canContinue(hudson.model.Result result)
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
protected AbstractBrakemanScanner	createScanner(String outputContent) Determines the type of Scanner to use.
hudson.plugins.analysis.core.PluginDescriptor	getDescriptor()
protected BrakemanPublisher.FileType	getFileType(String content) Determines the file type based upon the contents.
hudson.plugins.analysis.core.BuildResult	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.plugins.analysis.util.PluginLogger logger)
hudson.plugins.analysis.core.BuildResult	publishReport(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.plugins.analysis.util.PluginLogger logger)
protected Object	readResolve() Creates a new parser set for old versions of this class.

Methods inherited from class hudson.plugins.analysis.core.HealthAwarePublisher

perform, perform, updateBuildResult

Methods inherited from class hudson.plugins.analysis.core.HealthAwareRecorder

canComputeNew, canResolveRelativePaths, copyFilesWithAnnotationsToBuildFolder, expandFilePattern, getCanComputeNew, getCanResolveRelativePaths, getCanRunOnFailed, getDefaultEncoding, getFailedNewAll, getFailedNewHigh, getFailedNewLow, getFailedNewNormal, getFailedTotalAll, getFailedTotalHigh, getFailedTotalLow, getFailedTotalNormal, getHealthy, getMinimumPriority, getProjectActions, getRequiredMonitorService, getShouldDetectModules, getThresholdLimit, getThresholds, getUnHealthy, getUnstableNewAll, getUnstableNewHigh, getUnstableNewLow, getUnstableNewNormal, getUnstableTotalAll, getUnstableTotalHigh, getUnstableTotalLow, getUnstableTotalNormal, getUseDeltaValues, getUsePreviousBuildAsReference, getUseStableBuildAsReference, isAntBuild, isMavenBuild, isMavenBuild, isThresholdEnabled, perform, setCanComputeNew, setCanResolveRelativePaths, setCanRunOnFailed, setDefaultEncoding, setFailedNewAll, setFailedNewHigh, setFailedNewLow, setFailedNewNormal, setFailedTotalAll, setFailedTotalHigh, setFailedTotalLow, setFailedTotalNormal, setHealthy, setShouldDetectModules, setThresholdLimit, setUnHealthy, setUnstableNewAll, setUnstableNewHigh, setUnstableNewLow, setUnstableNewNormal, setUnstableTotalAll, setUnstableTotalHigh, setUnstableTotalLow, setUnstableTotalNormal, setUseDeltaValues, setUsePreviousBuildAsReference, setUseStableBuildAsReference, shouldDetectModules, useOnlyStableBuildsAsReference, usePreviousBuildAsReference

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

Field Detail

BRAKEMAN_DESCRIPTOR

@Extension
public static final BrakemanDescriptor BRAKEMAN_DESCRIPTOR

Descriptor of this publisher.

outputFile

public String outputFile

Constructor Detail

BrakemanPublisher

@DataBoundConstructor
public BrakemanPublisher(String outputFile)

Creates a new instance of BrakemanPublisher

Parameters:

outputFile - Workspace path to Brakeman output

BrakemanPublisher

@Deprecated
public BrakemanPublisher(String healthy,
                                     String unHealthy,
                                     String thresholdLimit,
                                     boolean useDeltaValues,
                                     String unstableTotalAll,
                                     String unstableTotalHigh,
                                     String unstableTotalNormal,
                                     String unstableTotalLow,
                                     String unstableNewAll,
                                     String unstableNewHigh,
                                     String unstableNewNormal,
                                     String unstableNewLow,
                                     String failedTotalAll,
                                     String failedTotalHigh,
                                     String failedTotalNormal,
                                     String failedTotalLow,
                                     String failedNewAll,
                                     String failedNewHigh,
                                     String failedNewNormal,
                                     String failedNewLow,
                                     boolean canRunOnFailed,
                                     boolean shouldDetectModules,
                                     boolean canComputeNew,
                                     String outputFile)

Deprecated. prefer setters from the base class

Creates a new instance of BrakemanPublisher.

Method Detail

readResolve

protected Object readResolve()

Creates a new parser set for old versions of this class.

Overrides:

readResolve in class hudson.plugins.analysis.core.HealthAwareRecorder

Returns:

this

perform

public hudson.plugins.analysis.core.BuildResult perform(hudson.model.Run<?,?> build,
                                                        hudson.FilePath workspace,
                                                        hudson.plugins.analysis.util.PluginLogger logger)
                                                 throws InterruptedException,
                                                        IOException

Overrides:

perform in class hudson.plugins.analysis.core.HealthAwarePublisher

Throws:

InterruptedException

IOException

publishReport

public hudson.plugins.analysis.core.BuildResult publishReport(hudson.model.Run<?,?> build,
                                                              hudson.FilePath workspace,
                                                              hudson.plugins.analysis.util.PluginLogger logger)
                                                       throws InterruptedException,
                                                              IOException

Throws:

InterruptedException

IOException

createScanner

protected AbstractBrakemanScanner createScanner(String outputContent)

Determines the type of Scanner to use.

Parameters:

outputContent -

Returns:

scanner

getFileType

protected BrakemanPublisher.FileType getFileType(String content)

Determines the file type based upon the contents.

Parameters:

content -

Returns:

result

getDescriptor

public hudson.plugins.analysis.core.PluginDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.plugins.analysis.core.HealthAwareRecorder

canContinue

protected boolean canContinue(hudson.model.Result result)

Overrides:

canContinue in class hudson.plugins.analysis.core.HealthAwareRecorder

createAggregator

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