rice.p2p.commonapi.testing
Class CommonAPITest

java.lang.Object
  rice.p2p.commonapi.testing.CommonAPITest

Direct Known Subclasses:

PastRegrTest, RawPastRegrTest, RawScribeRegrTest, ReplicationManagerRegrTest, ReplicationRegrTest, ScribeRegrTest, SplitStreamRegrTest

public abstract class CommonAPITest

extends java.lang.Object

Provides regression testing setup for applications written on top of the commonapi. Currently is written to use Pastry nodes, but this will be abstracted away.

Version:

$Id: CommonAPITest.java 3274 2006-05-15 16:17:47Z jeffh $

Author:

Alan Mislove

Field Summary

java.net.InetSocketAddress	BOOTSTRAP DESCRIBE THE FIELD
static int	BOOTSTRAP_PORT DESCRIBE THE FIELD
protected Environment	environment DESCRIBE THE FIELD
protected PastryNodeFactory	factory DESCRIBE THE FIELD
IdFactory	FACTORY DESCRIBE THE FIELD
static java.lang.String	FAILURE DESCRIBE THE FIELD
protected NodeIdFactory	idFactory DESCRIBE THE FIELD
static java.lang.String	INSTANCE_NAME DESCRIBE THE FIELD
protected Logger	logger DESCRIBE THE FIELD
protected Node[]	nodes DESCRIBE THE FIELD
int	NUM_NODES DESCRIBE THE FIELD
protected static int	PAD_SIZE DESCRIBE THE FIELD
protected Parameters	params DESCRIBE THE FIELD
int	PORT DESCRIBE THE FIELD
java.lang.String	PROTOCOL DESCRIBE THE FIELD
static java.lang.String	PROTOCOL_DIRECT DESCRIBE THE FIELD
protected NetworkSimulator	simulator DESCRIBE THE FIELD
java.lang.String	SIMULATOR DESCRIBE THE FIELD
static java.lang.String	SIMULATOR_EUCLIDEAN DESCRIBE THE FIELD
static java.lang.String	SIMULATOR_GT_ITM DESCRIBE THE FIELD
static java.lang.String	SIMULATOR_SPHERE DESCRIBE THE FIELD
static java.lang.String	SUCCESS DESCRIBE THE FIELD

Constructor Summary

CommonAPITest(Environment env)
Constructor, which takes no arguments and sets up the factories in preparation for node creation.

Method Summary

protected void	assertEquals(java.lang.String description, java.lang.Object expected, java.lang.Object actual) Thows an exception if expected is not equal to actual.
protected void	assertTrue(java.lang.String intention, boolean test) Throws an exception if the test condition is not met.
protected Node	createNode(int num) Method which creates a single node, given it's node number
void	createNodes() Method which creates the nodes
protected NodeHandle	getBootstrap() Gets a handle to a bootstrap node.
protected void	kill(int n) Method which kills the specified node
protected static Environment	parseArgs(java.lang.String[] args) process command line args
protected void	pause(int ms) Method which pauses for the provided number of milliseconds
protected abstract void	processNode(int num, Node node) Method which should process the given newly-created node
protected abstract void	runTest() Method which should run the test - this is called once all of the nodes have been created and are ready.
protected void	sectionDone() Method which prints the end of a test section.
protected void	sectionStart(java.lang.String name) Method which prints the beginning of a test section.
protected void	simulate() In case we're using the direct simulator, this method simulates the message passing.
void	start() Method which starts the creation of nodes
protected void	stepDone() Method which prints the end of a test section step, with an assumed success.
protected void	stepDone(java.lang.String status) Method which prints the end of a test section step.
protected void	stepDone(java.lang.String status, java.lang.String message) Method which prints the end of a test section step, as well as a message.
protected void	stepException(java.lang.Exception e) Method which prints an exception which occured during testing.
protected void	stepStart(java.lang.String name) Method which prints the beginning of a test section step.

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected Node[] nodes

DESCRIBE THE FIELD

factory

protected PastryNodeFactory factory

DESCRIBE THE FIELD

idFactory

protected NodeIdFactory idFactory

DESCRIBE THE FIELD

simulator

protected NetworkSimulator simulator

DESCRIBE THE FIELD

environment

protected Environment environment

DESCRIBE THE FIELD

params

protected Parameters params

DESCRIBE THE FIELD

NUM_NODES

public int NUM_NODES

DESCRIBE THE FIELD

FACTORY

public final IdFactory FACTORY

DESCRIBE THE FIELD

PORT

public int PORT

DESCRIBE THE FIELD

BOOTSTRAP

public java.net.InetSocketAddress BOOTSTRAP

DESCRIBE THE FIELD

PROTOCOL

public java.lang.String PROTOCOL

DESCRIBE THE FIELD

SIMULATOR

public java.lang.String SIMULATOR

DESCRIBE THE FIELD

logger

protected Logger logger

DESCRIBE THE FIELD

SUCCESS

public static final java.lang.String SUCCESS

DESCRIBE THE FIELD

See Also:

Constant Field Values

FAILURE

public static final java.lang.String FAILURE

DESCRIBE THE FIELD

See Also:

Constant Field Values

PAD_SIZE

protected static final int PAD_SIZE

DESCRIBE THE FIELD

See Also:

Constant Field Values

PROTOCOL_DIRECT

public static final java.lang.String PROTOCOL_DIRECT

DESCRIBE THE FIELD

See Also:

Constant Field Values

SIMULATOR_SPHERE

public static final java.lang.String SIMULATOR_SPHERE

DESCRIBE THE FIELD

See Also:

Constant Field Values

SIMULATOR_EUCLIDEAN

public static final java.lang.String SIMULATOR_EUCLIDEAN

DESCRIBE THE FIELD

See Also:

Constant Field Values

SIMULATOR_GT_ITM

public static final java.lang.String SIMULATOR_GT_ITM

DESCRIBE THE FIELD

See Also:

Constant Field Values

BOOTSTRAP_PORT

public static int BOOTSTRAP_PORT

DESCRIBE THE FIELD

INSTANCE_NAME

public static java.lang.String INSTANCE_NAME

DESCRIBE THE FIELD

Constructor Detail

CommonAPITest

public CommonAPITest(Environment env)
              throws java.io.IOException

Constructor, which takes no arguments and sets up the factories in preparation for node creation.

Parameters:

env - DESCRIBE THE PARAMETER

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION

Method Detail

getBootstrap

protected NodeHandle getBootstrap()

Gets a handle to a bootstrap node.

Returns:

handle to bootstrap node, or null.

createNodes

public void createNodes()

Method which creates the nodes

start

public void start()

Method which starts the creation of nodes

simulate

protected void simulate()

In case we're using the direct simulator, this method simulates the message passing.

createNode

protected Node createNode(int num)

Method which creates a single node, given it's node number

Parameters:

num - The number of creation order

Returns:

The created node

pause

protected void pause(int ms)

Method which pauses for the provided number of milliseconds

Parameters:

ms - The number of milliseconds to pause

kill

protected void kill(int n)

Method which kills the specified node

Parameters:

n - The node to kill

processNode

protected abstract void processNode(int num,
                                    Node node)

Method which should process the given newly-created node

Parameters:

num - The number o the node

node - The newly created node

runTest

protected abstract void runTest()

Method which should run the test - this is called once all of the nodes have been created and are ready.

sectionStart

protected final void sectionStart(java.lang.String name)

Method which prints the beginning of a test section.

Parameters:

name - The name of section

sectionDone

protected final void sectionDone()

Method which prints the end of a test section.

stepStart

protected final void stepStart(java.lang.String name)

Method which prints the beginning of a test section step.

Parameters:

name - The name of step

stepDone

protected final void stepDone()

Method which prints the end of a test section step, with an assumed success.

stepDone

protected final void stepDone(java.lang.String status)

Method which prints the end of a test section step.

Parameters:

status - The status of step

stepDone

protected final void stepDone(java.lang.String status,
                              java.lang.String message)

Method which prints the end of a test section step, as well as a message.

Parameters:

status - The status of section

message - The message

stepException

protected final void stepException(java.lang.Exception e)

Method which prints an exception which occured during testing.

Parameters:

e - The exception which was thrown

assertTrue

protected final void assertTrue(java.lang.String intention,
                                boolean test)

Throws an exception if the test condition is not met.

Parameters:

intention - DESCRIBE THE PARAMETER

test - DESCRIBE THE PARAMETER

assertEquals

protected final void assertEquals(java.lang.String description,
                                  java.lang.Object expected,
                                  java.lang.Object actual)

Thows an exception if expected is not equal to actual.

Parameters:

description - DESCRIBE THE PARAMETER

expected - DESCRIBE THE PARAMETER

actual - DESCRIBE THE PARAMETER

parseArgs

protected static Environment parseArgs(java.lang.String[] args)
                                throws java.io.IOException

process command line args

Parameters:

args - DESCRIBE THE PARAMETER

Returns:

DESCRIBE THE RETURN VALUE

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION