net.sf.lightair

Class Api

java.lang.Object

net.sf.lightair.Api

All Implemented Interfaces:

Keywords

public class Api
extends Object
implements Keywords

Light Air's programmatic API.

The general contract is to initialize(String) and shutdown() and in between perform either generateXsd() call or (a series of) setup(Map) and verify(Map) or await(Map) calls.

To generate XSD files:

 Api.initialize(Api.getPropertiesFileName());
 Api.generateXsd();
 Api.shutdown();
 

To setup and verify database:

 Map<String, List<String>> fileNames = new HashMap<>();
 fileNames.put(Keywords.DEFAULT_PROFILE, Arrays.asList("my-dataset-1.xml", "my-dataset-2.xml"));

 Api.initialize(Api.getPropertiesFileName());
 Api.setup(fileNames);
 // ...execute function under test...
 Api.verify(fileNames);
 // ...or for asynchronous functionality:
 Api.await(fileNames);
 // ...possibly repeat setup and verify / await for other tests...
 Api.shutdown();
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTIES_PROPERTY_NAME

Fields inherited from interface net.sf.lightair.internal.Keywords

ACTUAL, ANY_TOKEN, ARRAY_ELEMENT_SEPARATOR, ARRAY_INTEGER, ARRAY_LONG, ARRAY_STRING, AUTO_INDEX_DIRECTORY, AUTO_TOKEN, BIGDECIMAL, BLOB, BOOLEAN, BYTE, BYTES, CLOB, COLUMN, COLUMNS, DATA_TYPE, DATABASE_CONNECTION_URL, DATABASE_DRIVER_CLASS_NAME, DATABASE_PASSWORD, DATABASE_SCHEMA, DATABASE_USER_NAME, DATE, DATE_TOKEN, DECIMAL_DIGITS, DEFAULT_AUTO_INDEX_DIRECTORY, DEFAULT_PROFILE, DEFAULT_PROPERTIES_FILE_NAME, DEFAULT_XSD_DIRECTORY, DIFFERENCES, DIFFERENT, DOUBLE, ENV_DATABASE_CONNECTION_URL, ENV_DATABASE_DRIVER_CLASS_NAME, ENV_DATABASE_PASSWORD, ENV_DATABASE_SCHEMA, ENV_DATABASE_USER_NAME, ENV_TIME_DIFFERENCE_LIMIT_MILLIS, EXPECTED, FIXED_NSTRING, FIXED_STRING, FLOAT, INTEGER, JDBC_DATA_TYPE, JSON, JSONB, LONG, MISSING, NCLOB, NOT_NULL, NSTRING, NULL_TOKEN, PARAMETERS, SHORT, SIZE, SQL, STRING, TABLE, TIME, TIME_DIFFERENCE_LIMIT_MILLIS, TIME_TOKEN, TIMESTAMP, TIMESTAMP_TOKEN, UNEXPECTED, UUID, VALUE, VARIABLE_PREFIX, XSD_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
Api()

Method Summary

Modifier and Type	Method and Description
static void	await(Map<String,List<String>> fileNames) Verify database after an asynchronous test.
static void	ensureInitialized(String propertiesFileName) Initialize Light Air if it is not initialized already.
static void	ensureShutdown() Shutdown Light Air to properly release resources, like DB connections, if it is not shutdown already.
static void	generateXsd() Generate XSD files from the database structure.
static String	getPropertiesFileName() Get the file name of the main properties file.
static void	initialize(String propertiesFileName) Initialize Light Air.
static void	reInitialize() Re-initialize already initialized Light Air.
static void	setup(Map<String,List<String>> fileNames) Setup database.
static void	shutdown() Shutdown previously initialized Light Air to properly release resources, like DB connections.
static void	verify(Map<String,List<String>> fileNames) Verify database.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_PROPERTY_NAME

public static final String PROPERTIES_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

Api

public Api()

Method Detail

getPropertiesFileName

public static String getPropertiesFileName()

Get the file name of the main properties file.

Returns:

file name

initialize

public static void initialize(String propertiesFileName)

Initialize Light Air.

NOTE: ALWAYS call shutdown() after initialize() to properly release resources.

Parameters:

propertiesFileName - file name of the main Light Air properties

shutdown

public static void shutdown()

Shutdown previously initialized Light Air to properly release resources, like DB connections.

reInitialize

public static void reInitialize()

Re-initialize already initialized Light Air.

Reloads the properties file(s) and cleanly re-initializes Light Air.

ensureInitialized

public static void ensureInitialized(String propertiesFileName)

Initialize Light Air if it is not initialized already.

Parameters:

propertiesFileName - file name of the main Light Air properties

ensureShutdown

public static void ensureShutdown()

Shutdown Light Air to properly release resources, like DB connections, if it is not shutdown already.

generateXsd

public static void generateXsd()

Generate XSD files from the database structure.

setup

public static void setup(Map<String,List<String>> fileNames)

Setup database.

Parameters:

fileNames - map of profile names to lists of names of setup dataset files for the profile

verify

public static void verify(Map<String,List<String>> fileNames)

Verify database.

Parameters:

fileNames - map of profile names to lists of names of verification dataset files for the profile

await

public static void await(Map<String,List<String>> fileNames)

Verify database after an asynchronous test.

Verifies the database repeatedly until either the result is successful or timeout has expired.

Parameters:

fileNames - map of profile names to lists of names of verification dataset files for the profile