Package io.jenkins.plugins.analysis.core.model

Class AnalysisHistory

java.lang.Object

io.jenkins.plugins.analysis.core.model.AnalysisHistory

All Implemented Interfaces:

History, Iterable<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>>

public class AnalysisHistory
extends Object
implements History

Provides a history of static analysis results. The history starts from a baseline build and provides access to a historical build result of the same type (or to all historical results using the provided interator implementation). The results are filtered by a ResultSelector, so a history returns only results of the same type. This history can be configured to ignore the overall result of the associated Jenkins builds (see JobResultEvaluationMode). Additionally, this history can be configured to ignore the builds that did not pass the quality gate (see QualityGateEvaluationMode). Note that the baseline run might still be in progress and thus has not yet a result attached: i.e., the result of the getPrevious* methods may return different results on subsequent calls.

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalysisHistory.JobResultEvaluationMode	Determines how the overall build Result of the Run is taken into account when the previous result is searched for.
static class	AnalysisHistory.QualityGateEvaluationMode	Determines how the evaluation of the QualityGateEvaluator is taken into account when the previous result is searched for.

Constructor Summary

Constructors

Constructor	Description
AnalysisHistory(Run<?,?> baseline, ResultSelector selector)	Creates a new instance of AnalysisHistory.
AnalysisHistory(Run<?,?> baseline, ResultSelector selector, AnalysisHistory.QualityGateEvaluationMode qualityGateEvaluationMode, AnalysisHistory.JobResultEvaluationMode jobResultEvaluationMode)	Creates a new instance of AnalysisHistory.

Method Summary

Modifier and Type	Method	Description
Optional<ResultAction>	getBaselineAction()	Returns the baseline action (if already available).
Optional<AnalysisResult>	getBaselineResult()	Returns the baseline result (if already available).
Optional<Run<?,?>>	getBuild()	Returns the build that contains the historical result (if there is any).
edu.hm.hafner.analysis.Report	getIssues()	Returns the issues of the historical result.
Optional<AnalysisResult>	getResult()	Returns the historical result (if there is any).
boolean	hasMultipleResults()	Returns whether this history has more than one result.
Iterator<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AnalysisHistory

public AnalysisHistory(Run<?,?> baseline,
                       ResultSelector selector)

Creates a new instance of AnalysisHistory. This history ignores the QualityGateStatus of the quality gate and the Result of the associated Run.

Parameters:

baseline - the build to start the history from

selector - selects the associated action from a build

AnalysisHistory

public AnalysisHistory(Run<?,?> baseline,
                       ResultSelector selector,
                       AnalysisHistory.QualityGateEvaluationMode qualityGateEvaluationMode,
                       AnalysisHistory.JobResultEvaluationMode jobResultEvaluationMode)

Creates a new instance of AnalysisHistory.

Parameters:

baseline - the run to start the history from

selector - selects the type of the result (to get a result for the same type of static analysis)

qualityGateEvaluationMode - If set to AnalysisHistory.QualityGateEvaluationMode.IGNORE_QUALITY_GATE, then the result of the quality gate is ignored when selecting a reference build. If set to AnalysisHistory.QualityGateEvaluationMode.SUCCESSFUL_QUALITY_GATE a failing quality gate will be passed from build to build until the original reason for the failure has been resolved.

jobResultEvaluationMode - If set to AnalysisHistory.JobResultEvaluationMode.NO_JOB_FAILURE, then only successful or unstable reference builds will be considered (since analysis results might be inaccurate if the build failed). If set to AnalysisHistory.JobResultEvaluationMode.IGNORE_JOB_RESULT, then every build that contains a static analysis result is considered, even if the build failed.

Method Detail

getBaselineAction

public Optional<ResultAction> getBaselineAction()

Description copied from interface: History

Returns the baseline action (if already available).

Specified by:

getBaselineAction in interface History

Returns:

the baseline action

getBaselineResult

public Optional<AnalysisResult> getBaselineResult()

Description copied from interface: History

Returns the baseline result (if already available).

Specified by:

getBaselineResult in interface History

Returns:

the baseline result

getResult

public Optional<AnalysisResult> getResult()

Description copied from interface: History

Returns the historical result (if there is any).

Specified by:

getResult in interface History

Returns:

the historical result

getBuild

public Optional<Run<?,?>> getBuild()

Description copied from interface: History

Returns the build that contains the historical result (if there is any).

Specified by:

getBuild in interface History

Returns:

the historical result

getIssues

public edu.hm.hafner.analysis.Report getIssues()

Description copied from interface: History

Returns the issues of the historical result. If there is no historical build found, then an empty set of issues is returned.

Specified by:

getIssues in interface History

Returns:

the issues of the historical build

hasMultipleResults

public boolean hasMultipleResults()

Description copied from interface: History

Returns whether this history has more than one result.

Specified by:

hasMultipleResults in interface History

Returns:

true if there are multiple results, false otherwise

toString

public String toString()

Overrides:

toString in class Object

iterator

@NonNull
public Iterator<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>> iterator()

Specified by:

iterator in interface History

Specified by:

iterator in interface Iterable<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>>