pro.foundev.cassandra.commons.test

Class CassandraTestDB

java.lang.Object

pro.foundev.cassandra.commons.test.CassandraTestDB

All Implemented Interfaces:

Closeable, AutoCloseable

public class CassandraTestDB
extends Object
implements Closeable

Useful test class that provides very basic CRUD for testing support. It handles Session and Cluster setup and shutdown and will when used with the SpringJUnit4ClassRunner by implementing DisposableBean. It also cleans up after itself by truncating tables automatically after a test. If you save to a table it will truncate a table or if you explicitly call markForCleanup(keyspace, tableName). This feature is implemented by wiring up a custom Test Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected com.datastax.driver.core.Session	session

Constructor Summary

Constructors

Constructor and Description
CassandraTestDB(CassandraSessionFactory sessionFactory)

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Cleanup strategy to that truncates known tables.
void	close() Shuts down DataStax Java driver Session and Cluster objects safely
Long	count(String table) count on a given table.
static CassandraTestDB	create() Factory method for CassandraTestDB using default ConfigFinderImpl
static CassandraTestDB	create(ConfigFinder configFinder) Factory method for CassandraTestDB with optional ConfigFinder override.
void	createTestKeyspace(String keyspaceName) creates a simple keyspace for testing purposes with SimpleStrategy and replication factor of 1 will blow it away on test teardown
void	deleteTestKeyspaceIfExists(String keyspaceName) drops the keyspace if it doesn't exist.
com.datastax.driver.core.ResultSet	execute(com.datastax.driver.core.Statement statement) session.execute wrapper
com.datastax.driver.core.Session	getSession() Just returns the internal session object.
protected void	markForCleanUp(FullTableName fullTableName)
void	markForCleanUp(String table) assumes keyspace is already wired up
void	markForCleanUp(String keyspace, String tableName) Mark table for cleanup.
boolean	tableExists(String keyspaceName, String tableName) simple utility check to see if table exists, does mark table for cleanup if it does

Methods inherited from class java.lang.Object

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

Field Detail

session

protected final com.datastax.driver.core.Session session

Constructor Detail

CassandraTestDB

public CassandraTestDB(CassandraSessionFactory sessionFactory)

Parameters:

sessionFactory - owns the session object and responsible for setup

Method Detail

markForCleanUp

protected void markForCleanUp(FullTableName fullTableName)

create

public static CassandraTestDB create()
                              throws IOException

Factory method for CassandraTestDB using default ConfigFinderImpl

Returns:

CassandraTestDB

Throws:

IOException

create

public static CassandraTestDB create(ConfigFinder configFinder)
                              throws IOException

Factory method for CassandraTestDB with optional ConfigFinder override.

Returns:

CassandraTestDB

Throws:

IOException - when config file not found.

cleanUp

public void cleanUp()

Cleanup strategy to that truncates known tables. Depends on save or markForCleanup methods making the table known. Today there is a precondition on the Keyspace and Table name being declared in the Mapping. This may change later.

markForCleanUp

public void markForCleanUp(String keyspace,
                           String tableName)

Mark table for cleanup.

Parameters:

keyspace - keyspace where the table lives

tableName - table to truncate

markForCleanUp

public void markForCleanUp(String table)

assumes keyspace is already wired up

Parameters:

table - table to mark for cleanup

getSession

public com.datastax.driver.core.Session getSession()

Just returns the internal session object. Any queries that will be executed against this session are not tracked by the listener.

Returns:

createTestKeyspace

public void createTestKeyspace(String keyspaceName)

creates a simple keyspace for testing purposes with SimpleStrategy and replication factor of 1 will blow it away on test teardown

Parameters:

keyspaceName -

tableExists

public boolean tableExists(String keyspaceName,
                           String tableName)

simple utility check to see if table exists, does mark table for cleanup if it does

Parameters:

keyspaceName -

tableName -

Returns:

true if table is in system false if not

deleteTestKeyspaceIfExists

public void deleteTestKeyspaceIfExists(String keyspaceName)

drops the keyspace if it doesn't exist. great for testing methods that have manual keyspace resources

Parameters:

keyspaceName -

close

public void close()
           throws IOException

Shuts down DataStax Java driver Session and Cluster objects safely

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

execute

public com.datastax.driver.core.ResultSet execute(com.datastax.driver.core.Statement statement)

session.execute wrapper

Parameters:

statement - statement to execute

Returns:

count

public Long count(String table)

count on a given table. It will page on versions of C* 2.0.0 and greater. Otherwise it'll pull the whole results set into ram and offline the coordinator.

Parameters:

table - table to get count on

Returns:

total count of records in that table