com.xpandit.plugins.xrayjenkins.Utils

Class FileUtils

java.lang.Object

com.xpandit.plugins.xrayjenkins.Utils.FileUtils

public class FileUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static void	closeSilently(Closeable closeable) Utility method that close a Closeable object
static Set<String>	getFeatureFileNamesFromWorkspace(hudson.FilePath workspace, String path, hudson.model.TaskListener listener) This method will return all files with the ".feature" extension within a given build workspace and a path.
static List<hudson.FilePath>	getFeatureFilesFromWorkspace(hudson.FilePath workspace, String path, hudson.model.TaskListener listener) Utility method that returns all .features files from a folder, including those contained in sub folders.
static List<hudson.FilePath>	getFiles(hudson.FilePath workspace, String globExpression, hudson.model.TaskListener listener, hudson.remoting.VirtualChannel channel) Returns a list of files that matches the glob expression relatively to the workspace or that matches a file path.
static boolean	isApplicableAsModifiedFile(hudson.FilePath filePath, String lastModified) Checks if a given file was modified at least 'lastModified' ago.
static hudson.FilePath	readFile(hudson.FilePath workspace, String filePath, hudson.model.TaskListener listener) Given the Jenkins project workspace FilePath and the file path, will resolve the FilePath of the file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

closeSilently

public static void closeSilently(Closeable closeable)

Utility method that close a Closeable object

Parameters:

closeable - the Closeable object

getFeatureFilesFromWorkspace

public static List<hudson.FilePath> getFeatureFilesFromWorkspace(hudson.FilePath workspace,
                                                                 String path,
                                                                 hudson.model.TaskListener listener)
                                                          throws IOException,
                                                                 InterruptedException

Utility method that returns all .features files from a folder, including those contained in sub folders. This method works for master node and for slave (remote) nodes

Parameters:

workspace - the Jenkins project workspace

path - the folder path

listener - the TaskListener

Returns:

the list of the filepath's

Throws:

IOException

InterruptedException

getFeatureFileNamesFromWorkspace

public static Set<String> getFeatureFileNamesFromWorkspace(hudson.FilePath workspace,
                                                           String path,
                                                           hudson.model.TaskListener listener)
                                                    throws IOException,
                                                           InterruptedException

This method will return all files with the ".feature" extension within a given build workspace and a path.

Parameters:

workspace - the build's workspace

path - the relative or absolute path where to search for the feature files

listener - the lostener used to write some logs

Returns:

Unmodifiable set with the full absolute path of the feature files found

Throws:

IOException - Exception thrown when file/directory reading the operation fails

InterruptedException - Exception thrown when file/directory reading the operation fails

getFiles

public static List<hudson.FilePath> getFiles(hudson.FilePath workspace,
                                             String globExpression,
                                             hudson.model.TaskListener listener,
                                             hudson.remoting.VirtualChannel channel)
                                      throws IOException,
                                             InterruptedException

Returns a list of files that matches the glob expression relatively to the workspace or that matches a file path. The glob expression is relative, any attempt to match an absolute path will not work.

Parameters:

workspace - the workspace

globExpression - the glob expression. Must be relative to the workspace

Throws:

IOException

InterruptedException

readFile

public static hudson.FilePath readFile(hudson.FilePath workspace,
                                       String filePath,
                                       hudson.model.TaskListener listener)

Given the Jenkins project workspace FilePath and the file path, will resolve the FilePath of the file

Parameters:

workspace - the Jenkins workspace

filePath - the file path of the file

listener - the task listener

Returns:

the FilePath

isApplicableAsModifiedFile

public static boolean isApplicableAsModifiedFile(hudson.FilePath filePath,
                                                 String lastModified)

Checks if a given file was modified at least 'lastModified' ago. If 'lastModified' is empty or null, then we always return true.

Parameters:

filePath - the file to check.

lastModified - the time threshold.

Returns:

true, if 'lastModified' is blank or if the file was modified LESS than this value. False otherwise.