com.redhat.rhn.testing

Class TestUtils

java.lang.Object

com.redhat.rhn.testing.TestUtils

public class TestUtils
extends java.lang.Object

TestUtils, a simple package for utility functions helpful when writing unit tests

Method Summary

Modifier and Type	Method and Description
static boolean	arraySearch(java.lang.Object[] search, java.lang.String methodName, java.lang.Object key) Search an array by calling the passsed in method name with the key as the checker
static void	disableLocalizationDebugMode() Turns of the Config setting for L10N debug mode
static void	disableLocalizationLogging() Disable the *** ERROR: Message with id: [asciiString] not found.*** errors.
static void	enableLocalizationDebugMode() Sets the Config to indicate we want to be in Debug mode for Localization.
static void	enableLocalizationLogging() Enable the *** ERROR: Message with id: [asciiString] not found.*** errors.
static boolean	equalTest(java.lang.Object o1, java.lang.Object o2) Used to test the equals contract on objects.
static java.net.URL	findTestData(java.lang.String path) method to find a file relative to the calling class.
static void	flushAndEvict(java.lang.Object obj) Util to flush and evict an object from the Hibernate Session
static java.lang.Object	getPrivateField(java.lang.Object o, java.lang.String fieldName) Get a private field from a class.
static RhnMockHttpServletRequest	getRequestWithSessionAndUser() Get a request with a Session and a User.
static boolean	isLocalized(java.lang.String checkMe) Check the string to see if it passed through the LocalizationService.
static java.lang.Object	lookupFromCacheById(java.lang.Long id, java.lang.String queryname) Helper method to get a single object from the 2nd level cache by id
static java.lang.Object	lookupFromCacheByLabel(java.lang.String label, java.lang.String queryname) Helper method to get a single object from the 2nd level cache by label
static java.lang.Object	lookupTestObject(java.lang.String query) Finds a single instance of a persistent object.
static java.util.List	lookupTestObjects(java.lang.String query) Finds a list of persistent objects.
static void	printWhoCalledMe(int depth) Print the first few lines from a stacktrace so we can figure out who the caller is.
static java.lang.String	randomString() Return a random 13 letter string.
static java.lang.String	readAll(java.io.InputStream stream) Read whole stream into a string.
static java.lang.String	readAll(java.net.URL url) Connect to url and return the contents of that location as a string.
static java.lang.Object	reload(java.lang.Class objClass, java.io.Serializable id) Util to reload an object from the DB using Hibernate.
static java.lang.Object	reload(java.lang.Object obj) Util to reload an object using Hibernate
static int	removeObject(java.lang.Object toRemove) Removes an object from the database.
static DataResult	runTestQuery(java.lang.String mode, java.util.Map params) Run a test query
static void	saveAndFlush(java.lang.Object obj) Helper method to save objects to the database and flush the session.
static java.lang.Object	saveAndReload(java.lang.Object o) Save and reload an object from DB
static boolean	validateUIMessage(ActionHelper ah, java.lang.String key) Check the request in the ActionHelper to validate that there is a UI message in the session.
static void	writeByteArrayToFile(java.io.File file, byte[] array) Write a byte array to a file

Methods inherited from class java.lang.Object

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

Method Detail

findTestData

public static java.net.URL findTestData(java.lang.String path)
                                 throws java.lang.ClassNotFoundException,
                                        java.io.IOException

method to find a file relative to the calling class. primarily useful when writing tests that need access to external data. this lets you put the data relative to the test class file.

Parameters:

path - the path, relative to caller's location

Returns:

URL a URL referencing the file

Throws:

java.lang.ClassNotFoundException - if the calling class can not be found (i.e., should not happen)

java.io.IOException - if the specified file in an archive (eg. jar) and it cannot be copied to a temporary location

writeByteArrayToFile

public static void writeByteArrayToFile(java.io.File file,
                                        byte[] array)

Write a byte array to a file

Parameters:

file - to write bytearray to

array - to write out

readAll

public static java.lang.String readAll(java.io.InputStream stream)
                                throws java.io.IOException

Read whole stream into a string.

Parameters:

stream - the stream to consume

Returns:

the contents of the stream as a string

Throws:

java.io.IOException - if reading the file fails

readAll

public static java.lang.String readAll(java.net.URL url)
                                throws java.io.IOException

Connect to url and return the contents of that location as a string.

Parameters:

url - the URL to read from

Returns:

the contents of the URL as a string, or null if url is null

Throws:

java.io.IOException - if reading the file fails

getRequestWithSessionAndUser

public static RhnMockHttpServletRequest getRequestWithSessionAndUser()

Get a request with a Session and a User.

Returns:

a request with a Session and a User.

lookupTestObject

public static java.lang.Object lookupTestObject(java.lang.String query)
                                         throws java.lang.Exception

Finds a single instance of a persistent object.

Parameters:

query - The query to find the persistent object should be formulated to ensure a single object is returned or an error will occur.

Returns:

Object found or null if not

Throws:

java.lang.Exception - if there was a Hibernate related exception

lookupTestObjects

public static java.util.List lookupTestObjects(java.lang.String query)
                                        throws java.lang.Exception

Finds a list of persistent objects.

Parameters:

query - The query to find the persistent objects.

Returns:

Object found or null if not

Throws:

java.lang.Exception - if there was a Hibernate related exception

lookupFromCacheById

public static java.lang.Object lookupFromCacheById(java.lang.Long id,
                                                   java.lang.String queryname)
                                            throws java.lang.Exception

Helper method to get a single object from the 2nd level cache by id

Parameters:

id - Id of the object you want

queryname - Queryname for the query you want to run. queryname *MUST* have an :id attribute in it.

Returns:

Returns the object corresponding to id

Throws:

java.lang.Exception - exception

lookupFromCacheByLabel

public static java.lang.Object lookupFromCacheByLabel(java.lang.String label,
                                                      java.lang.String queryname)
                                               throws java.lang.Exception

Helper method to get a single object from the 2nd level cache by label

Parameters:

label - Label of the object you want

queryname - Queryname for the query you want to run. queryname *MUST* have a :label attribute in it.

Returns:

Returns the object corresponding to label

Throws:

java.lang.Exception - exception

printWhoCalledMe

public static void printWhoCalledMe(int depth)

Print the first few lines from a stacktrace so we can figure out who the caller is. This is similiar to doing a Thread.dumpStack() but it just doesn't spit out as many lines of the stacktrace.

Parameters:

depth - the number of lines of the stacktrace you want to see

flushAndEvict

public static void flushAndEvict(java.lang.Object obj)
                          throws org.hibernate.HibernateException

Util to flush and evict an object from the Hibernate Session

Parameters:

obj - to flush

Throws:

org.hibernate.HibernateException - if something bad happens

reload

public static java.lang.Object reload(java.lang.Class objClass,
                                      java.io.Serializable id)
                               throws org.hibernate.HibernateException

Util to reload an object from the DB using Hibernate.

Parameters:

objClass - of object being looked up

id - of object

Returns:

Object found or NULL if not

Throws:

org.hibernate.HibernateException - if something goes wrong.

reload

public static java.lang.Object reload(java.lang.Object obj)
                               throws org.hibernate.HibernateException

Util to reload an object using Hibernate

Parameters:

obj - to be reloaded

Returns:

Object found if not, null

Throws:

org.hibernate.HibernateException - if something bad happens.

saveAndFlush

public static void saveAndFlush(java.lang.Object obj)
                         throws org.hibernate.HibernateException

Helper method to save objects to the database and flush the session.

Parameters:

obj - object to save.

Throws:

org.hibernate.HibernateException - HibernateException

removeObject

public static int removeObject(java.lang.Object toRemove)

Removes an object from the database.

Parameters:

toRemove - Object to be removed.

Returns:

Number of rows affected.

enableLocalizationDebugMode

public static void enableLocalizationDebugMode()

Sets the Config to indicate we want to be in Debug mode for Localization. Usefull for checking if a set of strings is l10ned.

disableLocalizationDebugMode

public static void disableLocalizationDebugMode()

Turns of the Config setting for L10N debug mode

disableLocalizationLogging

public static void disableLocalizationLogging()

Disable the *** ERROR: Message with id: [asciiString] not found.*** errors. Some tests pass in non-translated strings which is OK.

enableLocalizationLogging

public static void enableLocalizationLogging()

Enable the *** ERROR: Message with id: [asciiString] not found.*** errors. Some tests pass in non-translated strings which is OK.

isLocalized

public static boolean isLocalized(java.lang.String checkMe)

Check the string to see if it passed through the LocalizationService.

Parameters:

checkMe - String to check if it was l10ned

Returns:

boolean if or not it was localized

validateUIMessage

public static boolean validateUIMessage(ActionHelper ah,
                                        java.lang.String key)

Check the request in the ActionHelper to validate that there is a UI message in the session. Useful for struts actions where you want to verify that it put something in the session.

Parameters:

ah - actionhelper used in the test

key - to the i18n resource

Returns:

boolean if it was found or not

randomString

public static java.lang.String randomString()

Return a random 13 letter string. Useful for creating unique string labels/names in your tests.

Returns:

String that is 13 chars long and alphanumeric

runTestQuery

public static DataResult runTestQuery(java.lang.String mode,
                                      java.util.Map params)

Run a test query

Parameters:

mode - to run

params - map

Returns:

DataResult List

arraySearch

public static boolean arraySearch(java.lang.Object[] search,
                                  java.lang.String methodName,
                                  java.lang.Object key)

Search an array by calling the passsed in method name with the key as the checker

Parameters:

search - array

methodName - to call on each object in the array (can be toString())

key - to compare to

Returns:

boolean if found or not

saveAndReload

public static java.lang.Object saveAndReload(java.lang.Object o)

Save and reload an object from DB

Parameters:

o - to save and reload.

Returns:

Object fresh from DB

getPrivateField

public static java.lang.Object getPrivateField(java.lang.Object o,
                                               java.lang.String fieldName)

Get a private field from a class. Good for testing the inner state of a class's member variables. Copied from: http://snippets.dzone.com/posts/show/2242

Parameters:

o - to check

fieldName - to find

Returns:

Object if found

equalTest

public static boolean equalTest(java.lang.Object o1,
                                java.lang.Object o2)

Used to test the equals contract on objects. The contract as specified by java.lang.Object states that if A.equals(B) is true then B.equals(A) is also true. It also specifies that if A.equals(B) is true then A.hashCode() will equals B.hashCode()

Parameters:

o1 - object1

o2 - object2

Returns:

both objects equal