org.kuali.kfs.sys

Class TestDataPreparator

java.lang.Object

org.kuali.kfs.sys.TestDataPreparator

public class TestDataPreparator
extends Object

provide with a set of utilities that can be used to prepare test data for unit testing. The core idea is to convert Java properties into a list of specified business objects or search criteria.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DELIMINATOR
static String	DEFAULT_FIELD_NAMES

Constructor Summary

Constructors

Constructor and Description
TestDataPreparator()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Map<String,Object>	buildCleanupCriteria(Class<? extends T> clazz, Properties properties, String propertyKey) build the cleanup criteria for "clazz" from the given properties.
static <T> Map<String,Object>	buildCleanupCriteria(Class<? extends T> clazz, Properties properties, String propertyKey, String fieldNames, String deliminator) build the cleanup criteria for "clazz" from the given properties.
static <T> List<T>	buildExpectedValueList(Class<? extends T> clazz, Properties properties, String propertyKeyPrefix, int numberOfData) build a list of objects of type "clazz" from the expected results provided by the given properties.
static <T> List<T>	buildExpectedValueList(Class<? extends T> clazz, Properties properties, String propertyKeyPrefix, String fieldNames, String deliminator, int numberOfData) build a list of objects of type "clazz" from the expected results provided by the given properties
static <T> Map<String,Object>	buildFieldValues(Class<T> clazz, Properties properties, String propertykey, String fieldNames, String deliminator) build the field name and value pairs from the given properties in the specified properties file
static <T> List<T>	buildTestDataList(Class<? extends T> clazz, Properties properties, String propertyKeyPrefix, int numberOfData) build a list of objects of type "clazz" from the test data provided by the given properties.
static <T> List<T>	buildTestDataList(Class<? extends T> clazz, Properties properties, String propertyKeyPrefix, String fieldNames, String deliminator, int numberOfData) build a list of objects of type "clazz" from the test data provided by the given properties
static <T> T	buildTestDataObject(Class<? extends T> clazz, Properties properties) Generates transaction data for a business object from properties
static <T> T	buildTestDataObject(Class<? extends T> clazz, Properties properties, String propertyKey) build an object of type "clazz" from the test data provided by the given properties
static <T> T	buildTestDataObject(Class<? extends T> clazz, Properties properties, String propertyKey, String fieldNames, String deliminator) build an object of type "clazz" from the test data provided by the given properties
static <T> boolean	contains(List<T> collection, T object, List<String> keyFields) test if the given object is in the given collection.
static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> void	doCleanUpWithoutReference(Class<T> clazz, Properties properties, String propertykey, String fieldNames, String deliminator) remove the existing data from the database so that they cannot affact the test results
static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> void	doCleanUpWithReference(Class<T> clazz, Properties properties, String propertykey, String fieldNames, String deliminator) remove the existing data from the database so that they cannot affact the test results
static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> List<T>	findMatching(Class<T> clazz, Properties properties, String propertykey, String fieldNames, String deliminator) remove the existing data from the database so that they cannot affact the test results
static <T> boolean	hasSameElements(List<T> collection1, List<T> collection2, List<String> keyFields) test if the given two collections contain the exactly same elements.
static Properties	loadPropertiesFromClassPath(String classPath) load properties from the given class path resource.
static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> void	persistDataObject(List<T> dataObjects) persist the given data object if it is not in the persistent store
static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> T	persistDataObject(T dataObject) persist the given data object if it is not in the persistent store

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIELD_NAMES

public static final String DEFAULT_FIELD_NAMES

See Also:

Constant Field Values

DEFAULT_DELIMINATOR

public static final String DEFAULT_DELIMINATOR

See Also:

Constant Field Values

Constructor Detail

TestDataPreparator

public TestDataPreparator()

Method Detail

loadPropertiesFromClassPath

public static Properties loadPropertiesFromClassPath(String classPath)

load properties from the given class path resource. The class path is different than the absolute path. If a resource is located at /project/test/org/kuali/kfs/util/message.properties, then its class path is org/kuali/kfs/util/message.properties, which is the fully-qualified Java package name plus the resource name.

Parameters:

classPath - the given class path of a resource

Returns:

properties loaded from the given resource.

buildTestDataList

public static <T> List<T> buildTestDataList(Class<? extends T> clazz,
                            Properties properties,
                            String propertyKeyPrefix,
                            int numberOfData)

build a list of objects of type "clazz" from the test data provided by the given properties. The default fieldNames and deliminator are used.

Parameters:

clazz - the the specified object type

properties - the given properties that contain the test data

propertyKeyPrefix - the test data with the given key prefix can be used to construct the return objects

numberOfData - the number of test data matching the search criteria

Returns:

a list of objects of type "clazz" from the test data provided by the given properties

buildTestDataList

public static <T> List<T> buildTestDataList(Class<? extends T> clazz,
                            Properties properties,
                            String propertyKeyPrefix,
                            String fieldNames,
                            String deliminator,
                            int numberOfData)

build a list of objects of type "clazz" from the test data provided by the given properties

Parameters:

clazz - the the specified object type

properties - the given properties that contain the test data

propertyKeyPrefix - the test data with the given key prefix can be used to construct the return objects

fieldNames - the field names of the test data columns

deliminator - the deliminator that is used to separate the field from each other

numberOfData - the number of test data matching the search criteria

Returns:

a list of objects of type "clazz" from the test data provided by the given properties

buildTestDataObject

public static <T> T buildTestDataObject(Class<? extends T> clazz,
                        Properties properties,
                        String propertyKey,
                        String fieldNames,
                        String deliminator)

