RobotTestBed (Robocode 1.11.2 API)

java.lang.Object
- robocode.control.events.BattleAdaptor
- - robocode.control.RobotTestBed<R>

All Implemented Interfaces:

IBattleListener
```
public abstract class RobotTestBed<R extends IBasicRobot>
extends BattleAdaptor
```
RobotTestBed provides a superclass that can be extended in order to implement JUnit tests for Robocode robots.
The user must set the system property robocode.home to the location of the robocode installation, otherwise we cannot set up the Robocode engine. If robocode.home is not a system property, we throw a RuntimeException.

Author:

Philip Johnson (original), Pavel Savara (contributor), Flemming N. Larsen (contributor)

Field Summary

Fields
Modifier and Type	Field and Description
`protected BattlefieldSpecification`	`battleFieldSpec` The battlefield specification, which is the default.
`protected static IRobocodeEngine`	`engine` The Robocode game engine instance used for this test.
`protected robocode.control.RobotTestBed.EngineErrorsListener`	`engineErrorsListener`
`protected int`	`errors` The number of errors generated during this battle so far.
`protected StringBuilder`	`errorText`
`protected Throwable`	`lastError`
`protected int`	`messages` The number of messages generated during this battle so far.
`protected R`	`robotObject` Instance of tested robot
`protected static String`	`robotsPath`
`protected robocode.control.RobotTestBed.TestErrorListener`	`testErrorListener`

Constructor Summary

Constructors
Constructor and Description

RobotTestBed()

