Package org.jvnet.hudson.test.fixtures

Class InboundAgentFixture

java.lang.Object

org.jvnet.hudson.test.fixtures.InboundAgentFixture

public class InboundAgentFixture
extends Object

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

 private static final InboundAgentFixture FIXTURE = InboundAgentFixture.newBuilder().build();

 public void method() {
     try {
         Slave agent = FIXTURE.createAgent(r, […]);
         […]
     } finally {
         FIXTURE.tearDown();
     }
 }
 

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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InboundAgentFixture.AgentArguments	Argument for an Agent.
static class	InboundAgentFixture.Options<O extends InboundAgentFixture.Options>	The options used to (re)start an inbound agent.

Constructor Summary

Constructors

Constructor	Description
InboundAgentFixture()

Method Summary

Modifier and Type	Method	Description
hudson.model.Slave	createAgent(JenkinsRule r, String name)	Creates, attaches, and starts a new inbound agent.
hudson.model.Slave	createAgent(JenkinsRule r, InboundAgentFixture.Options options)	Creates, attaches, and optionally starts a new inbound agent.
static String[]	createAgentRJR(JenkinsRule r, InboundAgentFixture.Options options)
static InboundAgentFixture.AgentArguments	getAgentArguments(JenkinsRule r, String name)
Set<File>	getJars()
Set<String>	getWorkDirs()
boolean	isAlive(String name)	Checks whether an existing inbound agent process is currently running.
void	start(InboundAgentFixture.AgentArguments agentArguments, InboundAgentFixture.Options options)
void	start(InboundAgentFixture.AgentArguments agentArguments, InboundAgentFixture.Options options, boolean stop)
void	start(JenkinsRule r, String name)	(Re-)starts an existing inbound agent.
void	start(JenkinsRule r, InboundAgentFixture.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	tearDown()
static void	waitForAgentOffline(JenkinsRule r, String name)
static void	waitForAgentOnline(JenkinsRule r, String name, Map<String,Level> loggers)

Methods inherited from class java.lang.Object

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

Constructor Details

InboundAgentFixture

public InboundAgentFixture()

Method Details

getWorkDirs

public Set<String> getWorkDirs()

getJars

public Set<File> getJars()

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,
 InboundAgentFixture.Options options)
                               throws Exception

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

Parameters:

options - the options

Throws:

Exception

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,
 InboundAgentFixture.Options options)
           throws Exception

(Re-)starts an existing inbound agent.

Throws:

Exception

start

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

Throws:

Exception

start

public void start(InboundAgentFixture.AgentArguments agentArguments,
 InboundAgentFixture.Options options,
 boolean stop)
           throws IOException

Throws:

IOException

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
 String name)

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).

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.)

tearDown

public void tearDown()

getAgentArguments

public static InboundAgentFixture.AgentArguments getAgentArguments(JenkinsRule r,
 String name)
                                                            throws IOException

Throws:

IOException

waitForAgentOnline

public static void waitForAgentOnline(JenkinsRule r,
 String name,
 Map<String,Level> loggers)
                               throws Exception

Throws:

Exception

waitForAgentOffline

public static void waitForAgentOffline(JenkinsRule r,
 String name)
                                throws InterruptedException

Throws:

InterruptedException

createAgentRJR

public static String[] createAgentRJR(JenkinsRule r,
 InboundAgentFixture.Options options)
                               throws Throwable

Throws:

Throwable