org.wso2.testgrid.common.util

Class FileUtil

java.lang.Object

org.wso2.testgrid.common.util.FileUtil

public class FileUtil
extends Object

Utility class for handling file operations.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	YAML_EXTENSION

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static void	compress(String sourceDir, String destination) Compress the files at sourceDir into the destination zip file.
static void	compressFiles(List<String> files, String destination) Creates a archive file of the list of files passing in the given destination.
static List<String>	getFilesOnDirectory(String directory, String glob) This method returns the list of files in a given directory after filtering a given glob pattern.
static List<String>	getTestPlanIdByReadingTGYaml(String workspace) Get test plan ids by reading testgrid yaml files contains in the testgrid home.
static boolean	isFileExist(String filePath) Check if file exist in given file path
static String	readFile(String filePath, String fileName) Read content from a given file
static <T> T	readYamlFile(String location, Class<T> type) Returns an instance of the specified type from the given configuration YAML.
static void	removeFile(String filePath) Remove file if exist by given file path
static void	saveFile(String content, String filePath, boolean append) Saves the content to a file with the given file path.
static void	saveFile(String content, String filePath, String fileName, boolean append) Saves the content to a file with the given name in the given file path.
static void	writeToFile(String filePath, String string) Writes a given string to a given file to persistent media.

Methods inherited from class java.lang.Object

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

Field Detail

YAML_EXTENSION

public static final String YAML_EXTENSION

See Also:

Constant Field Values

Constructor Detail

FileUtil

public FileUtil()

Method Detail

readYamlFile

public static <T> T readYamlFile(String location,
                                 Class<T> type)
                          throws IOException

Returns an instance of the specified type from the given configuration YAML.

Parameters:

location - location of the configuration YAML file

Returns:

instance of the specified type from the given configuration YAML

Throws:

IOException - thrown when no file is found in the given location or when error on closing file input stream

getFilesOnDirectory

public static List<String> getFilesOnDirectory(String directory,
                                               String glob)
                                        throws IOException

This method returns the list of files in a given directory after filtering a given glob pattern.

Parameters:

directory - the directory in which the files should be look-up

glob - the glob pattern to be filtered

Returns:

list of files

Throws:

IOException - thrown when an error occurred while accessing files on directory.

saveFile

public static void saveFile(String content,
                            String filePath,
                            String fileName,
                            boolean append)
                     throws IOException

Saves the content to a file with the given name in the given file path.

Parameters:

content - content to write in the file

filePath - location to save the file

fileName - name of the file

append - true if append, false if overwrite

Throws:

IOException - thrown when error on persisting file

saveFile

public static void saveFile(String content,
                            String filePath,
                            boolean append)
                     throws IOException

Saves the content to a file with the given file path.

Parameters:

content - The content to save into file

filePath - Whole file path to write

append - true if append, false if overwrite

Throws:

IOException - thrown when error on persisting file

isFileExist

public static boolean isFileExist(String filePath)

Check if file exist in given file path

Parameters:

filePath - The file path

Returns:

True if file exist

removeFile

public static void removeFile(String filePath)
                       throws TestGridException

Remove file if exist by given file path

Parameters:

filePath - File path to remove

Throws:

TestGridException - File deleting exception

readFile

public static String readFile(String filePath,
                              String fileName)
                       throws TestGridException

Read content from a given file

Parameters:

filePath - The file path to write

fileName - name of the file

Returns:

File content

Throws:

TestGridException - Throw when file reading error

compressFiles

public static void compressFiles(List<String> files,
                                 String destination)
                          throws TestGridException

Creates a archive file of the list of files passing in the given destination.

Parameters:

files - list of files to be archive

destination - path of the archive file

Throws:

TestGridException

compress

public static void compress(String sourceDir,
                            String destination)
                     throws IOException

Compress the files at sourceDir into the destination zip file.

Parameters:

sourceDir - the source dir that has contents to archive

destination - the zip file location

Throws:

IOException

writeToFile

public static void writeToFile(String filePath,
                               String string)
                        throws TestGridException

Writes a given string to a given file to persistent media.

Parameters:

filePath - absolute path of the file to be written

string - string to be written

Throws:

TestGridException - thrown on FileNotFoundException or UnsupportedEncodingException

getTestPlanIdByReadingTGYaml

public static List<String> getTestPlanIdByReadingTGYaml(String workspace)
                                                 throws TestGridException

Get test plan ids by reading testgrid yaml files contains in the testgrid home.

Parameters:

workspace - path of the current workspace

Throws:

TestGridException - thrown when IO exception on reading testgrid yaml files.