org.conqat.lib.commons.test

Class ManagedTestData

java.lang.Object

org.conqat.lib.commons.test.ManagedTestData

public class ManagedTestData
extends java.lang.Object

A test helper that provides access to a test-specific resources. Backed by a TestDataManager.

Constructor Summary

Constructors

Constructor and Description
ManagedTestData(java.lang.Class<?> contextClass)

Method Summary

Modifier and Type	Method and Description
java.io.File	copyDataDirectory(java.lang.String directoryName, java.io.File tempDir) Creates a copy of the given resource directory in the given tempDir.
java.lang.String	getDataContent(java.lang.String path) Returns the content of given resource.
java.io.File	getDataFile(java.lang.String fileName) Returns a copy of the given resource as temporary file.
java.io.File	getDataFile(java.lang.String fileName, java.io.File tempDir) Returns a copy of the given resource as temporary file.
Resource	getResource(java.lang.String path) Returns the given resource.
java.util.Optional<Resource>	getResourceIfExists(java.lang.String path) Returns the given resource or an empty optional if no resource with the given path exists.
java.util.List<Resource>	listResources(java.lang.String subfolder, java.util.function.Predicate<Resource> filter) Lists all resources contained in the given subfolder matching the given predicate.
java.util.List<Resource>	listResources(java.lang.String subfolder, java.lang.String... fileExtensions) Lists all resources contained in the given subfolder.
java.util.List<Resource>	listResourcesRecursively(java.lang.String subfolder, java.util.function.Predicate<Resource> filter) Lists all resources contained in the given subfolder recursively matching the given predicate.
java.util.List<Resource>	listResourcesRecursively(java.lang.String subfolder, java.lang.String... fileExtensions) Lists all resources contained in the given subfolder recursively.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedTestData

public ManagedTestData(java.lang.Class<?> contextClass)

Parameters:

contextClass - The (test) class using the managed test data. The package of the class determines the root folder that is used for resource lookups.

Method Detail

getResource

public Resource getResource(java.lang.String path)

Returns the given resource. The resource must be placed in the test-data folder under the package name of the contextClass. The path may also contain forward slashes to address sub-resources. The test-data directory is, for example, "engine/com.teamscale.index/test-data/com/teamscale/index/code_clones" for the context class com.teamscale.index.code_clones.TeamscaleCloneDetectionTest.

getResourceIfExists

public java.util.Optional<Resource> getResourceIfExists(java.lang.String path)

Returns the given resource or an empty optional if no resource with the given path exists. The resource must be placed in the test-data folder under the package name of the contextClass. The path may also contain forward slashes to address sub-resources. The test-data directory is, for example, "engine/com.teamscale.index/test-data/com/teamscale/index/code_clones" for * the context class com.teamscale.index.code_clones.TeamscaleCloneDetectionTest (does not include the name of the test).

getDataContent

public java.lang.String getDataContent(java.lang.String path)

Returns the content of given resource. The content is expected to be UTF-8 encoded and line separators are normalized. The resource must be placed in the test-data folder under the package name of the contextClass. The path may also contain forward slashes to address sub-resources. The test-data directory is, for example, "engine/com.teamscale.index/test-data/com/teamscale/index/code_clones" for the context class com.teamscale.index.code_clones.TeamscaleCloneDetectionTest (does not include the name of the test). In case you need to load the non-normalized content use getResource(String) and Resource.getContentAsRawString() or Resource.getAsByteArray() instead.

getDataFile

public java.io.File getDataFile(java.lang.String fileName)

Returns a copy of the given resource as temporary file. The original resource must be placed in the test-data folder under the package name of the contextClass. The path may also contain forward slashes to address sub-resources. The test-data directory is, for example, "engine/com.teamscale.index/test-data/com/teamscale/index/code_clones" for the context class com.teamscale.index.code_clones.TeamscaleCloneDetectionTest (does not include the name of the test). In case your test relies on the exact file name use getDataFile(String, File) instead, which allows you to copy into a given temporary directory under the original file name.

getDataFile

public java.io.File getDataFile(java.lang.String fileName,
                                java.io.File tempDir)

Returns a copy of the given resource as temporary file. The temporary copy is stored directly in the given tempDir. The original resource must be placed in the test-data folder under the package name of the contextClass. The path may also contain forward slashes to address sub-resources. The test-data directory is, for example, "engine/com.teamscale.index/test-data/com/teamscale/index/code_clones" for the context class com.teamscale.index.code_clones.TeamscaleCloneDetectionTest (does not include the name of the test).

copyDataDirectory

public java.io.File copyDataDirectory(java.lang.String directoryName,
                                      java.io.File tempDir)

Creates a copy of the given resource directory in the given tempDir. The original resource must be placed in the test-data folder under the package name of the contextClass. The path may also contain forward slashes to address sub-resources. The test-data directory is, for example, "engine/com.teamscale.index/test-data/com/teamscale/index/code_clones" for the context class com.teamscale.index.code_clones.TeamscaleCloneDetectionTest (does not include the name of the test).

Returns:

The root of the directory in the temporary location.

listResources

public java.util.List<Resource> listResources(java.lang.String subfolder,
                                              java.lang.String... fileExtensions)

Lists all resources contained in the given subfolder. If fileExtensions are given the resources that do not match any of them are filtered out.

listResources

public java.util.List<Resource> listResources(java.lang.String subfolder,
                                              java.util.function.Predicate<Resource> filter)

Lists all resources contained in the given subfolder matching the given predicate.

listResourcesRecursively

public java.util.List<Resource> listResourcesRecursively(java.lang.String subfolder,
                                                         java.lang.String... fileExtensions)

Lists all resources contained in the given subfolder recursively. If fileExtensions are given the resources that do not match any of them are filtered out.

listResourcesRecursively

public java.util.List<Resource> listResourcesRecursively(java.lang.String subfolder,
                                                         java.util.function.Predicate<Resource> filter)

Lists all resources contained in the given subfolder recursively matching the given predicate.