org.treetank

Class CoreTestHelper

java.lang.Object

org.treetank.CoreTestHelper

public final class CoreTestHelper
extends Object

Helper class for offering convenient usage of Sessions for test cases. This includes instantiation of databases plus resources.

Author:

Sebastian Graf, University of Konstanz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoreTestHelper.Holder
static class	CoreTestHelper.PATHS Paths where the data is stored to.

Field Summary

Fields

Modifier and Type	Field and Description
static Random	random Common random instance for generating common tag names.
static String	RESOURCENAME

Constructor Summary

Constructors

Constructor and Description
CoreTestHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkStructure(List<org.treetank.bucket.DumbDataFactory.DumbData> pDatas, org.treetank.api.IBucketReadTrx pRtx, long startKey) Checking the transaction with datas written sequentially.
static void	checkStructure(List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>> pEntries, org.treetank.api.IBucketReadTrx pRtx, boolean pWorkOnClone) Checking the transaction with meta entries written.
static void	closeEverything() Closing all resources as defined in the enum CoreTestHelper.PATHS.
static List<org.treetank.bucket.DumbDataFactory.DumbData>	combineDatas(org.treetank.bucket.DumbDataFactory.DumbData[][] pDatas) Combining multiple datas to one overall list.
static org.treetank.bucket.DumbDataFactory.DumbData[][]	createDatas(int[] pDatasPerRevision) Generating new atas passed on a given number of datas within a revision
static List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>>	createMetaEntries(int pNumbers) Creating a list of meta entries for testing the meta-bucket stuff
static boolean	createResource(org.treetank.access.conf.ResourceConfiguration resConf)
static org.treetank.bucket.DumbDataFactory.DumbData[][]	createTestData(CoreTestHelper.Holder pHolder) Create datas in different versions in Treetank and check directly afterwards the structure.
static List<List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>>>	createTestMeta(CoreTestHelper.Holder pHolder) Create datas in different versions in Treetank and check directly afterwards the structure.
static void	deleteEverything() Deleting all resources as defined in the enum CoreTestHelper.PATHS.
static org.treetank.bucket.DumbDataFactory.DumbData	generateOne() Generating one single DumbDataFactory.DumbData with random values.
static byte[]	generateRandomBytes(int pSize) Generating random bytes.
static com.google.common.hash.HashCode	generateRandomHash()
static org.treetank.bucket.DataBucket	getDataBucket(int offset, int length, long databucketKey, long lastBucketKey) Getting a data buckets filled with datas.
static org.treetank.io.IBackendReader	getFakedStructure(int[] offsets) Getting a fake structure for testing consisting of different arranged buckets.
static org.treetank.api.IStorage	getStorage(File file) Getting a database and create one of not existing.
static org.treetank.bucket.DumbDataFactory.DumbData[][]	insertDatasWithTransaction(int[] pDatasPerRevision, org.treetank.api.IBucketWriteTrx pWtx) Utility method to create datas per revision.
static List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>>	insertMetaWithTransaction(int pNumbers, org.treetank.api.IBucketWriteTrx pWtx, List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>> pAlreadyExistingEntries) Utility method to create datas per revision.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCENAME

public static final String RESOURCENAME

See Also:

Constant Field Values

random

public static final Random random

Common random instance for generating common tag names.

Constructor Detail

CoreTestHelper

public CoreTestHelper()

Method Detail

getStorage

public static final org.treetank.api.IStorage getStorage(File file)
                                                  throws org.treetank.exception.TTException

Getting a database and create one of not existing. This includes the creation of a resource with the settings in the builder as standard.

Parameters:

file - to be created

Returns:

a database-obj

Throws:

org.treetank.exception.TTException

createResource

public static final boolean createResource(org.treetank.access.conf.ResourceConfiguration resConf)
                                    throws org.treetank.exception.TTException

Throws:

org.treetank.exception.TTException

deleteEverything

public static final void deleteEverything()
                                   throws org.treetank.exception.TTException

Deleting all resources as defined in the enum CoreTestHelper.PATHS.

Throws:

org.treetank.exception.TTException

closeEverything

public static final void closeEverything()
                                  throws org.treetank.exception.TTException

Closing all resources as defined in the enum CoreTestHelper.PATHS.

Throws:

org.treetank.exception.TTException

generateRandomBytes

public static final byte[] generateRandomBytes(int pSize)

Generating random bytes.

Returns:

the random bytes

getDataBucket

public static final org.treetank.bucket.DataBucket getDataBucket(int offset,
                                           int length,
                                           long databucketKey,
                                           long lastBucketKey)

Getting a data buckets filled with datas.

Parameters:

