com.bigdata.btree

Class AbstractTupleCursorTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

junit.framework.TestCase2

com.bigdata.btree.AbstractTupleCursorTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

AbstractBTreeCursorTestCase, TestIndexSegmentCursors, TestRemoverator, TestReverserator

public abstract class AbstractTupleCursorTestCase
extends TestCase2

Abstract base class for ITupleCursor test suites.

Version:

$Id$

Author:

Bryan Thompson

Nested Class Summary

Nested classes/interfaces inherited from class junit.framework.TestCase2

TestCase2.MyProperties, TestCase2.RandomType

Field Summary

Fields inherited from class junit.framework.TestCase2

_randomType, log

Constructor Summary

Constructors

Constructor and Description
AbstractTupleCursorTestCase()
AbstractTupleCursorTestCase(String arg0)

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertEquals(ITuple expected, ITuple actual) Compares two tuples for equality based on their data (flags, keys, values, deleted marker, and version timestamp).
protected void	doBaseCaseTest(AbstractBTree btree) Test helper tests first(), last(), next(), prior(), and seek() given a B+Tree that has been pre-populated with some known tuples.
protected void	doEmptyIndexTest(AbstractBTree btree) Test helper tests for fence posts when the index is empty
protected void	doOneTupleTest(AbstractBTree btree) Test helper for fence posts when there is only a single tuple.
protected void	doReverseTraversalTest(AbstractBTree btree) Unit test for reverse traversal under a variety of edge cases.
protected BTree	getBaseCaseBTree() Return a B+Tree populated with data for doBaseCaseTest(AbstractBTree).
protected BTree	getOneTupleBTree() Creates, populates and returns a BTree for doOneTupleTest(AbstractBTree)
protected BTree	getReverseTraversalBTree() Return a B+Tree populated with data for doReverseTraversalTest(AbstractBTree).
protected ITupleCursor2<String>	newCursor(AbstractBTree btree) Create an appropriate cursor instance for the given B+Tree.
protected abstract ITupleCursor2<String>	newCursor(AbstractBTree btree, int flags, byte[] fromKey, byte[] toKey) Create an appropriate cursor instance for the given B+Tree.

Methods inherited from class junit.framework.TestCase2

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEqualsWithinUlps, assertSameArray, assertSameArray, assertSameBigDecimal, assertSameBigDecimal, assertSameBigInteger, assertSameBigInteger, assertSameIterator, assertSameIterator, assertSameIteratorAnyOrder, assertSameIteratorAnyOrder, assertSameValue, assertSameValue, assertZeroUlps, assertZeroUlps, fail, getInnerCause, getNormalInt, getProjectBuildPath, getProperties, getRandomObject, getRandomObject, getRandomOrder, getRandomString, getTestInputStream, getTestResource, getTestResource, getUlps, getUlps, isDEBUG, isDEBUG, isINFO, isINFO, isInnerCause, logProperties

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, setUp, tearDown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTupleCursorTestCase

public AbstractTupleCursorTestCase()

AbstractTupleCursorTestCase

public AbstractTupleCursorTestCase(String arg0)

Parameters:

arg0 -

Method Detail

newCursor

protected abstract ITupleCursor2<String> newCursor(AbstractBTree btree,
                              int flags,
                              byte[] fromKey,
                              byte[] toKey)

Create an appropriate cursor instance for the given B+Tree.

Parameters:

btree -

flags -

fromKey -

toKey -

Returns:

An ITupleCursor for that B+Tree.

newCursor

protected ITupleCursor2<String> newCursor(AbstractBTree btree)

Create an appropriate cursor instance for the given B+Tree.

Parameters:

btree -

Returns:

getBaseCaseBTree

protected BTree getBaseCaseBTree()

Return a B+Tree populated with data for doBaseCaseTest(AbstractBTree).

doBaseCaseTest

protected void doBaseCaseTest(AbstractBTree btree)

Test helper tests first(), last(), next(), prior(), and seek() given a B+Tree that has been pre-populated with some known tuples.

Parameters:

btree - The B+Tree.

See Also:

getBaseCaseBTree()

getReverseTraversalBTree

protected BTree getReverseTraversalBTree()

Return a B+Tree populated with data for doReverseTraversalTest(AbstractBTree).

Note: this unit test is setup to create a B+Tree with 2 leaves and a root node. This allows us to test the edge case where reverse traversal begins with a key that is LTE the first key in the 2nd leaf.

Note: This unit test does not work for the IndexSegment because the IndexSegmentBuilder will fill up each leaf in turn, so the first leaf winds up with 3 tuples and the second with only 2 rather than it being the other way around.

doReverseTraversalTest

protected void doReverseTraversalTest(AbstractBTree btree)

Unit test for reverse traversal under a variety of edge cases. The data is a B+Tree with two leaves

 (10,Bryan)
 (20,Mike)
 
 and
 
 (30,James)
 (40,Amy)
 (50,Mary)
 

This allows us to test the edge case where reverse traversal begins with a key that is LTE the first key in the 2nd leaf.

Parameters:

btree -

doEmptyIndexTest

protected void doEmptyIndexTest(AbstractBTree btree)

Test helper tests for fence posts when the index is empty

Note: this test can not be written for an IndexSegment since you can't have an empty IndexSegment.

Parameters:

btree - An empty B+Tree.

getOneTupleBTree

protected BTree getOneTupleBTree()

Creates, populates and returns a BTree for doOneTupleTest(AbstractBTree)

doOneTupleTest

protected void doOneTupleTest(AbstractBTree btree)

Test helper for fence posts when there is only a single tuple. including when attempting to visit tuples in a key range that does not overlap with the tuple that is actually in the index.

Parameters:

btree -

assertEquals

public static void assertEquals(ITuple expected,
                ITuple actual)

Compares two tuples for equality based on their data (flags, keys, values, deleted marker, and version timestamp).

Note: This will fail if you apply it to tuples reported by ITupleIterators whose DELETE flag was different since it verifies the DELETE flag state and that is a property of the iterator NOT the tuple. Whether or not a tuple is deleted is detected using ITuple.isDeletedVersion().

Parameters:

expected -

actual -