Add supporting S3 tags

src/main/java/hudson/plugins/s3/Entry.java

@@ -90,11 +90,16 @@ public final class Entry implements Describable<Entry> {
     */
     public List<MetadataPair> userMetadata;
 
+    /**
+     * Tags overrides
+     */
+    public List<TagPair> userTags;
+
     @DataBoundConstructor
     public Entry(String bucket, String sourceFile, String excludedFile, String storageClass, String selectedRegion,
                  boolean noUploadOnFailure, boolean uploadFromSlave, boolean managedArtifacts,
                  boolean useServerSideEncryption, boolean flatten, boolean gzipFiles, boolean keepForever,
-                 boolean showDirectlyInBrowser, List<MetadataPair> userMetadata) {
+                 boolean showDirectlyInBrowser, List<MetadataPair> userMetadata, List<TagPair> userTags) {
         this.bucket = bucket;
         this.sourceFile = sourceFile;
         this.excludedFile = excludedFile;
@@ -108,6 +113,7 @@ public Entry(String bucket, String sourceFile, String excludedFile, String stora
         this.gzipFiles = gzipFiles;
         this.keepForever = keepForever;
         this.userMetadata = userMetadata;
+        this.userTags = userTags;
         this.showDirectlyInBrowser = showDirectlyInBrowser;
     }
 

src/main/java/hudson/plugins/s3/S3BucketPublisher.java

@@ -85,8 +85,13 @@
      */
     private /*almost final*/ List<MetadataPair> userMetadata;
 
+    /**
+     * User tag key/value pairs to tag the upload with.
+     */
+    private /*almost final*/ List<TagPair> userTags;
+
     @DataBoundConstructor
-    public S3BucketPublisher(String profileName, List<Entry> entries, List<MetadataPair> userMetadata,
+    public S3BucketPublisher(String profileName, List<Entry> entries, List<MetadataPair> userMetadata, List<TagPair> userTags,
                              boolean dontWaitForConcurrentBuildCompletion, String consoleLogLevel, String pluginFailureResultConstraint,
                              boolean dontSetBuildResultOnFailure) {
         if (profileName == null) {
@@ -104,74 +109,87 @@
             this.userMetadata = new ArrayList<>();
         }
 
+        this.userTags = userTags;
+        if (this.userTags == null) {
+            this.userTags = new ArrayList<>();
+        }
+
         this.dontWaitForConcurrentBuildCompletion = dontWaitForConcurrentBuildCompletion;
         this.dontSetBuildResultOnFailure = dontSetBuildResultOnFailure;
         this.consoleLogLevel = parseLevel(consoleLogLevel);
         this.consoleLogLevelString = this.consoleLogLevel.getName();
         if (pluginFailureResultConstraint == null) {
             this.pluginFailureResultConstraint = Result.FAILURE;
         } else {
             this.pluginFailureResultConstraint = Result.fromString(pluginFailureResultConstraint);
         }
     }
 
     private Level parseLevel(String lvl) {
         if (lvl == null)
             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 (userTags == null)
+            userTags = new ArrayList<>();
+
         if (pluginFailureResultConstraint == null)
             pluginFailureResultConstraint = Result.FAILURE;
 
         if (consoleLogLevel != null && consoleLogLevelString == null) {
             consoleLogLevelString = consoleLogLevel.getName();
         }
 
         if (consoleLogLevel == null && consoleLogLevelString != null) {
             consoleLogLevel = parseLevel(consoleLogLevelString);
         }
 
         if(consoleLogLevel==null)
             consoleLogLevel = Level.INFO;
 
         if (consoleLogLevelString == null) {
             consoleLogLevelString = consoleLogLevel.getName();
         }
 
         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 List<TagPair> getUserTags() {
+        return userTags;
+    }
+
     @SuppressWarnings("unused")
     public String getProfileName() {
         return this.profileName;
@@ -317,9 +335,10 @@
 
 
                 final Map<String, String> escapedMetadata = buildMetadata(envVars, entry);
+                final Map<String, String> escapedTags = buildTags(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);
+                final List<FingerprintRecord> fingerprints = profile.upload(run, bucket, paths, filenames, escapedMetadata, escapedTags, storageClass, selRegion, entry.uploadFromSlave, entry.managedArtifacts, entry.useServerSideEncryption, entry.gzipFiles);
 
                 for (FingerprintRecord fingerprintRecord : fingerprints) {
                     records.add(fingerprintRecord);
@@ -420,6 +439,32 @@
         return escapedMetadata;
     }
 
+    private Map<String, String> buildTags(Map<String, String> envVars, Entry entry) {
+        final Map<String, String> mergedTags = new HashMap<>();
+
+        if (userTags != null) {
+            for (TagPair pair : userTags) {
+                mergedTags.put(pair.key, pair.value);
+            }
+        }
+
+        if (entry.userTags != null) {
+            for (TagPair pair : entry.userTags) {
+                mergedTags.put(pair.key, pair.value);
+            }
+        }
+
+        final Map<String, String> escapedTags = new HashMap<>();
+
+        for (Map.Entry<String, String> mapEntry : mergedTags.entrySet()) {
+            escapedTags.put(
+                    Util.replaceMacro(mapEntry.getKey(), envVars),
+                    Util.replaceMacro(mapEntry.getValue(), envVars));
+        }
+
+        return escapedTags;
+    }
+
     private String getFilename(FilePath src, boolean flatten, int searchIndex) {
         final String fileName;
         if (flatten) {

src/main/java/hudson/plugins/s3/S3Profile.java

@@ -126,6 +126,7 @@
                                     final List<FilePath> filePaths,
                                     final List<String> fileNames,
                                     final Map<String, String> userMetadata,
+                                    final Map<String, String> userTags,
                                     final String storageClass,
                                     final String selregion,
                                     final boolean uploadFromSlave,
@@ -151,10 +152,10 @@
 
                 final MasterSlaveCallable<String> upload;
                 if (gzipFiles) {
-                    upload = new S3GzipCallable(accessKey, secretKey, useRole, dest, userMetadata,
+                    upload = new S3GzipCallable(accessKey, secretKey, useRole, dest, userMetadata, userTags,
                             storageClass, selregion, useServerSideEncryption, getProxy());
                 } else {
-                    upload = new S3UploadCallable(accessKey, secretKey, useRole, dest, userMetadata,
+                    upload = new S3UploadCallable(accessKey, secretKey, useRole, dest, userMetadata, userTags,
                             storageClass, selregion, useServerSideEncryption, getProxy());
                 }
 

src/main/java/hudson/plugins/s3/TagPair.java

@@ -0,0 +1,43 @@
+package hudson.plugins.s3;
+
+import hudson.Extension;
+import hudson.model.Describable;
+import hudson.model.Descriptor;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public final class TagPair implements Describable<TagPair> {
+
+    /**
+     * The key of the user tag pair to tag an upload with.
+     * Can contain macros.
+     */
+    public String key;
+
+    /**
+     * The key of the user tag pair to tag an upload with.
+     * Can contain macros.
+     */
+    public String value;
+
+    @DataBoundConstructor
+    public TagPair(String key, String value) {
+        this.key = key;
+        this.value = value;
+    }
+
+    public Descriptor<TagPair> getDescriptor() {
+        return DESCRIPOR;
+    }
+
+    @Extension
+    public final static DescriptorImpl DESCRIPOR = new DescriptorImpl();
+
+    public static class DescriptorImpl extends Descriptor<TagPair> {
+
+        @Override
+        public String getDisplayName() {
+            return "Tag";
+        }
+    };
+}
+

src/main/java/hudson/plugins/s3/Uploads.java

@@ -2,6 +2,7 @@
 
 import com.amazonaws.AmazonServiceException;
 import com.amazonaws.services.s3.model.ObjectMetadata;
+import com.amazonaws.services.s3.model.ObjectTagging;
 import com.amazonaws.services.s3.model.PutObjectRequest;
 import com.amazonaws.services.s3.transfer.TransferManager;
 import com.amazonaws.services.s3.transfer.Upload;
@@ -21,8 +22,8 @@
     private final transient HashMap<FilePath, Upload> startedUploads = new HashMap<>();
     private final transient HashMap<FilePath, InputStream> openedStreams = new HashMap<>();
 
-    public Upload startUploading(TransferManager manager, FilePath file, InputStream inputsStream, String bucketName, String objectName, ObjectMetadata metadata) throws AmazonServiceException {
-        final PutObjectRequest request = new PutObjectRequest(bucketName, objectName, inputsStream, metadata);
+    public Upload startUploading(TransferManager manager, FilePath file, InputStream inputsStream, String bucketName, String objectName, ObjectMetadata metadata, ObjectTagging tags) throws AmazonServiceException {
+        final PutObjectRequest request = new PutObjectRequest(bucketName, objectName, inputsStream, metadata).withTagging(tags);
 
         // Set the buffer size (ReadLimit) equal to the multipart upload size,
         // allowing us to resend data if the connection breaks.

src/main/java/hudson/plugins/s3/callable/S3BaseUploadCallable.java

@@ -2,6 +2,8 @@
 
 import com.amazonaws.services.s3.internal.Mimetypes;
 import com.amazonaws.services.s3.model.ObjectMetadata;
+import com.amazonaws.services.s3.model.ObjectTagging;
+import com.amazonaws.services.s3.model.Tag;
 import hudson.FilePath;
 import hudson.ProxyConfiguration;
 import hudson.plugins.s3.Destination;
@@ -12,24 +14,28 @@
 import java.io.IOException;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
+import java.util.ArrayList;
 import java.util.Date;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 public abstract class S3BaseUploadCallable extends S3Callable<String> {
     private static final long serialVersionUID = 1L;
     private final Destination dest;
     private final String storageClass;
     private final Map<String, String> userMetadata;
+    private final Map<String, String> userTags;
     private final boolean useServerSideEncryption;
 
-
     public S3BaseUploadCallable(String accessKey, Secret secretKey, boolean useRole,
-                                Destination dest, Map<String, String> userMetadata, String storageClass, String selregion,
-                                boolean useServerSideEncryption, ProxyConfiguration proxy) {
+                                Destination dest, Map<String, String> userMetadata, Map<String, String> userTags,
+                                String storageClass, String selregion, boolean useServerSideEncryption, ProxyConfiguration proxy) {
         super(accessKey, secretKey, useRole, selregion, proxy);
         this.dest = dest;
         this.storageClass = storageClass;
         this.userMetadata = userMetadata;
+        this.userTags = userTags;
         this.useServerSideEncryption = useServerSideEncryption;
     }
 
@@ -86,6 +92,15 @@
         return metadata;
     }
 
+    protected ObjectTagging s3Tagging() {
+
+        final List<Tag> tags = userTags.entrySet().stream()
+                .map(entry -> new Tag(entry.getKey(), entry.getValue()))
+                .collect(Collectors.toList());
+
+        return new ObjectTagging(tags);
+    }
+
     public Destination getDest() {
         return dest;
     }

src/main/java/hudson/plugins/s3/callable/S3GzipCallable.java

@@ -1,6 +1,7 @@
 package hudson.plugins.s3.callable;
 
 import com.amazonaws.services.s3.model.ObjectMetadata;
+import com.amazonaws.services.s3.model.ObjectTagging;
 import com.amazonaws.services.s3.transfer.Upload;
 import com.amazonaws.event.ProgressListener;
 import com.amazonaws.event.ProgressEvent;
@@ -23,65 +24,66 @@
 import java.util.zip.GZIPOutputStream;
 
 public final class S3GzipCallable extends S3BaseUploadCallable implements MasterSlaveCallable<String> {
-    public S3GzipCallable(String accessKey, Secret secretKey, boolean useRole, Destination dest, Map<String, String> userMetadata, String storageClass, String selregion, boolean useServerSideEncryption, ProxyConfiguration proxy) {
-        super(accessKey, secretKey, useRole, dest, userMetadata, storageClass, selregion, useServerSideEncryption, proxy);
+    public S3GzipCallable(String accessKey, Secret secretKey, boolean useRole, Destination dest, Map<String, String> userMetadata, Map<String, String> userTags, String storageClass, String selregion, boolean useServerSideEncryption, ProxyConfiguration proxy) {
+        super(accessKey, secretKey, useRole, dest, userMetadata, userTags, storageClass, selregion, useServerSideEncryption, proxy);
     }
 
     // Return a File containing the gzipped contents of the input file.
     @SuppressFBWarnings("RV_RETURN_VALUE_IGNORED_BAD_PRACTICE")
     private File gzipFile(FilePath file) throws IOException, InterruptedException {
         final File localFile = File.createTempFile("s3plugin", ".bin");
         try (InputStream inputStream = file.read()) {
             try (OutputStream outputStream = new FileOutputStream(localFile)) {
                 try (OutputStream gzipStream = new GZIPOutputStream(outputStream, true)) {
                     IOUtils.copy(inputStream, gzipStream);
                     gzipStream.flush();
                 }
             }
         } catch (RuntimeException ex) {
             localFile.delete();
             throw ex;
         }
         return localFile;
     }
 
     // Hook to ensure that the file is deleted once the upload finishes.
     private static class CleanupHook implements ProgressListener {
         private final File localFile;
 
         CleanupHook(File localFile) {
             this.localFile = localFile;
         }
 
         @Override
         @SuppressFBWarnings({ "RV_RETURN_VALUE_IGNORED_BAD_PRACTICE", "SF_SWITCH_NO_DEFAULT" })
         public void progressChanged(ProgressEvent event) {
             switch (event.getEventType()) {
             case TRANSFER_CANCELED_EVENT:
             case TRANSFER_COMPLETED_EVENT:
             case TRANSFER_FAILED_EVENT:
                 localFile.delete();
             }
         }
     }
 
     @Override
     @SuppressFBWarnings({"RV_RETURN_VALUE_IGNORED_BAD_PRACTICE","OBL_UNSATISFIED_OBLIGATION"})
     public String invoke(FilePath file) throws IOException, InterruptedException {
         final File localFile = gzipFile(file);
         Upload upload = null;
 
         try {
             // This stream is asynchronously used in startUploading,
             // so we cannot use its AutoCloseable behaviour with a
             // try-with-resources statement, as that would likely
             // close the stream before the upload has succeeded.
             final InputStream gzippedStream = new FileInputStream(localFile);
             final ObjectMetadata metadata = buildMetadata(file);
+            final ObjectTagging tags = s3Tagging();
             metadata.setContentEncoding("gzip");
             metadata.setContentLength(localFile.length());
 
-            upload = Uploads.getInstance().startUploading(getTransferManager(), file, gzippedStream, getDest().bucketName, getDest().objectName, metadata);
+            upload = Uploads.getInstance().startUploading(getTransferManager(), file, gzippedStream, getDest().bucketName, getDest().objectName, metadata, tags);
 
             String md5 = MD5.generateFromFile(localFile);
 

src/main/java/hudson/plugins/s3/callable/S3UploadCallable.java

@@ -1,6 +1,7 @@
 package hudson.plugins.s3.callable;
 
 import com.amazonaws.services.s3.model.ObjectMetadata;
+import com.amazonaws.services.s3.model.ObjectTagging;
 import hudson.FilePath;
 import hudson.ProxyConfiguration;
 import hudson.plugins.s3.Destination;
@@ -14,8 +15,8 @@
 public final class S3UploadCallable extends S3BaseUploadCallable implements MasterSlaveCallable<String> {
     private static final long serialVersionUID = 1L;
 
-    public S3UploadCallable(String accessKey, Secret secretKey, boolean useRole, Destination dest, Map<String, String> userMetadata, String storageClass, String selregion, boolean useServerSideEncryption, ProxyConfiguration proxy) {
-        super(accessKey, secretKey, useRole, dest, userMetadata, storageClass, selregion, useServerSideEncryption, proxy);
+    public S3UploadCallable(String accessKey, Secret secretKey, boolean useRole, Destination dest, Map<String, String> userMetadata, Map<String, String> userTags, String storageClass, String selregion, boolean useServerSideEncryption, ProxyConfiguration proxy) {
+        super(accessKey, secretKey, useRole, dest, userMetadata, userTags, storageClass, selregion, useServerSideEncryption, proxy);
     }
 
     /**
@@ -24,9 +25,11 @@
     @Override
     public String invoke(FilePath file) throws IOException, InterruptedException {
         final ObjectMetadata metadata = buildMetadata(file);
+        final ObjectTagging tags = s3Tagging();
 
-        Uploads.getInstance().startUploading(getTransferManager(), file, file.read(), getDest().bucketName, getDest().objectName, metadata);
+        Uploads.getInstance().startUploading(getTransferManager(), file, file.read(), getDest().bucketName, getDest().objectName, metadata, tags);
 
         return MD5.generateFromFile(file);
     }
-}
+
+}

src/main/resources/hudson/plugins/s3/Entry/config.jelly

@@ -49,5 +49,14 @@
                 </f:entry>
             </f:repeatableProperty>
         </f:entry>
+        <f:entry title="Object tags">
+            <f:repeatableProperty field="userTags">
+                <f:entry title="">
+                    <div align="right">
+                        <f:repeatableDeleteButton />
+                    </div>
+                </f:entry>
+            </f:repeatableProperty>
+        </f:entry>
 
 </j:jelly>

src/main/resources/hudson/plugins/s3/S3BucketPublisher/config.jelly

@@ -26,6 +26,16 @@
     </f:repeatableProperty>
   </f:entry>
 
+  <f:entry title="Object tags">
+    <f:repeatableProperty field="userTags">
+      <f:entry title="">
+        <div align="right">
+          <f:repeatableDeleteButton />
+        </div>
+      </f:entry>
+    </f:repeatableProperty>
+  </f:entry>
+
   <f:entry title="Publish Failure Result Constraint" field="pluginFailureResultConstraint">
     <f:select />
   </f:entry>

src/main/resources/hudson/plugins/s3/TagPair/config.jelly

@@ -0,0 +1,11 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+
+    <f:entry title="Tag key" field="key">
+        <f:textbox />
+    </f:entry>
+    <f:entry title="Tag value" field="value">
+        <f:textbox />
+    </f:entry>
+
+</j:jelly>

src/main/resources/hudson/plugins/s3/TagPair/help-key.html

@@ -0,0 +1,4 @@
+<div>
+    Tag key for the files from this build. Can contain macros (e.g. environment
+    variables).
+</div>

src/main/resources/hudson/plugins/s3/TagPair/help-value.html

@@ -0,0 +1,4 @@
+<div>
+    Tag value for the files from this build. Can contain macros (e.g.
+    environment variables).
+</div>

src/test/java/hudson/plugins/s3/MinIOTest.java

@@ -146,11 +146,14 @@ private static void createAndRunPublisher(final JenkinsRule r) throws Exception
                         false,
                         true,
                         false,
+                        Collections.emptyList(),
                         Collections.emptyList())),
                 Collections.emptyList(),
+                Collections.emptyList(),
                 true,
                 "FINE",
-                null, false));
+                null,
+                false));
         r.buildAndAssertSuccess(job);
     }