Constructors
Constructor and Description
`RobotTestBed()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`after()`
`protected void`	`afterInit()` Called after the engine is initialized to perform additional setup.
`protected void`	`before()` The setup method run before each test, which sets up the listener on the engine for testing.
`protected void`	`beforeInit()`
`static void`	`cleanup()` Releases any resources used by this test bed.
`String`	`getEnemyName()` Must return a fully qualified enemy robot name to be in this battle.
`protected int`	`getExpectedErrors()`
`int`	`getExpectedRobotCount(String robotList)` Provides the number of robots in this battle.
`String`	`getInitialPositions()` Returns a comma or space separated list like: x1,y1,heading1, x2,y2,heading2, which are the coordinates and heading of robot #1 and #2.
`int`	`getNumRounds()` Provides the number of rounds in this battle.
`abstract String`	`getRobotName()` Must return a fully qualified robot name to be in this battle.
`boolean`	`isDeterministic()` Defaults to true, indicating that the battle is deterministic and robots will always start in the same position each time.
`static boolean`	`isDumpingErrors()` Gets whether error messages should be printed out.
`static boolean`	`isDumpingMessages()` Gets whether robot messages should be printed out.
`static boolean`	`isDumpingOutput()` Gets whether robot output should be printed out.
`static boolean`	`isDumpingPositions()` Gets whether robot positions should be printed during each turn.
`static boolean`	`isDumpingTurns()` Gets whether each turn should be printed out.
`boolean`	`isEnableRecording()`
`boolean`	`isEnableScreenshots()`
`protected void`	`run()`
`protected void`	`run(String enemyName)`
`protected void`	`run(String robotName, String enemyName)`
`protected void`	`runBattle(String robotList, int numRounds, String initialPositions)`
`protected void`	`runSetup()`
`protected void`	`runTeardown()`
`static void`	`setDumpingErrors(boolean dumpingErrors)` Sets whether error messages should be printed out.
`static void`	`setDumpingMessages(boolean dumpingMessages)` Sets whether robot messages should be printed out.
`static void`	`setDumpingOutput(boolean dumpingOutput)` Sets whether robot output should be printed out.
`static void`	`setDumpingPositions(boolean dumpingPositions)` Sets whether robot positions should be printed during each turn.
`static void`	`setDumpingTurns(boolean dumpingTurns)` Sets whether each turn should be printed out.
`static void`	`setErrorDumping(boolean value)` Thread-safe method to modify the error dumping flag.
`static void`	`setMessageDumping(boolean value)` Thread-safe method to modify the message dumping flag.
`static void`	`setOutputDumping(boolean value)` Thread-safe method to modify the output dumping flag.
`static void`	`setPositionDumping(boolean value)` Thread-safe method to modify the position dumping flag.
`static void`	`setTurnDumping(boolean value)` Thread-safe method to modify the turn dumping flag.

Methods inherited from class robocode.control.events.BattleAdaptor
onBattleCompleted, onBattleError, onBattleFinished, onBattleMessage, onBattlePaused, onBattleResumed, onBattleStarted, onRoundEnded, onRoundStarted, onTurnEnded, onTurnStarted

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - engine
```
protected static volatile IRobocodeEngine engine
```
    The Robocode game engine instance used for this test.
  - battleFieldSpec
```
protected final BattlefieldSpecification battleFieldSpec
```
    The battlefield specification, which is the default.
  - errors
```
protected int errors
```
    The number of errors generated during this battle so far.
  - errorText
```
protected StringBuilder errorText
```
  - lastError
```
protected Throwable lastError
```
  - engineErrorsListener
```
protected robocode.control.RobotTestBed.EngineErrorsListener engineErrorsListener
```
  - testErrorListener
```
protected robocode.control.RobotTestBed.TestErrorListener testErrorListener
```
  - messages
```
protected int messages
```
    The number of messages generated during this battle so far.
  - robotsPath
```
protected static volatile String robotsPath
```
  - robotObject
```
protected R extends IBasicRobot robotObject
```
    Instance of tested robot
- Constructor Detail
  - RobotTestBed
```
public RobotTestBed()
```
- Method Detail
  - setPositionDumping
```
public static void setPositionDumping(boolean value)
```
    Thread-safe method to modify the position dumping flag. Use this instead of directly modifying the isDumpingPositions field.
    
    Parameters:
    
    value - The new value for the flag
  - setTurnDumping
```
public static void setTurnDumping(boolean value)
```
    Thread-safe method to modify the turn dumping flag. Use this instead of directly modifying the isDumpingTurns field.
    
    Parameters:
    
    value - The new value for the flag
  - setOutputDumping
```
public static void setOutputDumping(boolean value)
```
    Thread-safe method to modify the output dumping flag. Use this instead of directly modifying the isDumpingOutput field.
    
    Parameters:
    
    value - The new value for the flag
  - setErrorDumping
```
public static void setErrorDumping(boolean value)
```
    Thread-safe method to modify the error dumping flag. Use this instead of directly modifying the isDumpingErrors field.
    
    Parameters:
    
    value - The new value for the flag
  - setMessageDumping
```
public static void setMessageDumping(boolean value)
```
    Thread-safe method to modify the message dumping flag. Use this instead of directly modifying the isDumpingMessages field.
    
    Parameters:
    
    value - The new value for the flag
  - isDumpingPositions
```
public static boolean isDumpingPositions()
```
    Gets whether robot positions should be printed during each turn.
    
    Returns:
    
    true if position dumping is enabled
  - setDumpingPositions
```
public static void setDumpingPositions(boolean dumpingPositions)
```
    Sets whether robot positions should be printed during each turn.
    
    Parameters:
    
    dumpingPositions - true to enable position dumping
  - isDumpingTurns
```
public static boolean isDumpingTurns()
```
    Gets whether each turn should be printed out.
    
    Returns:
    
    true if turn dumping is enabled
  - setDumpingTurns
```
public static void setDumpingTurns(boolean dumpingTurns)
```
    Sets whether each turn should be printed out.
    
    Parameters:
    
    dumpingTurns - true to enable turn dumping
  - isDumpingOutput
```
public static boolean isDumpingOutput()
```
    Gets whether robot output should be printed out.
    
    Returns:
    
    true if output dumping is enabled
  - setDumpingOutput
```
public static void setDumpingOutput(boolean dumpingOutput)
```
    Sets whether robot output should be printed out.
    
    Parameters:
    
    dumpingOutput - true to enable output dumping
  - isDumpingErrors
```
public static boolean isDumpingErrors()
```
    Gets whether error messages should be printed out.
    
    Returns:
    
    true if error dumping is enabled
  - setDumpingErrors
```
public static void setDumpingErrors(boolean dumpingErrors)
```
    Sets whether error messages should be printed out.
    
    Parameters:
    
    dumpingErrors - true to enable error dumping
  - isDumpingMessages
```
public static boolean isDumpingMessages()
```
    Gets whether robot messages should be printed out.
    
    Returns:
    
    true if message dumping is enabled
  - setDumpingMessages
```
public static void setDumpingMessages(boolean dumpingMessages)
```
    Sets whether robot messages should be printed out.
    
    Parameters:
    
    dumpingMessages - true to enable message dumping
  - getRobotName
```
public abstract String getRobotName()
```
    Must return a fully qualified robot name to be in this battle.
    You must override this event to specify the robot to battle in this test case.
    
    Returns:
    
    robot name.
  - getEnemyName
```
public String getEnemyName()
```
    Must return a fully qualified enemy robot name to be in this battle.
    You must override this event to specify the robot to battle in this test case.
    
    Returns:
    
    robot name.
  - getNumRounds
```
public int getNumRounds()
```
    Provides the number of rounds in this battle. Defaults to 1. Override this to change the number of rounds.
    
    Returns:
    
    The number of rounds.
  - getInitialPositions
```
public String getInitialPositions()
```
    Returns a comma or space separated list like: x1,y1,heading1, x2,y2,heading2, which are the coordinates and heading of robot #1 and #2. So "0,0,180, 50,80,270" means that robot #1 has position (0,0) and heading 180, and robot #2 has position (50,80) and heading 270.
    Override this method to explicitly specify the initial positions.
    Defaults to null, which means that the initial positions are determined randomly. Since battles are deterministic by default, the initial positions are randomly chosen but will always be the same each time you run the test case.
    
    Returns:
    
    The list of initial positions.
  - getExpectedRobotCount
```
public int getExpectedRobotCount(String robotList)
```
    Provides the number of robots in this battle.
    
    Parameters:
    
    robotList - The list of robots.
    
    Returns:
    
    The number of robots in this battle.
  - isDeterministic
```
public boolean isDeterministic()
```
    Defaults to true, indicating that the battle is deterministic and robots will always start in the same position each time.
    Override to support random initialization.
    
    Returns:
    
    True if the battle will be deterministic.
  - isEnableRecording
```
public boolean isEnableRecording()
```
  - isEnableScreenshots
```
public boolean isEnableScreenshots()
```
  - beforeInit
```
protected void beforeInit()
```
  - afterInit
```
protected void afterInit()
```
    Called after the engine is initialized to perform additional setup. Use this method to configure engine properties after initialization.
  - before
```
protected void before()
```
    The setup method run before each test, which sets up the listener on the engine for testing. Don't override this method; instead, override runSetup to add behavior before the test battle starts.
  - after
```
protected void after()
```
  - cleanup
```
public static void cleanup()
```
    Releases any resources used by this test bed.
    This method should be called when the test framework is being shut down to ensure proper cleanup of resources. It will close the Robocode engine and release all associated resources.
    It is recommended to call this method in a finally block or shutdown hook to ensure resources are properly released even if tests fail.
  - run
```
protected void run(String robotName,
                   String enemyName)
