org.conqat.lib.commons.test

Class ExpectedDataContainer

java.lang.Object

org.conqat.lib.commons.test.ExpectedDataContainer

public class ExpectedDataContainer
extends java.lang.Object

Represents a generic collection of test resource files that logically belong together. A container holds the resources that belong to a single test. It consists of a single expectedResource that holds the expected output of the test case and test resources that are considered to belong to the container by some naming heuristics. A container is formed around an expected file (default suffix is ".expected" if not stated differently in ExpectedResourceSource.expectedSuffix()). All files that have a longer common path prefix with expected file X than with any other expected file, belong to the test container of X. The "primary test resource" is the file exactly matching the expected file name without extension. Example Setups:

 folder/A.java                     <- container "folder/A.java", primary resource
 folder/A.java.expected            <- container "folder/A.java", expected resource
 folder/B.cpp                      <- container "folder/B.cpp", primary resource
 folder/BHeader.h                  <- container "folder/B.cpp"
 folder/B.cpp.expected             <- container "folder/B.cpp", expected resource
 folder/subfolder/B.metadata       <- container "folder/subfolder/B.java"
 folder/subfolder/B.java           <- container "folder/subfolder/B.java", primary resource
 folder/subfolder/B.java.expected  <- container "folder/subfolder/B.java", expected resource
 

See Also:

ExpectedResourceSource, of(List, String, String)

Method Summary

Modifier and Type	Method and Description
Resource	getExpectedResource() Returns the expected resource of the container.
Resource	getPrimaryTestResource() Returns the primary test resource, which is the only resource whose name matches the expected resource without the suffix.
Resource	getSingleTestResource(java.lang.String... suffixes) Returns a single test resource.
java.util.List<Resource>	getTestResources() Returns all test resource that belong to the container (not including the expected resource).
static java.util.List<ExpectedDataContainer>	of(java.util.List<Resource> resources, java.lang.String path, java.lang.String expectedSuffix) Builds a list of ExpectedDataContainers out of the given resources.
java.lang.String	toString() Used as test case name.

Methods inherited from class java.lang.Object

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

Method Detail

getExpectedResource

public Resource getExpectedResource()

Returns the expected resource of the container.

getTestResources

public java.util.List<Resource> getTestResources()

Returns all test resource that belong to the container (not including the expected resource).

getPrimaryTestResource

public Resource getPrimaryTestResource()

Returns the primary test resource, which is the only resource whose name matches the expected resource without the suffix. e.g. for "Test.java.expected" "Test.java" would be the primary test resource.

getSingleTestResource

public Resource getSingleTestResource(java.lang.String... suffixes)

Returns a single test resource. If suffixes are given only a resource that matches one of them is returned. The method asserts that the selection is unambiguous.

toString

public java.lang.String toString()

Used as test case name.

Overrides:

toString in class java.lang.Object

of

public static java.util.List<ExpectedDataContainer> of(java.util.List<Resource> resources,
                                                       java.lang.String path,
                                                       java.lang.String expectedSuffix)

Builds a list of ExpectedDataContainers out of the given resources. Resources are grouped by the given expectedSuffix. Files that either start with the same resource name, the same basename (excluding any file extensions and suffix numbers) or the same folder (including subfolders) as the #expectedFile are considered.

Parameters:

path - Is the subpath that was used to search for resources. It is stripped from the representativeName to make it more readable.