-
Notifications
You must be signed in to change notification settings - Fork 272
/
IssuesPublisher.java
188 lines (165 loc) · 8.19 KB
/
IssuesPublisher.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
package io.jenkins.plugins.analysis.core.steps;
import java.nio.charset.Charset;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import edu.hm.hafner.analysis.Report;
import hudson.model.Job;
import hudson.model.Run;
import io.jenkins.plugins.analysis.core.model.AggregationAction;
import io.jenkins.plugins.analysis.core.model.AnalysisHistory;
import io.jenkins.plugins.analysis.core.model.AnalysisHistory.JobResultEvaluationMode;
import io.jenkins.plugins.analysis.core.model.AnalysisHistory.QualityGateEvaluationMode;
import io.jenkins.plugins.analysis.core.model.AnalysisResult;
import io.jenkins.plugins.analysis.core.model.ByIdResultSelector;
import io.jenkins.plugins.analysis.core.model.DeltaReport;
import io.jenkins.plugins.analysis.core.util.HealthDescriptor;
import io.jenkins.plugins.analysis.core.model.History;
import io.jenkins.plugins.analysis.core.model.ResetReferenceAction;
import io.jenkins.plugins.analysis.core.model.ResultAction;
import io.jenkins.plugins.analysis.core.model.ResultSelector;
import io.jenkins.plugins.analysis.core.scm.Blames;
import io.jenkins.plugins.analysis.core.util.JenkinsFacade;
import io.jenkins.plugins.analysis.core.util.LogHandler;
import io.jenkins.plugins.analysis.core.util.QualityGateEvaluator;
import io.jenkins.plugins.analysis.core.util.QualityGateStatus;
import io.jenkins.plugins.analysis.core.util.QualityGateStatusHandler;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import static io.jenkins.plugins.analysis.core.model.AnalysisHistory.JobResultEvaluationMode.*;
import static io.jenkins.plugins.analysis.core.model.AnalysisHistory.QualityGateEvaluationMode.*;
/**
* Publishes issues: Stores the created issues in an {@link AnalysisResult}. The result is attached to the {@link Run}
* by registering a {@link ResultAction}.
*
* @author Ullrich Hafner
*/
class IssuesPublisher {
private final AnnotatedReport report;
private final Run<?, ?> run;
private final HealthDescriptor healthDescriptor;
private final String name;
private final Charset sourceCodeEncoding;
private final QualityGateEvaluator qualityGate;
private final String referenceJobName;
private final QualityGateEvaluationMode qualityGateEvaluationMode;
private final JobResultEvaluationMode jobResultEvaluationMode;
private final LogHandler logger;
private final QualityGateStatusHandler qualityGateStatusHandler;
@SuppressWarnings("ParameterNumber")
IssuesPublisher(final Run<?, ?> run, final AnnotatedReport report,
final HealthDescriptor healthDescriptor, final QualityGateEvaluator qualityGate,
final String name, final String referenceJobName, final boolean ignoreQualityGate,
final boolean ignoreFailedBuilds, final Charset sourceCodeEncoding, final LogHandler logger,
final QualityGateStatusHandler qualityGateStatusHandler) {
this.report = report;
this.run = run;
this.healthDescriptor = healthDescriptor;
this.name = name;
this.sourceCodeEncoding = sourceCodeEncoding;
this.qualityGate = qualityGate;
this.referenceJobName = referenceJobName;
qualityGateEvaluationMode = ignoreQualityGate ? IGNORE_QUALITY_GATE : SUCCESSFUL_QUALITY_GATE;
jobResultEvaluationMode = ignoreFailedBuilds ? NO_JOB_FAILURE : IGNORE_JOB_RESULT;
this.logger = logger;
this.qualityGateStatusHandler = qualityGateStatusHandler;
}
private String getId() {
return report.getId();
}
/**
* Creates a new {@link AnalysisResult} and attaches the result in a {@link ResultAction} that is registered with
* the current run.
*
* @return the created result action
*/
ResultAction attachAction() {
logger.log("Attaching ResultAction with ID '%s' to run '%s'.", getId(), run);
ResultSelector selector = ensureThatIdIsUnique();
AnalysisResult result = createAnalysisResult(report.getReport(), selector, report.getBlames(),
report.getSizeOfOrigin());
logger.log("Created analysis result for %d issues (found %d new issues, fixed %d issues)",
result.getTotalSize(), result.getNewSize(), result.getFixedSize());
ResultAction action = new ResultAction(run, result, healthDescriptor, getId(), name, sourceCodeEncoding);
run.addAction(action);
run.addOrReplaceAction(new AggregationAction());
return action;
}
private ResultSelector ensureThatIdIsUnique() {
ResultSelector selector = new ByIdResultSelector(getId());
Optional<ResultAction> other = selector.get(run);
if (other.isPresent()) {
throw new IllegalStateException(
String.format("ID %s is already used by another action: %s%n", getId(), other.get()));
}
return selector;
}
@SuppressWarnings("PMD.PrematureDeclaration")
private AnalysisResult createAnalysisResult(final Report filtered, final ResultSelector selector,
final Blames blames, final Map<String, Integer> sizeOfOrigin) {
DeltaReport deltaReport = new DeltaReport(filtered, createAnalysisHistory(selector, filtered), run.getNumber());
QualityGateStatus qualityGateStatus = evaluateQualityGate(filtered, deltaReport);
reportHealth(filtered);
logger.log(filtered);
return new AnalysisHistory(run, selector).getResult()
.map(previous -> new AnalysisResult(run, getId(), deltaReport, blames, qualityGateStatus, sizeOfOrigin,
previous))
.orElseGet(
() -> new AnalysisResult(run, getId(), deltaReport, blames, qualityGateStatus, sizeOfOrigin));
}
private void reportHealth(final Report filtered) {
if (healthDescriptor.isEnabled()) {
if (healthDescriptor.isValid()) {
filtered.logInfo("Enabling health report (%s)", healthDescriptor);
}
else {
filtered.logInfo("Health report is invalid (%s) - skipping", healthDescriptor);
}
}
else {
filtered.logInfo("Health report is disabled - skipping");
}
}
private QualityGateStatus evaluateQualityGate(final Report filtered, final DeltaReport deltaReport) {
QualityGateStatus qualityGateStatus;
if (qualityGate.isEnabled()) {
filtered.logInfo("Evaluating quality gates");
qualityGateStatus = qualityGate.evaluate(deltaReport.getStatistics(), filtered::logInfo);
if (qualityGateStatus.isSuccessful()) {
filtered.logInfo("-> All quality gates have been passed");
}
else {
filtered.logInfo("-> Some quality gates have been missed: overall result is %s", qualityGateStatus);
}
qualityGateStatusHandler.handleStatus(qualityGateStatus);
}
else {
filtered.logInfo("No quality gates have been set - skipping");
qualityGateStatus = QualityGateStatus.INACTIVE;
}
return qualityGateStatus;
}
private History createAnalysisHistory(final ResultSelector selector, final Report filtered) {
Run<?, ?> baseline = run;
if (referenceJobName != null) {
Optional<Job<?, ?>> referenceJob = new JenkinsFacade().getJob(referenceJobName);
if (referenceJob.isPresent()) {
baseline = referenceJob.get().getLastBuild();
}
}
return new AnalysisHistory(baseline, selector, determineQualityGateEvaluationMode(filtered),
jobResultEvaluationMode);
}
private QualityGateEvaluationMode determineQualityGateEvaluationMode(final Report filtered) {
Run<?, ?> previous = run.getPreviousCompletedBuild();
if (previous != null) {
List<ResetReferenceAction> actions = previous.getActions(ResetReferenceAction.class);
for (ResetReferenceAction action : actions) {
if (report.getId().equals(action.getId())) {
filtered.logInfo("Resetting reference build, ignoring quality gate result for one build");
return IGNORE_QUALITY_GATE;
}
}
}
return qualityGateEvaluationMode;
}
}