org.jboss.byteman.contrib.bmunit

Class BMUnit

java.lang.Object

org.jboss.byteman.contrib.bmunit.BMUnit

public class BMUnit
extends Object

Byteman Unit test manager class which provides support for loading and unloading scripts. This version assumes loads the agent as needed (unless inhibited -- see below) using System properties to control what hostname and port it uses for the socket. Other system properties can be used to configure operation of the load/unload operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_HOST System property specifying the host to be used when starting the agent and when submitting rules to it.
static String	AGENT_INHIBIT System property which inhibits automatic loading of the agent.
static String	AGENT_POLICY System property specifying whether to set a security policy when loading the agent.
static String	AGENT_PORT System property specifying the port to be used when starting the agent and when submitting rules to it.
static String	LOAD_DIRECTORY System property which identifies the directory from which to start searching for rule script.
static String	RESOURCE_LOAD_DIRECTORY System property which identifies the resource load directory from which to start searching for rule script.
static String	VERBOSE System property which enables tracing of bmunit activity

Constructor Summary

Constructors

Constructor and Description
BMUnit()

Method Summary

Modifier and Type	Method and Description
protected static String	findScript(String dir, String... names)
protected static String	findScript(String dir, String name) Tries to find dir/name in the working directory.
static String	getHost() getter for the host name used to communicate with the agent
static boolean	getPolicy() getter for the security policy setting
static int	getPort() getter for the port used to communicate with the agent
static void	loadScriptFile(Class<?> clazz, String dir) loads a script by calling loadScriptFile(clazz, null, dir)
static void	loadScriptFile(Class<?> clazz, String testName, String dir) loads a script from the load directory using the name of a unit test as the root name for the script file and ".btm" or, failing that, ".txt" for the file extension
static void	loadScriptText(Class<?> clazz, String testname, String scriptText) loads a script supplied as a text String rather than via a file on disk
static void	unloadScriptFile(Class<?> clazz, String testName) loads a script from the load directory using the name of a unit test as the root name for the script file and ".btm" or, failing that, ".txt" for the file extension
static void	unloadScriptText(Class<?> clazz, String testName) unloads a script previously supplied as a text String

Methods inherited from class java.lang.Object

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

Field Detail

LOAD_DIRECTORY

public static final String LOAD_DIRECTORY

System property which identifies the directory from which to start searching for rule script. If unset the current working directory of the test is used.

See Also:

Constant Field Values

RESOURCE_LOAD_DIRECTORY

public static final String RESOURCE_LOAD_DIRECTORY

System property which identifies the resource load directory from which to start searching for rule script.

See Also:

Constant Field Values

AGENT_PORT

public static final String AGENT_PORT

System property specifying the port to be used when starting the agent and when submitting rules to it. You can normally just use the default port.

See Also:

Constant Field Values

AGENT_HOST

public static final String AGENT_HOST

System property specifying the host to be used when starting the agent and when submitting rules to it. You can normally just use the default host.

See Also:

Constant Field Values

AGENT_POLICY

public static final String AGENT_POLICY

System property specifying whether to set a security policy when loading the agent.

See Also:

Constant Field Values

AGENT_INHIBIT

public static final String AGENT_INHIBIT

System property which inhibits automatic loading of the agent. If you set this then you have to load the agent yourself using the Install API or ensure JUnit loads by forking a JVM and passing the necessary -javaagent options on the command line. You may also want to set this if you you have loaded the agent into a remote service in another JVM driven by your unit test.

See Also:

Constant Field Values

VERBOSE

public static final String VERBOSE

System property which enables tracing of bmunit activity

See Also:

Constant Field Values

Constructor Detail

BMUnit

public BMUnit()

Method Detail

getHost

public static String getHost()

getter for the host name used to communicate with the agent

getPort

public static int getPort()

getter for the port used to communicate with the agent

getPolicy

public static boolean getPolicy()

getter for the security policy setting

loadScriptFile

public static void loadScriptFile(Class<?> clazz,
                                  String dir)
                           throws Exception

loads a script by calling loadScriptFile(clazz, null, dir)

Parameters:

clazz - the test class

dir - the directory to load the script from

Throws:

Exception

loadScriptFile

public static void loadScriptFile(Class<?> clazz,
                                  String testName,
                                  String dir)
                           throws Exception

loads a script from the load directory using the name of a unit test as the root name for the script file and ".btm" or, failing that, ".txt" for the file extension

Parameters:

clazz - the classname of the unit test

testName - the name of the unit test method

dir - the directory in which the scripts are located

Throws:

Exception

unloadScriptFile

public static void unloadScriptFile(Class<?> clazz,
                                    String testName)
                             throws Exception

loads a script from the load directory using the name of a unit test as the root name for the script file and ".btm" or, failing that, ".txt" for the file extension

Parameters:

clazz - the test class

testName - the test name

Throws:

Exception

loadScriptText

public static void loadScriptText(Class<?> clazz,
                                  String testname,
                                  String scriptText)
                           throws Exception

loads a script supplied as a text String rather than via a file on disk

Parameters:

clazz - the test class

testname - the test name

scriptText - the text of the rule or rules contained in the script

Throws:

Exception

unloadScriptText

public static void unloadScriptText(Class<?> clazz,
                                    String testName)
                             throws Exception

unloads a script previously supplied as a text String

Parameters:

clazz - the test class

testName - the test name

Throws:

Exception

findScript

protected static String findScript(String dir,
                                   String name)

Tries to find dir/name in the working directory. If not found, tries to add the ".btm", then ".txt" suffixes. If still not found, tries to find the above on the classpath

Parameters:

dir - The name of the directory

name - The file name

Returns:

The fully qualified name of the file, or null if not found

findScript

protected static String findScript(String dir,
                                   String... names)