com.bigdata.quorum

Class AbstractQuorumTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

junit.framework.TestCase2

com.bigdata.io.TestCase3

com.bigdata.quorum.AbstractQuorumTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

TestHA3QuorumSemantics, TestSingletonQuorumSemantics

public abstract class AbstractQuorumTestCase
extends TestCase3

Abstract base class for testing using a MockQuorumFixture.

Version:

$Id$

Author:

Bryan Thompson

Nested Class Summary

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

TestCase2.MyProperties, TestCase2.RandomType

Field Summary

Fields

Modifier and Type	Field and Description
protected MockQuorumFixture.MockQuorum.MockQuorumActor[]	actors The per-client quorum actor objects.
protected com.bigdata.quorum.MockQuorumFixture.MockQuorumMember[]	clients The clients.
protected MockQuorumFixture	fixture The mock shared quorum state object.
protected int	k The service replication factor (this must be set in #setupUp()).
protected MockQuorumFixture.MockQuorum[]	quorums The per-client quorum objects.

Fields inherited from class com.bigdata.io.TestCase3

r

Fields inherited from class junit.framework.TestCase2

_randomType, log

Constructor Summary

Constructors

Constructor and Description
AbstractQuorumTestCase()
AbstractQuorumTestCase(String name)

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertCondition(Runnable cond, long timeout, TimeUnit units) Wait up to a timeout until some condition succeeds.
protected void	setUp()
protected void	tearDown()
static String	toString(Map<Long,UUID[]> votes) Helper method provides nice rendering of a votes snapshot.

Methods inherited from class com.bigdata.io.TestCase3

assertCondition, assertEquals, assertEquals, getBytes, getPort, getRandomData, getRandomData

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, toString

Methods inherited from class java.lang.Object

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

Field Detail

k

protected int k

The service replication factor (this must be set in #setupUp()).

quorums

protected MockQuorumFixture.MockQuorum[] quorums

The per-client quorum objects.

clients

protected com.bigdata.quorum.MockQuorumFixture.MockQuorumMember[] clients

The clients.

actors

protected MockQuorumFixture.MockQuorum.MockQuorumActor[] actors

The per-client quorum actor objects. The unit tests send events on the behalf of the clients using these actor objects.

fixture

protected MockQuorumFixture fixture

The mock shared quorum state object.

Constructor Detail

AbstractQuorumTestCase

public AbstractQuorumTestCase()

AbstractQuorumTestCase

public AbstractQuorumTestCase(String name)

Method Detail

setUp

protected void setUp()
              throws Exception

Overrides:

setUp in class TestCase3

Throws:

Exception

tearDown

protected void tearDown()
                 throws Exception

Overrides:

tearDown in class TestCase3

Throws:

Exception

assertCondition

public static void assertCondition(Runnable cond,
                   long timeout,
                   TimeUnit units)

Wait up to a timeout until some condition succeeds.

Whenever more than one AbstractQuorum is under test there will be concurrent indeterminism concerning the precise ordering and timing as updates propagate from the AbstractQuorum which takes some action (castVote(), pipelineAdd(), etc.) to the other quorums attached to the same MockQuorumFixture. This uncertainty about the ordering and timing state changes is not dissimilar from the uncertainty we face in a real distributed system.

While there are times when this uncertainty does not affect the behavior of the tests, there are other times when we must have a guarantee that a specific vote order or pipeline order was established. For those cases, this method may be used to await an arbitrary condition. This method simply retries until the condition becomes true, sleeping a little after each failure.

Actions executed in the main thread of the unit test will directly update the internal state of the MockQuorumFixture, which is shared across the MockQuorumFixture.MockQuorums. However, uncertainty about ordering can arise as a result of the interleaving of the actions taken by the QuorumWatchers in response to both top-level actions and actions taken by other QuorumWatchers. For example, the vote order or the pipeline order are fully determined based on sequence such as the following:

 actor0.pipelineAdd();
 actor2.pipelineAdd();
 actor1.pipelineAdd();
 

When in doubt, or when a unit test displays stochastic behavior, you can use this method to wait until the quorum state has been correctly replicated to the Quorums under test.

Parameters:

cond - The condition, which must throw an AssertionFailedError if it does not succeed.

timeout - The timeout.

unit -

Throws:

junit.framework.AssertionFailedError - if the condition does not succeed within the timeout.

toString

public static String toString(Map<Long,UUID[]> votes)

Helper method provides nice rendering of a votes snapshot.

Note: The snapshot uses a UUID[] rather than a collection for each lastCommitTime key. However, by default toString() for an array does not provide a nice rendering.

Parameters:

votes - The votes.

Returns:

The human readable representation.