com.redhat.lightblue.test

Class AbstractCRUDTestController

java.lang.Object

com.redhat.lightblue.test.AbstractCRUDTestController

public abstract class AbstractCRUDTestController
extends Object

Testing harness for junit tests that need to stand an in-memory instance of lightblue. The assumption is made that one LightblueFactory will be used per test suite.

For initialization code that needs to be executed prior to the AbstractCRUDTestController(), use the @BeforeClass annotation. NOTE: This does not use the rest layer.

Example Usage:
Response response = lightblueFactory.getMediator().insert( createRequest_FromResource(InsertionRequest.class, "./path/to/insert/metadata.json"));

Author:

dcrissman

Field Summary

Fields

Modifier and Type	Field and Description
static String	REMOVE_ALL_HOOKS

Constructor Summary

Constructors

Constructor and Description
AbstractCRUDTestController() Defaults to statically loading lightblue.
AbstractCRUDTestController(boolean loadStatically) Creates an instance of the LightblueFactory.

Method Summary

Modifier and Type	Method and Description
static void	cleanup()
protected static <T extends Request> T	createRequest_FromJsonString(Class<T> type, String jsonString) Creates and returns a Request based on the passed in jsonString.
protected static <T extends Request> T	createRequest_FromResource(Class<T> type, String jsonFile) Creates and returns a Request based on the passed in jsonFile.
protected static <T extends Request> T	createRequest(Class<T> type, com.fasterxml.jackson.databind.JsonNode node) Creates and returns a Request based on the passed in JsonNode
static void	ensureDatasource(com.fasterxml.jackson.databind.JsonNode node, String datasource)
protected String	getDatasource() Override to set the datasource values for all metadata to the returned value of this method.
protected abstract com.fasterxml.jackson.databind.JsonNode	getDatasourcesJson() Creates and returns an instance of JsonNode that represents the relevant lightblue-datasources.json.
Set<String>	getHooksToRemove()
protected com.fasterxml.jackson.databind.JsonNode	getLightblueCrudJson() Creates and returns an instance of JsonNode that represents the relevant lightblue-crud.json.
protected static LightblueFactory	getLightblueFactory()
protected com.fasterxml.jackson.databind.JsonNode	getLightblueMetadataJson() Creates and returns an instance of JsonNode that represents the relevant lightblue-metadata.json.
protected abstract com.fasterxml.jackson.databind.JsonNode[]	getMetadataJsonNodes() Create and returns an array of JsonNodes from which to load the LightblueFactory with.
static void	grantAnyoneAccess(com.fasterxml.jackson.databind.JsonNode node) Deep dives to set all access levels to 'anyone'.
boolean	isGrantAnyoneAccess()
static void	stripHooks(com.fasterxml.jackson.databind.JsonNode node, Set<String> hooksToRemove) Strips out the specified hooks.

Methods inherited from class java.lang.Object

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

Field Detail

REMOVE_ALL_HOOKS

public static final String REMOVE_ALL_HOOKS

See Also:

Constant Field Values

Constructor Detail

AbstractCRUDTestController

public AbstractCRUDTestController()
                           throws Exception

Defaults to statically loading lightblue.

Throws:

Exception

AbstractCRUDTestController

public AbstractCRUDTestController(boolean loadStatically)
                           throws Exception

Creates an instance of the LightblueFactory.

Parameters:

loadStatically - - true loads lightblue statically for the duration of the suite, otherwise false will load lightblue for each test.

Throws:

IOException

ClassNotFoundException

NoSuchMethodException

IllegalAccessException

InvocationTargetException

InstantiationException

Exception

Method Detail

cleanup

public static void cleanup()

getLightblueFactory

protected static LightblueFactory getLightblueFactory()

Returns:

the lightblueFactory

grantAnyoneAccess

public static void grantAnyoneAccess(com.fasterxml.jackson.databind.JsonNode node)

Deep dives to set all access levels to 'anyone'.

Parameters:

node - - root JsonNode

getLightblueCrudJson

protected com.fasterxml.jackson.databind.JsonNode getLightblueCrudJson()
                                                                throws Exception

Creates and returns an instance of JsonNode that represents the relevant lightblue-crud.json. If not set by a subclass, then the default settings will be used.

Returns:

the JsonNode to use when configuring the lightblue crud controllers, or null to use the default LightblueFactory setting.

Throws:

Exception

getLightblueMetadataJson

protected com.fasterxml.jackson.databind.JsonNode getLightblueMetadataJson()
                                                                    throws Exception

Creates and returns an instance of JsonNode that represents the relevant lightblue-metadata.json. If not set by a subclass, then the default settings will be used.

Returns:

the JsonNode to use when configuring the lightblue metadata, or null to use the default LightblueFactory setting.

Throws:

Exception

getDatasourcesJson

protected abstract com.fasterxml.jackson.databind.JsonNode getDatasourcesJson()
                                                                       throws Exception

Creates and returns an instance of JsonNode that represents the relevant lightblue-datasources.json.

Returns:

the resource name for the json file that contains the datasources. If null, embedded configuration is used.

Throws:

Exception

getMetadataJsonNodes

protected abstract com.fasterxml.jackson.databind.JsonNode[] getMetadataJsonNodes()
                                                                           throws Exception

Create and returns an array of JsonNodes from which to load the LightblueFactory with. These EntityMetadata instances will be available to all tests in the suite.

Returns:

an array of JsonNodes from which to load the LightblueFactory with.

Throws:

Exception

ensureDatasource

public static void ensureDatasource(com.fasterxml.jackson.databind.JsonNode node,
                                    String datasource)

getDatasource

protected String getDatasource()

Override to set the datasource values for all metadata to the returned value of this method. By default null will be returned disabling this feature.

Returns:

String name of datasource to use in all metadata.

stripHooks

public static void stripHooks(com.fasterxml.jackson.databind.JsonNode node,
                              Set<String> hooksToRemove)

Strips out the specified hooks. Pass in 'ALL' or REMOVE_ALL_HOOKS to remove all the hooks on the node.

Parameters:

node - - root JsonNode

hooksToRemove - - Set of hook names to remove from entityInfo.

getHooksToRemove

public Set<String> getHooksToRemove()

Returns:

Set of hook names to remove. By default returns REMOVE_ALL_HOOKS, which will remove all hooks.

isGrantAnyoneAccess

public boolean isGrantAnyoneAccess()

Returns:

true if access settings on metadata should be altered to 'anyone', otherwise false. Defaults to true.

createRequest_FromResource

protected static <T extends Request> T createRequest_FromResource(Class<T> type,
                                                                  String jsonFile)
                                                           throws IOException

Creates and returns a Request based on the passed in jsonFile.

Parameters:

type - - Request class to instantiate.

jsonFile - - File containing metadata json

Returns:

a Request based on the passed in jsonFile.

Throws:

IOException

createRequest_FromJsonString

protected static <T extends Request> T createRequest_FromJsonString(Class<T> type,
                                                                    String jsonString)
                                                             throws IOException

Creates and returns a Request based on the passed in jsonString.

Parameters:

type - - Request class to instantiate.

jsonString - - String of metadata json

Returns:

a Request based on the passed in jsonString.

Throws:

IOException

createRequest

protected static <T extends Request> T createRequest(Class<T> type,
                                                     com.fasterxml.jackson.databind.JsonNode node)

Creates and returns a Request based on the passed in JsonNode

Parameters:

type - - Request class to instantiate.

node - - JsonNode of actions metadata

Returns:

a Request based on the passed in JsonNode