Package org.jvnet.hudson.test.junit.jupiter

Class RealJenkinsExtension

java.lang.Object

org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension

public class RealJenkinsExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback

Like JenkinsSessionExtension but running Jenkins in a more realistic environment.

Though Jenkins is run in a separate JVM using Winstone (java -jar jenkins.war), you can still do “whitebox” testing: directly calling Java API methods, starting from JenkinsRule or not. This is because the test code gets sent to the remote JVM and loaded and run there. (Thus when using Maven, there are at least three JVMs involved: Maven itself; the Surefire booter with your top-level test code; and the Jenkins controller with test bodies.) Just as with JenkinsRule, all plugins found in the test classpath will be enabled, but with more realistic behavior: class loaders in a graph, pluginFirstClassLoader and maskClasses, etc.

“Compile-on-save” style development works for classes and resources in the current plugin: with a suitable IDE, you can edit a source file, have it be sent to target/classes/, and rerun a test without needing to go through a full Maven build cycle. This is because target/test-classes/the.hpl is used to load unpacked plugin resources.

Like JenkinsRule, the controller is started in “development mode”: the setup wizard is suppressed, the update center is not checked, etc.

Known limitations:

• Execution is a bit slower due to the overhead of launching a new JVM; and class loading overhead cannot be shared between test cases. More memory is needed.
• Remote calls must be serializable. Use methods like runRemotely(RealJenkinsExtension.StepWithReturnAndOneArg, Serializable) and/or XStreamSerializable as needed.
• static state cannot be shared between the top-level test code and test bodies (though the compiler will not catch this mistake).
• When using a snapshot dep on Jenkins core, you must build jenkins.war to test core changes (there is no “compile-on-save” support for this).
• TestExtension is not available (but try addSyntheticPlugin(org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension.SyntheticPlugin)).
• LoggerRule is not available, however additional loggers can be configured via withLogger(Class, Level)}.
• BuildWatcher is not available, but you can use TailLog instead.

Systems not yet tested:

• Possibly Timeout can be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RealJenkinsExtension.CustomJenkinsRule
static final class	RealJenkinsExtension.Endpoint
static final class	RealJenkinsExtension.Init2
static class	RealJenkinsExtension.JenkinsStartupException
static final class	RealJenkinsExtension.ProxyException
static interface	RealJenkinsExtension.Step	One step to run.
static interface	RealJenkinsExtension.Step2<T extends Serializable>
static class	RealJenkinsExtension.StepException
static interface	RealJenkinsExtension.StepWithFourArgs<A1 extends Serializable,A2 extends Serializable,A3 extends Serializable,A4 extends Serializable>
static interface	RealJenkinsExtension.StepWithOneArg<A1 extends Serializable>
static interface	RealJenkinsExtension.StepWithReturnAndFourArgs<R extends Serializable,A1 extends Serializable,A2 extends Serializable,A3 extends Serializable,A4 extends Serializable>
static interface	RealJenkinsExtension.StepWithReturnAndOneArg<R extends Serializable,A1 extends Serializable>
static interface	RealJenkinsExtension.StepWithReturnAndThreeArgs<R extends Serializable,A1 extends Serializable,A2 extends Serializable,A3 extends Serializable>
static interface	RealJenkinsExtension.StepWithReturnAndTwoArgs<R extends Serializable,A1 extends Serializable,A2 extends Serializable>
static interface	RealJenkinsExtension.StepWithThreeArgs<A1 extends Serializable,A2 extends Serializable,A3 extends Serializable>
static interface	RealJenkinsExtension.StepWithTwoArgs<A1 extends Serializable,A2 extends Serializable>
static final class	RealJenkinsExtension.SyntheticPlugin	Alternative to addPlugins(java.lang.String...) or TestExtension that lets you build a test-only plugin on the fly.

Constructor Summary

Constructors

Constructor	Description
RealJenkinsExtension()
RealJenkinsExtension(RealJenkinsExtension source)	Links this extension to another, with getHome() to be initialized by whichever copy starts first.

Method Summary

