forked from d6y/hudson-s3
-
Notifications
You must be signed in to change notification settings - Fork 193
/
S3BucketPublisher.java
501 lines (412 loc) · 18.4 KB
/
S3BucketPublisher.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
package hudson.plugins.s3;
import com.amazonaws.AmazonClientException;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.s3.AmazonS3Client;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import hudson.*;
import hudson.model.*;
import hudson.model.listeners.RunListener;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.BuildStepMonitor;
import hudson.tasks.Fingerprinter.FingerprintAction;
import hudson.tasks.Publisher;
import hudson.tasks.Recorder;
import hudson.util.CopyOnWriteList;
import hudson.util.FormValidation;
import hudson.util.ListBoxModel;
import jenkins.model.Jenkins;
import jenkins.tasks.SimpleBuildStep;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import javax.annotation.Nonnull;
import java.io.IOException;
import java.io.PrintStream;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
public final class S3BucketPublisher extends Recorder implements SimpleBuildStep {
private String profileName;
@Extension
public static final DescriptorImpl DESCRIPTOR = new DescriptorImpl();
private final List<Entry> entries;
private boolean dontWaitForConcurrentBuildCompletion;
private Level consoleLogLevel;
private Result pluginFailureResultConstraint;
/**
* User metadata key/value pairs to tag the upload with.
*/
private /*almost final*/ List<MetadataPair> userMetadata;
@DataBoundConstructor
public S3BucketPublisher(String profileName, List<Entry> entries, List<MetadataPair> userMetadata,
boolean dontWaitForConcurrentBuildCompletion, String consoleLogLevel, String pluginFailureResultConstraint) {
if (profileName == null) {
// defaults to the first one
final S3Profile[] sites = DESCRIPTOR.getProfiles();
if (sites.length > 0)
profileName = sites[0].getName();
}
this.profileName = profileName;
this.entries = entries;
if (userMetadata == null)
userMetadata = new ArrayList<>();
this.userMetadata = userMetadata;
this.dontWaitForConcurrentBuildCompletion = dontWaitForConcurrentBuildCompletion;
this.consoleLogLevel = parseLevel(consoleLogLevel);
this.pluginFailureResultConstraint = Result.fromString(pluginFailureResultConstraint);
}
private Level parseLevel(String lvl) {
switch (lvl) {
case "WARNING": return Level.WARNING;
case "SEVERE": return Level.SEVERE;
default: return Level.INFO;
}
}
protected Object readResolve() {
if (userMetadata == null)
userMetadata = new ArrayList<>();
if (pluginFailureResultConstraint == null)
pluginFailureResultConstraint = Result.FAILURE;
if(consoleLogLevel==null)
consoleLogLevel = Level.INFO;
return this;
}
private Result constrainResult(Result r, @Nonnull TaskListener listener) {
final PrintStream console = listener.getLogger();
// pass through NOT_BUILT and ABORTED
if (r.isWorseThan(Result.FAILURE)) {
return r;
} else if (r.isWorseThan(pluginFailureResultConstraint)) {
log(console, "Build result constrained by configuration to: " + pluginFailureResultConstraint + " from: " + Result.UNSTABLE);
return pluginFailureResultConstraint;
}
return r;
}
@SuppressWarnings("unused")
public List<Entry> getEntries() {
return entries;
}
@SuppressWarnings("unused")
public List<MetadataPair> getUserMetadata() {
return userMetadata;
}
@SuppressWarnings("unused")
public String getProfileName() {
return this.profileName;
}
@SuppressWarnings("unused")
public Result getPluginFailureResultConstraint() {
if (pluginFailureResultConstraint == null) {
return Result.FAILURE;
}
return pluginFailureResultConstraint;
}
@SuppressWarnings("unused")
public boolean isDontWaitForConcurrentBuildCompletion() {
return dontWaitForConcurrentBuildCompletion;
}
@SuppressWarnings("unused")
public Level getConsoleLogLevel() {
return consoleLogLevel;
}
public S3Profile getProfile() {
return getProfile(profileName);
}
public static S3Profile getProfile(String profileName) {
final S3Profile[] profiles = DESCRIPTOR.getProfiles();
if (profileName == null && profiles.length > 0)
// default
return profiles[0];
for (S3Profile profile : profiles) {
if (profile.getName().equals(profileName))
return profile;
}
throw new IllegalArgumentException("Can't find profile: " + profileName);
}
@Override
public Collection<? extends Action> getProjectActions(AbstractProject<?, ?> project) {
return ImmutableList.of(new S3ArtifactsProjectAction(project));
}
private void log(final PrintStream logger, final String message) {
log(Level.INFO, logger, message);
}
private void log(final Level level, final PrintStream logger, final String message) {
if(level.intValue() >= consoleLogLevel.intValue()) {
logger.println(StringUtils.defaultString(getDescriptor().getDisplayName()) + ' ' + message);
}
}
@Override
public void perform(@Nonnull Run<?, ?> run, @Nonnull FilePath ws, @Nonnull Launcher launcher, @Nonnull TaskListener listener)
throws InterruptedException {
final PrintStream console = listener.getLogger();
if (Result.ABORTED.equals(run.getResult())) {
log(Level.SEVERE, console, "Skipping publishing on S3 because build aborted");
return;
}
if (run.isBuilding()) {
log(console, "Build is still running");
}
final S3Profile profile = getProfile();
if (profile == null) {
log(Level.SEVERE, console, "No S3 profile is configured.");
run.setResult(constrainResult(Result.UNSTABLE, listener));
return;
}
log(console, "Using S3 profile: " + profile.getName());
try {
final Map<String, String> envVars = run.getEnvironment(listener);
final Map<String, String> record = Maps.newHashMap();
final List<FingerprintRecord> artifacts = Lists.newArrayList();
for (Entry entry : entries) {
if (entry.noUploadOnFailure && Result.FAILURE.equals(run.getResult())) {
// build failed. don't post
log(Level.WARNING, console, "Skipping publishing on S3 because build failed");
continue;
}
final String expanded = Util.replaceMacro(entry.sourceFile, envVars);
final String exclude = Util.replaceMacro(entry.excludedFile, envVars);
if (expanded == null) {
throw new IOException();
}
final String bucket = Util.replaceMacro(entry.bucket, envVars);
final String storageClass = Util.replaceMacro(entry.storageClass, envVars);
final String selRegion = entry.selectedRegion;
final List<FilePath> paths = new ArrayList<>();
final List<String> filenames = new ArrayList<>();
for (String startPath : expanded.split(",")) {
for (FilePath path : ws.list(startPath, exclude)) {
if (path.isDirectory()) {
throw new IOException(path + " is a directory");
}
paths.add(path);
final int workspacePath = FileHelper.getSearchPathLength(ws.getRemote(),
startPath.trim(),
getProfile().isKeepStructure());
filenames.add(getFilename(path, entry.flatten, workspacePath));
log(console, "bucket=" + bucket + ", file=" + path.getName() + " region=" + selRegion + ", will be uploaded from slave=" + entry.uploadFromSlave + " managed=" + entry.managedArtifacts + " , server encryption " + entry.useServerSideEncryption);
}
}
if (paths.isEmpty()) {
printDiagnostics(ws, console, expanded);
continue;
}
final Map<String, String> escapedMetadata = buildMetadata(envVars, entry);
final List<FingerprintRecord> records = Lists.newArrayList();
final List<FingerprintRecord> fingerprints = profile.upload(run, bucket, paths, filenames, escapedMetadata, storageClass, selRegion, entry.uploadFromSlave, entry.managedArtifacts, entry.useServerSideEncryption, entry.gzipFiles);
for (FingerprintRecord fingerprintRecord : fingerprints) {
records.add(fingerprintRecord);
fingerprintRecord.setKeepForever(entry.keepForever);
fingerprintRecord.setShowDirectlyInBrowser(entry.showDirectlyInBrowser);
}
if (entry.managedArtifacts) {
artifacts.addAll(fingerprints);
fillFingerprints(run, listener, record, fingerprints);
}
}
// don't bother adding actions if none of the artifacts are managed
if (!artifacts.isEmpty()) {
addS3ArtifactsAction(run, profile, artifacts);
addFingerprintAction(run, record);
}
} catch (AmazonClientException|IOException e) {
e.printStackTrace(listener.error("Failed to upload files"));
run.setResult(constrainResult(Result.UNSTABLE, listener));
}
}
private void addS3ArtifactsAction(Run<?, ?> run, S3Profile profile, List<FingerprintRecord> artifacts) {
S3ArtifactsAction existingAction = run.getAction(S3ArtifactsAction.class);
if (existingAction != null) {
existingAction.addArtifacts(artifacts);
} else {
run.addAction(new S3ArtifactsAction(run, profile, artifacts));
}
}
private void addFingerprintAction(Run<?, ?> run, Map<String, String> record) {
FingerprintAction existingAction = run.getAction(FingerprintAction.class);
if (existingAction != null) {
existingAction.add(record);
} else {
run.addAction(new FingerprintAction(run, record));
}
}
private void printDiagnostics(@Nonnull FilePath ws, PrintStream console, String expanded) throws IOException {
log(Level.WARNING, console, "No file(s) found: " + expanded);
try {
final String error = ws.validateAntFileMask(expanded, 100);
if (error != null) {
log(Level.WARNING, console, error);
}
} catch (InterruptedException ignored) {
// don't want to die here just because
// validateAntFileMask found no alternative paths within
// alloted bounds limit
}
}
private void fillFingerprints(@Nonnull Run<?, ?> run, @Nonnull TaskListener listener, Map<String, String> record, List<FingerprintRecord> fingerprints) throws IOException {
for (FingerprintRecord r : fingerprints) {
final Fingerprint fp = r.addRecord(run);
if (fp == null) {
listener.error("Fingerprinting failed for " + r.getName());
continue;
}
fp.addFor(run);
record.put(r.getName(), fp.getHashString());
}
}
private Map<String, String> buildMetadata(Map<String, String> envVars, Entry entry) {
final Map<String, String> mergedMetadata = new HashMap<>();
if (userMetadata != null) {
for (MetadataPair pair : userMetadata) {
mergedMetadata.put(pair.key, pair.value);
}
}
if (entry.userMetadata != null) {
for (MetadataPair pair : entry.userMetadata) {
mergedMetadata.put(pair.key, pair.value);
}
}
final Map<String, String> escapedMetadata = new HashMap<>();
for (Map.Entry<String, String> mapEntry : mergedMetadata.entrySet()) {
escapedMetadata.put(
Util.replaceMacro(mapEntry.getKey(), envVars),
Util.replaceMacro(mapEntry.getValue(), envVars));
}
return escapedMetadata;
}
private String getFilename(FilePath src, boolean flatten, int searchIndex) {
final String fileName;
if (flatten) {
fileName = src.getName();
} else {
final String relativeFileName = src.getRemote();
fileName = relativeFileName.substring(searchIndex);
}
return fileName;
}
@Extension
public static final class S3DeletedJobListener extends RunListener<Run> {
@Override
public void onDeleted(Run run) {
final S3ArtifactsAction artifacts = run.getAction(S3ArtifactsAction.class);
if (artifacts != null) {
final S3Profile profile = S3BucketPublisher.getProfile(artifacts.getProfile());
for (FingerprintRecord record : artifacts.getArtifacts()) {
if (!record.isKeepForever()) {
profile.delete(run, record);
}
}
}
}
}
public BuildStepMonitor getRequiredMonitorService() {
return dontWaitForConcurrentBuildCompletion ? BuildStepMonitor.NONE : BuildStepMonitor.STEP;
}
public static final class DescriptorImpl extends BuildStepDescriptor<Publisher> {
private final CopyOnWriteList<S3Profile> profiles = new CopyOnWriteList<S3Profile>();
public static final Level[] consoleLogLevels = { Level.INFO, Level.WARNING, Level.SEVERE };
private static final Logger LOGGER = Logger.getLogger(DescriptorImpl.class.getName());
private static final Result[] pluginFailureResultConstraints = { Result.FAILURE, Result.UNSTABLE, Result.SUCCESS };
public DescriptorImpl(Class<? extends Publisher> clazz) {
super(clazz);
load();
}
public Regions[] regions = Entry.regions;
public String[] storageClasses = Entry.storageClasses;
public DescriptorImpl() {
this(S3BucketPublisher.class);
}
@Override
public String getDisplayName() {
return "Publish artifacts to S3 Bucket";
}
@Override
public String getHelpFile() {
return "/plugin/s3/help.html";
}
@Override
public boolean configure(StaplerRequest req, JSONObject json) {
final JSONArray array = json.optJSONArray("profile");
if (array != null) {
profiles.replaceBy(req.bindJSONToList(S3Profile.class, array));
} else {
profiles.replaceBy(req.bindJSON(S3Profile.class, json.getJSONObject("profile")));
}
save();
return true;
}
@SuppressWarnings("unused")
public ListBoxModel doFillProfileNameItems() {
final ListBoxModel model = new ListBoxModel();
for (S3Profile profile : profiles) {
model.add(profile.getName(), profile.getName());
}
return model;
}
public ListBoxModel doFillConsoleLogLevelItems() {
final ListBoxModel model = new ListBoxModel();
for (Level l : consoleLogLevels) {
model.add(l.getName(), l.getLocalizedName());
}
return model;
}
@SuppressWarnings("unused")
public ListBoxModel doFillPluginFailureResultConstraintItems() {
final ListBoxModel model = new ListBoxModel();
for (Result r : pluginFailureResultConstraints) {
model.add(r.toString(), r.toString());
}
return model;
}
@SuppressWarnings("unused")
public void replaceProfiles(List<S3Profile> profiles) {
this.profiles.replaceBy(profiles);
save();
}
public Level[] getConsoleLogLevels() {
return consoleLogLevels;
}
public S3Profile[] getProfiles() {
final S3Profile[] profileArray = new S3Profile[profiles.size()];
return profiles.toArray(profileArray);
}
public Result[] getPluginFailureResultConstraints() {
return pluginFailureResultConstraints;
}
@SuppressWarnings("unused")
public FormValidation doLoginCheck(final StaplerRequest req, StaplerResponse rsp) {
final String name = Util.fixNull(req.getParameter("name"));
final String accessKey = Util.fixNull(req.getParameter("accessKey"));
final String secretKey = Util.fixNull(req.getParameter("secretKey"));
final String useIAMCredential = Util.fixNull(req.getParameter("useRole"));
final boolean couldBeValidated = !name.isEmpty() && !accessKey.isEmpty() && !secretKey.isEmpty();
final boolean useRole = Boolean.parseBoolean(useIAMCredential);
if (!couldBeValidated) {
if (name.isEmpty())
return FormValidation.ok("Please, enter name");
if (useRole)
return FormValidation.ok();
if (accessKey.isEmpty())
return FormValidation.ok("Please, enter accessKey");
if (secretKey.isEmpty())
return FormValidation.ok("Please, enter secretKey");
}
final AmazonS3Client client = ClientHelper.createClient(accessKey, secretKey, useRole, Jenkins.getActiveInstance().proxy);
try {
client.listBuckets();
} catch (AmazonClientException e) {
LOGGER.log(Level.SEVERE, e.getMessage(), e);
return FormValidation.error("Can't connect to S3 service: " + e.getMessage());
}
return FormValidation.ok("Check passed!");
}
@Override
public boolean isApplicable(Class<? extends AbstractProject> aClass) {
return true;
}
}
}