The Unified and Autonomous Development Platform
feat(workspace): Add configurable teardown script support
Robin Shenf5a36c2127eb
diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PosixShell.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PosixShell.javaindex 5a0af32f88..9f009f9aa8 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PosixShell.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PosixShell.java@@ -39,6 +39,19 @@ public class PosixShell extends WorkspaceShell {super.setSetupCommands(setupCommands);}+ @Editable(order=300, descriptionProvider="getTeardownCommandDescription")+ @Interpolative+ @Code(language=Code.SHELL, variableProvider="suggestVariables")+ @Override+ public String getTeardownCommands() {+ return super.getTeardownCommands();+ }++ @Override+ public void setTeardownCommands(String teardownCommands) {+ super.setTeardownCommands(teardownCommands);+ }+@Overridepublic ShellFacility getFacility() {return new PosixFacility(shell);diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PowerShell.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PowerShell.javaindex 60a2b70032..6398ec44ab 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PowerShell.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/PowerShell.java@@ -39,6 +39,19 @@ public class PowerShell extends WorkspaceShell {super.setSetupCommands(setupCommands);}+ @Editable(order=200, descriptionProvider="getTeardownCommandDescription")+ @Code(language=Code.POWER_SHELL, variableProvider="suggestVariables")+ @Interpolative+ @Override+ public String getTeardownCommands() {+ return super.getTeardownCommands();+ }++ @Override+ public void setTeardownCommands(String teardownCommands) {+ super.setTeardownCommands(teardownCommands);+ }+@Overridepublic ShellFacility getFacility() {return new PowerShellFacility(powershell);diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WindowsBatchShell.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WindowsBatchShell.javaindex d46e653f71..e206bd5251 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WindowsBatchShell.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WindowsBatchShell.java@@ -24,6 +24,19 @@ public class WindowsBatchShell extends WorkspaceShell {super.setSetupCommands(setupCommands);}+ @Editable(order=200, descriptionProvider="getTeardownCommandDescription")+ @Interpolative+ @Code(language=Code.SHELL, variableProvider="suggestVariables")+ @Override+ public String getTeardownCommands() {+ return super.getTeardownCommands();+ }++ @Override+ public void setTeardownCommands(String teardownCommands) {+ super.setTeardownCommands(teardownCommands);+ }+@Overridepublic ShellFacility getFacility() {return new WindowsBatchFacility();diff --git a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WorkspaceShell.java b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WorkspaceShell.javaindex 75e6e01995..78b4d950e2 100644--- a/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WorkspaceShell.java+++ b/server-core/src/main/java/io/onedev/server/model/support/workspace/spec/shell/WorkspaceShell.java@@ -18,6 +18,8 @@ public abstract class WorkspaceShell implements Serializable {protected static final String CHECK_TOD_VERSION_COMMAND = "tod check-version";private String setupCommands;++ private String teardownCommands;public String getSetupCommands() {return setupCommands;@@ -27,6 +29,14 @@ public abstract class WorkspaceShell implements Serializable {this.setupCommands = setupCommands;}+ public String getTeardownCommands() {+ return teardownCommands;+ }++ public void setTeardownCommands(String teardownCommands) {+ this.teardownCommands = teardownCommands;+ }+public abstract ShellFacility getFacility();public abstract String decorateRunPromptCommand(String command, String systemPrompt, String userPrompt,@@ -46,5 +56,13 @@ public abstract class WorkspaceShell implements Serializable {run from working directory holding cloned repository files. It runs after cache anduser data restored and config files generated""");}++ protected static String getTeardownCommandDescription() {+ return _T("""+ Optionally specify shell commands to run to tear down the workspace. These commands will+ run from working directory holding cloned repository files when the workspace is being+ stopped, before cache and user data are uploaded. Failure of these commands will be+ logged without affecting the upload""");+ }}diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.javaindex 95013a985e..5854edf167 100644--- a/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/resource/WorkerResource.java@@ -286,7 +286,7 @@ public class WorkerResource {context.getCacheConfigFacades(),context.getUserDataFacades(),context.getConfigFileFacades(),- context.getSetupScriptConfig());+ context.getScriptConfig());return SerializationUtils.serialize(data);}diff --git a/server-core/src/main/java/io/onedev/server/workspace/WorkspaceContext.java b/server-core/src/main/java/io/onedev/server/workspace/WorkspaceContext.javaindex 16eaeb83a1..adb975736b 100644--- a/server-core/src/main/java/io/onedev/server/workspace/WorkspaceContext.java+++ b/server-core/src/main/java/io/onedev/server/workspace/WorkspaceContext.java@@ -12,7 +12,7 @@ import org.jspecify.annotations.Nullable;import io.onedev.k8shelper.CacheConfigFacade;import io.onedev.k8shelper.CloneInfo;import io.onedev.k8shelper.ConfigFileFacade;-import io.onedev.k8shelper.SetupScriptConfig;+import io.onedev.k8shelper.ScriptConfig;import io.onedev.k8shelper.UserDataFacade;import io.onedev.server.model.support.administration.workspaceprovisioner.WorkspaceProvisioner;import io.onedev.server.model.support.workspace.spec.CacheConfig;@@ -161,18 +161,20 @@ public class WorkspaceContext implements Serializable {.collect(toList());}- @Nullable- public SetupScriptConfig getSetupScriptConfig() {+ public ScriptConfig getScriptConfig() {var shell = spec.getShell();- if (shell.getSetupCommands() != null) {- return new SetupScriptConfig(- shell.getFacility().normalizeCommands(shell.getSetupCommands()),- shell.getFacility().getScriptExtension(),- shell.getFacility().getExecutable(),- shell.getFacility().getScriptOptions());- } else {- return null;- }+ var facility = shell.getFacility();+ return new ScriptConfig(+ normalizeCommands(shell.getSetupCommands()),+ normalizeCommands(shell.getTeardownCommands()),+ facility.getScriptExtension(),+ facility.getExecutable(),+ facility.getScriptOptions());+ }++ @Nullable+ private String normalizeCommands(@Nullable String commands) {+ return commands != null ? spec.getShell().getFacility().normalizeCommands(commands) : null;}}diff --git a/server-ee b/server-eeindex b721b068e9..5d4394a20a 160000--- a/server-ee+++ b/server-ee@@ -1 +1 @@-Subproject commit b721b068e99c4b01cff6d7fd0491e057229d0c7d+Subproject commit 5d4394a20a36468554408d680da4969ab2b9a7f3diff --git a/server-plugin/server-plugin-provisioner-serverdocker/src/main/java/io/onedev/server/plugin/provisioner/serverdocker/ServerDockerProvisioner.java b/server-plugin/server-plugin-provisioner-serverdocker/src/main/java/io/onedev/server/plugin/provisioner/serverdocker/ServerDockerProvisioner.javaindex 06a4ba3508..59283759ac 100644--- a/server-plugin/server-plugin-provisioner-serverdocker/src/main/java/io/onedev/server/plugin/provisioner/serverdocker/ServerDockerProvisioner.java+++ b/server-plugin/server-plugin-provisioner-serverdocker/src/main/java/io/onedev/server/plugin/provisioner/serverdocker/ServerDockerProvisioner.java@@ -37,6 +37,7 @@ import org.apache.commons.lang3.SystemUtils;import org.jspecify.annotations.Nullable;import io.onedev.agent.AgentUtils;+import io.onedev.agent.AwaitableFutureTask;import io.onedev.agent.workspace.FileData;import io.onedev.agent.workspace.GitExecutionResult;import io.onedev.agent.workspace.WorkspaceUtils;@@ -346,10 +347,9 @@ public class ServerDockerProvisioner extends WorkspaceProvisioner implements Docvar containerWorkspacePath = WORKSPACE_PATH;- var setupScriptConfig = context.getSetupScriptConfig();- var entrypointArgs = WorkspaceHelper.buildEntrypointArgs(setupScriptConfig, true);- if (setupScriptConfig != null)- WorkspaceHelper.writeSetupScript(workspaceDir, setupScriptConfig);+ var scriptConfig = context.getScriptConfig();+ var entrypointArgs = WorkspaceHelper.buildEntrypointArgs(scriptConfig, true);+ WorkspaceHelper.writeScripts(workspaceDir, scriptConfig);var containerReadyFile = new File(workspaceDir, CONTAINER_READY_FILE);if (containerReadyFile.exists())@@ -386,7 +386,7 @@ public class ServerDockerProvisioner extends WorkspaceProvisioner implements Doc});}- var future = OneDev.getInstance(ExecutorService.class).submit(() -> {+ var future = new AwaitableFutureTask<Void>(() -> {workspaceLogger.log("Starting docker container...");callWithRegistryLogins(docker, allRegistryLogins, () -> {@@ -430,7 +430,9 @@ public class ServerDockerProvisioner extends WorkspaceProvisioner implements Docthrow new ExplicitException("Docker container exited with code " + executeResult.getReturnCode());return null;});+ return null;});+ OneDev.getInstance(ExecutorService.class).execute(future);try {awaitContainerReady(future, containerReadyFile);@@ -477,6 +479,11 @@ public class ServerDockerProvisioner extends WorkspaceProvisioner implements Docfuture.get();} catch (InterruptedException e) {future.cancel(true);+ /*+ * Wait for the container to stop, so that teardown commands defined in+ * its entrypoint finish before cache and user data are uploaded below+ */+ future.await();throw new RuntimeException(e);} catch (ExecutionException e) {throw new RuntimeException(e);diff --git a/server-plugin/server-plugin-provisioner-servershell/src/main/java/io/onedev/server/plugin/provisioner/servershell/ServerShellProvisioner.java b/server-plugin/server-plugin-provisioner-servershell/src/main/java/io/onedev/server/plugin/provisioner/servershell/ServerShellProvisioner.javaindex ddd4c2c2ef..a1cf2cb346 100644--- a/server-plugin/server-plugin-provisioner-servershell/src/main/java/io/onedev/server/plugin/provisioner/servershell/ServerShellProvisioner.java+++ b/server-plugin/server-plugin-provisioner-servershell/src/main/java/io/onedev/server/plugin/provisioner/servershell/ServerShellProvisioner.java@@ -2,6 +2,7 @@ package io.onedev.server.plugin.provisioner.servershell;import static io.onedev.agent.AgentUtils.testCommands;import static io.onedev.agent.workspace.WorkspaceUtils.setupShellProvisioned;+import static io.onedev.agent.workspace.WorkspaceUtils.teardownShellProvisioned;import static io.onedev.agent.workspace.WorkspaceUtils.testTmuxAvailability;import static io.onedev.k8shelper.WorkspaceHelper.buildEnvVars;import static io.onedev.server.workspace.ServerProvisionerUtils.getWorkDir;@@ -170,8 +171,8 @@ public class ServerShellProvisioner extends WorkspaceProvisioner implements TestcacheProvisioners.add(cacheProvisioner);}- if (context.getSetupScriptConfig() != null)- setupShellProvisioned(context.getSetupScriptConfig(), workspaceDir, envVars, workspaceLogger);+ var scriptConfig = context.getScriptConfig();+ setupShellProvisioned(scriptConfig, workspaceDir, envVars, workspaceLogger);return new WorkspaceRuntime() {@@ -217,9 +218,10 @@ public class ServerShellProvisioner extends WorkspaceProvisioner implements Testnew CountDownLatch(1).await();} catch (InterruptedException e) {throw new RuntimeException(e);- } finally {+ } finally {try {- for (var cacheProvisioner : cacheProvisioners)+ teardownShellProvisioned(scriptConfig, workspaceDir, envVars, workspaceLogger);+ for (var cacheProvisioner : cacheProvisioners)cacheProvisioner.upload(workspaceDir, workspaceLogger);} finally {for (var shellId : getShellLabels().keySet())