Skip to content

fixed JENKINS-60473 #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

fixed JENKINS-60473 #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
de54b46
fixed JENKINS-60473
Dec 13, 2020
d801256
removed ambigous if-else
Dec 13, 2020
b04197f
added javadoc
Dec 14, 2020
abcaa62
fixed javadoc issues
Dec 15, 2020
95fa43e
correctly formatted the file
Dec 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 81 additions & 58 deletions src/main/java/org/jenkinsci/plugins/docker/workflow/WithContainerStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,40 +25,17 @@

import com.google.common.base.Optional;
import com.google.inject.Inject;
import hudson.AbortException;
import hudson.EnvVars;
import hudson.Extension;
import hudson.FilePath;
import hudson.Launcher;
import hudson.LauncherDecorator;
import hudson.Proc;
import hudson.Util;
import hudson.*;
import hudson.model.Computer;
import hudson.model.Node;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.slaves.WorkspaceList;
import hudson.util.VersionNumber;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.jenkinsci.plugins.docker.commons.tools.DockerTool;
import org.jenkinsci.plugins.docker.workflow.client.DockerClient;
import org.jenkinsci.plugins.docker.workflow.client.WindowsDockerClient;
import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl;
import org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl;
import org.jenkinsci.plugins.workflow.steps.AbstractStepImpl;
import org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback;
import org.jenkinsci.plugins.workflow.steps.BodyInvoker;
import org.jenkinsci.plugins.workflow.steps.StepContext;
import org.jenkinsci.plugins.workflow.steps.StepContextParameter;
import org.jenkinsci.plugins.workflow.steps.*;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;

Expand All @@ -68,22 +45,26 @@
import java.io.IOException;
import java.io.Serializable;
import java.nio.charset.Charset;
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;

