Package com.atlassian.bamboo.testutils.agent

Class RemoteAgent

java.lang.Object

com.atlassian.bamboo.testutils.agent.RemoteAgent

All Implemented Interfaces:

Closeable, AutoCloseable

public class RemoteAgent
extends Object
implements Closeable

Class to start and set up remote agent. To be used in tests. Assumption is it will be created with constructor and later closed with close(). Usually one can use @see RemoteAgentRule. Alternatively it can be created in try-with-resources block or handled manually. Watch out as it does some unexpected things like removing all local agents from the server.

Constructor Summary

Constructors

Constructor	Description
RemoteAgent()
RemoteAgent(boolean tearDownLocalAgents)
RemoteAgent(BambooEnvironmentData bambooEnvironmentData)
RemoteAgent(BambooEnvironmentData bambooEnvironmentData, boolean tearDownLocalAgents, String ephemeralFor)
RemoteAgent(BambooEnvironmentData bambooEnvironmentData, boolean tearDownLocalAgents, String ephemeralFor, boolean tryToReuseAgent)

Method Summary

Modifier and Type	Method	Description
void	close()
File	getAgentExecutionDirectory()	Get remote agent installation directory
File	getAgentHomeDirectory()	Get remote agent home directory
long	getAgentId()	Get remote agent id
RemoteAgent	restartAgent()	Restarts the agent.
void	setLogsFolderName(@Nullable String logsFolderName)	Set log folder name.
RemoteAgent	startAgent()	Start remote agent if it's not started yet
RemoteAgent	stopAgent()	Stops the remote agent
RemoteAgent	updateBootstrap()	Start remote agent only for boostrap update

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteAgent

public RemoteAgent()
            throws Exception

Throws:

Exception

RemoteAgent

public RemoteAgent(boolean tearDownLocalAgents)
            throws Exception

Throws:

Exception

RemoteAgent

public RemoteAgent(BambooEnvironmentData bambooEnvironmentData)
            throws Exception

Throws:

Exception

RemoteAgent

public RemoteAgent(BambooEnvironmentData bambooEnvironmentData,
 boolean tearDownLocalAgents,
 String ephemeralFor)
            throws Exception

Throws:

Exception

RemoteAgent

public RemoteAgent(BambooEnvironmentData bambooEnvironmentData,
 boolean tearDownLocalAgents,
 String ephemeralFor,
 boolean tryToReuseAgent)
            throws Exception

Throws:

Exception

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

startAgent

public RemoteAgent startAgent()
                       throws Exception

Start remote agent if it's not started yet

Returns:

this

Throws:

Exception

updateBootstrap

public RemoteAgent updateBootstrap()
                            throws Exception

Start remote agent only for boostrap update

Returns:

this

Throws:

Exception

stopAgent

public RemoteAgent stopAgent()
                      throws Exception

Stops the remote agent

Returns:

this

Throws:

Exception

restartAgent

public RemoteAgent restartAgent()
                         throws Exception

Restarts the agent. Does not wait for the agent to fully come up.

Returns:

this

Throws:

Exception

setLogsFolderName

public void setLogsFolderName(@Nullable
 @Nullable String logsFolderName)

Set log folder name. Used only if REMOTE_AGENT_LOGS_DIRECTORY system property is not empty.

Parameters:

logsFolderName -

getAgentHomeDirectory

public File getAgentHomeDirectory()

Get remote agent home directory

getAgentExecutionDirectory

public File getAgentExecutionDirectory()

Get remote agent installation directory

getAgentId

public long getAgentId()

Get remote agent id