```
  - run
```
protected void run(String enemyName)
```
  - run
```
protected void run()
```
  - getExpectedErrors
```
protected int getExpectedErrors()
```
  - runSetup
```
protected void runSetup()
```
  - runTeardown
```
protected void runTeardown()
```
  - runBattle
```
protected void runBattle(String robotList,
                         int numRounds,
                         String initialPositions)
```

Class RobotTestBed<R extends IBasicRobot>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class robocode.control.events.BattleAdaptor

Methods inherited from class java.lang.Object

Field Detail

engine

battleFieldSpec

errors

errorText

lastError

engineErrorsListener

testErrorListener

messages

robotsPath

robotObject

Constructor Detail

RobotTestBed

Method Detail

setPositionDumping

setTurnDumping

setOutputDumping

setErrorDumping

setMessageDumping

isDumpingPositions

setDumpingPositions

isDumpingTurns

setDumpingTurns

isDumpingOutput

setDumpingOutput

isDumpingErrors

setDumpingErrors

isDumpingMessages

setDumpingMessages

getRobotName

getEnemyName

getNumRounds

getInitialPositions

getExpectedRobotCount

isDeterministic

isEnableRecording

isEnableScreenshots

beforeInit

afterInit

before

after

cleanup

run

run

run

getExpectedErrors

runSetup

runTeardown

runBattle