TestAgent (UnetStack 3.4.0 API)

org.arl.unet.TestAgent

Base agent for developing functional tests.
Tests are defined in the tests() method that subclasses should implement. Individual tests are defined using the test() method, and test groups are defined using the group() method.
Tests that return null or true are displayed as PASS. Tests that return false are considered as FAIL. Tests that return other values are considered to have passed, and the string value is included in the report. If a test has assertions that fail or exceptions that are thrown, the test is considered to have failed and details are logged in the log file. All test report entries in the log file are marked as [TEST] for ease of search.

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`auto`	Run test automatically on startup, and kill agent on completion.
`protected boolean`	`pass`

Inherited fields
Fields inherited from class	Fields
`class UnetAgent`	`timeout`

Properties Summary

Properties
Type	Name and description
`int`	`duration` Total duration (in seconds) for periodic tests (0 = run for ever).
`int`	`period` Period (in seconds) for periodic tests (0 = aperiodic).

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getDescription()` Gets help information on using the test.
	`int`	`getIterations()` Stops periodic tests.
	`String`	`getReport()` Gets the last test report.
	`String`	`getRun()` Runs the test once.
	`String`	`getStart()` Starts the test periodically.
	`String`	`getStop()` Stops periodic tests.
	`protected void`	`group(String name, Closure cl)` Define a group of tests.
	`void`	`setup()`
	`void`	`startup()`
	`protected void`	`test(String name, String value)` Define a test.
	`protected void`	`test(String name, Closure cl, int mustPass = 1, int outOf = 1)` Define a test.
	`protected void`	`tests()` Defines the tests to run.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class UnetAgent`	`addCapability, allOf, deregister, deregister, die, get, get, getBuildInfo, getLogLevel, getParam, getParameterClasses, getParameterClasses, getParameterList, getParameterList, getServices, getTitle, getVersion, init, isReadOnly, longValue, processMessage, processQuery, processRequest, register, register, set, set, setLogLevel, setParam, setup, shutdown, startup, subscribeForService, subscribeForService, trace, trace, trace, unsubscribeForService, unsubscribeForService`

- Field Detail
  - protected boolean auto
    
    Run test automatically on startup, and kill agent on completion. A test agent that is designed to run a test once and quit may set this to true during startup().
  - protected boolean pass
- Property Detail
  - int duration
    
    Total duration (in seconds) for periodic tests (0 = run for ever).
  - int period
    
    Period (in seconds) for periodic tests (0 = aperiodic).
- Method Detail
  - String getDescription()
    
    Gets help information on using the test.
  - int getIterations()
    
    Stops periodic tests.
  - String getReport()
    
    Gets the last test report.
  - String getRun()
    
    Runs the test once.
  - String getStart()
    
    Starts the test periodically.
  - String getStop()
    
    Stops periodic tests.
  - protected void group(String name, Closure cl)
    
    Define a group of tests.
    Parameters:
    name - name of the test group
    cl - closure that will run all the tests in the group
  - @Override void setup()
  - @Override void startup()
  - protected void test(String name, String value)
    
    Define a test.
    Parameters:
    name - name of the test
    value - value to display
  - protected void test(String name, Closure cl, int mustPass = 1, int outOf = 1)
    
    Define a test.
    Parameters:
    name - name of the test
    cl - closure that runs the test
    mustPass - minimum number of times the test should pass
    outOf - maxmimum number of times the test should be run
  - protected void tests()
    
    Defines the tests to run. This method should be overridden by subclasses to provide the body of the test.

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Groovy] Class TestAgent

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected boolean auto

protected boolean pass

Property Detail

int duration

int period

Method Detail

String getDescription()

int getIterations()

String getReport()

String getRun()

String getStart()

String getStop()

protected void group(String name, Closure cl)

@Override void setup()

@Override void startup()

protected void test(String name, String value)

protected void test(String name, Closure cl, int mustPass = 1, int outOf = 1)

protected void tests()