Skip to content

The Unified and Autonomous Development Platform

Fix issue #641 - Able to mount directories under job workspace in run container step

Robin Shenb7c90f0ae31f
diff --git a/pom.xml b/pom.xml
index 66a10cf342..22e4651ea2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -579,7 +579,7 @@
</repositories>
<properties>
<commons.version>2.1.1</commons.version>
- <agent.version>1.2.17</agent.version>
+ <agent.version>1.3.0</agent.version>
<slf4j.version>1.7.30</slf4j.version>
<logback.version>1.2.0</logback.version>
<antlr.version>4.7.2</antlr.version>
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
index 3d843c47cb..82e65c4167 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
@@ -19,7 +19,8 @@ import io.onedev.server.model.Build;
import io.onedev.server.web.editable.annotation.Editable;
import io.onedev.server.web.editable.annotation.Interpolative;
-@Editable(order=150, name="Run Container")
+@Editable(order=150, name="Run Container", description="Run specified docker container. To access files in "
+ + "job workspace, either use environment variable <tt>JOB_WORKSPACE</tt>, or specify volume mounts")
public class RunContainerStep extends Step {
private static final long serialVersionUID = 1L;
@@ -32,6 +33,8 @@ public class RunContainerStep extends Step {
private String workingDir;
+ private List<VolumeMount> volumeMounts = new ArrayList<>();
+
private boolean useTTY;
@Override
@@ -39,7 +42,10 @@ public class RunContainerStep extends Step {
Map<String, String> envMap = new HashMap<>();
for (EnvVar var: getEnvVars())
envMap.put(var.getName(), var.getValue());
- return new RunContainerFacade(getImage(), getArgs(), envMap, getWorkingDir(), isUseTTY());
+ Map<String, String> mountMap = new HashMap<>();
+ for (VolumeMount mount: getVolumeMounts())
+ mountMap.put(mount.getSourcePath(), mount.getTargetPath());
+ return new RunContainerFacade(getImage(), getArgs(), envMap, getWorkingDir(), mountMap, isUseTTY());
}
@Editable(order=100, description="Specify container image to run. <b class='text-warning'>NOTE:</b> A shell must "
@@ -86,6 +92,15 @@ public class RunContainerStep extends Step {
this.envVars = envVars;
}
+ @Editable(order=500, description="Optionally mount directories or files under job workspace into container")
+ public List<VolumeMount> getVolumeMounts() {
+ return volumeMounts;
+ }
+
+ public void setVolumeMounts(List<VolumeMount> volumeMounts) {
+ this.volumeMounts = volumeMounts;
+ }
+
@Editable(order=10000, name="Enable TTY Mode", description="Many commands print outputs with ANSI colors in "
+ "TTY mode to help identifying problems easily. However some commands running in this mode may "
+ "wait for user input to cause build hanging. This can normally be fixed by adding extra options "
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/VolumeMount.java b/server-core/src/main/java/io/onedev/server/buildspec/step/VolumeMount.java
new file mode 100644
index 0000000000..4ce6e270fa
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/VolumeMount.java
@@ -0,0 +1,49 @@
+package io.onedev.server.buildspec.step;
+
+import java.io.Serializable;
+import java.util.List;
+
+import org.hibernate.validator.constraints.NotEmpty;
+
+import io.onedev.commons.codeassist.InputSuggestion;
+import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.web.editable.annotation.Editable;
+import io.onedev.server.web.editable.annotation.Interpolative;
+
+@Editable
+public class VolumeMount implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private String source;
+
+ private String target;
+
+ @Editable(order=100, description="Specify a path relative to job workspace to be used as mount source")
+ @Interpolative(variableSuggester="suggestVariables")
+ @NotEmpty
+ public String getSourcePath() {
+ return source;
+ }
+
+ public void setSourcePath(String sourcePath) {
+ this.source = sourcePath;
+ }
+
+ @Editable(order=200, description="Specify a path inside container to be used as mount target")
+ @Interpolative(variableSuggester="suggestVariables")
+ @NotEmpty
+ public String getTargetPath() {
+ return target;
+ }
+
+ public void setTargetPath(String targetPath) {
+ this.target = targetPath;
+ }
+
+ @SuppressWarnings("unused")
+ private static List<InputSuggestion> suggestVariables(String matchWith) {
+ return BuildSpec.suggestVariables(matchWith, false, false);
+ }
+
+}
diff --git a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
index 68dac31778..7bb0abc0e1 100644
--- a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
+++ b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
@@ -845,7 +845,21 @@ public class KubernetesExecutor extends JobExecutor implements Testable<TestData
"image", container.getImage());
if (runContainerFacade.isUseTTY())
stepContainerSpec.put("tty", true);
- stepContainerSpec.put("volumeMounts", commonVolumeMounts);
+
+ List<Object> volumeMounts = new ArrayList<>(commonVolumeMounts);
+ for (Map.Entry<String, String> entry: container.getVolumeMounts().entrySet()) {
+ String subPath = StringUtils.stripStart(entry.getKey(), "/\\");
+ if (osInfo.isWindows())
+ subPath = "workspace\\" + subPath;
+ else
+ subPath = "workspace/" + subPath;
+ volumeMounts.add(CollectionUtils.newLinkedHashMap(
+ "name", "build-home",
+ "mountPath", entry.getValue(),
+ "subPath", subPath));
+ }
+ stepContainerSpec.put("volumeMounts", volumeMounts);
+
List<Map<Object, Object>> envs = new ArrayList<>(commonEnvs);
for (Map.Entry<String, String> entry: container.getEnvMap().entrySet()) {
envs.add(CollectionUtils.newLinkedHashMap(
diff --git a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
index 2a01836d95..be666eb6ca 100644
--- a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
@@ -214,7 +214,8 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
private int runStepContainer(String image, @Nullable String entrypoint,
List<String> arguments, Map<String, String> environments,
- @Nullable String workingDir, List<Integer> position, boolean useTTY) {
+ @Nullable String workingDir, Map<String, String> volumeMounts,
+ List<Integer> position, boolean useTTY) {
String containerName = network + "-step-" + stringifyPosition(position);
Commandline docker = newDocker();
docker.addArgs("run", "--name=" + containerName, "--network=" + network);
@@ -223,6 +224,11 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
docker.addArgs("-v", getHostPath(hostBuildHome.getAbsolutePath()) + ":" + containerBuildHome);
+ for (Map.Entry<String, String> entry: volumeMounts.entrySet()) {
+ String hostPath = getHostPath(new File(hostWorkspace, entry.getKey()).getAbsolutePath());
+ docker.addArgs("-v", hostPath + ":" + entry.getValue());
+ }
+
if (entrypoint != null)
docker.addArgs("-w", containerWorkspace);
else if (workingDir != null)
@@ -294,7 +300,8 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
hostBuildHome, commandFacade, osInfo, hostAuthInfoHome.get() != null);
int exitCode = runStepContainer(execution.getImage(), entrypoint.executable(),
- entrypoint.arguments(), new HashMap<>(), null, position, commandFacade.isUseTTY());
+ entrypoint.arguments(), new HashMap<>(), null, new HashMap<>(),
+ position, commandFacade.isUseTTY());
if (exitCode != 0) {
jobLogger.error("Step \"" + stepNames + "\" is failed: Command exited with code " + exitCode);
@@ -310,7 +317,7 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
if (container.getArgs() != null)
arguments.addAll(Arrays.asList(StringUtils.parseQuoteTokens(container.getArgs())));
int exitCode = runStepContainer(container.getImage(), null, arguments, container.getEnvMap(),
- container.getWorkingDir(), position, rubContainerFacade.isUseTTY());
+ container.getWorkingDir(), container.getVolumeMounts(), position, rubContainerFacade.isUseTTY());
if (exitCode != 0) {
jobLogger.error("Step \"" + stepNames + "\" is failed: Container exited with code " + exitCode);
return false;
diff --git a/server-product/src/test/java/io/onedev/server/product/Test.java b/server-product/src/test/java/io/onedev/server/product/Test.java
index 684fdcd076..a96bf27a34 100644
--- a/server-product/src/test/java/io/onedev/server/product/Test.java
+++ b/server-product/src/test/java/io/onedev/server/product/Test.java
@@ -1,13 +1,9 @@
package io.onedev.server.product;
-import java.net.MalformedURLException;
-import java.net.URL;
-
public class Test {
@org.junit.Test
- public void test() throws MalformedURLException {
- System.out.println(new URL("ssh://localhost:6611").getHost());
+ public void test() {
}
}
\ No newline at end of file