com.synopsys.protecode.sc.jenkins.utils

Class UtilitiesFile

java.lang.Object

com.synopsys.protecode.sc.jenkins.utils.UtilitiesFile

public final class UtilitiesFile
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	ALL_FILES_PATTERN Pattern used to get all files from directory or directory structure .* stands for anything but newlines.
static String	ALL_FILES_REGEX_STRING String used as regexp to get all files from directory or directory structure .* stands for anything but newlines.
static String	ZIP_FILE_PREFIX Used in the zip file name as the identifier for the zip file to be made.

Method Summary

Modifier and Type	Method and Description
static boolean	createRemoteDirectory(String name, hudson.FilePath workspace, hudson.model.TaskListener listener) Creates a directory in the specified workspace.
static List<hudson.FilePath>	getArtifacts(hudson.model.Run<?,?> run, Pattern pattern, hudson.FilePath directoryToScan) Returns any produced artifacts for the build.
static List<hudson.FilePath>	getFiles(hudson.FilePath fileDirectory, boolean includeSubdirectories, Pattern pattern, hudson.model.Run<?,?> run, hudson.model.TaskListener listener) Returns files in a directory
static hudson.FilePath	packageFiles(hudson.FilePath workspace, List<hudson.FilePath> files, String zipFileName) Method zips files at the location of the first file.
static Pattern	patternOrAll(String pattern) A convenience method which either returns a pattern which includes all files or a pattern for the given string.
static boolean	removeFilePackage(hudson.FilePath zipFile)
static hudson.FilePath	reportsDirectory(hudson.model.Run<?,?> run) Convenience method for reports directory.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FILES_REGEX_STRING

public static final String ALL_FILES_REGEX_STRING

String used as regexp to get all files from directory or directory structure .* stands for anything but newlines. The string is used to make sure of backward compatibility, since it's stored as string not pattern.

See Also:

Constant Field Values

ALL_FILES_PATTERN

public static final Pattern ALL_FILES_PATTERN

Pattern used to get all files from directory or directory structure .* stands for anything but newlines.

ZIP_FILE_PREFIX

public static final String ZIP_FILE_PREFIX

Used in the zip file name as the identifier for the zip file to be made.

See Also:

Constant Field Values

Method Detail

getArtifacts

public static List<hudson.FilePath> getArtifacts(hudson.model.Run<?,?> run,
                                                 Pattern pattern,
                                                 hudson.FilePath directoryToScan)

Returns any produced artifacts for the build.

Parameters:

run - Instance of the build

pattern - Regexp pattern used for including only certain artifacts

directoryToScan - the relative path in workspace to scan

Returns:

List of FilePaths produced as artifacts

getFiles

public static List<hudson.FilePath> getFiles(hudson.FilePath fileDirectory,
                                             boolean includeSubdirectories,
                                             Pattern pattern,
                                             hudson.model.Run<?,?> run,
                                             hudson.model.TaskListener listener)

Returns files in a directory

Parameters:

fileDirectory - Name of the directory to parse through for files

includeSubdirectories - If true the method returns all files from the directory structure.

pattern - Regex to include only certain files. If all is required use UtilitiesFile.ALL_FILES_PATTERN

run - Jenkins build run instance

listener - Jenkins console

Returns:

list of files

packageFiles

public static hudson.FilePath packageFiles(hudson.FilePath workspace,
                                           List<hudson.FilePath> files,
                                           String zipFileName)
                                    throws Exception

Method zips files at the location of the first file.

Parameters:

workspace - the directory to make the zip file and the base for all listed files.

files - List of file paths

zipFileName - Name for the zip file

Returns:

the zip file of all files to be

Throws:

IOException - thrown when adding files to zip fails

Exception

removeFilePackage

public static boolean removeFilePackage(hudson.FilePath zipFile)
                                 throws Exception

Throws:

Exception

createRemoteDirectory

public static boolean createRemoteDirectory(String name,
                                            hudson.FilePath workspace,
                                            hudson.model.TaskListener listener)
                                     throws InterruptedException,
                                            IOException

Creates a directory in the specified workspace.

Parameters:

name - The name of the directory to create

workspace - The workspace in which to create the directory

listener - The build listener for logging information and possible errors to build console.

Returns:

true if creating the directing was successful.

Throws:

IOException - thrown when cannot read location/create zip into it

InterruptedException - on interrupt (perhaps build cancellation etc)

reportsDirectory

public static hudson.FilePath reportsDirectory(hudson.model.Run<?,?> run)
                                        throws IOException,
                                               InterruptedException

Convenience method for reports directory.

Parameters:

run - The run instance of the build

Returns:

File object pointing to the

Throws:

IOException - Failure to read/create directory

InterruptedException - Failure to read/create directory

patternOrAll

public static Pattern patternOrAll(String pattern)

A convenience method which either returns a pattern which includes all files or a pattern for the given string. If the String object "pattern" is empty then the method will return a pattern which includes all.

Parameters:

pattern - The string representation of the pattern.

Returns:

Either a Pattern object with the given string or a pattern for all