public class WithContainerStep extends AbstractStepImpl {

private static final Logger LOGGER = Logger.getLogger(WithContainerStep.class.getName());
private final @Nonnull String image;
private final @Nonnull
String image;
private String args;
private String toolName;
private static boolean needToContainerizePath = false;

@DataBoundConstructor public WithContainerStep(@Nonnull String image) {
@DataBoundConstructor
public WithContainerStep(@Nonnull String image) {
this.image = image;
}

public String getImage() {
return image;
}
Expand All @@ -101,7 +82,8 @@ public String getToolName() {
return toolName;
}

@DataBoundSetter public void setToolName(String toolName) {
@DataBoundSetter
public void setToolName(String toolName) {
this.toolName = Util.fixEmpty(toolName);
}

Expand All @@ -112,22 +94,31 @@ private static void destroy(String container, Launcher launcher, Node node, EnvV
// TODO switch to GeneralNonBlockingStepExecution
public static class Execution extends AbstractStepExecutionImpl {
private static final long serialVersionUID = 1;
@Inject(optional=true) private transient WithContainerStep step;
@StepContextParameter private transient Launcher launcher;
@StepContextParameter private transient TaskListener listener;
@StepContextParameter private transient FilePath workspace;
@StepContextParameter private transient EnvVars env;
@StepContextParameter private transient Computer computer;
@StepContextParameter private transient Node node;
@Inject(optional = true)
private transient WithContainerStep step;
@StepContextParameter
private transient Launcher launcher;
@StepContextParameter
private transient TaskListener listener;
@StepContextParameter
private transient FilePath workspace;
@StepContextParameter
private transient EnvVars env;
@StepContextParameter
private transient Computer computer;
@StepContextParameter
private transient Node node;
@SuppressWarnings("rawtypes") // TODO not compiling on cloudbees.ci
@StepContextParameter private transient Run run;
@StepContextParameter
private transient Run run;
private String container;
private String toolName;

public Execution() {
}

@Override public boolean start() throws Exception {
@Override
public boolean start() throws Exception {
EnvVars envReduced = new EnvVars(env);
EnvVars envHost = computer.getEnvironment();
envReduced.entrySet().removeAll(envHost.entrySet());
Expand All @@ -140,10 +131,19 @@ public Execution() {
workspace.mkdirs(); // otherwise it may be owned by root when created for -v
String ws = getPath(workspace);
toolName = step.toolName;

DockerClient dockerClient = launcher.isUnix()
? new DockerClient(launcher, node, toolName)
: new WindowsDockerClient(launcher, node, toolName);

String containerOsType = dockerClient.inspect(new EnvVars(), step.image, ".Os");

if (!launcher.isUnix() && containerOsType != null && containerOsType.equalsIgnoreCase("linux")) {
needToContainerizePath = true;
dockerClient.setNeedToContainerizePath(true);
dockerClient.setContainerUnix(true);
}

VersionNumber dockerVersion = dockerClient.version();
if (dockerVersion != null) {
if (dockerVersion.isOlderThan(new VersionNumber("1.7"))) {
Expand Down Expand Up @@ -194,7 +194,8 @@ public Execution() {
volumes.put(tmp, tmp);
}

String command = launcher.isUnix() ? "cat" : "cmd.exe";
String command = dockerClient.runCommand();

container = dockerClient.run(env, step.image, step.args, ws, volumes, volumesFromContainers, envReduced, dockerClient.whoAmI(), /* expected to hang until killed */ command);
final List<String> ps = dockerClient.listProcess(env, container);
if (!ps.contains(command)) {
Expand All @@ -207,9 +208,9 @@ public Execution() {

ImageAction.add(step.image, run);
getContext().newBodyInvoker().
withContext(BodyInvoker.mergeLauncherDecorators(getContext().get(LauncherDecorator.class), new Decorator(container, envHost, ws, toolName, dockerVersion))).
withCallback(new Callback(container, toolName)).
start();
withContext(BodyInvoker.mergeLauncherDecorators(getContext().get(LauncherDecorator.class), new Decorator(container, envHost, ws, toolName, dockerVersion))).
withCallback(new Callback(container, toolName)).
start();
return false;
}

Expand All @@ -227,7 +228,8 @@ private static FilePath tempDir(FilePath ws) {
return ws.sibling(ws.getName() + System.getProperty(WorkspaceList.class.getName(), "@") + "tmp");
}

@Override public void stop(@Nonnull Throwable cause) throws Exception {
@Override
public void stop(@Nonnull Throwable cause) throws Exception {
if (container != null) {
LOGGER.log(Level.FINE, "stopping container " + container, cause);
destroy(container, launcher, getContext().get(Node.class), env, toolName);
Expand All @@ -242,7 +244,8 @@ private static class Decorator extends LauncherDecorator implements Serializable
private final String container;
private final String[] envHost;
private final String ws;
private final @CheckForNull String toolName;
private final @CheckForNull
String toolName;
private final boolean hasEnv;
private final boolean hasWorkdir;

Expand All @@ -255,9 +258,11 @@ private static class Decorator extends LauncherDecorator implements Serializable
this.hasWorkdir = dockerVersion != null && dockerVersion.compareTo(new VersionNumber("17.12")) >= 0;
}

@Override public Launcher decorate(final Launcher launcher, final Node node) {
@Override
public Launcher decorate(final Launcher launcher, final Node node) {
return new Launcher.DecoratedLauncher(launcher) {
@Override public Proc launch(Launcher.ProcStarter starter) throws IOException {
@Override
public Proc launch(Launcher.ProcStarter starter) throws IOException {
String executable;
try {
executable = getExecutable();
Expand Down Expand Up @@ -311,8 +316,8 @@ private static class Decorator extends LauncherDecorator implements Serializable
masksPrefixList.add(false);
prefix.addAll(envReduced);
masksPrefixList.addAll(envReduced.stream()
.map(v -> true)
.collect(Collectors.toList()));
.map(v -> true)
.collect(Collectors.toList()));
}

boolean[] originalMasks = starter.masks();
Expand All @@ -332,17 +337,28 @@ private static class Decorator extends LauncherDecorator implements Serializable
System.arraycopy(originalMasks, 0, masks, prefix.size(), originalMasks.length);
starter.masks(masks);

if (needToContainerizePath && ws != null) {
String wsTrimmed = ws.replaceAll("[/\\\\]+$", "");
List<String> cmds = starter.cmds();
for (int i = 0; i < cmds.size(); i++) {
cmds.set(i, WindowsDockerClient.containerizePath(cmds.get(i), wsTrimmed));
}
}

return super.launch(starter);
}
@Override public void kill(Map<String,String> modelEnvVars) throws IOException, InterruptedException {

@Override
public void kill(Map<String, String> modelEnvVars) throws IOException, InterruptedException {
ByteArrayOutputStream baos = new ByteArrayOutputStream();
String executable = getExecutable();
if (getInner().launch().cmds(executable, "exec", container, "ps", "-A", "-o", "pid,command", "e").stdout(baos).quiet(true).start().joinWithTimeout(DockerClient.CLIENT_TIMEOUT, TimeUnit.SECONDS, listener) != 0) {
throw new IOException("failed to run ps");
}
List<String> pids = new ArrayList<String>();
LINE: for (String line : baos.toString(Charset.defaultCharset().name()).split("\n")) {
for (Map.Entry<String,String> entry : modelEnvVars.entrySet()) {
LINE:
for (String line : baos.toString(Charset.defaultCharset().name()).split("\n")) {
for (Map.Entry<String, String> entry : modelEnvVars.entrySet()) {
// TODO this is imprecise: false positive when argv happens to match KEY=value even if environment does not. Cf. trick in BourneShellScript.
if (!line.contains(entry.getKey() + "=" + entry.getValue())) {
continue LINE;
Expand All @@ -364,6 +380,7 @@ private static class Decorator extends LauncherDecorator implements Serializable
}
}
}

private String getExecutable() throws IOException, InterruptedException {
EnvVars env = new EnvVars();
for (String pair : envHost) {
Expand All @@ -387,31 +404,37 @@ private static class Callback extends BodyExecutionCallback.TailCall {
this.toolName = toolName;
}

@Override protected void finished(StepContext context) throws Exception {
@Override
protected void finished(StepContext context) throws Exception {
destroy(container, context.get(Launcher.class), context.get(Node.class), context.get(EnvVars.class), toolName);
}

}

@Extension public static class DescriptorImpl extends AbstractStepDescriptorImpl {
@Extension
public static class DescriptorImpl extends AbstractStepDescriptorImpl {

public DescriptorImpl() {
super(Execution.class);
}

@Override public String getFunctionName() {
@Override
public String getFunctionName() {
return "withDockerContainer";
}

@Override public String getDisplayName() {
@Override
public String getDisplayName() {
return "Run build steps inside a Docker container";
}

@Override public boolean takesImplicitBlockArgument() {
@Override
public boolean takesImplicitBlockArgument() {
return true;
}

@Override public boolean isAdvanced() {
@Override
public boolean isAdvanced() {
return true;
}

Expand Down
Loading