com.atlassian.vcache.internal.test.utils

Class VCacheTestHelper

java.lang.Object

com.atlassian.vcache.internal.test.utils.VCacheTestHelper

public class VCacheTestHelper
extends Object

Test helper provides functionality to help create appropriate vcache mocks for unit tests. Each test class will need to open the WorkContext doorway using:

@Rule public EstablishWorkContext context = new EstablishWorkContext();

Example: vcacheFactory = VCachesTestHelper.getProxiedFactory(); cache = VCachesTestHelper.getExternalCache(factory, "TestDECache", String.class);; //it also builds expectations for cache creation calls ... doReturn(result(cachedString)).when(cache).get(eq(key), any(Supplier.class)); ... cache.put("key", value, PutPolicy.PUT_ALWAYS);

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
VCacheTestHelper()

Method Summary

Modifier and Type	Method and Description
static void	cleanContext() Clean up vcache context.
static <T extends Serializable> DirectExternalCache<T>	getExternalCache(VCacheFactory mockVcacheFactory, String name, Class<T> clazz) Build DirectExternalCache and set up mockito expectations for appropriate calls of VCacheFactory
static <T extends Serializable> DirectExternalCache<T>	getExternalCache(VCacheFactory mockVcacheFactory, String name, Class<T> clazz, ExternalCacheSettings settings) Build DirectExternalCache and set up mockito expectations for appropriate calls of VCacheFactory
static VCacheFactory	getFactory() Build VCacheFactory and set-up all necessary context.
static VCacheFactory	getFactory(Supplier<RequestContext> contextSupplier) Build VCacheFactory and set-up all necessary context.
static <K,V> JvmCache<K,V>	getJvmCache(VCacheFactory mockVcacheFactory, String cacheName) Build JvmCache and set up mockito expectations for appropriate calls of VCacheFactory
static <K,V> JvmCache<K,V>	getJvmCache(VCacheFactory mockVcacheFactory, String cacheName, JvmCacheSettings settings) Build JvmCache and set up mockito expectations for appropriate calls of VCacheFactory
static VCacheFactory	getProxiedFactory() Build VCacheFactory and set-up all necessary context.
static <T extends Serializable> TransactionalExternalCache<T>	getTransactionalCache(VCacheFactory mockVcacheFactory, String name, Class<T> clazz) Build TransactionalExternalCache and set up mockito expectations for appropriate calls of VCacheFactory
static <T extends Serializable> TransactionalExternalCache<T>	getTransactionalCache(VCacheFactory mockVcacheFactory, String name, Class<T> clazz, ExternalCacheSettings settings) Build TransactionalExternalCache and set up mockito expectations for appropriate calls of VCacheFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

VCacheTestHelper

public VCacheTestHelper()

Method Detail

getFactory

public static VCacheFactory getFactory()

Build VCacheFactory and set-up all necessary context. Please don't forget to call cleanContext() after tests to clean up vcache context.

Returns:

VCacheFactory suitable for testing.

getFactory

public static VCacheFactory getFactory(Supplier<RequestContext> contextSupplier)

Build VCacheFactory and set-up all necessary context. Please don't forget to call cleanContext() after tests to clean up vcache context.

Parameters:

contextSupplier - the context supplier to be used when creating caches.

Returns:

VCacheFactory suitable for testing.

getProxiedFactory

public static VCacheFactory getProxiedFactory()

Build VCacheFactory and set-up all necessary context. Please don't forget to call cleanContext() after tests to clean up vcache context.

Returns:

VCacheFactory suitable for testing. Returned value is mockito proxied object, so can be used to build test expectations.

getExternalCache

public static <T extends Serializable> DirectExternalCache<T> getExternalCache(VCacheFactory mockVcacheFactory,
                                                                               String name,
                                                                               Class<T> clazz)

Build DirectExternalCache and set up mockito expectations for appropriate calls of VCacheFactory

Type Parameters:

T - type of cached objects

Parameters:

mockVcacheFactory - mockito proxied or mocked VCacheFactory

name - name of the cache

clazz - class of cached objects

Returns:

DirectExternalCache proxied by mockito.

getExternalCache

public static <T extends Serializable> DirectExternalCache<T> getExternalCache(VCacheFactory mockVcacheFactory,
                                                                               String name,
                                                                               Class<T> clazz,
                                                                               ExternalCacheSettings settings)

Build DirectExternalCache and set up mockito expectations for appropriate calls of VCacheFactory

Type Parameters:

T - type of cached objects

Parameters:

mockVcacheFactory - mockito proxied or mocked VCacheFactory

name - name of the cache

clazz - class of cached objects

settings - cache settings

Returns:

DirectExternalCache proxied by mockito.

getJvmCache

public static <K,V> JvmCache<K,V> getJvmCache(VCacheFactory mockVcacheFactory,
                                              String cacheName)

Build JvmCache and set up mockito expectations for appropriate calls of VCacheFactory

Type Parameters:

K - type of cache keys

V - type of cached objects

Parameters:

mockVcacheFactory - mockito proxied or mocked VCacheFactory

cacheName - name of the cache

Returns:

JvmCache proxied by mockito.

getJvmCache

public static <K,V> JvmCache<K,V> getJvmCache(VCacheFactory mockVcacheFactory,
                                              String cacheName,
                                              JvmCacheSettings settings)

Build JvmCache and set up mockito expectations for appropriate calls of VCacheFactory

Type Parameters:

K - type of cache keys

V - type of cached objects

Parameters:

mockVcacheFactory - mockito proxied or mocked VCacheFactory

cacheName - name of the cache

settings - cache settings

Returns:

JvmCache proxied by mockito.

getTransactionalCache

public static <T extends Serializable> TransactionalExternalCache<T> getTransactionalCache(VCacheFactory mockVcacheFactory,
                                                                                           String name,
                                                                                           Class<T> clazz)

Build TransactionalExternalCache and set up mockito expectations for appropriate calls of VCacheFactory

Type Parameters:

T - type of cached objects

Parameters:

mockVcacheFactory - mockito proxied or mocked VCacheFactory

name - name of the cache

clazz - class of cached objects

Returns:

TransactionalExternalCache proxied by mockito.

getTransactionalCache

public static <T extends Serializable> TransactionalExternalCache<T> getTransactionalCache(VCacheFactory mockVcacheFactory,
                                                                                           String name,
                                                                                           Class<T> clazz,
                                                                                           ExternalCacheSettings settings)

Build TransactionalExternalCache and set up mockito expectations for appropriate calls of VCacheFactory

Type Parameters:

T - type of cached objects

Parameters:

mockVcacheFactory - mockito proxied or mocked VCacheFactory

name - name of the cache

clazz - class of cached objects

settings - cache settings

Returns:

TransactionalExternalCache proxied by mockito.

cleanContext

public static void cleanContext()

Clean up vcache context.