Modifier and Type	Method	Description
RealJenkinsExtension	addPlugins(String... plugins)	Add some plugins to the test classpath.
RealJenkinsExtension	addSyntheticPlugin(RealJenkinsExtension.SyntheticPlugin plugin)	Adds a test-only plugin to the controller based on sources defined in this module.
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
SSLContext	buildSSLContext()	Builds a SSLContext trusting the current instance.
<T extends Serializable> T	call(RealJenkinsExtension.Step2<T> s)	Run a step with a return value on the remote system.
static String	checkResult(HttpURLConnection conn)
File	createSyntheticPlugin(RealJenkinsExtension.SyntheticPlugin plugin)	Creates a test-only plugin based on sources defined in this module, but does not install it.
Path	createTempDirectory(String prefix)	Creates a temporary directory.
org.htmlunit.WebClient	createWebClient()	Create a client configured to trust any self-signed certificate used by this instance.
void	deprovision()	Deletes JENKINS_HOME.
RealJenkinsExtension	extraEnv(String key, String value)	Set an extra environment variable.
File	getHome()	Obtains the Jenkins home directory.
static List<String>	getJacocoAgentOptions()
String	getName()
X509Certificate	getRootCA()
String	getRootCAPem()	Returns the autogenerated self-signed root CA in PEM format, or null if https() has not been called.
String[]	getTruststoreJavaOptions()
URL	getUrl()	Similar to JenkinsRule.getURL().
RealJenkinsExtension	https()	Sets up HTTPS for the current instance, and disables plain HTTP.
RealJenkinsExtension	https(String host, KeyStoreManager keyStoreManager, X509Certificate rootCA)	Sets up HTTPS for the current instance, and disables plain HTTP.
RealJenkinsExtension	includeTestClasspathPlugins(boolean includeTestClasspathPlugins)	The intended use case for this is to use the plugins bundled into the war withWar(File) instead of the plugins in the pom.
boolean	isAlive()	Returns true if the Jenkins process is alive.
RealJenkinsExtension	javaOptions(String... options)	Add some JVM startup options.
RealJenkinsExtension	jenkinsOptions(String... options)	Add some Jenkins (including Winstone) startup options.
RealJenkinsExtension	omitPlugins(String... plugins)	Omit some plugins in the test classpath.
RealJenkinsExtension	prepareHomeLazily(boolean prepareHomeLazily)	Allows JENKINS_HOME initialization to be delayed until startJenkins() is called for the first time.
void	run(org.junit.rules.ErrorCollector errors, RealJenkinsExtension.Step step)	Run a step on the remote system, but do not immediately fail, just record any error.
void	run(RealJenkinsExtension.Step step)	Run a step on the remote system.
void	runRemotely(RealJenkinsExtension.Step... steps)	Runs one or more steps on the remote system.
<T extends Serializable> T	runRemotely(RealJenkinsExtension.Step2<T> s)
<A1 extends Serializable, A2 extends Serializable, A3 extends Serializable, A4 extends Serializable> void	runRemotely(RealJenkinsExtension.StepWithFourArgs<A1,A2,A3,A4> s, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
<A1 extends Serializable> void	runRemotely(RealJenkinsExtension.StepWithOneArg<A1> s, A1 arg1)
<R extends Serializable, A1 extends Serializable, A2 extends Serializable, A3 extends Serializable, A4 extends Serializable> R	runRemotely(RealJenkinsExtension.StepWithReturnAndFourArgs<R,A1,A2,A3,A4> s, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
<R extends Serializable, A1 extends Serializable> R	runRemotely(RealJenkinsExtension.StepWithReturnAndOneArg<R,A1> s, A1 arg1)
<R extends Serializable, A1 extends Serializable, A2 extends Serializable, A3 extends Serializable> R	runRemotely(RealJenkinsExtension.StepWithReturnAndThreeArgs<R,A1,A2,A3> s, A1 arg1, A2 arg2, A3 arg3)
<R extends Serializable, A1 extends Serializable, A2 extends Serializable> R	runRemotely(RealJenkinsExtension.StepWithReturnAndTwoArgs<R,A1,A2> s, A1 arg1, A2 arg2)
<A1 extends Serializable, A2 extends Serializable, A3 extends Serializable> void	runRemotely(RealJenkinsExtension.StepWithThreeArgs<A1,A2,A3> s, A1 arg1, A2 arg2, A3 arg3)
<A1 extends Serializable, A2 extends Serializable> void	runRemotely(RealJenkinsExtension.StepWithTwoArgs<A1,A2> s, A1 arg1, A2 arg2)
void	setHome(File newHome)	Switch the Jenkins home directory.
void	startJenkins()
void	stopJenkins()	Stops Jenkins and releases any system resources associated with it.
void	stopJenkinsForcibly()	Stops Jenkins abruptly, without giving it a chance to shut down cleanly.
void	then(RealJenkinsExtension.Step... steps)	Run one Jenkins session, send one or more test thunks, and shut down.
<T extends Serializable> T	then(RealJenkinsExtension.Step2<T> s)	Run one Jenkins session, send a test thunk, and shut down.
RealJenkinsExtension	withBootClasspath(File... files)
RealJenkinsExtension	withColor(PrefixedOutputStream.AnsiColor color)	Applies ANSI coloration to log lines produced by this instance, complementing withName(java.lang.String).
RealJenkinsExtension	withDebugPort(int debugPort)	Allows usage of a static debug port instead of a random one.
RealJenkinsExtension	withDebugServer(boolean debugServer)	Allows to use debug in server mode or client mode.
RealJenkinsExtension	withDebugSuspend(boolean debugSuspend)	Whether to suspend the controller VM on startup until debugger is connected.
RealJenkinsExtension	withFIPSEnabled()	Use withFIPSEnabled(FIPSTestBundleProvider) with default value of FIPSTestBundleProvider.get()
RealJenkinsExtension	withFIPSEnabled(io.jenkins.test.fips.FIPSTestBundleProvider fipsTestBundleProvider)
RealJenkinsExtension	withHost(String host)	Sets a custom host name for the Jenkins root URL.
RealJenkinsExtension	withHttpListenAddress(String httpListenAddress)	Provides a custom interface to listen to.
RealJenkinsExtension	withJavaHome(String JavaHome)	Allows to specify a java home, defaults to JAVA_HOME if not used
RealJenkinsExtension	withLogger(Class<?> clazz, Level level)
RealJenkinsExtension	withLogger(String logger, Level level)
RealJenkinsExtension	withName(String name)	Sets a name for this instance, which will be prefixed to log messages to simplify debugging.
RealJenkinsExtension	withPackageLogger(Class<?> clazz, Level level)
RealJenkinsExtension	withPort(int port)	Provides a custom fixed port instead of a random one.
RealJenkinsExtension	withPrefix(String prefix)	Sets a custom prefix for the Jenkins root URL.
RealJenkinsExtension	withTimeout(int timeout)	Adjusts the test timeout.
RealJenkinsExtension	withWar(File war)	Sets a custom WAR file to be used by the extension instead of the one in the path or war/target/jenkins.war in case of core.

Methods inherited from class java.lang.Object

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

Constructor Details

RealJenkinsExtension

public RealJenkinsExtension()

RealJenkinsExtension

public RealJenkinsExtension(RealJenkinsExtension source)

Links this extension to another, with getHome() to be initialized by whichever copy starts first. Also copies configuration related to the setup of that directory: includeTestClasspathPlugins(boolean), addPlugins(java.lang.String...), addSyntheticPlugin(org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension.SyntheticPlugin), and omitPlugins(java.lang.String...). Other configuration such as javaOptions(String...) may be applied to both, but that is your choice.

Method Details

addPlugins

public RealJenkinsExtension addPlugins(String... plugins)

Add some plugins to the test classpath.

Parameters:

plugins - Filenames of the plugins to install. These are expected to be absolute test classpath resources, such as plugins/workflow-job.hpi for example.

For small fake plugins built for this purpose and exercising some bit of code, use addSyntheticPlugin(org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension.SyntheticPlugin). If you wish to test with larger archives of real plugins, this is possible for example by binding dependency:copy to the process-test-resources phase.

In most cases you do not need this method. Simply add whatever plugins you are interested in testing against to your POM in test scope. These, and their transitive dependencies, will be loaded in all RealJenkinsExtension tests. This method is useful if only a particular test may load the tested plugin, or if the tested plugin is not available in a repository for use as a test dependency.

addSyntheticPlugin

public RealJenkinsExtension addSyntheticPlugin(RealJenkinsExtension.SyntheticPlugin plugin)

Adds a test-only plugin to the controller based on sources defined in this module. Useful when you wish to define some types, register some Extensions, etc. and there is no existing plugin that does quite what you want (that you are comfortable adding to the test classpath and maintaining the version of).

If you also have some test suites based on JenkinsRule, you may not want to use Extension since (unlike TestExtension) it would be loaded in all such tests. Instead create a package-info.java specifying an @OptionalPackage whose requirePlugins lists the same RealJenkinsExtension.SyntheticPlugin.shortName(String). (You will need to .header("Plugin-Dependencies", "variant:0") to use this API.) Then use @OptionalExtension on all your test extensions. These will then be loaded only in RealJenkinsExtension-based tests requesting this plugin.

Parameters:

plugin - the configured RealJenkinsExtension.SyntheticPlugin

createSyntheticPlugin

public File createSyntheticPlugin(RealJenkinsExtension.SyntheticPlugin plugin)
                           throws IOException,
URISyntaxException

Creates a test-only plugin based on sources defined in this module, but does not install it.

See addSyntheticPlugin(org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension.SyntheticPlugin) for more details. Prefer that method if you simply want the plugin to be installed automatically.

Parameters:

plugin - the configured RealJenkinsExtension.SyntheticPlugin

Returns:

the JPI file for the plugin

Throws:

IOException

URISyntaxException

See Also:

• addSyntheticPlugin(org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension.SyntheticPlugin)

omitPlugins

public RealJenkinsExtension omitPlugins(String... plugins)

Omit some plugins in the test classpath.

Parameters:

plugins - one or more code names, like token-macro

javaOptions

public RealJenkinsExtension javaOptions(String... options)

Add some JVM startup options.

Parameters:

options - one or more options, like -Dorg.jenkinsci.Something.FLAG=true

jenkinsOptions

public RealJenkinsExtension jenkinsOptions(String... options)

Add some Jenkins (including Winstone) startup options. You probably meant to use javaOptions(String...).

Parameters:

options - one or more options, like --webroot=/tmp/war --pluginroot=/tmp/plugins

extraEnv

public RealJenkinsExtension extraEnv(String key,
 String value)

Set an extra environment variable.

Parameters:

value - null to cancel a previously set variable

withTimeout

public RealJenkinsExtension withTimeout(int timeout)

Adjusts the test timeout. The timer starts when startJenkins() completes and runRemotely(org.jvnet.hudson.test.junit.jupiter.RealJenkinsExtension.Step...) is ready. The default is currently set to 600 (10m).

Parameters:

timeout - number of seconds before exiting, or zero to disable

withHost

public RealJenkinsExtension withHost(String host)

Sets a custom host name for the Jenkins root URL.

By default, this is just localhost. But you may wish to set it to something else that resolves to localhost, such as some-id.localtest.me. This is particularly useful when running multiple copies of Jenkins (and/or other services) in one test case, since browser cookies are sensitive to host but not port and so otherwise HttpServletRequest.getSession(boolean) might accidentally be shared across otherwise distinct services.

Calling this method does not change the fact that Jenkins will be configured to listen only on localhost for security reasons (so others in the same network cannot access your system under test, especially if it lacks authentication).

When using HTTPS, use https(String, KeyStoreManager, X509Certificate) instead.

withPrefix

public RealJenkinsExtension withPrefix(@NonNull
 String prefix)

Sets a custom prefix for the Jenkins root URL.

By default, the prefix defaults to /jenkins.

If not empty, must start with '/' and not end with '/'.

withWar

public RealJenkinsExtension withWar(File war)

Sets a custom WAR file to be used by the extension instead of the one in the path or war/target/jenkins.war in case of core.

withJavaHome

public RealJenkinsExtension withJavaHome(String JavaHome)

Allows to specify a java home, defaults to JAVA_HOME if not used

withLogger

public RealJenkinsExtension withLogger(Class<?> clazz,
 Level level)

withPackageLogger

public RealJenkinsExtension withPackageLogger(Class<?> clazz,
 Level level)

withLogger

public RealJenkinsExtension withLogger(String logger,
 Level level)

withName

public RealJenkinsExtension withName(String name)

Sets a name for this instance, which will be prefixed to log messages to simplify debugging.

getName

public String getName()

withColor

public RealJenkinsExtension withColor(PrefixedOutputStream.AnsiColor color)

Applies ANSI coloration to log lines produced by this instance, complementing withName(java.lang.String). Ignored when on CI.

withPort

public RealJenkinsExtension withPort(int port)

Provides a custom fixed port instead of a random one.

Parameters:

port - a custom port to use instead of a random one.

withHttpListenAddress

public RealJenkinsExtension withHttpListenAddress(String httpListenAddress)

Provides a custom interface to listen to.

Important: for security reasons this should be overridden only in special scenarios, such as testing inside a Docker container. Otherwise a developer running tests could inadvertently expose a Jenkins service without password protection, allowing remote code execution.

Parameters:

httpListenAddress - network interface such as

0.0.0.0

. Defaults to

127.0.0.1

.

withDebugPort

public RealJenkinsExtension withDebugPort(int debugPort)

Allows usage of a static debug port instead of a random one.

This allows to use predefined debug configurations in the IDE.

Typical usage is in a base test class where multiple named controller instances are defined with fixed ports

 public RealJenkinsExtension cc1 = new RealJenkinsExtension().withName("cc1").withDebugPort(4001).withDebugServer(false);

 public RealJenkinsExtension cc2 = new RealJenkinsExtension().withName("cc2").withDebugPort(4002).withDebugServer(false);
 

Then have debug configurations in the IDE set for ports

• 5005 (test VM) - debugger mode "attach to remote vm"
• 4001 (cc1) - debugger mode "listen to remote vm"
• 4002 (cc2) - debugger mode "listen to remote vm"

This allows for debugger to reconnect in scenarios where restarts of controllers are involved.

Parameters:

debugPort - the TCP port to use for debugging this Jenkins instance. Between 0 (random) and 65536 (excluded).

withDebugServer

public RealJenkinsExtension withDebugServer(boolean debugServer)

Allows to use debug in server mode or client mode. Client mode is friendlier to controller restarts.

Parameters:

debugServer - true to use server=y, false to use server=n

See Also:

• withDebugPort(int)

withDebugSuspend

public RealJenkinsExtension withDebugSuspend(boolean debugSuspend)

Whether to suspend the controller VM on startup until debugger is connected. Defaults to false.

Parameters:

debugSuspend - true to suspend the controller VM on startup until debugger is connected.

includeTestClasspathPlugins

public RealJenkinsExtension includeTestClasspathPlugins(boolean includeTestClasspathPlugins)

The intended use case for this is to use the plugins bundled into the war withWar(File) instead of the plugins in the pom. A typical scenario for this feature is a test which does not live inside a plugin's src/test/java

Parameters:

includeTestClasspathPlugins - false if plugins from pom should not be used (default true)

prepareHomeLazily

public RealJenkinsExtension prepareHomeLazily(boolean prepareHomeLazily)

Allows JENKINS_HOME initialization to be delayed until startJenkins() is called for the first time.

This allows methods such as addPlugins(java.lang.String...) to be called dynamically inside of test methods, which enables related tests that need to configure RealJenkinsExtension in different ways to be defined in the same class using only a single instance of RealJenkinsExtension.

withFIPSEnabled

public RealJenkinsExtension withFIPSEnabled()

Use withFIPSEnabled(FIPSTestBundleProvider) with default value of FIPSTestBundleProvider.get()

withFIPSEnabled

public RealJenkinsExtension withFIPSEnabled(io.jenkins.test.fips.FIPSTestBundleProvider fipsTestBundleProvider)

Parameters:

fipsTestBundleProvider - the FIPSTestBundleProvider to use for testing

withBootClasspath

public RealJenkinsExtension withBootClasspath(File... files)

Parameters:

files - add some File to bootclasspath

getJacocoAgentOptions

public static List<String> getJacocoAgentOptions()

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception

deprovision

public void deprovision()
                 throws Exception

Deletes JENKINS_HOME.

This method does not need to be invoked when using @Rule or @ClassRule to run RealJenkinsRule.

Throws:

Exception

createTempDirectory

public Path createTempDirectory(String prefix)
                         throws IOException

Creates a temporary directory. Unlike Files.createTempDirectory(String, FileAttribute...) this will be cleaned up after the test exits (like TemporaryFolder), and will honor java.io.tmpdir set by Surefire after StaticProperty.JAVA_IO_TMPDIR has been initialized.

Throws:

IOException

isAlive

public boolean isAlive()

Returns true if the Jenkins process is alive.

getTruststoreJavaOptions

public String[] getTruststoreJavaOptions()

then

public void then(RealJenkinsExtension.Step... steps)
          throws Throwable

Run one Jenkins session, send one or more test thunks, and shut down.

Throws:

Throwable

then

public <T extends Serializable> T then(RealJenkinsExtension.Step2<T> s)
                                throws Throwable

Run one Jenkins session, send a test thunk, and shut down.

Throws:

Throwable

getUrl

public URL getUrl()
           throws MalformedURLException

Similar to JenkinsRule.getURL(). Requires Jenkins to be started before using startJenkins().

Always ends with a '/'.

Throws:

MalformedURLException

https

public RealJenkinsExtension https()

Sets up HTTPS for the current instance, and disables plain HTTP. This generates a self-signed certificate for localhost. The corresponding root CA that needs to be trusted by HTTP client can be obtained using getRootCA().

Returns:

the current instance

See Also:

• createWebClient()

https

public RealJenkinsExtension https(@NonNull
 String host,
 @NonNull
 KeyStoreManager keyStoreManager,
 @NonNull
 X509Certificate rootCA)

Sets up HTTPS for the current instance, and disables plain HTTP.

You don't need to call withHost(String) when calling this method.

Parameters:

host - the host name to use in the certificate

keyStoreManager - a key store manager containing the key and certificate to use for HTTPS. It needs to be valid for the given host

rootCA - the certificate that needs to be trusted by callers.

Returns:

the current instance

See Also:

• createWebClient()
• withHost(String)

getRootCA

@Nullable
public X509Certificate getRootCA()

Returns:

the current autogenerated root CA or null if https() has not been called.

getRootCAPem

@Nullable
public String getRootCAPem()

Returns the autogenerated self-signed root CA in PEM format, or null if https() has not been called. Typically used to configure InboundAgentRule.Options.Builder.cert(java.lang.String).

Returns:

the root CA in PEM format, or null if unavailable

buildSSLContext

@NonNull
public SSLContext buildSSLContext()
                           throws NoSuchAlgorithmException

Builds a SSLContext trusting the current instance.

Throws:

NoSuchAlgorithmException

getHome

public File getHome()

Obtains the Jenkins home directory. Normally it will suffice to use LocalData to populate files.

setHome

public void setHome(File newHome)

Switch the Jenkins home directory. Will affect subsequent startups of this extension, but not other copies linked via RealJenkinsExtension(RealJenkinsExtension). Normally unnecessary but could be used to simulate running on the wrong home.

createWebClient

public org.htmlunit.WebClient createWebClient()

Create a client configured to trust any self-signed certificate used by this instance.

startJenkins

public void startJenkins()
                  throws Exception

Throws:

Exception

checkResult

@CheckForNull
public static String checkResult(HttpURLConnection conn)
                          throws IOException

Throws:

IOException

stopJenkins

public void stopJenkins()
                 throws Exception

Stops Jenkins and releases any system resources associated with it. If Jenkins is already stopped then invoking this method has no effect.

Throws:

Exception

stopJenkinsForcibly

public void stopJenkinsForcibly()

Stops Jenkins abruptly, without giving it a chance to shut down cleanly. If Jenkins is already stopped then invoking this method has no effect.

runRemotely

public void runRemotely(RealJenkinsExtension.Step... steps)
                 throws Throwable

Runs one or more steps on the remote system. (Compared to multiple calls, passing a series of steps is slightly more efficient as only one network call is made.)

Throws:

Throwable

run

public void run(RealJenkinsExtension.Step step)
         throws Throwable

Run a step on the remote system. Alias for runRemotely(RealJenkinsExtension.Step...) (with one step) that is easier to resolve for lambdas.

Throws:

Throwable

run

public void run(org.junit.rules.ErrorCollector errors,
 RealJenkinsExtension.Step step)

Run a step on the remote system, but do not immediately fail, just record any error. Same as ErrorCollector.checkSucceeds(java.util.concurrent.Callable<T>) but more concise to call.

runRemotely

public <T extends Serializable> T runRemotely(RealJenkinsExtension.Step2<T> s)
                                       throws Throwable

Throws:

Throwable

call

public <T extends Serializable> T call(RealJenkinsExtension.Step2<T> s)
                                throws Throwable

Run a step with a return value on the remote system. Alias for runRemotely(RealJenkinsExtension.Step2) that is easier to resolve for lambdas.

Throws:

Throwable

runRemotely

public <A1 extends Serializable> void runRemotely(RealJenkinsExtension.StepWithOneArg<A1> s,
 A1 arg1)
                                           throws Throwable

Throws:

Throwable

runRemotely

public <A1 extends Serializable,
A2 extends Serializable>
void runRemotely(RealJenkinsExtension.StepWithTwoArgs<A1,A2> s,
 A1 arg1,
 A2 arg2)
          throws Throwable

Throws:

Throwable

runRemotely

public <A1 extends Serializable,
A2 extends Serializable,
A3 extends Serializable>
void runRemotely(RealJenkinsExtension.StepWithThreeArgs<A1,A2,A3> s,
 A1 arg1,
 A2 arg2,
 A3 arg3)
          throws Throwable

Throws:

Throwable

runRemotely

public <A1 extends Serializable,
A2 extends Serializable,
A3 extends Serializable,
A4 extends Serializable>
void runRemotely(RealJenkinsExtension.StepWithFourArgs<A1,A2,A3,A4> s,
 A1 arg1,
 A2 arg2,
 A3 arg3,
 A4 arg4)
          throws Throwable

Throws:

Throwable

runRemotely

public <R extends Serializable,
A1 extends Serializable>
R runRemotely(RealJenkinsExtension.StepWithReturnAndOneArg<R,A1> s,
 A1 arg1)
       throws Throwable

Throws:

Throwable

runRemotely

public <R extends Serializable,
A1 extends Serializable,
A2 extends Serializable>
R runRemotely(RealJenkinsExtension.StepWithReturnAndTwoArgs<R,A1,A2> s,
 A1 arg1,
 A2 arg2)
       throws Throwable

Throws:

Throwable

runRemotely

public <R extends Serializable,
A1 extends Serializable,
A2 extends Serializable,
A3 extends Serializable>
R runRemotely(RealJenkinsExtension.StepWithReturnAndThreeArgs<R,A1,A2,A3> s,
 A1 arg1,
 A2 arg2,
 A3 arg3)
       throws Throwable

Throws:

Throwable

runRemotely

public <R extends Serializable,
A1 extends Serializable,
A2 extends Serializable,
A3 extends Serializable,
A4 extends Serializable>
R runRemotely(RealJenkinsExtension.StepWithReturnAndFourArgs<R,A1,A2,A3,A4> s,
 A1 arg1,
 A2 arg2,
 A3 arg3,
 A4 arg4)
       throws Throwable

Throws:

Throwable