Skip to content
Permalink
Browse files
Merge pull request #93 from abayer/jenkins-40866
[JENKINS-40866] Docker agent in stage can reuse global node
  • Loading branch information
abayer committed Jan 19, 2017
2 parents b4d556f + 747764d commit 3222d5ababdf848fe7b81d78f40140330a9d6051
@@ -0,0 +1,85 @@
/*
* The MIT License
*
* Copyright (c) 2017, CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

package org.jenkinsci.plugins.pipeline.modeldefinition.agent;

import org.kohsuke.stapler.DataBoundSetter;

import javax.annotation.CheckForNull;
import javax.annotation.Nullable;

public abstract class AbstractDockerAgent<D extends AbstractDockerAgent<D>> extends DeclarativeAgent<D> {
protected String label;
protected String args = "";
protected String registryUrl;
protected String registryCredentialsId;
protected boolean reuseNode;

public @Nullable
String getRegistryUrl() {
return registryUrl;
}

@DataBoundSetter
public void setRegistryUrl(String registryUrl) {
this.registryUrl = registryUrl;
}

public @Nullable String getRegistryCredentialsId() {
return registryCredentialsId;
}

@DataBoundSetter
public void setRegistryCredentialsId(String registryCredentialsId) {
this.registryCredentialsId = registryCredentialsId;
}

public boolean getReuseNode() {
return reuseNode;
}

@DataBoundSetter
public void setReuseNode(boolean reuseNode) {
this.reuseNode = reuseNode;
}

public @CheckForNull
String getLabel() {
return label;
}

@DataBoundSetter
public void setLabel(String label) {
this.label = label;
}

public @CheckForNull String getArgs() {
return args;
}

@DataBoundSetter
public void setArgs(String args) {
this.args = args;
}
}
@@ -40,6 +40,7 @@ public class DockerPipeline extends DeclarativeAgent<DockerPipeline> {
private String args = "";
private String registryUrl;
private String registryCredentialsId;
private boolean reuseNode;

@DataBoundConstructor
public DockerPipeline(@Nonnull String image) {
@@ -64,6 +65,14 @@ public void setRegistryCredentialsId(String registryCredentialsId) {
this.registryCredentialsId = registryCredentialsId;
}

public boolean getReuseNode() {
return reuseNode;
}

@DataBoundSetter
public void setReuseNode(boolean reuseNode) {
this.reuseNode = reuseNode;
}

public @Nullable String getLabel() {
return label;
@@ -26,6 +26,7 @@

import hudson.Extension;
import org.jenkinsci.Symbol;
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.AbstractDockerAgent;
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent;
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentDescriptor;
import org.kohsuke.stapler.DataBoundConstructor;
@@ -35,53 +36,13 @@
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class DockerPipelineFromDockerfile extends DeclarativeAgent<DockerPipelineFromDockerfile> {
private String label;
public class DockerPipelineFromDockerfile extends AbstractDockerAgent<DockerPipelineFromDockerfile> {
private String filename;
private String args = "";
private String registryUrl;
private String registryCredentialsId;

@DataBoundConstructor
public DockerPipelineFromDockerfile() {
}

public @Nullable String getRegistryUrl() {
return registryUrl;
}

@DataBoundSetter
public void setRegistryUrl(String registryUrl) {
this.registryUrl = registryUrl;
}

public @Nullable String getRegistryCredentialsId() {
return registryCredentialsId;
}

@DataBoundSetter
public void setRegistryCredentialsId(String registryCredentialsId) {
this.registryCredentialsId = registryCredentialsId;
}

public @CheckForNull String getLabel() {
return label;
}

@DataBoundSetter
public void setLabel(String label) {
this.label = label;
}

public @CheckForNull String getArgs() {
return args;
}

@DataBoundSetter
public void setArgs(String args) {
this.args = args;
}

public @Nonnull Object getFilename() {
return filename;
}
@@ -0,0 +1,73 @@
/*
* The MIT License
*
* Copyright (c) 2017, CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/


package org.jenkinsci.plugins.pipeline.modeldefinition.agent.impl

import hudson.FilePath
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentScript
import org.jenkinsci.plugins.pipeline.modeldefinition.steps.DeclarativePropsStep
import org.jenkinsci.plugins.workflow.cps.CpsScript

public abstract class AbstractDockerPipelineScript<A extends DeclarativeAgent<A>> extends DeclarativeAgentScript<A> {

public AbstractDockerPipelineScript(CpsScript s, A a) {
super(s, a)
}

@Override
public Closure run(Closure body) {
if (describable.reuseNode && script.getContext(FilePath.class) != null) {
return {
configureRegistry(body).call()
}
} else {
String targetLabel = script.declarativeProps(property: DeclarativePropsStep.Property.LABEL,
override: describable.label)
LabelScript labelScript = (LabelScript) Label.DescriptorImpl.instanceForName("label", [label: targetLabel]).getScript(script)
return labelScript.run {
configureRegistry(body).call()
}
}
}

protected Closure configureRegistry(Closure body) {
return {
String registryUrl = script.declarativeProps(property: DeclarativePropsStep.Property.REGISTRY_URL,
override: describable.registryUrl)
String registryCreds = script.declarativeProps(property: DeclarativePropsStep.Property.REGISTRY_CREDENTIALS,
override: describable.registryCredentialsId)
if (registryUrl != null) {
script.getProperty("docker").withRegistry(registryUrl, registryCreds) {
runImage(body).call()
}
} else {
runImage(body).call()
}
}
}

protected abstract Closure runImage(Closure body)
}
@@ -28,36 +28,16 @@ package org.jenkinsci.plugins.pipeline.modeldefinition.agent.impl
import hudson.model.Result
import org.jenkinsci.plugins.pipeline.modeldefinition.SyntheticStageNames
import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentScript
import org.jenkinsci.plugins.pipeline.modeldefinition.steps.DeclarativePropsStep

import org.jenkinsci.plugins.workflow.cps.CpsScript

public class DockerPipelineFromDockerfileScript extends DeclarativeAgentScript<DockerPipelineFromDockerfile> {
public class DockerPipelineFromDockerfileScript extends AbstractDockerPipelineScript<DockerPipelineFromDockerfile> {

public DockerPipelineFromDockerfileScript(CpsScript s, DockerPipelineFromDockerfile a) {
super(s, a)
}

@Override
public Closure run(Closure body) {
String targetLabel = script.declarativeProps(property: DeclarativePropsStep.Property.LABEL,
override: describable.label)
LabelScript labelScript = (LabelScript) Label.DescriptorImpl.instanceForName("label", [label: targetLabel]).getScript(script)
return labelScript.run {
String registryUrl = script.declarativeProps(property: DeclarativePropsStep.Property.REGISTRY_URL,
override: describable.registryUrl)
String registryCreds = script.declarativeProps(property: DeclarativePropsStep.Property.REGISTRY_CREDENTIALS,
override: describable.registryCredentialsId)
if (registryUrl != null) {
script.getProperty("docker").withRegistry(registryUrl, registryCreds) {
runImage(body).call()
}
} else {
runImage(body).call()
}
}
}

public Closure runImage(Closure body) {
return {
def img = null
@@ -95,7 +75,9 @@ public class DockerPipelineFromDockerfileScript extends DeclarativeAgentScript<D

private Closure buildImage() {
return {
script.checkout script.scm
if (!script.fileExists(describable.getDockerfileAsString())) {
script.checkout script.scm
}
try {
def hash = Utils.stringToSHA1(script.readFile(describable.getDockerfileAsString()))
def imgName = "${hash}"
@@ -28,37 +28,15 @@ package org.jenkinsci.plugins.pipeline.modeldefinition.agent.impl
import hudson.model.Result
import org.jenkinsci.plugins.pipeline.modeldefinition.SyntheticStageNames
import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent
import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentScript
import org.jenkinsci.plugins.pipeline.modeldefinition.steps.DeclarativePropsStep
import org.jenkinsci.plugins.workflow.cps.CpsScript

public class DockerPipelineScript extends DeclarativeAgentScript<DockerPipeline> {
public class DockerPipelineScript extends AbstractDockerPipelineScript<DockerPipeline> {

public DockerPipelineScript(CpsScript s, DockerPipeline a) {
super(s, a)
}

@Override
public Closure run(Closure body) {
String targetLabel = script.declarativeProps(property: DeclarativePropsStep.Property.LABEL,
override: describable.label)
LabelScript labelScript = (LabelScript) Label.DescriptorImpl.instanceForName("label", [label: targetLabel]).getScript(script)
return labelScript.run {
String registryUrl = script.declarativeProps(property: DeclarativePropsStep.Property.REGISTRY_URL,
override: describable.registryUrl)
String registryCreds = script.declarativeProps(property: DeclarativePropsStep.Property.REGISTRY_CREDENTIALS,
override: describable.registryCredentialsId)
if (registryUrl != null) {
script.getProperty("docker").withRegistry(registryUrl, registryCreds) {
runImage(body).call()
}
} else {
runImage(body).call()
}
}
}

public Closure runImage(Closure body) {
return {
if (!Utils.withinAStage()) {
@@ -78,6 +78,23 @@ public void agentDocker() throws Exception {
agentDocker("agentDocker", "-v /tmp:/tmp -p 80:80");
}

@Test
public void agentDockerReuseNode() throws Exception {
agentDocker("agentDockerReuseNode");
}

@Test
public void agentDockerDontReuseNode() throws Exception {
assumeDocker();
// Bind mounting /var on OS X doesn't work at the moment
onAllowedOS(PossibleOS.LINUX);

expect(Result.FAILURE, "agentDockerDontReuseNode")
.logContains("The answer is 42")
.go();

}

@Test
public void agentDockerWithNullDockerArgs() throws Exception {
agentDocker("agentDockerWithNullDockerArgs");

0 comments on commit 3222d5a

Please sign in to comment.