Package org.jvnet.hudson.test

Class InboundAgentRule

java.lang.Object

org.junit.rules.ExternalResource

org.jvnet.hudson.test.InboundAgentRule

All Implemented Interfaces:

org.junit.rules.TestRule

public final class InboundAgentRule
extends org.junit.rules.ExternalResource

Manages inbound agents. While these run on the local host, they are launched outside of Jenkins.

To avoid flakiness when tearing down the test, ensure that the agent has gone offline with:

 Slave agent = inboundAgents.createAgent(r, […]);
 try {
     […]
 } finally {
     inboundAgents.stop(r, agent.getNodeName());
 }
 

See Also:

• JenkinsRule.createComputerLauncher(hudson.EnvVars)
• JenkinsRule.createSlave()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	InboundAgentRule.AgentArguments
static final class	InboundAgentRule.Options	The options used to (re)start an inbound agent.

Constructor Summary

Constructors

Constructor	Description
InboundAgentRule()

Method Summary

Modifier and Type	Method	Description
protected void	after()
hudson.model.Slave	createAgent(JenkinsRule r, String name)	Creates, attaches, and starts a new inbound agent.
hudson.model.Slave	createAgent(JenkinsRule r, InboundAgentRule.Options options)	Creates, attaches, and optionally starts a new inbound agent.
void	createAgent(RealJenkinsRule rr, String name)
void	createAgent(RealJenkinsRule rr, InboundAgentRule.Options options)
boolean	isAlive(String name)	Checks whether an existing inbound agent process is currently running.
void	start(InboundAgentRule.AgentArguments agentArguments, InboundAgentRule.Options options)
void	start(JenkinsRule r, String name)	(Re-)starts an existing inbound agent.
void	start(JenkinsRule r, InboundAgentRule.Options options)	(Re-)starts an existing inbound agent.
void	start(RealJenkinsRule r, InboundAgentRule.Options options)	(Re-)starts an existing inbound agent.
void	stop(String name)	Stops an existing inbound agent.
void	stop(JenkinsRule r, String name)	Stop an existing inbound agent and wait for it to go offline.
void	stop(RealJenkinsRule rjr, String name)	Stop an existing inbound agent and wait for it to go offline.

Methods inherited from class org.junit.rules.ExternalResource

apply, before

Methods inherited from class java.lang.Object

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

Constructor Details

InboundAgentRule

public InboundAgentRule()

Method Details

createAgent

public hudson.model.Slave createAgent(@NonNull
 JenkinsRule r,
 @CheckForNull
 String name)
                               throws Exception

Creates, attaches, and starts a new inbound agent.

Parameters:

name - an optional Slave.getNodeName()

Throws:

Exception

createAgent

public hudson.model.Slave createAgent(@NonNull
 JenkinsRule r,
 InboundAgentRule.Options options)
                               throws Exception

Creates, attaches, and optionally starts a new inbound agent.

Parameters:

options - the options

Throws:

Exception

createAgent

public void createAgent(@NonNull
 RealJenkinsRule rr,
 @CheckForNull
 String name)
                 throws Throwable

Throws:

Throwable

createAgent

public void createAgent(@NonNull
 RealJenkinsRule rr,
 InboundAgentRule.Options options)
                 throws Throwable

Throws:

Throwable

start

public void start(@NonNull
 JenkinsRule r,
 @NonNull
 String name)
           throws Exception

(Re-)starts an existing inbound agent.

Throws:

Exception

start

public void start(@NonNull
 JenkinsRule r,
 InboundAgentRule.Options options)
           throws Exception

(Re-)starts an existing inbound agent.

Throws:

Exception

start

public void start(@NonNull
 RealJenkinsRule r,
 InboundAgentRule.Options options)
           throws Throwable

(Re-)starts an existing inbound agent.

Throws:

Throwable

start

public void start(InboundAgentRule.AgentArguments agentArguments,
 InboundAgentRule.Options options)
           throws Exception

Throws:

Exception

stop

public void stop(@NonNull
 JenkinsRule r,
 @NonNull
 String name)
          throws InterruptedException

Stop an existing inbound agent and wait for it to go offline.

Throws:

InterruptedException

stop

public void stop(@NonNull
 RealJenkinsRule rjr,
 @NonNull
 String name)
          throws Throwable

Stop an existing inbound agent and wait for it to go offline.

Throws:

Throwable

stop

public void stop(@NonNull
 String name)
          throws InterruptedException

Stops an existing inbound agent. You need only call this to simulate an agent crash, followed by start(org.jvnet.hudson.test.JenkinsRule, java.lang.String).

Throws:

InterruptedException

isAlive

public boolean isAlive(String name)

Checks whether an existing inbound agent process is currently running. (This is distinct from whether Jenkins considers the computer to be connected.)

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource