org.kaazing.k3po.junit.rules

Class K3poRule

java.lang.Object

org.junit.rules.Verifier

org.kaazing.k3po.junit.rules.K3poRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class K3poRule
extends org.junit.rules.Verifier

A K3poRule specifies how a Test using k3po is executed.

Constructor Summary

Constructors

Constructor and Description
K3poRule() Allocates a new K3poRule.

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement statement, org.junit.runner.Description description)
void	awaitBarrier(String barrierName) Wait for barrier to fire.
void	finish() Blocking call to await for the K3po threads to stop executing.
void	notifyBarrier(String barrierName) Notify barrier to fire.
K3poRule	scriptProperty(String property) Overrides a script property.
K3poRule	setControlURI(URI controlURI) Sets the URI on which to communicate to the k3po driver.
K3poRule	setScriptRoot(String scriptRoot) Sets the ClassPath root of where to look for scripts when resolving them.
void	start() Starts the connects in the robot scripts.

Methods inherited from class org.junit.rules.Verifier

verify

Methods inherited from class java.lang.Object

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

Constructor Detail

K3poRule

public K3poRule()

Allocates a new K3poRule.

Method Detail

setScriptRoot

public K3poRule setScriptRoot(String scriptRoot)

Sets the ClassPath root of where to look for scripts when resolving them.

Parameters:

scriptRoot - is a directory/package name of where to resolve scripts from.

Returns:

an instance of K3poRule for convenience

setControlURI

public K3poRule setControlURI(URI controlURI)

Sets the URI on which to communicate to the k3po driver.

Parameters:

controlURI - the URI on which to connect

Returns:

an instance of K3poRule for convenience

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement statement,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

Overrides:

apply in class org.junit.rules.Verifier

start

public void start()

Starts the connects in the robot scripts. The accepts are implicitly started just prior to the test logic in the Specification.

finish

public void finish()
            throws Exception

Blocking call to await for the K3po threads to stop executing. If the connects have not already been initiated via the start() method, they will be implicitly called.

Throws:

Exception - if an error has occurred in the execution of the tests.

awaitBarrier

public void awaitBarrier(String barrierName)
                  throws InterruptedException

Wait for barrier to fire.

Parameters:

barrierName - is the name of the barrier to await

Throws:

InterruptedException - if await is interrupted

scriptProperty

public K3poRule scriptProperty(String property)

Overrides a script property.

Parameters:

property - of script

Returns:

K3po rule for convenience

notifyBarrier

public void notifyBarrier(String barrierName)
                   throws InterruptedException

Notify barrier to fire.

Parameters:

barrierName - is the name for the barrier to notify

Throws:

InterruptedException - if notify is interrupted (note: waits for confirm that is notified)