/
ResolveScmStep.java
346 lines (313 loc) · 10.5 KB
/
ResolveScmStep.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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/*
* The MIT License
*
* Copyright (c) 2017 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
package org.jenkinsci.plugins.workflow.multibranch;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.AbortException;
import hudson.Extension;
import hudson.model.Descriptor;
import hudson.model.TaskListener;
import hudson.scm.SCM;
import hudson.util.FormValidation;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import jenkins.scm.api.SCMHead;
import jenkins.scm.api.SCMHeadObserver;
import jenkins.scm.api.SCMRevision;
import jenkins.scm.api.SCMSource;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.jenkinsci.plugins.workflow.steps.Step;
import org.jenkinsci.plugins.workflow.steps.StepContext;
import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
import org.jenkinsci.plugins.workflow.steps.StepExecution;
import org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
/**
* Resolves an {@link SCM} from a {@link SCMSource} using a priority list of target branch names.
*
* @since 2.10
*/
public class ResolveScmStep extends Step {
/**
* The {@link SCMSource}
*/
@NonNull
private final SCMSource source;
/**
* The {@link SCMSource}
*/
@NonNull
private final List<String> targets;
/**
* If {@code true} then {@code null} will be returned in the event that none of the target branch names can be
* resolved.
*/
private boolean ignoreErrors;
/**
* Constructor.
*
* @param source The {@link SCMSource}
* @param targets The {@link SCMSource}
*/
@DataBoundConstructor
public ResolveScmStep(@NonNull SCMSource source, @NonNull List<String> targets) {
this.source = source;
this.targets = new ArrayList<>(targets);
}
/**
* Gets the {@link SCMSource} to resolve from.
*
* @return the {@link SCMSource} to resolve from.
*/
@NonNull
public SCMSource getSource() {
return source;
}
/**
* Gets the {@link SCMHead} names to try and resolve.
*
* @return the {@link SCMHead} names to try and resolve.
*/
@NonNull
public List<String> getTargets() {
return Collections.unmodifiableList(targets);
}
/**
* Returns {@code true} if and only if errors will be ignored.
*
* @return {@code true} if and only if errors will be ignored.
*/
public boolean isIgnoreErrors() {
return ignoreErrors;
}
/**
* Sets the error handling behaviour.
*
* @param ignoreErrors {@code true} if and only if errors will be ignored.
*/
@DataBoundSetter
public void setIgnoreErrors(boolean ignoreErrors) {
this.ignoreErrors = ignoreErrors;
}
/**
* {@inheritDoc}
*/
@Override
public StepExecution start(StepContext context) throws Exception {
return new Execution(context, this);
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return "ResolveScmStep{" +
"source=" + source +
", targets=" + targets +
", ignoreErrors=" + ignoreErrors +
'}';
}
/**
* Our {@link Descriptor}.
*/
@Extension
public static class DescriptorImpl extends StepDescriptor {
/**
* {@inheritDoc}
*/
@Override
public Set<Class<?>> getRequiredContext() {
return Collections.singleton(TaskListener.class);
}
/**
* {@inheritDoc}
*/
@Override
public String getFunctionName() {
return "resolveScm";
}
/**
* {@inheritDoc}
*/
@NonNull
@Override
public String getDisplayName() {
return "Resolves an SCM from an SCM Source and a list of candidate target branch names";
}
@Override
public Step newInstance(@CheckForNull StaplerRequest req, @NonNull JSONObject formData)
throws FormException {
assert req != null : "see contract for method, it's never null but has to claim it could be";
// roll our own because we want the groovy api to be easier than the jelly form binding would have us
JSONObject src = formData.getJSONObject("source");
src.put("id", "_");
SCMSource source = req.bindJSON(SCMSource.class, src);
List<String> targets = new ArrayList<>();
// TODO JENKINS-27901 use standard control when available
Object t = formData.get("targets");
if (t instanceof JSONObject) {
JSONObject o = (JSONObject) t;
targets.add(o.getString("target"));
} else if (t instanceof JSONArray) {
JSONArray a = (JSONArray) t;
for (int i = 0; i < a.size(); i++) {
JSONObject o = a.getJSONObject(i);
targets.add(o.getString("target"));
}
}
ResolveScmStep step = new ResolveScmStep(source, targets);
if (formData.optBoolean("ignoreErrors", false)) {
step.setIgnoreErrors(true);
}
return step;
}
public FormValidation doCheckTarget(@QueryParameter String value) {
if (StringUtils.isNotBlank(value)) {
return FormValidation.ok();
}
return FormValidation.error("You must supply a target branch name to resolve");
}
}
/**
* Our {@link StepExecution}.
*/
public static class Execution extends SynchronousStepExecution<SCM> {
/**
* Ensure consistent serialization.
*/
private static final long serialVersionUID = 1L;
/**
* The {@link SCMSource}
*/
@NonNull
private transient final SCMSource source;
/**
* The {@link SCMSource}
*/
@NonNull
private final List<String> targets;
/**
* If {@code true} then {@code null} will be returned in the event that none of the target branch names can be
* resolved.
*/
private boolean ignoreErrors;
/**
* Our constructor.
*
* @param context the context.
* @param step the step.
*/
Execution(StepContext context, ResolveScmStep step) {
super(context);
this.source = step.getSource();
this.targets = new ArrayList<>(step.getTargets());
this.ignoreErrors = step.isIgnoreErrors();
}
/**
* {@inheritDoc}
*/
@Override
protected SCM run() throws Exception {
StepContext context = getContext();
TaskListener listener = context.get(TaskListener.class);
assert listener != null;
PrintStream out = listener.getLogger();
out.printf("Checking for first existing branch from %s...%n", targets);
SCMRevision fetch = source.fetch(new ObserverImpl(targets), listener).result();
if (fetch == null) {
if (ignoreErrors) {
out.println("Could not find any matching branch");
return null;
}
throw new AbortException("Could not find any matching branch");
}
out.printf("Found %s at revision %s%n", fetch.getHead().getName(), fetch);
return source.build(fetch.getHead(), fetch);
}
}
/**
* An observer that collects the {@link SCMRevision} of a named {@link SCMHead} from a list of priority
* candidates and stops observing when the preferred candidate is found.
*/
private static class ObserverImpl extends SCMHeadObserver {
/**
* The heads we are looking for
*/
private final Map<String, SCMRevision> revision = new LinkedHashMap<>();
/**
* Constructor.
*
* @param heads the {@link SCMHead#getName()} to get the {@link SCMRevision} of.
*/
public ObserverImpl(@NonNull List<String> heads) {
heads.getClass(); // fail fast if null
for (String head : heads) {
if (StringUtils.isNotBlank(head)) {
revision.put(head, null);
}
}
}
/**
* Returns the result.
*
* @return the result.
*/
@CheckForNull
public SCMRevision result() {
for (SCMRevision r : revision.values()) {
if (r != null) {
return r;
}
}
return null;
}
/**
* {@inheritDoc}
*/
@Override
public void observe(@NonNull SCMHead head, @NonNull SCMRevision revision) {
if (this.revision.containsKey(head.getName())) {
this.revision.put(head.getName(), revision);
}
}
/**
* {@inheritDoc}
*/
@Override
public boolean isObserving() {
return revision.values().iterator().next() == null;
}
}
}