/
WorkflowJob.java
729 lines (633 loc) · 26.2 KB
/
WorkflowJob.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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
/*
* The MIT License
*
* Copyright (c) 2013-2014, 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.job;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.AbortException;
import hudson.BulkChange;
import hudson.Extension;
import hudson.ExtensionList;
import hudson.FilePath;
import hudson.Functions;
import hudson.Launcher;
import hudson.init.InitMilestone;
import hudson.init.Initializer;
import hudson.model.Action;
import hudson.model.BallColor;
import hudson.model.Computer;
import hudson.model.Descriptor;
import hudson.model.DescriptorVisibilityFilter;
import hudson.model.Item;
import hudson.model.ItemGroup;
import hudson.model.Items;
import hudson.model.Job;
import hudson.model.JobProperty;
import hudson.model.Label;
import hudson.model.Node;
import hudson.model.Queue;
import hudson.model.Run;
import hudson.model.RunMap;
import hudson.model.TaskListener;
import hudson.model.TopLevelItem;
import hudson.model.TopLevelItemDescriptor;
import hudson.model.listeners.SCMListener;
import hudson.model.queue.CauseOfBlockage;
import hudson.model.queue.QueueTaskFuture;
import hudson.model.queue.SubTask;
import hudson.scm.PollingResult;
import hudson.scm.SCM;
import hudson.scm.SCMRevisionState;
import hudson.search.SearchIndexBuilder;
import hudson.security.ACL;
import hudson.security.Permission;
import hudson.slaves.WorkspaceList;
import hudson.triggers.SCMTrigger;
import hudson.triggers.Trigger;
import hudson.triggers.TriggerDescriptor;
import hudson.util.AlternativeUiTextProvider;
import hudson.util.DescribableList;
import hudson.widgets.HistoryWidget;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.servlet.ServletException;
import jenkins.model.BlockedBecauseOfBuildInProgress;
import jenkins.model.Jenkins;
import jenkins.model.ParameterizedJobMixIn;
import jenkins.model.lazy.LazyBuildMixIn;
import jenkins.triggers.SCMTriggerItem;
import net.sf.json.JSONObject;
import org.acegisecurity.Authentication;
import org.jenkinsci.plugins.workflow.flow.BlockableResume;
import org.jenkinsci.plugins.workflow.flow.FlowDefinition;
import org.jenkinsci.plugins.workflow.flow.FlowDefinitionDescriptor;
import org.jenkinsci.plugins.workflow.job.properties.DisableConcurrentBuildsJobProperty;
import org.jenkinsci.plugins.workflow.job.properties.DisableResumeJobProperty;
import org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
@SuppressWarnings({"unchecked", "rawtypes"})
public final class WorkflowJob extends Job<WorkflowJob,WorkflowRun> implements LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>, ParameterizedJobMixIn.ParameterizedJob<WorkflowJob, WorkflowRun>, TopLevelItem, Queue.FlyweightTask, SCMTriggerItem, BlockableResume {
private static final Logger LOGGER = Logger.getLogger(WorkflowJob.class.getName());
private FlowDefinition definition;
/** @deprecated - use {@link PipelineTriggersJobProperty} */
private DescribableList<Trigger<?>,TriggerDescriptor> triggers = new DescribableList<>(this);
private volatile Integer quietPeriod;
@SuppressWarnings("deprecation")
private hudson.model.BuildAuthorizationToken authToken;
private transient LazyBuildMixIn<WorkflowJob,WorkflowRun> buildMixIn;
/** @deprecated replaced by {@link DisableConcurrentBuildsJobProperty} */
private @CheckForNull Boolean concurrentBuild;
/**
* Map from {@link SCM#getKey} to last version we encountered during polling.
* TODO is it important to persist this? {@link hudson.model.AbstractProject#pollingBaseline} is not persisted.
*/
private transient volatile Map<String,SCMRevisionState> pollingBaselines;
private volatile boolean disabled;
public WorkflowJob(ItemGroup parent, String name) {
super(parent, name);
buildMixIn = createBuildMixIn();
}
@Override public void onCreatedFromScratch() {
super.onCreatedFromScratch();
buildMixIn.onCreatedFromScratch();
}
@Override public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException {
super.onLoad(parent, name);
if (buildMixIn == null) {
buildMixIn = createBuildMixIn();
}
buildMixIn.onLoad(parent, name);
if (triggers != null && !triggers.isEmpty()) {
setTriggers(triggers.toList());
}
if (concurrentBuild != null) {
setConcurrentBuild(concurrentBuild);
}
getTriggersJobProperty().stopTriggers();
getTriggersJobProperty().startTriggers(Items.currentlyUpdatingByXml());
}
private LazyBuildMixIn<WorkflowJob,WorkflowRun> createBuildMixIn() {
return new LazyBuildMixIn<WorkflowJob,WorkflowRun>() {
@Override protected WorkflowJob asJob() {
return WorkflowJob.this;
}
@Override protected Class<WorkflowRun> getBuildClass() {
return WorkflowRun.class;
}
};
}
public FlowDefinition getDefinition() {
return definition;
}
public void setDefinition(FlowDefinition definition) {
this.definition = definition;
try {
save();
} catch (IOException x) {
LOGGER.log(Level.WARNING, "could not save " + this, x);
}
}
@SuppressWarnings("deprecation")
@Override protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, Descriptor.FormException {
super.submit(req, rsp);
JSONObject json = req.getSubmittedForm();
definition = req.bindJSON(FlowDefinition.class, json.getJSONObject("definition"));
authToken = hudson.model.BuildAuthorizationToken.create(req);
if (req.getParameter("hasCustomQuietPeriod") != null) {
quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));
} else {
quietPeriod = null;
}
makeDisabled(json.optBoolean("disable"));
getTriggersJobProperty().stopTriggers();
getTriggersJobProperty().startTriggers(Items.currentlyUpdatingByXml());
}
@Override public void addProperty(JobProperty jobProp) throws IOException {
super.addProperty(jobProp);
if (jobProp instanceof PipelineTriggersJobProperty) {
getTriggersJobProperty().stopTriggers();
getTriggersJobProperty().startTriggers(Items.currentlyUpdatingByXml());
}
}
@Override public boolean isBuildable() {
for (JobProperty<?> property : properties) {
if (property instanceof WorkflowJobProperty) {
Boolean buildable = ((WorkflowJobProperty) property).isBuildable();
if (buildable != null) {
return buildable;
}
}
}
return ParameterizedJobMixIn.ParameterizedJob.super.isBuildable();
}
@Override protected RunMap<WorkflowRun> _getRuns() {
return buildMixIn._getRuns();
}
@Override public LazyBuildMixIn<WorkflowJob,WorkflowRun> getLazyBuildMixIn() {
return buildMixIn;
}
@Override protected void removeRun(WorkflowRun run) {
buildMixIn.removeRun(run);
}
@Override @Deprecated public WorkflowRun getBuild(String id) {
return buildMixIn.getBuild(id);
}
@Override public WorkflowRun getBuildByNumber(int n) {
return buildMixIn.getBuildByNumber(n);
}
@Override public WorkflowRun getFirstBuild() {
return buildMixIn.getFirstBuild();
}
@Override public WorkflowRun getLastBuild() {
return buildMixIn.getLastBuild();
}
@Override public WorkflowRun getNearestBuild(int n) {
return buildMixIn.getNearestBuild(n);
}
@Override public WorkflowRun getNearestOldBuild(int n) {
return buildMixIn.getNearestOldBuild(n);
}
@Override protected HistoryWidget createHistoryWidget() {
return buildMixIn.createHistoryWidget();
}
@Override public @CheckForNull QueueTaskFuture<WorkflowRun> scheduleBuild2(int quietPeriod, Action... actions) {
return ParameterizedJobMixIn.ParameterizedJob.super.scheduleBuild2(quietPeriod, actions);
}
@Override protected SearchIndexBuilder makeSearchIndex() {
return getParameterizedJobMixIn().extendSearchIndex(super.makeSearchIndex());
}
@Override public boolean isDisabled() {
return disabled;
}
@Restricted(DoNotUse.class)
@Override public void setDisabled(boolean disabled) {
this.disabled = disabled;
}
@Override public boolean supportsMakeDisabled() {
return true;
}
@Override public BallColor getIconColor() {
if (isDisabled()) {
return isBuilding() ? BallColor.DISABLED_ANIME : BallColor.DISABLED;
} else {
return super.getIconColor();
}
}
@SuppressWarnings("deprecation")
@Override public hudson.model.BuildAuthorizationToken getAuthToken() {
return authToken;
}
@Override public int getQuietPeriod() {
return quietPeriod != null ? quietPeriod : Jenkins.getActiveInstance().getQuietPeriod();
}
@Restricted(DoNotUse.class) // for config-quietPeriod.jelly
public boolean getHasCustomQuietPeriod() {
return quietPeriod!=null;
}
public void setQuietPeriod(Integer seconds) throws IOException {
this.quietPeriod = seconds;
save();
}
// TODO delete after baseline has https://github.com/jenkinsci/jenkins/pull/3099
@Override public boolean isBuildBlocked() {
return getCauseOfBlockage() != null;
}
// TODO delete after baseline has https://github.com/jenkinsci/jenkins/pull/3099
@Deprecated
@Override public String getWhyBlocked() {
CauseOfBlockage c = getCauseOfBlockage();
return c != null ? c.getShortDescription() : null;
}
@Override public CauseOfBlockage getCauseOfBlockage() {
if (isLogUpdated() && !isConcurrentBuild()) {
WorkflowRun lastBuild = getLastBuild();
if (lastBuild != null) {
return new BlockedBecauseOfBuildInProgress(lastBuild);
} // else race condition, cf. AbstractProject
}
return null;
}
@Exported
@Override public boolean isConcurrentBuild() {
return getProperty(DisableConcurrentBuildsJobProperty.class) == null;
}
@Exported
public boolean isResumeBlocked() {
return getProperty(DisableResumeJobProperty.class) != null;
}
public void setResumeBlocked(boolean resumeBlocked) {
try {
boolean previousState = isResumeBlocked();
if (resumeBlocked != previousState) {
BulkChange bc = new BulkChange(this);
try {
removeProperty(DisableResumeJobProperty.class);
if (resumeBlocked) {
addProperty(new DisableResumeJobProperty());
}
bc.commit();
} finally {
bc.abort();
}
}
} catch (IOException ioe) {
LOGGER.log(Level.WARNING, "Error persisting resume property statue", ioe);
}
}
public void setConcurrentBuild(boolean b) throws IOException {
concurrentBuild = null;
boolean propertyExists = getProperty(DisableConcurrentBuildsJobProperty.class) != null;
// If the property exists, concurrent builds are disabled. So if the argument here is true and the
// property exists, we need to remove the property, while if the argument is false and the property
// does not exist, we need to add the property. Yay for flipping boolean values around!
if (propertyExists == b) {
BulkChange bc = new BulkChange(this);
try {
removeProperty(DisableConcurrentBuildsJobProperty.class);
if (!b) {
addProperty(new DisableConcurrentBuildsJobProperty());
}
bc.commit();
} finally {
bc.abort();
}
}
}
@Override public ACL getACL() {
ACL acl = super.getACL();
for (JobProperty<?> property : properties) {
if (property instanceof WorkflowJobProperty) {
acl = ((WorkflowJobProperty) property).decorateACL(acl);
}
}
return acl;
}
@Override public void checkAbortPermission() {
checkPermission(CANCEL);
}
@Override public boolean hasAbortPermission() {
return hasPermission(CANCEL);
}
/**
* @deprecated Just use {@link #CANCEL}.
*/
@Deprecated
public static final Permission ABORT = CANCEL;
@Override public Collection<? extends SubTask> getSubTasks() {
// TODO mostly copied from AbstractProject, except SubTaskContributor is not available:
List<SubTask> subTasks = new ArrayList<>();
subTasks.add(this);
for (JobProperty<? super WorkflowJob> p : properties) {
subTasks.addAll(p.getSubTasks());
}
return subTasks;
}
@SuppressFBWarnings(value="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE", justification="TODO 1.653+ switch to Jenkins.getInstanceOrNull")
@Override public Label getAssignedLabel() {
Jenkins j = Jenkins.getInstance();
if (j == null) {
return null;
}
return j.getSelfLabel();
}
@Override public Node getLastBuiltOn() {
return Jenkins.getInstance();
}
@Override public Object getSameNodeConstraint() {
return this;
}
@Override public String getPronoun() {
return AlternativeUiTextProvider.get(PRONOUN, this, "Pipeline");
}
@Override public TopLevelItemDescriptor getDescriptor() {
return (DescriptorImpl) Jenkins.getActiveInstance().getDescriptorOrDie(WorkflowJob.class);
}
@Override public Map<TriggerDescriptor, Trigger<?>> getTriggers() {
return getTriggersJobProperty().getTriggersMap();
}
public PipelineTriggersJobProperty getTriggersJobProperty() {
PipelineTriggersJobProperty triggerProp = getProperty(PipelineTriggersJobProperty.class);
if (triggerProp == null) {
triggerProp = new PipelineTriggersJobProperty(new ArrayList<Trigger>());
}
return triggerProp;
}
@Restricted(NoExternalUse.class)
public void addTriggersJobPropertyWithoutStart(PipelineTriggersJobProperty prop) throws IOException {
super.addProperty(prop);
}
public void setTriggers(List<Trigger<?>> inputTriggers) throws IOException {
triggers = null;
BulkChange bc = new BulkChange(this);
try {
PipelineTriggersJobProperty originalProp = getTriggersJobProperty();
removeProperty(PipelineTriggersJobProperty.class);
PipelineTriggersJobProperty triggerProp = new PipelineTriggersJobProperty(null);
triggerProp.setTriggers(inputTriggers);
addProperty(triggerProp);
bc.commit();
originalProp.stopTriggers();
// No longer need to start triggers here - that's done by when we add the property.
} finally {
bc.abort();
}
}
public void addTrigger(Trigger trigger) throws IOException {
BulkChange bc = new BulkChange(this);
try {
PipelineTriggersJobProperty originalProp = getTriggersJobProperty();
Trigger old = originalProp.getTriggerForDescriptor(trigger.getDescriptor());
if (old != null) {
originalProp.removeTrigger(old);
old.stop();
}
originalProp.addTrigger(trigger);
removeProperty(PipelineTriggersJobProperty.class);
addProperty(originalProp);
bc.commit();
} finally {
bc.abort();
}
}
@Override
public void removeProperty(JobProperty jobProperty) throws IOException {
// Need to make sure we stop any triggers.
if (jobProperty instanceof PipelineTriggersJobProperty) {
((PipelineTriggersJobProperty)jobProperty).stopTriggers();
}
super.removeProperty(jobProperty);
}
@Override
public void addAction(Action a) {
super.getActions().add(a);
}
@Override
public void replaceAction(Action a) {
// CopyOnWriteArrayList does not support Iterator.remove, so need to do it this way:
List<Action> old = new ArrayList<>(1);
List<Action> current = super.getActions();
for (Action a2 : current) {
if (a2.getClass() == a.getClass()) {
old.add(a2);
}
}
current.removeAll(old);
addAction(a);
}
@Override public Item asItem() {
return this;
}
@Override public SCMTrigger getSCMTrigger() {
for (Trigger t : getTriggersJobProperty().getTriggers()) {
if (t instanceof SCMTrigger) {
return (SCMTrigger) t;
}
}
return null;
}
@Override public Collection<? extends SCM> getSCMs() {
WorkflowRun b = getLastSuccessfulBuild();
if (b == null) {
b = getLastCompletedBuild();
}
if (b == null) {
return Collections.emptySet();
}
Map<String,SCM> scms = new LinkedHashMap<>();
for (WorkflowRun.SCMCheckout co : b.checkouts(null)) {
scms.put(co.scm.getKey(), co.scm);
}
return scms.values();
}
public @CheckForNull SCM getTypicalSCM() {
SCM typical = null;
for (SCM scm : getSCMs()) {
if (typical == null) {
typical = scm;
} else if (typical.getDescriptor() != scm.getDescriptor()) {
return null;
}
}
return typical;
}
@SuppressFBWarnings(value="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE", justification="TODO 1.653+ switch to Jenkins.getInstanceOrNull")
@Override public PollingResult poll(TaskListener listener) {
if (!isBuildable()) {
listener.getLogger().println("Build disabled");
return PollingResult.NO_CHANGES;
}
// TODO 2.11+ call SCMDecisionHandler
// TODO call SCMPollListener
WorkflowRun lastBuild = getLastBuild();
if (lastBuild == null) {
listener.getLogger().println("no previous build to compare to");
// Note that we have no equivalent of AbstractProject.NoSCM because without an initial build we do not know if this project has any SCM at all.
return Queue.getInstance().contains(this) ? PollingResult.NO_CHANGES : PollingResult.BUILD_NOW;
}
WorkflowRun perhapsCompleteBuild = getLastSuccessfulBuild();
if (perhapsCompleteBuild == null) {
perhapsCompleteBuild = lastBuild;
}
if (pollingBaselines == null) {
pollingBaselines = new ConcurrentHashMap<>();
}
PollingResult result = PollingResult.NO_CHANGES;
for (WorkflowRun.SCMCheckout co : perhapsCompleteBuild.checkouts(listener)) {
if (!co.scm.supportsPolling()) {
listener.getLogger().println("polling not supported from " + co.workspace + " on " + co.node);
continue;
}
String key = co.scm.getKey();
SCMRevisionState pollingBaseline = pollingBaselines.get(key);
if (pollingBaseline == null) {
pollingBaseline = co.pollingBaseline; // after a restart, transient cache will be empty
}
if (pollingBaseline == null) {
listener.getLogger().println("no polling baseline in " + co.workspace + " on " + co.node);
continue;
}
try {
FilePath workspace;
Launcher launcher;
WorkspaceList.Lease lease;
if (co.scm.requiresWorkspaceForPolling()) {
Jenkins j = Jenkins.getInstance();
if (j == null) {
listener.error("Jenkins is shutting down");
continue;
}
Computer c = j.getComputer(co.node);
if (c == null) {
listener.error("no such computer " + co.node);
continue;
}
workspace = new FilePath(c.getChannel(), co.workspace);
launcher = workspace.createLauncher(listener).decorateByEnv(getEnvironment(c.getNode(), listener));
lease = c.getWorkspaceList().acquire(workspace, !isConcurrentBuild());
} else {
workspace = null;
launcher = null;
lease = null;
}
PollingResult r;
try {
r = co.scm.compareRemoteRevisionWith(this, launcher, workspace, listener, pollingBaseline);
if (r.remote != null) {
pollingBaselines.put(key, r.remote);
}
} finally {
if (lease != null) {
lease.release();
}
}
if (r.change.compareTo(result.change) > 0) {
result = r; // note that if we are using >1 checkout, we can clobber baseline/remote here; anyway SCMTrigger only calls hasChanges()
}
} catch (AbortException x) {
listener.error("polling failed in " + co.workspace + " on " + co.node + ": " + x.getMessage());
} catch (Exception x) {
listener.error("polling failed in " + co.workspace + " on " + co.node).println(Functions.printThrowable(x).trim()); // TODO 2.43+ use Functions.printStackTrace
}
}
return result;
}
@Extension public static final class SCMListenerImpl extends SCMListener {
@Override public void onCheckout(Run<?,?> build, SCM scm, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState pollingBaseline) throws Exception {
if (build instanceof WorkflowRun && pollingBaseline != null) {
WorkflowJob job = ((WorkflowRun) build).getParent();
if (job.pollingBaselines == null) {
job.pollingBaselines = new ConcurrentHashMap<>();
}
job.pollingBaselines.put(scm.getKey(), pollingBaseline);
}
}
}
@Override protected void performDelete() throws IOException, InterruptedException {
makeDisabled(true);
// TODO call SCM.processWorkspaceBeforeDeletion
super.performDelete();
}
@Initializer(before=InitMilestone.EXTENSIONS_AUGMENTED)
public static void alias() {
Items.XSTREAM2.alias("flow-definition", WorkflowJob.class);
WorkflowRun.alias();
}
@Extension(ordinal=1) public static final class DescriptorImpl extends TopLevelItemDescriptor {
@Override public String getDisplayName() {
return Messages.WorkflowJob_DisplayName();
}
@Override public TopLevelItem newInstance(ItemGroup parent, String name) {
return new WorkflowJob(parent, name);
}
/**
* Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.
*
* TODO: Override when the baseline is upgraded to 2.x
* TODO: Replace to {@code StandaloneProjectsCategory.ID}
*
* @return A string it represents a ItemCategory identifier.
*/
public String getCategoryId() {
return "standalone-projects";
}
/**
* Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.
*
* TODO: Override when the baseline is upgraded to 2.x
*
* @return A string with the Item description.
*/
public String getDescription() {
return Messages.WorkflowJob_Description();
}
/**
* Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.
*
* TODO: Override when the baseline is upgraded to 2.x
*
* @return A string it represents a URL pattern to get the Item icon in different sizes.
*/
public String getIconFilePathPattern() {
return "plugin/workflow-job/images/:size/pipelinejob.png";
}
/** TODO JENKINS-20020 can delete this in case {@code f:dropdownDescriptorSelector} defaults to applying {@code h.filterDescriptors} */
@Restricted(DoNotUse.class) // Jelly
public Collection<FlowDefinitionDescriptor> getDefinitionDescriptors(WorkflowJob context) {
return DescriptorVisibilityFilter.apply(context, ExtensionList.lookup(FlowDefinitionDescriptor.class));
}
}
}