XRAYJENKINS-52 features files are now being upload in a single Zip file

Author: Hugo Braz

src/main/java/com/xpandit/plugins/xrayjenkins/Utils/FileUtils.java

@@ -7,6 +7,7 @@
  */
 package com.xpandit.plugins.xrayjenkins.Utils;
 
+import com.google.common.collect.Sets;
 import com.xpandit.plugins.xrayjenkins.exceptions.XrayJenkinsGenericException;
 import hudson.FilePath;
 import hudson.model.TaskListener;
@@ -15,6 +16,8 @@
 import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Set;
+import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang3.StringUtils;
 import java.util.Collections;
 
@@ -53,6 +56,24 @@ public static List<FilePath> getFeatureFilesFromWorkspace(FilePath workspace,
         }
         return paths;
     }
+    
+    public static Set<String> getFeatureFileNamesFromWorkspace(FilePath workspace,
+                                                               String path,
+                                                               TaskListener listener) throws IOException, InterruptedException {
+        final List<FilePath> filePaths = getFeatureFilesFromWorkspace(workspace, path, listener);
+        final Set<String> fileNames = Sets.newHashSet();
+        
+        if (CollectionUtils.isNotEmpty(filePaths)) {
+            for (FilePath fp : filePaths) {
+                String remoteFileName = fp.getRemote();
+                if (StringUtils.isNotBlank(remoteFileName)) {
+                    fileNames.add(remoteFileName);
+                }
+            }
+        }
+        
+        return Collections.unmodifiableSet(fileNames);
+    }
 
     private static String getErrors(FilePath workspace,
                            String path,

src/main/java/com/xpandit/plugins/xrayjenkins/task/XrayImportFeatureBuilder.java

@@ -16,6 +16,7 @@
 import com.xpandit.plugins.xrayjenkins.model.HostingType;
 import com.xpandit.plugins.xrayjenkins.model.ServerConfiguration;
 import com.xpandit.plugins.xrayjenkins.model.XrayInstance;
+import com.xpandit.plugins.xrayjenkins.task.filefilters.OnlyFeatureFilesInPathFilter;
 import com.xpandit.xray.exception.XrayClientCoreGenericException;
 import com.xpandit.xray.model.FileStream;
 import com.xpandit.xray.model.UploadResult;
@@ -34,9 +35,12 @@
 import hudson.tasks.Builder;
 import hudson.util.FormValidation;
 import hudson.util.ListBoxModel;
+import java.io.File;
+import java.io.FileFilter;
 import java.io.IOException;
 import java.util.Date;
 import java.util.List;
+import java.util.Set;
 import javax.annotation.Nonnull;
 import jenkins.tasks.SimpleBuildStep;
 import org.apache.commons.lang3.StringUtils;
@@ -49,7 +53,9 @@
 /**
  * This class is responsible for performing the Xray: Cucumber Features Import Task
  */
-public class XrayImportFeatureBuilder extends Builder implements SimpleBuildStep{
+public class XrayImportFeatureBuilder extends Builder implements SimpleBuildStep {
+    
+    private static final String TMP_ZIP_FILENAME = "xray_cucumber_features.zip";
 
     private String serverInstance;
     private String folderPath;
@@ -142,26 +148,22 @@ public void perform(@Nonnull Run<?, ?> run,
 
     }
 
-    private void processImport(FilePath workspace,
-                          XrayTestImporter client,
-                          TaskListener listener) throws IOException, InterruptedException {
-        List<FilePath> paths;
-        try{
-            paths = FileUtils.getFeatureFilesFromWorkspace(workspace, this.folderPath, listener);
-        } catch (IOException | InterruptedException e){
-            listener.getLogger().println("An error occurred while getting the feature files");
-            throw e;
-        }
+    private void processImport(final FilePath workspace,
+                          final XrayTestImporter client,
+                          final TaskListener listener) throws IOException, InterruptedException {
+        
         try{
-            for(FilePath fp : paths){
-                if(isApplicableAsModifiedFile(fp)){
-                    FileStream f = new com.xpandit.xray.model.FileStream(fp.getName(),
-                            fp.read(),
-                            ContentType.APPLICATION_JSON);
-                    UploadResult up = client.importFeatures(this.projectKey, f);
-                    listener.getLogger().println(up.getMessage());
-                }
-            }
+            final Set<String> validFilePath = FileUtils.getFeatureFileNamesFromWorkspace(workspace, this.folderPath, listener);
+            final FilePath zipFile = createZipFile(workspace);
+            
+            // Create Zip file in the workspace's root folder
+            workspace.zip(zipFile.write(), new OnlyFeatureFilesInPathFilter(validFilePath, lastModified));
+
+            // Uploads the Zip file to the Jira instance
+            uploadZipFile(client, listener, zipFile);
+            
+            // Deletes the Zip File
+            deleteFile(zipFile, listener);
 
         } catch(XrayClientCoreGenericException  e){
             listener.error(e.getMessage());
@@ -171,28 +173,28 @@ private void processImport(FilePath workspace,
         }
 
     }
-
-    private boolean isApplicableAsModifiedFile(FilePath filePath) throws InterruptedException, IOException{
-        if(StringUtils.isBlank(lastModified)){
-            //the modified field is not used so we return true
-            return true;
+    
+    private void deleteFile(FilePath file, TaskListener listener) throws IOException, InterruptedException {
+        try {
+            file.delete();
+            listener.getLogger().println("Temporary file: " + file.getRemote() + " deleted");
+        } catch (IOException | InterruptedException e) {
+            listener.getLogger().println("Unable to delete temporary file: " + file.getRemote());
+            throw e;
         }
-        int lastModifiedIntValue = getLastModifiedIntValue();
-        Long diffInMillis = new Date().getTime() - filePath.lastModified();
-        Long diffInHour = diffInMillis /  DateUtils.MILLIS_PER_HOUR;
-        return diffInHour <= lastModifiedIntValue;
     }
 
-    private int getLastModifiedIntValue(){
-        try{
-            int m = Integer.parseInt(this.lastModified);
-            if(m <= 0){
-                throw new XrayJenkinsGenericException("last modified value must be a positive integer");
-            }
-            return m;
-        } catch (NumberFormatException e){
-            throw new XrayJenkinsGenericException("last modified value is not an integer");
-        }
+    private void uploadZipFile(XrayTestImporter client, TaskListener listener, FilePath zipFile) throws IOException, InterruptedException {
+        FileStream zipFileStream = new FileStream(
+                zipFile.getName(),
+                zipFile.read(),
+                ContentType.APPLICATION_JSON);
+        UploadResult uploadResult = client.importFeatures(this.projectKey, zipFileStream);
+        listener.getLogger().println(uploadResult.getMessage());
+    }
+
+    private FilePath createZipFile(final FilePath workspace) {
+        return new FilePath(workspace, TMP_ZIP_FILENAME);
     }
 
     @Extension

src/main/java/com/xpandit/plugins/xrayjenkins/task/filefilters/OnlyFeatureFilesInPathFilter.java

@@ -0,0 +1,60 @@
+package com.xpandit.plugins.xrayjenkins.task.filefilters;
+
+import com.xpandit.plugins.xrayjenkins.exceptions.XrayJenkinsGenericException;
+import hudson.FilePath;
+import java.io.File;
+import java.io.FileFilter;
+import java.io.IOException;
+import java.util.Date;
+import java.util.Set;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.time.DateUtils;
+
+public class OnlyFeatureFilesInPathFilter implements FileFilter {
+
+    private final Set<String> validFilePaths;
+    private final String lastModified;
+    
+    public OnlyFeatureFilesInPathFilter(Set<String> validFilePaths, String lastModified) {
+        this.validFilePaths = validFilePaths;
+        this.lastModified = lastModified;
+    }
+
+    @Override
+    public boolean accept(File pathname) {
+        try {
+            return validFilePaths.contains(pathname.getAbsolutePath()) &&
+                    isApplicableAsModifiedFile(pathname);
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    private boolean isApplicableAsModifiedFile(File file) throws InterruptedException, IOException {
+        return file != null && isApplicableAsModifiedFile(new FilePath(file));
+    }
+
+    private boolean isApplicableAsModifiedFile(FilePath filePath) throws InterruptedException, IOException{
+        if(StringUtils.isBlank(lastModified)){
+            //the modified field is not used so we return true
+            return true;
+        }
+        int lastModifiedIntValue = getLastModifiedIntValue();
+        long diffInMillis = new Date().getTime() - filePath.lastModified();
+        long diffInHour = diffInMillis / DateUtils.MILLIS_PER_HOUR;
+        
+        return diffInHour <= lastModifiedIntValue;
+    }
+
+    private int getLastModifiedIntValue(){
+        try{
+            int m = Integer.parseInt(this.lastModified);
+            if(m <= 0){
+                throw new XrayJenkinsGenericException("last modified value must be a positive integer");
+            }
+            return m;
+        } catch (NumberFormatException e){
+            throw new XrayJenkinsGenericException("last modified value is not an integer");
+        }
+    }
+}