Package org.kaazing.k3po.junit.rules

Class K3poRule

java.lang.Object

org.junit.rules.Verifier

org.kaazing.k3po.junit.rules.K3poRule

public class K3poRule
extends org.junit.rules.Verifier

A K3poRule specifies how a Test using k3po is executed.

Constructor Summary

Constructors

Constructor	Description
K3poRule()	Allocates a new K3poRule.

Method Summary

Modifier and Type	Method	Description
K3poRule	addScriptRoot(java.lang.String shortName, java.lang.String packagePath)	Adds a named ClassPath root of where to look for scripts when resolving them.
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement statement, org.junit.runner.Description description)
void	awaitBarrier(java.lang.String barrierName)	Wait for barrier to fire.
void	finish()	Blocking call to await for the K3po threads to stop executing.
void	notifyBarrier(java.lang.String barrierName)	Notify barrier to fire.
K3poRule	scriptProperty(java.lang.String property)	Overrides a script property.
K3poRule	setControlURI(java.net.URI controlURI)	Sets the URI on which to communicate to the k3po driver.
K3poRule	setScriptRoot(java.lang.String packagePath)	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 java.lang.Object

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

Methods inherited from class org.junit.rules.Verifier

verify

Constructor Detail

K3poRule

public K3poRule()

Allocates a new K3poRule.

Method Detail

setScriptRoot

public K3poRule setScriptRoot(java.lang.String packagePath)

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

Parameters:

packagePath - is a package path used resolve relative script names

Returns:

an instance of K3poRule for convenience

addScriptRoot

public K3poRule addScriptRoot(java.lang.String shortName,
                              java.lang.String packagePath)

Adds a named ClassPath root of where to look for scripts when resolving them. Specifications should reference the short name using "${shortName}/..." in script names.

Parameters:

shortName - the short name used to refer to the package path

packagePath - a package path used resolve relative script names

Returns:

an instance of K3poRule for convenience

setControlURI

public K3poRule setControlURI(java.net.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)

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 java.lang.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:

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

awaitBarrier

public void awaitBarrier(java.lang.String barrierName)
                  throws java.lang.Exception

Wait for barrier to fire.

Parameters:

barrierName - is the name of the barrier to await

Throws:

java.lang.InterruptedException - if await is interrupted

java.lang.Exception

scriptProperty

public K3poRule scriptProperty(java.lang.String property)

Overrides a script property.

Parameters:

property - of script

Returns:

K3po rule for convenience

notifyBarrier

public void notifyBarrier(java.lang.String barrierName)
                   throws java.lang.Exception

Notify barrier to fire.

Parameters:

barrierName - is the name for the barrier to notify

Throws:

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

java.lang.Exception