to.etc.webapp.testsupport

Class TestDataContextMock

java.lang.Object

to.etc.webapp.testsupport.TestDataContextStub

to.etc.webapp.testsupport.TestDataContextMock

All Implemented Interfaces:

AutoCloseable, QDataContext

@DefaultNonNull
public class TestDataContextMock
extends TestDataContextStub

Special mock data context that should be used for tests that never hit the database. Use register methods to mock query results.m Get inserted instances during logic run in case you need to check for inserted data. JENKINSTODO move class to test resource location once Jenkins maven build is fixed. This is not production code. Created by vmijic on 11.6.15..

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestDataContextMock.ISavedObjectDecorator Adds custom data decoration for objects that are being 'saved' inside mock context.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL

Constructor Summary

Constructors

Constructor and Description
TestDataContextMock(TestDataContextMock.ISavedObjectDecorator onSaveCallback)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears accumulated list of inserted/deleted objects.
void	delete(Object o) Cause the object to be deleted from the database.
<T> T	find(Class<T> clz, Object pk) Load the persistent object with the specified type and primary key from the database.
<T> T	get(Class<T> clz, Object pk) Load the persistent object with the specified type and primary key from the database.
<T> List<T>	getDeleted(Class<T> type)
<T> List<T>	getInserted(Class<T> type)
<T> T	getInstance(Class<T> clz, Object pk) Load the persistent object with the specified type and primary key from the database.
protected <T> T	processQueryOneTestId(String testId)
protected <T> List<T>	processQueryTestId(String testId)
protected Object[]	processSelectionOneTestId(String testId)
protected List<Object[]>	processSelectionTestId(String testId)
<T> List<T>	query(QCriteria<T> q) Execute the query specified by q and return a list of results.
List<Object[]>	query(QSelection<?> sel) Issue a selection query, where multiple fields or projections on fields are selected from a base class.
<T> T	queryOne(QCriteria<T> q) Execute the query specified by q, and expect and return at most 1 result.
Object[]	queryOne(QSelection<?> sel) Execute the selection query specified by q, and expect and return at most 1 result.
void	registerQuery(boolean override, String testId, List<?> criteriaResult) Enables specifying fallback testId mocks, only in case when previously it is not defined.
void	registerQuery(String testId, List<?> criteriaResult)
void	registerQueryOne(boolean override, String testId, Object queryOneResult) Enables specifying fallback testId mocks, only in case when previously it is not defined.
void	registerQueryOne(String testId, Object queryOneResult)
void	registerSelection(boolean override, String testId, List<Object[]> selectionResult) Enables specifying fallback testId mocks, only in case when previously it is not defined.
void	registerSelection(String testId, List<Object[]> selectionResult)
void	registerSelectionOne(boolean override, String testId, Object... selectionResult) Enables specifying fallback testId mocks, only in case when previously it is not defined.
void	registerSelectionOne(String testId, Object... selectionResult)
void	save(Object o) Cause the object to be inserted in the database.

Methods inherited from class to.etc.webapp.testsupport.TestDataContextStub

addCommitAction, addListener, attach, close, commit, decrement, find, getConnection, getFactory, getInstance, inTransaction, original, query, queryOne, refresh, rollback, setIgnoreClose, setKeepOriginals, startTransaction, testGetUseCount

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final String NULL

See Also:

Constant Field Values

Constructor Detail

TestDataContextMock

public TestDataContextMock(@Nullable
                           TestDataContextMock.ISavedObjectDecorator onSaveCallback)

Method Detail

save

public void save(Object o)
          throws Exception

Description copied from interface: QDataContext

Cause the object to be inserted in the database.

Specified by:

save in interface QDataContext

Overrides:

save in class TestDataContextStub

Throws:

Exception

delete

public void delete(Object o)
            throws Exception

Description copied from interface: QDataContext

Cause the object to be deleted from the database.

Specified by:

delete in interface QDataContext

Overrides:

delete in class TestDataContextStub

Throws:

Exception

get

@Nonnull
public <T> T get(@Nonnull
                          Class<T> clz,
                          @Nonnull
                          Object pk)
                   throws Exception

Description copied from interface: QDataContext

Load the persistent object with the specified type and primary key from the database. This will execute an actual select in the database if the object is not yet cached, ensuring that the object actually exists. If the object does not exist this will raise QNotFoundException.

Specified by:

get in interface QDataContext

Overrides:

get in class TestDataContextStub

Type Parameters:

T - The object type.

Parameters:

clz - The persistent class for which an instance is being sought.

pk - The PK for the instance required.

Returns:

The actual and fully initialized instance (or proxy).

Throws:

Exception

getInstance

@Nonnull
public <T> T getInstance(@Nonnull
                                  Class<T> clz,
                                  @Nonnull
                                  Object pk)
                           throws Exception

Description copied from interface: QDataContext

Load the persistent object with the specified type and primary key from the database. This will return an object always even if the object does not exist in the database! This should only be used when you need an instance representing a given primary key that you know exists. This usually returns a proxy, meaning that nonexistent objects will throw exceptions as soon as properties other than it's primary key are accessed. To get an object and be sure it is present in the database use QDataContext.find(Class, Object).

Specified by:

getInstance in interface QDataContext

Overrides:

getInstance in class TestDataContextStub

Type Parameters:

T - The object type

Parameters:

clz - The persistent class for which an instance is being sought.

pk - The PK for the instance required.

Returns:

Always returns an instance; it can be invalid when it does not really exist on the backing store.

Throws:

Exception

find

@Nullable
public <T> T find(@Nonnull
                            Class<T> clz,
                            @Nonnull
                            Object pk)
                     throws Exception

Description copied from interface: QDataContext

Load the persistent object with the specified type and primary key from the database. This will execute an actual select in the database if the object is not yet cached, ensuring that the object actually exists. If the object does not exist this will return null.

Specified by:

find in interface QDataContext

Overrides:

find in class TestDataContextStub

Type Parameters:

T - The object type.

Parameters:

clz - The persistent class for which an instance is being sought.

pk - The PK for the instance required.

Returns:

Null if the instance does not exist, the actual and fully initialized instance (or proxy) otherwise.

Throws:

Exception

query

public List<Object[]> query(QSelection<?> sel)
                     throws Exception

Description copied from interface: QDataContext

Issue a selection query, where multiple fields or projections on fields are selected from a base class.

Specified by:

query in interface QDataContext

Overrides:

query in class TestDataContextStub

Returns:

Throws:

Exception

query

public <T> List<T> query(QCriteria<T> q)
                  throws Exception

Description copied from interface: QDataContext

Execute the query specified by q and return a list of results. Before and after the query execution all registered listeners will be called.

Specified by:

query in interface QDataContext

Overrides:

query in class TestDataContextStub

Type Parameters:

T - The return type for this query, a persistent class type

Parameters:

q - The selection criteria

Returns:

Throws:

Exception

queryOne

@Nullable
public <T> T queryOne(@Nonnull
                                QCriteria<T> q)
                         throws Exception

Description copied from interface: QDataContext

Execute the query specified by q, and expect and return at most 1 result. If the query has no result this will return null. If more than one result is obtained this will throw an IllegalStateException.

Specified by:

queryOne in interface QDataContext

Overrides:

queryOne in class TestDataContextStub

Returns:

Throws:

Exception

queryOne

@Nullable
public Object[] queryOne(@Nonnull
                                   QSelection<?> sel)
                            throws Exception

Description copied from interface: QDataContext

Execute the selection query specified by q, and expect and return at most 1 result. If the query has no result this will return null. If more than one result is obtained this will throw an IllegalStateException.

Specified by:

queryOne in interface QDataContext

Overrides:

queryOne in class TestDataContextStub

Returns:

Throws:

Exception

processQueryTestId

protected <T> List<T> processQueryTestId(String testId)

processQueryOneTestId

@Nullable
protected <T> T processQueryOneTestId(String testId)

processSelectionTestId

protected List<Object[]> processSelectionTestId(String testId)

processSelectionOneTestId

@Nullable
protected Object[] processSelectionOneTestId(String testId)

registerQuery

public void registerQuery(String testId,
                          List<?> criteriaResult)

registerQuery

public void registerQuery(boolean override,
                          String testId,
                          List<?> criteriaResult)

Enables specifying fallback testId mocks, only in case when previously it is not defined.

Parameters:

override - when T - overrides already existing mocks, otherwise keep existing value.

testId -

criteriaResult -

registerSelection

public void registerSelection(String testId,
                              List<Object[]> selectionResult)

registerSelection

public void registerSelection(boolean override,
                              String testId,
                              List<Object[]> selectionResult)

Enables specifying fallback testId mocks, only in case when previously it is not defined.

Parameters:

override - when T - overrides already existing mocks, otherwise keep existing value.

testId -

selectionResult -

registerQueryOne

public void registerQueryOne(String testId,
                             @Nullable
                             Object queryOneResult)

registerQueryOne

public void registerQueryOne(boolean override,
                             String testId,
                             @Nullable
                             Object queryOneResult)

Enables specifying fallback testId mocks, only in case when previously it is not defined.

Parameters:

override - when T - overrides already existing mocks, otherwise keep existing value.

testId -

queryOneResult -

registerSelectionOne

public void registerSelectionOne(String testId,
                                 @Nullable
                                 Object... selectionResult)

registerSelectionOne

public void registerSelectionOne(boolean override,
                                 String testId,
                                 @Nullable
                                 Object... selectionResult)

Enables specifying fallback testId mocks, only in case when previously it is not defined.

Parameters:

override - when T - overrides already existing mocks, otherwise keep existing value.

testId -

selectionResult -

getInserted

public <T> List<T> getInserted(Class<T> type)

getDeleted

public <T> List<T> getDeleted(Class<T> type)

clear

public void clear()

Clears accumulated list of inserted/deleted objects. Use between test methods when context is shared between methods. jal: why is is needed? Why not create a new one- that is way less prone to errors.