offset - offset to start within the bucket

length - length of the bucket

databucketKey - key of the databucket

lastBucketKey - key of the former bucket

Returns:

a DataBucket filled

generateOne

public static final org.treetank.bucket.DumbDataFactory.DumbData generateOne()

Generating one single DumbDataFactory.DumbData with random values.

Returns:

one DumbDataFactory.DumbData with random values.

getFakedStructure

public static final org.treetank.io.IBackendReader getFakedStructure(int[] offsets)
                                                              throws org.treetank.exception.TTIOException

Getting a fake structure for testing consisting of different arranged buckets. This structure starts with the key 1 and incrementally sets a new bucketkey for the defined offsets in the indirectbuckets to simulate different versions and data-offsets. The key retrieved thereby has always the value 6 (1 (starting) + 5 (number of indirect layers)

Parameters:

offsets - an array with offsets internally of the tree.

Returns:

a IBackendReader-mock

Throws:

org.treetank.exception.TTIOException

createTestMeta

public static final List<List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>>> createTestMeta(CoreTestHelper.Holder pHolder)
                                                                                                                                                       throws org.treetank.exception.TTException

Create datas in different versions in Treetank and check directly afterwards the structure.

Parameters:

pHolder - for getting the transaction

Returns:

a two-dimensional array of datas.

Throws:

org.treetank.exception.TTException

createTestData

public static final org.treetank.bucket.DumbDataFactory.DumbData[][] createTestData(CoreTestHelper.Holder pHolder)
                                                                             throws org.treetank.exception.TTException

Create datas in different versions in Treetank and check directly afterwards the structure.

Parameters:

pHolder - for getting the transaction

Returns:

a two-dimensional array of datas.

Throws:

org.treetank.exception.TTException

insertDatasWithTransaction

public static final org.treetank.bucket.DumbDataFactory.DumbData[][] insertDatasWithTransaction(int[] pDatasPerRevision,
                                                                          org.treetank.api.IBucketWriteTrx pWtx)
                                                                                         throws org.treetank.exception.TTException

Utility method to create datas per revision.

Parameters:

pDatasPerRevision - to create

pWtx - to store to.

Throws:

org.treetank.exception.TTException

insertMetaWithTransaction

public static final List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>> insertMetaWithTransaction(int pNumbers,
                                                                                                                                             org.treetank.api.IBucketWriteTrx pWtx,
                                                                                                                                             List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>> pAlreadyExistingEntries)
                                                                                                                                                            throws org.treetank.exception.TTException

Utility method to create datas per revision.

Parameters:

pNumbers - number to create

pWtx - to store to.

pAlreadyExistingEntries - already existing entries

Returns:

List> returning the inserted data

Throws:

org.treetank.exception.TTException

createMetaEntries

public static final List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>> createMetaEntries(int pNumbers)

Creating a list of meta entries for testing the meta-bucket stuff

Parameters:

pNumbers - of entries

Returns:

a list containing map-entries of dumbvalues and dumbkeys.

createDatas

public static final org.treetank.bucket.DumbDataFactory.DumbData[][] createDatas(int[] pDatasPerRevision)

Generating new atas passed on a given number of datas within a revision

Parameters:

pDatasPerRevision - denote the number of datas within all versions

Returns:

a two-dimensional array containing the datas.

checkStructure

public static final void checkStructure(List<Map.Entry<org.treetank.bucket.DumbMetaEntryFactory.DumbKey,org.treetank.bucket.DumbMetaEntryFactory.DumbValue>> pEntries,
                  org.treetank.api.IBucketReadTrx pRtx,
                  boolean pWorkOnClone)
                                 throws org.treetank.exception.TTIOException

Checking the transaction with meta entries written.

Parameters:

pEntries - to be compared with

pRtx - to check

pWorkOnClone - parameter if the check should occur on cloned structure

Throws:

org.treetank.exception.TTIOException

checkStructure

public static final void checkStructure(List<org.treetank.bucket.DumbDataFactory.DumbData> pDatas,
                  org.treetank.api.IBucketReadTrx pRtx,
                  long startKey)
                                 throws org.treetank.exception.TTIOException

Checking the transaction with datas written sequentially.

Parameters:

pDatas - to be compared with

pRtx - to check

Throws:

org.treetank.exception.TTIOException

combineDatas

public static final List<org.treetank.bucket.DumbDataFactory.DumbData> combineDatas(org.treetank.bucket.DumbDataFactory.DumbData[][] pDatas)

Combining multiple datas to one overall list.

Parameters:

pDatas - to be combined

Returns:

a list of all data in one list.

generateRandomHash

public static final com.google.common.hash.HashCode generateRandomHash()