Package org.jvnet.hudson.test

Class JenkinsRule

java.lang.Object
org.jvnet.hudson.test.JenkinsRule
All Implemented Interfaces:
hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction, org.junit.rules.MethodRule, org.junit.rules.TestRule
Direct Known Subclasses:
GroovyJenkinsRule, NodeProvisionerRule, RealJenkinsRule.CustomJenkinsRule
public class JenkinsRule extends Object implements org.junit.rules.TestRule, org.junit.rules.MethodRule, hudson.model.RootAction
JUnit rule to allow test cases to fire up a Jenkins instance.
Since:
1.436
Author:
Stephen Connolly
See Also:

  • Field Details

    • env

      protected TestEnvironment env

    • testDescription

      protected org.junit.runner.Description testDescription

    • hudson

      @Deprecated public hudson.model.Hudson hudson
      Deprecated.
      Points to the same object as jenkins does.

    • jenkins

      public jenkins.model.Jenkins jenkins

    • homeLoader

      protected HudsonHomeLoader homeLoader

    • localPort

      protected int localPort
      TCP/IP port that the server is listening on.

    • server

      protected org.eclipse.jetty.server.Server server

    • contextPath

      public String contextPath
      Where in the Server is Jenkins deployed?

      Just like ServletContext.getContextPath(), starts with '/' but doesn't end with '/'. Unlike JenkinsRule.WebClient.getContextPath() this is not a complete URL.

    • tearDowns

      protected List<LenientRunnable> tearDowns
      Runnables to be invoked at after() .

    • recipes

      protected List<JenkinsRecipe.Runner> recipes

    • jsDebugger

      protected JavaScriptDebugger jsDebugger
      JavaScript "debugger" that provides you information about the JavaScript call stack and the current values of the local variables in those stack frame.

      Unlike Java debugger, which you as a human interfaces directly and interactively, this JavaScript debugger is to be interfaced by your program (or through the expression evaluation capability of your Java debugger.)

    • useLocalPluginManager

      @Deprecated public boolean useLocalPluginManager
      Deprecated.
      Use pluginManager
      If this test case has additional WithPlugin annotations, set to true. This will cause a fresh PluginManager to be created for this test. Leaving this to false enables the test harness to use a pre-loaded plugin manager, which runs faster.

    • timeout

      public int timeout
      Number of seconds until the test times out. The WithTimeout rule can be used to specify this value per test. In case of debugging session, the default timeout behavior is removed. Otherwise it's set to 3 minutes.

    • computerConnectorTester

      public JenkinsComputerConnectorTester computerConnectorTester

    • NO_PROPERTIES

      public static final List<hudson.tools.ToolProperty<?>> NO_PROPERTIES

    • SLAVE_DEBUG_PORT

      public static final int SLAVE_DEBUG_PORT
      Specify this to a TCP/IP port number to have slaves started with the debugger.

  • Constructor Details

    • JenkinsRule

      public JenkinsRule()

  • Method Details

    • getInstance

      public jenkins.model.Jenkins getInstance()

    • before

      public void before() throws Throwable
      Override to set up your specific external resource.
      Throws:
      Throwable - if setup fails (which will disable after

    • _configureJenkinsForTest

      public static void _configureJenkinsForTest(jenkins.model.Jenkins jenkins) throws Exception
      Configures a Jenkins instance for test.
      Parameters:
      jenkins - jenkins instance which has to be configured
      Throws:
      Exception - if unable to configure
      Since:
      2.50

    • configureUpdateCenter

      protected void configureUpdateCenter() throws Exception
      Configures the update center setting for the test. By default, we load updates from local proxy to avoid network traffic as much as possible.
      Throws:
      Exception

    • _configureUpdateCenter

      public static void _configureUpdateCenter(jenkins.model.Jenkins jenkins) throws Exception
      Internal method used to configure update center to avoid network traffic.
      Parameters:
      jenkins - the Jenkins to configure
      Throws:
      Exception
      Since:
      2.50

    • after

      public void after() throws Exception
      Override to tear down your specific external resource.
      Throws:
      Exception

    • _stopJenkins

      public static void _stopJenkins(org.eclipse.jetty.server.Server server, List<LenientRunnable> tearDowns, jenkins.model.Jenkins jenkins)
      Internal method to stop Jenkins instance.
      Parameters:
      server - server on which Jenkins is running.
      tearDowns - tear down methods for tests
      jenkins - the jenkins instance
      Since:
      2.50

    • apply

      public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base, org.junit.runners.model.FrameworkMethod method, Object target)
      Backward compatibility with JUnit 4.8.
      Specified by:
      apply in interface org.junit.rules.MethodRule

    • apply

      public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
      Specified by:
      apply in interface org.junit.rules.TestRule

    • getIconFileName

      public String getIconFileName()
      Specified by:
      getIconFileName in interface hudson.model.Action

    • getDisplayName

      public String getDisplayName()
      Specified by:
      getDisplayName in interface hudson.model.Action
      Specified by:
      getDisplayName in interface hudson.model.ModelObject

    • getUrlName

      public String getUrlName()
      Specified by:
      getUrlName in interface hudson.model.Action

    • newHudson

      protected hudson.model.Hudson newHudson() throws Exception
      Creates a new instance of Jenkins. If the derived class wants to create it in a different way, you can override it.
      Throws:
      Exception

    • getPluginManager

      public hudson.PluginManager getPluginManager()

    • setPluginManager

      public void setPluginManager(hudson.PluginManager pluginManager)
      Sets the PluginManager to be used when creating a new Jenkins instance.
      Parameters:
      pluginManager - null to let Jenkins create a new instance of default plugin manager, like it normally does when running as a webapp outside the test.

    • with

      public JenkinsRule with(hudson.PluginManager pluginManager)

    • getWebAppRoot

      public File getWebAppRoot() throws Exception
      Throws:
      Exception

    • createWebServer2

      protected jakarta.servlet.ServletContext createWebServer2() throws Exception
      Prepares a webapp hosting environment to get ServletContext implementation that we need for testing.
      Throws:
      Exception

    • createWebServer2

      protected jakarta.servlet.ServletContext createWebServer2(@CheckForNull BiConsumer<org.eclipse.jetty.ee9.webapp.WebAppContext,org.eclipse.jetty.server.Server> contextAndServerConsumer) throws Exception
      Prepares a webapp hosting environment to get ServletContext implementation that we need for testing.
      Parameters:
      contextAndServerConsumer - configures the WebAppContext and the Server for the instance, before they are started
      Throws:
      Exception
      Since:
      2.63

    • _createWebAppContext2

      public static org.eclipse.jetty.ee9.webapp.WebAppContext _createWebAppContext2(String contextPath, Consumer<Integer> portSetter, ClassLoader classLoader, int localPort, Supplier<org.eclipse.jetty.security.LoginService> loginServiceSupplier) throws Exception
      Creates a web server on which Jenkins can run
      Parameters:
      contextPath - the context path at which to put Jenkins
      portSetter - the port on which the server runs will be set using this function
      classLoader - the class loader for the WebAppContext
      localPort - port on which the server runs
      loginServiceSupplier - configures the LoginService for the instance
      Returns:
      the Server
      Throws:
      Exception
      Since:
      2.50

    • _createWebAppContext2

      public static org.eclipse.jetty.ee9.webapp.WebAppContext _createWebAppContext2(String contextPath, Consumer<Integer> portSetter, ClassLoader classLoader, int localPort, Supplier<org.eclipse.jetty.security.LoginService> loginServiceSupplier, @CheckForNull BiConsumer<org.eclipse.jetty.ee9.webapp.WebAppContext,org.eclipse.jetty.server.Server> contextAndServerConsumer) throws Exception
      Creates a web server on which Jenkins can run
      Parameters:
      contextPath - the context path at which to put Jenkins
      portSetter - the port on which the server runs will be set using this function
      classLoader - the class loader for the WebAppContext
      localPort - port on which the server runs
      loginServiceSupplier - configures the LoginService for the instance
      contextAndServerConsumer - configures the WebAppContext and the Server for the instance, before they are started
      Returns:
      the Server
      Throws:
      Exception
      Since:
      2.50

    • configureUserRealm

      protected org.eclipse.jetty.security.LoginService configureUserRealm()
      Configures a security realm for a test.

    • _configureUserRealm

      public static org.eclipse.jetty.security.LoginService _configureUserRealm()
      Creates a HashLoginService with three users: alice, bob and charlie The password is same as the username
      Returns:
      a new login service
      Since:
      2.50

    • createProject

      public <T extends hudson.model.TopLevelItem> T createProject(Class<T> type, String name) throws IOException
      Creates a new job.
      Parameters:
      type - Top level item type.
      name - Item name.
      Throws:
      IllegalArgumentException - if the project of the given name already exists.
      IOException

    • createProject

      public <T extends hudson.model.TopLevelItem> T createProject(Class<T> type) throws IOException
      Creates a new job with an unique name.
      Parameters:
      type - Top level item type.
      Throws:
      IOException

    • createFreeStyleProject

      public hudson.model.FreeStyleProject createFreeStyleProject() throws IOException
      Throws:
      IOException

    • createFreeStyleProject

      public hudson.model.FreeStyleProject createFreeStyleProject(String name) throws IOException
      Throws:
      IOException

    • createFolder

      public MockFolder createFolder(String name) throws IOException
      Creates a simple folder that other jobs can be placed in.
      Throws:
      IOException
      Since:
      1.494

    • createUniqueProjectName

      protected String createUniqueProjectName()

    • createLocalLauncher

      public hudson.Launcher.LocalLauncher createLocalLauncher()
      Creates Launcher.LocalLauncher. Useful for launching processes.

    • createTmpDir

      @Deprecated public File createTmpDir() throws IOException
      Deprecated.
      Use TemporaryFolder instead.
      Allocates a new temporary directory for the duration of this test.
      Throws:
      IOException

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave(boolean waitForChannelConnect) throws Exception
      Throws:
      Exception

    • disconnectSlave

      public void disconnectSlave(hudson.slaves.DumbSlave slave) throws Exception
      Throws:
      Exception

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave() throws Exception
      Creates and attaches a new outbound agent.
      Throws:
      Exception
      See Also:

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave(@CheckForNull hudson.model.Label l) throws Exception
      Creates and launches a new slave on the local host.
      Throws:
      Exception

    • createDummySecurityRealm

      public JenkinsRule.DummySecurityRealm createDummySecurityRealm()
      Creates a test SecurityRealm that recognizes username==password as valid.
      See Also:

    • getURL

      public URL getURL() throws IOException
      Returns the URL of the webapp top page. URL ends with '/'.
      Throws:
      IOException

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave(@CheckForNull hudson.EnvVars env) throws Exception
      Throws:
      Exception

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave(@CheckForNull hudson.model.Label l, @CheckForNull hudson.EnvVars env) throws Exception
      Throws:
      Exception

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave(@CheckForNull String labels, @CheckForNull hudson.EnvVars env) throws Exception
      Creates a slave with certain additional environment variables
      Throws:
      Exception

    • createSlave

      @NonNull public hudson.slaves.DumbSlave createSlave(@NonNull String nodeName, @CheckForNull String labels, @CheckForNull hudson.EnvVars env) throws Exception
      Throws:
      Exception

    • createPretendSlave

      public PretendSlave createPretendSlave(FakeLauncher faker) throws Exception
      Throws:
      Exception

    • createComputerLauncher

      @NonNull public hudson.slaves.ComputerLauncher createComputerLauncher(@CheckForNull hudson.EnvVars env) throws URISyntaxException, IOException
      Creates a launcher for starting a local agent. This is an outbound agent using SimpleCommandLauncher.
      Parameters:
      env - Environment variables to add to the slave process. Can be null.
      Throws:
      URISyntaxException
      IOException
      See Also:

    • createOnlineSlave

      @NonNull public hudson.slaves.DumbSlave createOnlineSlave() throws Exception
      Create a new slave on the local host and wait for it to come online before returning.
      Throws:
      Exception

    • createOnlineSlave

      @NonNull public hudson.slaves.DumbSlave createOnlineSlave(@CheckForNull hudson.model.Label l) throws Exception
      Create a new slave on the local host and wait for it to come online before returning.
      Throws:
      Exception

    • createOnlineSlave

      @NonNull public hudson.slaves.DumbSlave createOnlineSlave(@CheckForNull hudson.model.Label l, @CheckForNull hudson.EnvVars env) throws Exception
      Create a new slave on the local host and wait for it to come online before returning
      Throws:
      Exception
      See Also:

    • createApiToken

      @NonNull public String createApiToken(@NonNull hudson.model.User user)
      Use the new API token system introduced in 2.129 to generate a token for the given user.

    • waitOnline

      public void waitOnline(hudson.model.Slave s) throws Exception
      Waits for a newly created slave to come online.
      Throws:
      Exception
      See Also:

    • showAgentLogs

      public void showAgentLogs(hudson.model.Slave s, LoggerRule loggerRule) throws Exception
      Same as showAgentLogs(Slave, Map) but taking a preconfigured list of loggers as a convenience.
      Throws:
      Exception

    • showAgentLogs

      public void showAgentLogs(hudson.model.Slave s, Map<String,Level> loggers) throws Exception
      Forward agent logs to standard error of the test process. Otherwise log messages would be sent only to Computer.getLogText() etc., or discarded entirely (if below Level.INFO).
      Parameters:
      s - an online agent
      loggers - Logger.getName() tied to log level
      Throws:
      Exception

    • interactiveBreak

      public void interactiveBreak() throws Exception
      Blocks until the ENTER key is hit. This is useful during debugging a test so that one can inspect the state of Hudson through the web browser.
      Throws:
      Exception

    • last

      public <T> T last(List<T> items)
      Returns the last item in the list.

    • pause

      public void pause() throws IOException
      Pauses the execution until ENTER is hit in the console.

      This is often very useful so that you can interact with Hudson from an browser, while developing a test case.

      Throws:
      IOException

    • search

      public org.htmlunit.Page search(String q) throws Exception
      Performs a search from the search box.
      Throws:
      Exception

    • getJSON

      public JenkinsRule.JSONWebResponse getJSON(@NonNull String path) throws IOException
      Get JSON from a Jenkins relative endpoint. Create a new default webclient. If you want to configure the webclient, for example to set a token for authentication, or accept other HTTP responses than 200, you can use JenkinsRule.WebClient.getJSON(String) directly.
      Parameters:
      path - relative path, should not start with '/'
      Returns:
      The JSON response from server.
      Throws:
      IOException

    • postJSON

      public JenkinsRule.JSONWebResponse postJSON(@NonNull String path, @NonNull Object json) throws IOException, SAXException
      POST a JSON payload to a URL on the underlying Jenkins instance using the crumb.
      Parameters:
      path - The url path on Jenkins.
      json - An object that produces a JSON string from it's toString method.
      Returns:
      A JSON response.
      Throws:
      IOException
      SAXException

    • configRoundtrip

      public void configRoundtrip() throws Exception
      Hits the Hudson system configuration and submits without any modification.
      Throws:
      Exception

    • configRoundtrip

      public <P extends hudson.model.Item> P configRoundtrip(P job) throws Exception
      Loads a configuration page and submits it without any modifications, to perform a round-trip configuration test.

      See Configuration Round-trip Testing

      Throws:
      Exception

    • configRoundtrip

      public <B extends hudson.tasks.Builder> B configRoundtrip(B before) throws Exception
      Performs a configuration round-trip testing for a builder.
      Throws:
      Exception

    • configRoundtrip

      public <P extends hudson.tasks.Publisher> P configRoundtrip(P before) throws Exception
      Performs a configuration round-trip testing for a publisher.
      Throws:
      Exception

    • configRoundtrip

      public <C extends hudson.slaves.ComputerConnector> C configRoundtrip(C before) throws Exception
      Throws:
      Exception

    • configRoundtrip

      public hudson.model.User configRoundtrip(hudson.model.User u) throws Exception
      Throws:
      Exception

    • configRoundtrip

      public <N extends hudson.model.Node> N configRoundtrip(N node) throws Exception
      Throws:
      Exception

    • configRoundtrip

      public <V extends hudson.model.View> V configRoundtrip(V view) throws Exception
      Throws:
      Exception

    • configRoundtrip

      public <C extends hudson.slaves.Cloud> C configRoundtrip(C cloud) throws Exception
      Performs a configuration round-trip testing for a cloud. The given cloud is added to the cloud list of Jenkins.

      If a cloud with the same name already exists, then this old one will be replaced by the given one.

      Throws:
      Exception

    • assertBuildStatus

      public <R extends hudson.model.Run> R assertBuildStatus(hudson.model.Result status, R r) throws Exception
      Asserts that the outcome of the build is a specific outcome.

      Consider RunMatchers.hasStatus(Result) as an alternative.

      Throws:
      Exception

    • assertBuildStatus

      public <R extends hudson.model.Run> R assertBuildStatus(hudson.model.Result status, Future<? extends R> r) throws Exception
      Throws:
      Exception

    • isGoodHttpStatus

      public boolean isGoodHttpStatus(int status)
      Determines whether the specified HTTP status code is generally "good"

    • assertGoodStatus

      public void assertGoodStatus(org.htmlunit.Page page)
      Assert that the specified page can be served with a "good" HTTP status, eg, the page is not missing and can be served without a server error

    • assertBuildStatusSuccess

      public <R extends hudson.model.Run> R assertBuildStatusSuccess(R r) throws Exception
      Throws:
      Exception

    • assertBuildStatusSuccess

      public <R extends hudson.model.Run> R assertBuildStatusSuccess(Future<? extends R> r) throws Exception
      Throws:
      Exception

    • buildAndAssertSuccess

      @NonNull public <J extends hudson.model.Job<J, R> & jenkins.model.ParameterizedJobMixIn.ParameterizedJob<J, R>, R extends hudson.model.Run<J, R> & hudson.model.Queue.Executable> R buildAndAssertSuccess(@NonNull J job) throws Exception
      Throws:
      Exception

    • buildAndAssertStatus

      @NonNull public <J extends hudson.model.Job<J, R> & jenkins.model.ParameterizedJobMixIn.ParameterizedJob<J, R>, R extends hudson.model.Run<J, R> & hudson.model.Queue.Executable> R buildAndAssertStatus(@NonNull hudson.model.Result status, @NonNull J job) throws Exception
      Runs specified job and asserts that in finished with given build result.
      Throws:
      Exception
      Since:
      TODO

    • buildAndAssertSuccess

      @NonNull public hudson.model.FreeStyleBuild buildAndAssertSuccess(@NonNull hudson.model.FreeStyleProject job) throws Exception
      Avoids need for cumbersome this.<J,R>buildAndAssertSuccess(...) type hints under JDK 7 javac (and supposedly also IntelliJ).
      Throws:
      Exception

    • assertLogContains

      public void assertLogContains(String substring, hudson.model.Run run) throws IOException
      Asserts that the console output of the build contains the given substring.

      Consider RunMatchers.logContains(String) as an alternative.

      Throws:
      IOException

    • assertLogNotContains

      public void assertLogNotContains(String substring, hudson.model.Run run) throws IOException
      Asserts that the console output of the build does not contain the given substring.

      Consider Matchers.not(org.hamcrest.Matcher<T>) and RunMatchers.logContains(String) as an alternative.

      Throws:
      IOException

    • getLog

      public static String getLog(hudson.model.Run run) throws IOException
      Get entire log file as plain text. Run.getLog() is deprecated for reasons that are irrelevant in tests, and also does not strip console annotations which are a distraction in test output.
      Throws:
      IOException

    • waitForCompletion

      public <R extends hudson.model.Run<?, ?>> R waitForCompletion(R r) throws InterruptedException
      Waits for a build to complete. Useful in conjunction with BuildWatcher.

      As an alternative, if using Awaitibility, you can use await().until(() -> r, RunMatchers.completed());

      Returns:
      the same build, once done
      Throws:
      InterruptedException
      Since:
      1.607

    • waitForMessage

      public <R extends hudson.model.Run<?, ?>> R waitForMessage(String message, R r) throws IOException, InterruptedException
      Waits for a build log to contain a specified string. Useful in conjunction with BuildWatcher.
      Returns:
      the same build, once it does
      Throws:
      IOException
      InterruptedException
      Since:
      1.607

    • assertXPath

      public void assertXPath(org.htmlunit.html.HtmlPage page, String xpath)
      Asserts that the XPath matches.

    • assertXPath

      public void assertXPath(org.htmlunit.html.DomNode page, String xpath)
      Asserts that the XPath matches the contents of a DomNode page. This variant of assertXPath(HtmlPage page, String xpath) allows us to examine XmlPages.

    • assertXPathValue

      public void assertXPathValue(org.htmlunit.html.DomNode page, String xpath, String expectedValue)

    • assertXPathValueContains

      public void assertXPathValueContains(org.htmlunit.html.DomNode page, String xpath, String needle)

    • assertXPathResultsContainText

      public void assertXPathResultsContainText(org.htmlunit.html.DomNode page, String xpath, String needle)

    • assertAllImageLoadSuccessfully

      public void assertAllImageLoadSuccessfully(org.htmlunit.html.HtmlPage p)
      Makes sure that all the images in the page loads successfully. (By default, HtmlUnit doesn't load images.)

    • assertStringContains

      public void assertStringContains(String message, String haystack, String needle)

    • assertStringContains

      public void assertStringContains(String haystack, String needle)

    • assertHelpExists

      public void assertHelpExists(Class<? extends hudson.model.Describable> type, String properties) throws Exception
      Asserts that help files exist for the specified properties of the given instance.
      Parameters:
      type - The describable class type that should have the associated help files.
      properties - ','-separated list of properties whose help files should exist.
      Throws:
      Exception

    • submit

      public org.htmlunit.html.HtmlPage submit(org.htmlunit.html.HtmlForm form) throws Exception
      Submits the form. Plain HtmlForm.submit(SubmittableElement) doesn't work correctly due to the use of YUI in Jenkins.
      Throws:
      Exception

    • submit

      public org.htmlunit.html.HtmlPage submit(org.htmlunit.html.HtmlForm form, String name) throws Exception
      Submits the form by clicking the submit button of the given name.
      Parameters:
      name - This corresponds to the @name of <f:submit />
      Throws:
      Exception

    • findPreviousInputElement

      public org.htmlunit.html.HtmlInput findPreviousInputElement(org.htmlunit.html.HtmlElement current, String name)

    • getButtonByCaption

      public org.htmlunit.html.HtmlButton getButtonByCaption(org.htmlunit.html.HtmlForm f, String s)

    • createTaskListener

      public hudson.model.TaskListener createTaskListener()
      Creates a TaskListener connected to stdout.

    • assertEqualBeans

      public void assertEqualBeans(Object lhs, Object rhs, String properties) throws InvocationTargetException, IllegalAccessException, NoSuchMethodException
      Asserts that two JavaBeans are equal as far as the given list of properties are concerned.

      This method takes two objects that have properties (getXyz, isXyz, or just the public xyz field), and makes sure that the property values for each given property are equals (by using MatcherAssert.assertThat(Object, org.hamcrest.Matcher))

      Property values can be null on both objects, and that is OK, but passing in a property that doesn't exist will fail an assertion.

      This method is very convenient for comparing a large number of properties on two objects, for example to verify that the configuration is identical after a config screen roundtrip.

      Parameters:
      lhs - One of the two objects to be compared.
      rhs - The other object to be compared
      properties - ','-separated list of property names that are compared.
      Throws:
      InvocationTargetException
      IllegalAccessException
      NoSuchMethodException
      Since:
      1.297

    • setQuietPeriod

      @Deprecated public void setQuietPeriod(int qp)
      Deprecated.
      use Jenkins.setQuietPeriod(java.lang.Integer)

    • assertEqualDataBoundBeans

      public void assertEqualDataBoundBeans(Object lhs, Object rhs) throws InvocationTargetException, NoSuchMethodException, IllegalAccessException
      Works like assertEqualBeans(Object, Object, String) but figure out the properties via DataBoundConstructor and DataBoundSetter
      Throws:
      InvocationTargetException
      NoSuchMethodException
      IllegalAccessException

    • assertEqualDataBoundBeans

      public void assertEqualDataBoundBeans(List<?> lhs, List<?> rhs) throws Exception
      Makes sure that two collections are identical via assertEqualDataBoundBeans(Object, Object)
      Throws:
      Exception

    • findDataBoundConstructor

      public Constructor<?> findDataBoundConstructor(Class<?> c)

    • get

      public <T extends hudson.model.Descriptor<?>> T get(Class<T> d)
      Gets the descriptor instance of the current Hudson by its type.

    • isSomethingHappening

      public boolean isSomethingHappening()
      Returns true if Hudson is building something or going to build something.

    • waitUntilNoActivity

      public void waitUntilNoActivity() throws Exception
      Waits until Hudson finishes building everything, including those in the queue.
      Throws:
      Exception

    • waitUntilNoActivityUpTo

      public void waitUntilNoActivityUpTo(int timeout) throws Exception
      Waits until Hudson finishes building everything, including those in the queue, or fail the test if the specified timeout milliseconds is
      Throws:
      Exception

    • recipe

      public void recipe() throws Exception
      Called during the before() to give a test case an opportunity to control the test environment in which Hudson is run.

      One could override this method and call a series of withXXX methods, or you can use the annotations with Recipe meta-annotation.

      Throws:
      Exception

    • recipeLoadCurrentPlugin

      public void recipeLoadCurrentPlugin() throws Exception
      If this test harness is launched for a Jenkins plugin, locate the target/test-classes/the.jpl and add a recipe to install that to the new Jenkins.

      This file is created by maven-hpi-plugin at the testCompile phase when the current packaging is jpi.

      Throws:
      Exception

    • withNewHome

      public JenkinsRule withNewHome()

    • withExistingHome

      public JenkinsRule withExistingHome(File source) throws Exception
      Throws:
      Exception

    • withPresetData

      public JenkinsRule withPresetData(String name)
      Declares that this test case expects to start with one of the preset data sets. See test/src/main/preset-data/ for available datasets and what they mean.

    • with

      public JenkinsRule with(HudsonHomeLoader homeLoader)

    • executeOnServer

      public <V> V executeOnServer(Callable<V> c) throws Exception
      Executes the given closure on the server, by the servlet request handling thread, in the context of an HTTP request.

      In JenkinsRule, a thread that's executing the test code is different from the thread that carries out HTTP requests made through JenkinsRule.WebClient. But sometimes you want to make assertions and other calls with side-effect from within the request handling thread.

      This method allows you to do just that. It is useful for testing some methods that require StaplerRequest2 and StaplerResponse2, or getting the credential of the current user (via Jenkins.getAuthentication(), and so on.

      Parameters:
      c - The closure to be executed on the server.
      Returns:
      The return value from the closure.
      Throws:
      Exception - If a closure throws any exception, that exception will be carried forward.

    • writeReplace

      protected Object writeReplace()
      Sometimes a part of a test case may ends up creeping into the serialization tree of Saveable.save(), so detect that and flag that as an error.

    • createWebClient

      public JenkinsRule.WebClient createWebClient()
      Create a web client instance using the browser version returned by BrowserVersion.getDefault() with support for the Fetch API.

    • getTestDescription

      public org.junit.runner.Description getTestDescription()