io.jenkins.jenkinsfile.runner

Class JenkinsLauncher

java.lang.Object

io.jenkins.jenkinsfile.runner.JenkinsEmbedder

io.jenkins.jenkinsfile.runner.JenkinsLauncher

All Implemented Interfaces:

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

Direct Known Subclasses:

CLILauncher, JenkinsfileRunnerLauncher

public abstract class JenkinsLauncher
extends JenkinsEmbedder

Shared behaviour for different modes of launching an embedded Jenkins in the context of jenkinsfile-runner.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected Bootstrap	bootstrap

Fields inherited from class io.jenkins.jenkinsfile.runner.JenkinsEmbedder

contextPath, env, homeLoader, jenkins, localPort, MIME_TYPES, NO_PROPERTIES, recipes, server, tearDowns

Constructor Summary

Constructors

Constructor and Description
JenkinsLauncher(Bootstrap bootstrap)

Method Summary

Modifier and Type	Method and Description
void	after() Skips the clean up.
void	before() Override to set up your specific external resource.
protected org.eclipse.jetty.security.LoginService	configureUserRealm() Supply a dummy LoginService that allows nobody.
protected javax.servlet.ServletContext	createWebServer() Sets up Jetty without any actual TCP port serving HTTP.
protected abstract int	doLaunch() Actually launches the Jenkins instance, without any time out or output message.
protected abstract String	getThreadName()
int	launch()
void	recipe()
protected void	setupHome(File home) Prepare the newly allocated home with additional files.

Methods inherited from class io.jenkins.jenkinsfile.runner.JenkinsEmbedder

configureUpdateCenter, createLocalLauncher, createTaskListener, createUniqueProjectName, getDisplayName, getIconFileName, getInstance, getPluginManager, getURL, getUrlName, getWebAppRoot, interactiveBreak, isSomethingHappening, newJenkins, pause, setPluginManager, setQuietPeriod, waitUntilNoActivity, waitUntilNoActivityUpTo, with, with, withExistingHome, withNewHome, withPresetData

Methods inherited from class java.lang.Object

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

Field Detail

bootstrap

protected final Bootstrap bootstrap

Constructor Detail

JenkinsLauncher

public JenkinsLauncher(Bootstrap bootstrap)

Method Detail

createWebServer

protected javax.servlet.ServletContext createWebServer()
                                                throws Exception

Sets up Jetty without any actual TCP port serving HTTP.

Specified by:

createWebServer in class JenkinsEmbedder

Throws:

Exception

launch

public int launch()
           throws Throwable

Throws:

Throwable

getThreadName

protected abstract String getThreadName()

Returns:

the thread name to use for executing the action

doLaunch

protected abstract int doLaunch()
                         throws Exception

Actually launches the Jenkins instance, without any time out or output message.

Returns:

the return code for the process

Throws:

Exception

recipe

public void recipe()

Specified by:

recipe in class JenkinsEmbedder

configureUserRealm

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

Supply a dummy LoginService that allows nobody.

Specified by:

configureUserRealm in class JenkinsEmbedder

before

public void before()
            throws Throwable

Description copied from class: JenkinsEmbedder

Override to set up your specific external resource.

Overrides:

before in class JenkinsEmbedder

Throws:

Throwable - if setup fails (which will disable after

after

public void after()
           throws Exception

Skips the clean up. This was initially motivated by SLF4J leaving gnarly messages. The whole JVM is going to die anyway, so we don't really care about cleaning up anything nicely.

Overrides:

after in class JenkinsEmbedder

Throws:

Exception

setupHome

protected void setupHome(File home)
                  throws IOException

Description copied from class: JenkinsEmbedder

Prepare the newly allocated home with additional files. Currently only Groovy Hooks

Specified by:

setupHome in class JenkinsEmbedder

Parameters:

home - the target home directory (freshly allocated)

Throws:

IOException - any issue during the copy should interrupt the execution