-
Notifications
You must be signed in to change notification settings - Fork 28
/
BuildStatusChecksPublisher.java
160 lines (145 loc) · 5.48 KB
/
BuildStatusChecksPublisher.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
package io.jenkins.plugins.checks.status;
import java.io.File;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import hudson.Extension;
import hudson.FilePath;
import hudson.model.Job;
import hudson.model.Queue;
import hudson.model.Result;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.model.listeners.RunListener;
import hudson.model.listeners.SCMListener;
import hudson.model.queue.QueueListener;
import hudson.scm.SCM;
import hudson.scm.SCMRevisionState;
import io.jenkins.plugins.checks.api.ChecksConclusion;
import io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder;
import io.jenkins.plugins.checks.api.ChecksPublisher;
import io.jenkins.plugins.checks.api.ChecksPublisherFactory;
import io.jenkins.plugins.checks.api.ChecksStatus;
import io.jenkins.plugins.util.JenkinsFacade;
/**
* A publisher which publishes different statuses through the checks API based on the stage of the {@link Queue.Item}
* or {@link Run}.
*/
public final class BuildStatusChecksPublisher {
private static final JenkinsFacade JENKINS = new JenkinsFacade();
private static final StatusChecksProperties DEFAULT_PROPERTIES = new DefaultStatusCheckProperties();
private static void publish(final ChecksPublisher publisher, final ChecksStatus status,
final ChecksConclusion conclusion, final String name) {
publisher.publish(new ChecksDetailsBuilder()
.withName(name)
.withStatus(status)
.withConclusion(conclusion)
.build());
}
private static StatusChecksProperties findProperties(final Job<?, ?> job) {
return JENKINS.getExtensionsFor(StatusChecksProperties.class)
.stream()
.filter(p -> p.isApplicable(job))
.findFirst()
.orElse(DEFAULT_PROPERTIES);
}
/**
* {@inheritDoc}
*
* <p>
* Listens to the queue and publishes checks in "queued" state for entering items.
* </p>
*/
@Extension
public static class JobScheduledListener extends QueueListener {
/**
* {@inheritDoc}
*
* <p>
* When a job enters queue, creates the check on "queued".
* </p>
*/
@Override
public void onEnterWaiting(final Queue.WaitingItem wi) {
if (!(wi.task instanceof Job)) {
return;
}
final Job job = (Job)wi.task;
final StatusChecksProperties properties = findProperties(job);
if (!properties.isSkip(job)) {
publish(ChecksPublisherFactory.fromJob(job, TaskListener.NULL), ChecksStatus.QUEUED,
ChecksConclusion.NONE, properties.getName(job));
}
}
}
/**
* {@inheritDoc}
*
* <p>
* Listens to the SCM checkout and publishes checks.
* </p>
*/
@Extension
public static class JobCheckoutListener extends SCMListener {
/**
* {@inheritDoc}
* <p>
* When checkout finished, update the check to "in progress".
* </p>
*/
@Override
public void onCheckout(final Run<?, ?> run, final SCM scm, final FilePath workspace,
final TaskListener listener, @CheckForNull final File changelogFile,
@CheckForNull final SCMRevisionState pollingBaseline) {
final StatusChecksProperties properties = findProperties(run.getParent());
if (!properties.isSkip(run.getParent())) {
publish(ChecksPublisherFactory.fromRun(run, listener), ChecksStatus.IN_PROGRESS, ChecksConclusion.NONE,
properties.getName(run.getParent()));
}
}
}
/**
* {@inheritDoc}
*
* <p>
* Listens to the run and publishes checks.
* </p>
*/
@Extension
public static class JobCompletedListener extends RunListener<Run<?, ?>> {
/**
* {@inheritDoc}
*
* <p>
* When a job completes, completes the check.
* </p>
*/
@Override
public void onCompleted(final Run run, @CheckForNull final TaskListener listener) {
final StatusChecksProperties properties = findProperties(run.getParent());
if (!properties.isSkip(run.getParent())) {
publish(ChecksPublisherFactory.fromRun(run, listener), ChecksStatus.COMPLETED, extractConclusion(run),
properties.getName(run.getParent()));
}
}
private ChecksConclusion extractConclusion(final Run<?, ?> run) {
Result result = run.getResult();
if (result == null) {
throw new IllegalStateException("No result when the run completes, run: " + run.toString());
}
if (result.isBetterOrEqualTo(Result.SUCCESS)) {
return ChecksConclusion.SUCCESS;
}
else if (result.isBetterOrEqualTo(Result.UNSTABLE) || result.isBetterOrEqualTo(Result.FAILURE)) {
return ChecksConclusion.FAILURE;
}
else if (result.isBetterOrEqualTo(Result.NOT_BUILT)) {
return ChecksConclusion.SKIPPED;
}
else if (result.isBetterOrEqualTo(Result.ABORTED)) {
return ChecksConclusion.CANCELED;
}
else {
throw new IllegalStateException("Unsupported run result: " + result);
}
}
}
}