io.jenkins.jenkinsfile.runner

Class JenkinsEmbedder

java.lang.Object

io.jenkins.jenkinsfile.runner.JenkinsEmbedder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction

Direct Known Subclasses:

JenkinsLauncher

public abstract class JenkinsEmbedder
extends Object
implements hudson.model.RootAction

Some code is inherited from JenkinsEmbedder in Jenkins Test Harness

Author:

Stephen Connolly, Oleg Nenashev

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	contextPath Where in the Server is Jenkins deployed?
protected ExecutionEnvironment	env
protected HudsonHomeLoader	homeLoader
jenkins.model.Jenkins	jenkins
protected int	localPort TCP/IP port that the server is listening on.
static org.eclipse.jetty.http.MimeTypes	MIME_TYPES
static List<hudson.tools.ToolProperty<?>>	NO_PROPERTIES
protected List<JenkinsRecipe.Runner>	recipes
protected org.eclipse.jetty.server.Server	server
protected List<LenientRunnable>	tearDowns Runnables to be invoked at after() .

Constructor Summary

Constructors

Constructor and Description
JenkinsEmbedder()

Method Summary

Modifier and Type	Method and Description
void	after() Override to tear down your specific external resource.
void	before() Override to set up your specific external resource.
protected void	configureUpdateCenter() Configures the update center setting for the test.
protected abstract org.eclipse.jetty.security.LoginService	configureUserRealm()
hudson.Launcher.LocalLauncher	createLocalLauncher() Creates Launcher.LocalLauncher.
hudson.model.TaskListener	createTaskListener() Creates a TaskListener connected to stdout.
protected String	createUniqueProjectName()
protected abstract javax.servlet.ServletContext	createWebServer() Prepares a webapp hosting environment to get ServletContext implementation that we need for testing.
String	getDisplayName()
String	getIconFileName()
jenkins.model.Jenkins	getInstance()
hudson.PluginManager	getPluginManager()
URL	getURL() Returns the URL of the webapp top page.
String	getUrlName()
File	getWebAppRoot()
void	interactiveBreak() Blocks until the ENTER key is hit.
boolean	isSomethingHappening() Returns true if Hudson is building something or going to build something.
protected hudson.model.Hudson	newHudson() Creates a new instance of Jenkins.
void	pause() Pauses the execution until ENTER is hit in the console.
abstract void	recipe()
void	setPluginManager(hudson.PluginManager pluginManager) Sets the PluginManager to be used when creating a new Jenkins instance.
void	setQuietPeriod(int qp)
void	waitUntilNoActivity() Waits until Hudson finishes building everything, including those in the queue.
void	waitUntilNoActivityUpTo(int timeout) Waits until Hudson finishes building everything, including those in the queue, or fail the test if the specified timeout milliseconds is
JenkinsEmbedder	with(HudsonHomeLoader homeLoader)
JenkinsEmbedder	with(hudson.PluginManager pluginManager)
JenkinsEmbedder	withExistingHome(File source)
JenkinsEmbedder	withNewHome()
JenkinsEmbedder	withPresetData(String name) Declares that this test case expects to start with one of the preset data sets.

Methods inherited from class java.lang.Object

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

Field Detail

env

protected ExecutionEnvironment env

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 '/'.

tearDowns

protected List<LenientRunnable> tearDowns

Runnables to be invoked at after() .

recipes

protected List<JenkinsRecipe.Runner> recipes

NO_PROPERTIES

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

MIME_TYPES

public static final org.eclipse.jetty.http.MimeTypes MIME_TYPES

Constructor Detail

JenkinsEmbedder

public JenkinsEmbedder()

Method Detail

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

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

after

public void after()
           throws Exception

Override to tear down your specific external resource.

Throws:

Exception

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 JenkinsEmbedder with(hudson.PluginManager pluginManager)

getWebAppRoot

public File getWebAppRoot()
                   throws Exception

Throws:

Exception

createWebServer

protected abstract javax.servlet.ServletContext createWebServer()
                                                         throws Exception

Prepares a webapp hosting environment to get ServletContext implementation that we need for testing.

Throws:

Exception

createUniqueProjectName

protected String createUniqueProjectName()

createLocalLauncher

public hudson.Launcher.LocalLauncher createLocalLauncher()

Creates Launcher.LocalLauncher. Useful for launching processes.

getURL

public URL getURL()
           throws IOException

Returns the URL of the webapp top page. URL ends with '/'.

Throws:

IOException

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

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

createTaskListener

public hudson.model.TaskListener createTaskListener()

Creates a TaskListener connected to stdout.

setQuietPeriod

public void setQuietPeriod(int qp)
                    throws IOException

Throws:

IOException

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 abstract void recipe()
                     throws Exception

Throws:

Exception

withNewHome

public JenkinsEmbedder withNewHome()

withExistingHome

public JenkinsEmbedder withExistingHome(File source)
                                 throws Exception

Throws:

Exception

withPresetData

public JenkinsEmbedder 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 JenkinsEmbedder with(HudsonHomeLoader homeLoader)

configureUserRealm

protected abstract org.eclipse.jetty.security.LoginService configureUserRealm()