org.jvnet.hudson.test

Class RestartableJenkinsRule

java.lang.Object

org.jvnet.hudson.test.RestartableJenkinsRule

All Implemented Interfaces:

org.junit.rules.MethodRule

public class RestartableJenkinsRule
extends Object
implements org.junit.rules.MethodRule

Provides a pattern for executing a sequence of steps. In between steps, Jenkins gets restarted.

To use this, add this rule instead of JenkinsRule to the test, then from your test method, call step(Closure) or addStep(Statement) repeatedly.

The rule will evaluate your test method to collect all steps, then execute them in turn and restart Jenkins in between.

Since:

1.567

Author:

Kohsuke Kawaguchi

See Also:

JenkinsRule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestartableJenkinsRule.Builder
static interface	RestartableJenkinsRule.Step One step to run, intended to be a SAM for lambdas with then(org.jvnet.hudson.test.RestartableJenkinsRule.Step).

Field Summary

Fields

Modifier and Type	Field and Description
File	home JENKINS_HOME
JenkinsRule	j

Constructor Summary

Constructors

Constructor and Description
RestartableJenkinsRule()

Method Summary

Modifier and Type	Method and Description
void	addStep(org.junit.runners.model.Statement step)
void	addStep(org.junit.runners.model.Statement step, boolean expectedToStartCorrectly)
void	addStepWithDirtyShutdown(org.junit.runners.model.Statement step) Similar to addStep(Statement) but we simulate a dirty shutdown after the step, rather than a clean one.
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runners.model.FrameworkMethod method, Object target)
protected JenkinsRule	createJenkinsRule(org.junit.runner.Description description)
void	step(groovy.lang.Closure c)
void	then(RestartableJenkinsRule.Step s) Run one Jenkins session and shut down.
void	thenDoesNotStart()
void	thenWithHardShutdown(RestartableJenkinsRule.Step s) Run one Jenkins session and then simulate the Jenkins process ending without a clean shutdown.

Methods inherited from class java.lang.Object

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

Field Detail

j

public JenkinsRule j

home

public File home

JENKINS_HOME

Constructor Detail

RestartableJenkinsRule

public RestartableJenkinsRule()

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runners.model.FrameworkMethod method,
                                               Object target)

Specified by:

apply in interface org.junit.rules.MethodRule

step

public void step(groovy.lang.Closure c)

then

public void then(RestartableJenkinsRule.Step s)

Run one Jenkins session and shut down.

Since:

2.24

thenWithHardShutdown

public void thenWithHardShutdown(RestartableJenkinsRule.Step s)

Run one Jenkins session and then simulate the Jenkins process ending without a clean shutdown. This can be used to test that data is appropriately persisted without relying on shutdown processes.

Implementation note: we're actually just copying the JENKINS_HOME, which takes some time - so the shutdown isn't truly instant (additional data may be written while this happens).

thenDoesNotStart

public void thenDoesNotStart()

addStep

public void addStep(org.junit.runners.model.Statement step)

addStep

public void addStep(org.junit.runners.model.Statement step,
                    boolean expectedToStartCorrectly)

addStepWithDirtyShutdown

public void addStepWithDirtyShutdown(org.junit.runners.model.Statement step)

Similar to addStep(Statement) but we simulate a dirty shutdown after the step, rather than a clean one. See thenWithHardShutdown(Step) for how this is done.

createJenkinsRule

protected JenkinsRule createJenkinsRule(org.junit.runner.Description description)