net.sf.javagimmicks.sql.testing

Class HsqlDbTestRule

java.lang.Object

org.junit.rules.ExternalResource

net.sf.javagimmicks.sql.testing.HsqlDbTestRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class HsqlDbTestRule
extends org.junit.rules.ExternalResource

A JUnit TestRule that creates a temporary file-based Hypersonic SQL database during test execution and wraps a Commons-DBCP BasicDataSource around it.

The developer can influence the temporary folder, where the database should be created and/or can provide initial configuration logic for the used BasicDataSource via a HsqlDbTestRule.DataSourceConfigurator.

Usage example:

 public class HsqlDbTestRuleTest
 {
 
    @Rule
    public HsqlDbTestRule _db = new HsqlDbTestRule();
 
    @Test
    public void test() throws SQLException
    {
       final Connection connection = _db.getConnection();
       assertNotNull(connection);
 
       // Do some DB operations
 
       conneciton.close();
    }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HsqlDbTestRule.DataSourceConfigurator A command interface for providing custom configuration logic for the internal BasicDataSource.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_TEST_DB The name of the temporary Hypersonic SQL database that is creating during test runs.

Constructor Summary

Constructors

Constructor and Description
HsqlDbTestRule() Creates a new instance with no special configuration.
HsqlDbTestRule(File dbFolder) Creates a new instance using the given folder for the internal database.
HsqlDbTestRule(HsqlDbTestRule.DataSourceConfigurator configurator) Creates a new instance using the given HsqlDbTestRule.DataSourceConfigurator for the internal database.
HsqlDbTestRule(HsqlDbTestRule.DataSourceConfigurator configurator, File dbFolder) Creates a new instance using the given HsqlDbTestRule.DataSourceConfigurator and folder for the internal database.

Method Summary

Methods

Modifier and Type	Method and Description
Connection	getConnection() Retrieves a new Connection to the temporary Hypersonic SQL database.
File	getDatabaseFolder() Returns the folder where the test database is or will be created.
org.apache.commons.dbcp.BasicDataSource	getDataSource() Returns the BasicDataSource representing the temporary Hypersonic SQL database.
void	init()
void	shutdown()

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Field Detail

NAME_TEST_DB

public static final String NAME_TEST_DB

The name of the temporary Hypersonic SQL database that is creating during test runs.

See Also:

Constant Field Values

Constructor Detail

HsqlDbTestRule

public HsqlDbTestRule(HsqlDbTestRule.DataSourceConfigurator configurator,
              File dbFolder)

Creates a new instance using the given HsqlDbTestRule.DataSourceConfigurator and folder for the internal database.

Parameters:

configurator - a HsqlDbTestRule.DataSourceConfigurator for performing custom configuration logic on the internal BasicDataSource

dbFolder - the temporary folder where the database should be set up

HsqlDbTestRule

public HsqlDbTestRule(HsqlDbTestRule.DataSourceConfigurator configurator)

Creates a new instance using the given HsqlDbTestRule.DataSourceConfigurator for the internal database.

Parameters:

configurator - a HsqlDbTestRule.DataSourceConfigurator for performing custom configuration logic on the internal BasicDataSource

HsqlDbTestRule

public HsqlDbTestRule(File dbFolder)

Creates a new instance using the given folder for the internal database.

Parameters:

dbFolder - the temporary folder where the database should be set up

HsqlDbTestRule

public HsqlDbTestRule()

Creates a new instance with no special configuration.

Method Detail

getDataSource

public org.apache.commons.dbcp.BasicDataSource getDataSource()

Returns the BasicDataSource representing the temporary Hypersonic SQL database.

Returns:

the BasicDataSource representing the temporary Hypersonic SQL database

getConnection

public Connection getConnection()
                         throws SQLException

Retrieves a new Connection to the temporary Hypersonic SQL database.

Returns:

a new Connection to the temporary Hypersonic SQL database

Throws:

SQLException

getDatabaseFolder

public File getDatabaseFolder()

Returns the folder where the test database is or will be created.

Returns:

the folder where the test database is or will be created

init

public void init()
          throws Throwable

Throws:

Throwable

shutdown

public void shutdown()