Class IssuesRecorder
java.lang.Object
hudson.tasks.BuildStepCompatibilityLayer
hudson.tasks.Publisher
hudson.tasks.Recorder
io.jenkins.plugins.analysis.core.steps.IssuesRecorder
- All Implemented Interfaces:
ExtensionPoint
,Describable<Publisher>
,BuildStep
Freestyle or Maven job
Recorder
that scans report files or the console log for issues. Stores the created
issues in an AnalysisResult
. The result is attached to a Run
by registering a ResultAction
.
Additional features:
- It provides a
QualityGateEvaluator
that is checked after each run. If the quality gate is not passed, then the build will be set toResult.UNSTABLE
orResult.FAILURE
, depending on the configuration properties. - It provides thresholds for the build health that could be adjusted in the configuration screen.
These values are used by the
HealthReportBuilder
to compute the health and the health trend graph.
- Author:
- Ullrich Hafner
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Descriptor for this step: defines the context and the UI elements.Nested classes/interfaces inherited from class hudson.tasks.Publisher
Publisher.DescriptorExtensionListImpl
Nested classes/interfaces inherited from interface hudson.tasks.BuildStep
BuildStep.PublisherList
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Field Summary
Fields inherited from interface hudson.tasks.BuildStep
BUILDERS, PUBLISHERS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addQualityGate
(int size, QualityGate.QualityGateType type, QualityGate.QualityGateResult result) Appends the specified quality gates to the end of the list of quality gates.boolean
Returns whether the results for each configured static analysis result should be aggregated into a single result or if every tool should get an individual result.boolean
Returns whether SCM blaming should be disabled.boolean
Returns whether recording should be enabled for failed builds as well.int
Deprecated.int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
boolean
boolean
Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.int
getId()
boolean
boolean
getName()
Returns the reference build id to get the results for the issue difference computation.Returns the reference job to get the results for the issue difference computation.getScm()
List<io.jenkins.plugins.prism.SourceCodeDirectory>
Deprecated.this method is only intended to be called by the UIgetTools()
Returns the static analysis tools that will scan files and create issues.int
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
int
Deprecated.replaced bygetQualityGates()
boolean
Returns whether all issues should be published using the Checks API.boolean
isQuiet()
Returns whether report logging should be enabled.boolean
Returns whether SCM blaming should be disabled.boolean
Returns whether publishing checks should be skipped.boolean
perform
(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) protected Object
Called after de-serialization to retain backward compatibility or to populate new elements (that would be otherwise initialized tonull
).void
setAggregatingResults
(boolean aggregatingResults) void
setBlameDisabled
(boolean blameDisabled) void
setChecksInfo
(io.jenkins.plugins.checks.steps.ChecksInfo checksInfo) void
setEnabledForFailure
(boolean enabledForFailure) void
setFailedNewAll
(int size) Deprecated.void
setFailedNewHigh
(int size) Deprecated.void
setFailedNewLow
(int size) Deprecated.void
setFailedNewNormal
(int size) Deprecated.void
setFailedTotalAll
(int size) Deprecated.void
setFailedTotalHigh
(int size) Deprecated.void
setFailedTotalLow
(int size) Deprecated.void
setFailedTotalNormal
(int size) Deprecated.void
setFailOnError
(boolean failOnError) Determines whether to fail the build on errors during the step of recording issues.void
setFilters
(List<RegexpFilter> filters) void
setForensicsDisabled
(boolean forensicsDisabled) Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.void
setHealthy
(int healthy) Sets the healthy threshold, i.e.void
Defines the ID of the results.void
setIgnoreFailedBuilds
(boolean ignoreFailedBuilds) Iftrue
, then only successful or unstable reference builds will be considered.void
setIgnoreQualityGate
(boolean ignoreQualityGate) Iftrue
, then the result of the quality gate is ignored when selecting a reference build.void
setMinimumSeverity
(String minimumSeverity) Sets the minimum severity to consider when computing the health report.void
Defines the name of the results.void
setPublishAllIssues
(boolean publishAllIssues) void
setQualityGates
(List<QualityGate> qualityGates) Defines the optional list of quality gates.void
setQuiet
(boolean quiet) void
setReferenceBuildId
(String referenceBuildId) Sets the reference build id to get the results for the issue difference computatation.void
setReferenceJobName
(String referenceJobName) Sets the reference job to get the results for the issue difference computation.void
Sets the SCM that should be used to find the reference build for.void
setSkipBlames
(boolean skipBlames) void
setSkipPublishingChecks
(boolean skipPublishingChecks) void
setSourceCodeEncoding
(String sourceCodeEncoding) Sets the encoding to use to read source files.void
setSourceDirectories
(List<io.jenkins.plugins.prism.SourceCodeDirectory> sourceDirectories) Sets the paths to the directories that contain the source code.void
setSourceDirectory
(String sourceDirectory) Sets the path to the directory that contains the source code.void
setToolProxies
(List<ToolProxy> toolProxies) Deprecated.this method is only intended to be called by the UIvoid
Sets the static analysis tools that will scan files and create issues.void
Sets the static analysis tools that will scan files and create issues.void
setTrendChartType
(TrendChartType trendChartType) Sets the type of the trend chart that should be shown on the job page.void
setUnhealthy
(int unhealthy) Sets the healthy threshold, i.e.void
setUnstableNewAll
(int size) Deprecated.void
setUnstableNewHigh
(int size) Deprecated.void
setUnstableNewLow
(int size) Deprecated.void
setUnstableNewNormal
(int size) Deprecated.void
setUnstableTotalAll
(int size) Deprecated.void
setUnstableTotalHigh
(int size) Deprecated.void
setUnstableTotalLow
(int size) Deprecated.void
setUnstableTotalNormal
(int size) Deprecated.Methods inherited from class hudson.tasks.Publisher
all, getProjectAction, needsToRunAfterFinalized, prebuild
Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer
getProjectAction, getProjectActions, perform, prebuild
-
Constructor Details
-
IssuesRecorder
@DataBoundConstructor public IssuesRecorder()Creates a new instance ofIssuesRecorder
.
-
-
Method Details
-
readResolve
Called after de-serialization to retain backward compatibility or to populate new elements (that would be otherwise initialized tonull
).- Returns:
- this
-
setScm
Sets the SCM that should be used to find the reference build for. The reference recorder will select the SCM based on a substring comparison, there is no need to specify the full name.- Parameters:
scm
- the ID of the SCM to use (a substring of the full ID)
-
getScm
-
setQualityGates
Defines the optional list of quality gates.- Parameters:
qualityGates
- the quality gates
-
addQualityGate
public void addQualityGate(int size, QualityGate.QualityGateType type, QualityGate.QualityGateResult result) Appends the specified quality gates to the end of the list of quality gates.- Parameters:
size
- the minimum number of issues that fails the quality gatetype
- the type of the quality gateresult
- determines whether the quality gate is a warning or failure
-
getQualityGates
-
setId
Defines the ID of the results. The ID is used as URL of the results and as name in UI elements. If no ID is given, then the ID of the associated result object is used.Note: this property is not used if
isAggregatingResults
isfalse
. It is also not visible in the UI in order to simplify the user interface.- Parameters:
id
- the ID of the results
-
getId
-
setName
Defines the name of the results. The name is used for all labels in the UI. If no name is given, then the name of the associatedStaticAnalysisLabelProvider
is used.Note: this property is not used if
isAggregatingResults
isfalse
. It is also not visible in the UI in order to simplify the user interface.- Parameters:
name
- the name of the results
-
getName
-
getToolProxies
Deprecated.this method is only intended to be called by the UIGets the static analysis tools that will scan files and create issues.- Returns:
- the static analysis tools (wrapped as
ToolProxy
) - See Also:
-
setToolProxies
Deprecated.this method is only intended to be called by the UISets the static analysis tools that will scan files and create issues.- Parameters:
toolProxies
- the static analysis tools (wrapped asToolProxy
)- See Also:
-
setTools
Sets the static analysis tools that will scan files and create issues.- Parameters:
tools
- the static analysis tools
-
setTools
Sets the static analysis tools that will scan files and create issues.- Parameters:
tool
- the static analysis tooladditionalTools
- additional static analysis tools (might be empty)- See Also:
-
getTools
Returns the static analysis tools that will scan files and create issues.- Returns:
- the static analysis tools
-
getSourceCodeEncoding
-
setSourceCodeEncoding
Sets the encoding to use to read source files.- Parameters:
sourceCodeEncoding
- the encoding, e.g. "ISO-8859-1"
-
getSourceDirectory
-
setSourceDirectory
Sets the path to the directory that contains the source code. If not relative and thus not part of the workspace then this directory needs to be added in Jenkins global configuration to prevent accessing of forbidden resources.- Parameters:
sourceDirectory
- directory containing the source code
-
setSourceDirectories
@DataBoundSetter public void setSourceDirectories(List<io.jenkins.plugins.prism.SourceCodeDirectory> sourceDirectories) Sets the paths to the directories that contain the source code. If not relative and thus not part of the workspace then these directories need to be added in Jenkins global configuration to prevent accessing of forbidden resources.- Parameters:
sourceDirectories
- directories containing the source code
-
getSourceDirectories
-
getAggregatingResults
public boolean getAggregatingResults()Returns whether the results for each configured static analysis result should be aggregated into a single result or if every tool should get an individual result.- Returns:
true
if the results of each static analysis tool should be aggregated into a single result,false
if every tool should get an individual result.
-
setAggregatingResults
@DataBoundSetter public void setAggregatingResults(boolean aggregatingResults) -
isQuiet
public boolean isQuiet()Returns whether report logging should be enabled.- Returns:
true
report logging is disabledfalse
report logging is enabled
-
setQuiet
@DataBoundSetter public void setQuiet(boolean quiet) -
getBlameDisabled
public boolean getBlameDisabled()Returns whether SCM blaming should be disabled.- Returns:
true
if SCM blaming should be disabled
-
setBlameDisabled
@DataBoundSetter public void setBlameDisabled(boolean blameDisabled) -
isSkipBlames
public boolean isSkipBlames()Returns whether SCM blaming should be disabled.- Returns:
true
if SCM blaming should be disabled
-
setSkipBlames
@DataBoundSetter public void setSkipBlames(boolean skipBlames) -
getForensicsDisabled
Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.Not used anymore.- Returns:
true
if SCM forensics should be disabled
-
setForensicsDisabled
Deprecated.Forensics will be automatically skipped if the Forensics recorder is not activated.Not used anymore.- Parameters:
forensicsDisabled
- not used
-
isSkipPublishingChecks
public boolean isSkipPublishingChecks()Returns whether publishing checks should be skipped.- Returns:
true
if publishing checks should be skipped,false
otherwise
-
setSkipPublishingChecks
@DataBoundSetter public void setSkipPublishingChecks(boolean skipPublishingChecks) -
isPublishAllIssues
public boolean isPublishAllIssues()Returns whether all issues should be published using the Checks API. If set tofalse
only new issues will be published.- Returns:
true
if all issues should be published,false
if only new issues should be published
-
setPublishAllIssues
@DataBoundSetter public void setPublishAllIssues(boolean publishAllIssues) -
setFailOnError
@DataBoundSetter public void setFailOnError(boolean failOnError) Determines whether to fail the build on errors during the step of recording issues.- Parameters:
failOnError
- iftrue
then the build will be failed on errors,false
then errors are only reported in the UI
-
getFailOnError
public boolean getFailOnError() -
getEnabledForFailure
public boolean getEnabledForFailure()Returns whether recording should be enabled for failed builds as well.- Returns:
true
if recording should be enabled for failed builds as well,false
if recording is enabled for successful or unstable builds only
-
setEnabledForFailure
@DataBoundSetter public void setEnabledForFailure(boolean enabledForFailure) -
setIgnoreQualityGate
@DataBoundSetter public void setIgnoreQualityGate(boolean ignoreQualityGate) Iftrue
, then the result of the quality gate is ignored when selecting a reference build. This option is disabled by default so a failing quality gate will be passed from build to build until the original reason for the failure has been resolved.- Parameters:
ignoreQualityGate
- iftrue
then the result of the quality gate is ignored, otherwise only build with a successful quality gate are selected
-
getIgnoreQualityGate
public boolean getIgnoreQualityGate() -
setIgnoreFailedBuilds
@DataBoundSetter public void setIgnoreFailedBuilds(boolean ignoreFailedBuilds) Iftrue
, then only successful or unstable reference builds will be considered. This option is enabled by default, since analysis results might be inaccurate if the build failed. Iffalse
, every build that contains a static analysis result is considered, even if the build failed.- Parameters:
ignoreFailedBuilds
- iftrue
then a stable build is used as reference
-
getIgnoreFailedBuilds
public boolean getIgnoreFailedBuilds() -
setReferenceJobName
Sets the reference job to get the results for the issue difference computation.- Parameters:
referenceJobName
- the name of reference job
-
getReferenceJobName
Returns the reference job to get the results for the issue difference computation. If the job is not defined, thenNO_REFERENCE_DEFINED
is returned.- Returns:
- the name of reference job, or
NO_REFERENCE_DEFINED
if undefined
-
setReferenceBuildId
Sets the reference build id to get the results for the issue difference computatation.- Parameters:
referenceBuildId
- the build id of the reference job
-
getReferenceBuildId
Returns the reference build id to get the results for the issue difference computation. If the build id not defined, thenNO_REFERENCE_DEFINED
is returned.- Returns:
- the build id of the reference job, or
NO_REFERENCE_DEFINED
if undefined.
-
getHealthy
public int getHealthy() -
setHealthy
@DataBoundSetter public void setHealthy(int healthy) Sets the healthy threshold, i.e. the number of issues when health is reported as 100%.- Parameters:
healthy
- the number of issues when health is reported as 100%
-
getUnhealthy
public int getUnhealthy() -
setUnhealthy
@DataBoundSetter public void setUnhealthy(int unhealthy) Sets the healthy threshold, i.e. the number of issues when health is reported as 0%.- Parameters:
unhealthy
- the number of issues when health is reported as 0%
-
getMinimumSeverity
-
setTrendChartType
Sets the type of the trend chart that should be shown on the job page.- Parameters:
trendChartType
- the type of the trend chart to use
-
getTrendChartType
-
setMinimumSeverity
Sets the minimum severity to consider when computing the health report. Issues with a severity less than this value will be ignored.- Parameters:
minimumSeverity
- the severity to consider
-
getFilters
-
setFilters
-
setChecksInfo
public void setChecksInfo(@CheckForNull io.jenkins.plugins.checks.steps.ChecksInfo checksInfo) -
getRequiredMonitorService
-
getDescriptor
- Specified by:
getDescriptor
in interfaceDescribable<Publisher>
- Overrides:
getDescriptor
in classRecorder
-
perform
public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException- Specified by:
perform
in interfaceBuildStep
- Overrides:
perform
in classBuildStepCompatibilityLayer
- Throws:
InterruptedException
IOException
-
setUnstableTotalAll
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableTotalHigh
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewAll
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableTotalNormal
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableTotalLow
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableTotalLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewHigh
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewNormal
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setUnstableNewLow
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getUnstableNewLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalAll
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalHigh
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalNormal
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedTotalLow
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedTotalLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewAll
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewAll
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewHigh
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewHigh
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewNormal
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewNormal
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
setFailedNewLow
Deprecated.Sets the quality gate.- Parameters:
size
- number of issues
-
getFailedNewLow
Deprecated.replaced bygetQualityGates()
Gets the quality gate.- Returns:
- 0
-
getQualityGates()