com.varmateo.testutils

Class TestUtils

java.lang.Object

com.varmateo.testutils.TestUtils

public final class TestUtils
extends Object

Utility functions intended for use in unit tests.

Method Summary

Modifier and Type	Method and Description
static Path	getInputsDir(Class<?> testsuiteClass) Retrieves the directory containing the test input files for the given testsuite class.
static Path	getPath(Class<?> testSuiteClass, String pathName) Retrives the path for a test file related with the given testsuit class.
static String	getSystemProperty(String key) Retrieves the value of a given system property.
static Path	newTempDir(Class<?> testSuiteClass) Retrieves the directory to be used as temporary directory for the given testsuite class.

Methods inherited from class java.lang.Object

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

Method Detail

getSystemProperty

public static String getSystemProperty(String key)

Retrieves the value of a given system property. If the system property is not set, then it will blow up.

Parameters:

key - The name of the system property whose value is to be returned.

Returns:

The value of the given system property.

getInputsDir

public static Path getInputsDir(Class<?> testsuiteClass)

Retrieves the directory containing the test input files for the given testsuite class.

By convention the path of directory with test input files is obtained in the following way:

• The prefix component is obtained from the value of the TestUtils.inputTestFilesDir system property. This is usually set to ${basedir}/test/resources in the Maven project pom.xml.
• The remaining path components are obtained from the fully qualified class name by replacing "." with the path separator char.

Parameters:

testsuiteClass - Class for which we will return in directory with input files for the corresponding testsuite.

Returns:

The path for the directory continaining the test input files for the given testsuite class.

newTempDir

public static Path newTempDir(Class<?> testSuiteClass)
                       throws IOException

Retrieves the directory to be used as temporary directory for the given testsuite class.

The temporary directory will be created under the path specified by the TestUtils.tmpTestFilesDir system property. The base name of the temporary directory is generated automatically.

The returned path will be different every time this method is called. This method is intended to be called from within test cases. Each test case should call this method to have its down dedicated temporary directory.

When this method returns, the temporary directory is sure to exist.

Parameters:

testSuiteClass - The Java class of the testsuite for which we are to return its dedicated temporary directory.

Returns:

The path to a newly created temporary directory.

Throws:

IOException - If there were any problems creating the temporary directory.

getPath

public static Path getPath(Class<?> testSuiteClass,
                           String pathName)

Retrives the path for a test file related with the given testsuit class.

The pathName is assumed to be relative to the inputs directory for the given testsuit class. See getInputsDir(Class) for a description on on how the inputs directory is obtained.

Parameters:

testSuiteClass -

pathName - A path relative to the inputs directory for the given testsuite class.

Returns:

The path for the desired test file of the testsuite.