build an object of type "clazz" from the test data provided by the given properties

Parameters:

clazz - the the specified object type

properties - the given properties that contain the test data

propertyKey - the test data with the given key

fieldNames - the field names of the test data columns

deliminator - the deliminator that is used to separate the field from each other

Returns:

an object of type "clazz" from the test data provided by the given properties

buildTestDataObject

public static <T> T buildTestDataObject(Class<? extends T> clazz,
                        Properties properties,
                        String propertyKey)

build an object of type "clazz" from the test data provided by the given properties

Parameters:

clazz - the the specified object type

properties - the given properties that contain the test data

propertyKey - the test data with the given key

Returns:

an object of type "clazz" from the test data provided by the given properties

buildExpectedValueList

public static <T> List<T> buildExpectedValueList(Class<? extends T> clazz,
                                 Properties properties,
                                 String propertyKeyPrefix,
                                 int numberOfData)

build a list of objects of type "clazz" from the expected results provided by the given properties. The default fieldNames and deliminator are used.

Parameters:

clazz - the the specified object type. The instance of this type should be comparable through overriding Object.equals()

properties - the given properties that contain the expected results

propertyKeyPrefix - the expected results with the given key prefix can be used to construct the return objects

numberOfData - the number of the expected results matching the search criteria

Returns:

a list of objects of type "clazz" from the expected results provided by the given properties

buildExpectedValueList

public static <T> List<T> buildExpectedValueList(Class<? extends T> clazz,
                                 Properties properties,
                                 String propertyKeyPrefix,
                                 String fieldNames,
                                 String deliminator,
                                 int numberOfData)

build a list of objects of type "clazz" from the expected results provided by the given properties

Parameters:

clazz - the the specified object type. The instance of this type should be comparable through overriding Object.equals()

properties - the given properties that contain the expected results

propertyKeyPrefix - the expected results with the given key prefix can be used to construct the return objects

fieldNames - the field names of the expected results columns

deliminator - the deliminator that is used to separate the field from each other

numberOfData - the number of the expected results matching the search criteria

Returns:

a list of objects of type "clazz" from the expected results provided by the given properties

buildCleanupCriteria

public static <T> Map<String,Object> buildCleanupCriteria(Class<? extends T> clazz,
                                          Properties properties,
                                          String propertyKey)

build the cleanup criteria for "clazz" from the given properties. The default fieldNames and deliminator are used.

Parameters:

clazz - the the specified object type.

properties - the given properties that contain the cleanup criteria fields and values

propertyKey - the given property whose value provides the cleanup criteria values

Returns:

the cleanup criteria for "clazz" from the given properties

buildCleanupCriteria

public static <T> Map<String,Object> buildCleanupCriteria(Class<? extends T> clazz,
                                          Properties properties,
                                          String propertyKey,
                                          String fieldNames,
                                          String deliminator)

build the cleanup criteria for "clazz" from the given properties.

Parameters:

clazz - the the specified object type.

properties - the given properties that contain the cleanup criteria fields and values

propertyKey - the given property whose value provides the cleanup criteria values

fieldNames - the field names of the cleanup columns

deliminator - the deliminator that is used to separate the field from each other

Returns:

the cleanup criteria for "clazz" from the given properties

persistDataObject

public static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> T persistDataObject(T dataObject)

persist the given data object if it is not in the persistent store

Parameters:

dataObject - the given data object

Returns:

return the data object persisted into the data store

persistDataObject

public static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> void persistDataObject(List<T> dataObjects)

persist the given data object if it is not in the persistent store

Parameters:

dataObject - the given data object

doCleanUpWithoutReference

public static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> void doCleanUpWithoutReference(Class<T> clazz,
                                                                                          Properties properties,
                                                                                          String propertykey,
                                                                                          String fieldNames,
                                                                                          String deliminator)
                                      throws Exception

remove the existing data from the database so that they cannot affact the test results

Throws:

Exception

doCleanUpWithReference

public static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> void doCleanUpWithReference(Class<T> clazz,
                                                                                       Properties properties,
                                                                                       String propertykey,
                                                                                       String fieldNames,
                                                                                       String deliminator)
                                   throws Exception

remove the existing data from the database so that they cannot affact the test results

Throws:

Exception

findMatching

public static <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> List<T> findMatching(Class<T> clazz,
                                                                                Properties properties,
                                                                                String propertykey,
                                                                                String fieldNames,
                                                                                String deliminator)
                                                                                     throws Exception

remove the existing data from the database so that they cannot affact the test results

Throws:

Exception

buildFieldValues

public static <T> Map<String,Object> buildFieldValues(Class<T> clazz,
                                      Properties properties,
                                      String propertykey,
                                      String fieldNames,
                                      String deliminator)
                                           throws Exception

build the field name and value pairs from the given properties in the specified properties file

Throws:

Exception

contains

public static <T> boolean contains(List<T> collection,
                   T object,
                   List<String> keyFields)

test if the given object is in the given collection. The given key fields can be used for the comparison.

Returns:

true if the given object is in the given collection; otherwise, false

hasSameElements

public static <T> boolean hasSameElements(List<T> collection1,
                          List<T> collection2,
                          List<String> keyFields)

test if the given two collections contain the exactly same elements. The given key fields can be used for the comparison.

Returns:

true if the given two collections contain the exactly same elements; otherwise, false

buildTestDataObject

public static <T> T buildTestDataObject(Class<? extends T> clazz,
                        Properties properties)

Generates transaction data for a business object from properties

Parameters:

businessObject - the transction business object

Returns:

the transction business object with data

Throws:

Exception - thrown if an exception is encountered for any reason