com.github.kostyasha.yad.steps

Class DockerShellStep

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.github.kostyasha.yad.steps.DockerShellStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class DockerShellStep
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Author:

Kanstantsin Shautsou

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerShellStep.DescriptorImpl
static class	DockerShellStep.MyAttachContainerResultCallback

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
DockerShellStep()

Method Summary

Modifier and Type	Method and Description
protected static void	addRunVars(hudson.model.Run run, hudson.model.TaskListener listener, com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.command.CreateContainerCmd containerConfig)
protected void	appendContainerConfig(hudson.model.Run<?,?> run, hudson.model.TaskListener listener, com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.command.CreateContainerCmd containerConfig, YADockerConnector connector)
YADockerConnector	getConnector()
DockerContainerLifecycle	getContainerLifecycle()
protected static hudson.EnvVars	getEnvVars(hudson.model.Run run, hudson.model.TaskListener listener) Return all job related vars without executor vars.
String	getExecutorScript()
YADockerConnector	getLongConnector()
String	getShellScript()
protected static void	insertLabels(com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.command.CreateContainerCmd containerConfig, hudson.model.Run run) Append some tags to identify who created this container.
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setConnector(YADockerConnector connector)
void	setContainerLifecycle(DockerContainerLifecycle containerLifecycle)
void	setExecutorScript(String executorScript)
void	setLongConnector(YADockerConnector longConnector)
void	setShellScript(String shellScript)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

DockerShellStep

@DataBoundConstructor
public DockerShellStep()

Method Detail

getConnector

public YADockerConnector getConnector()

setConnector

@DataBoundSetter
public void setConnector(YADockerConnector connector)

getLongConnector

@CheckForNull
public YADockerConnector getLongConnector()

setLongConnector

@DataBoundSetter
public void setLongConnector(@CheckForNull
                                              YADockerConnector longConnector)

getContainerLifecycle

public DockerContainerLifecycle getContainerLifecycle()

setContainerLifecycle

@DataBoundSetter
public void setContainerLifecycle(DockerContainerLifecycle containerLifecycle)

getShellScript

@CheckForNull
public String getShellScript()

setShellScript

@DataBoundSetter
public void setShellScript(String shellScript)

getExecutorScript

@CheckForNull
public String getExecutorScript()

setExecutorScript

@DataBoundSetter
public void setExecutorScript(String executorScript)

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> run,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

appendContainerConfig

protected void appendContainerConfig(hudson.model.Run<?,?> run,
                                     hudson.model.TaskListener listener,
                                     com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.command.CreateContainerCmd containerConfig,
                                     YADockerConnector connector)

addRunVars

protected static void addRunVars(hudson.model.Run run,
                                 hudson.model.TaskListener listener,
                                 com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.command.CreateContainerCmd containerConfig)

getEnvVars

protected static hudson.EnvVars getEnvVars(hudson.model.Run run,
                                           hudson.model.TaskListener listener)
                                    throws IOException,
                                           InterruptedException

Return all job related vars without executor vars. I.e. slave is running in osx, but docker image for shell is linux.

Throws:

IOException

InterruptedException

insertLabels

protected static void insertLabels(com.github.kostyasha.yad_docker_java.com.github.dockerjava.api.command.CreateContainerCmd containerConfig,
                                   hudson.model.Run run)

Append some tags to identify who created this container.