Skip to content

The Unified and Autonomous Development Platform

feat: Migrate 'More Options' to 'Image Build Options' in BuildImageStep

Robin Shen3861fa4dd996
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
index c58c4d63da..3e25873374 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java
@@ -38,6 +38,7 @@ import com.google.common.collect.Lists;
import io.onedev.commons.codeassist.InputSuggestion;
import io.onedev.commons.utils.ExceptionUtils;
+import io.onedev.commons.utils.ExplicitException;
import io.onedev.commons.utils.StringUtils;
import io.onedev.commons.utils.WordUtils;
import io.onedev.server.OneDev;
@@ -2842,4 +2843,21 @@ public class BuildSpec implements Serializable, Validatable {
}
}
+ @SuppressWarnings("unused")
+ private void migrate55(VersionedYamlDoc doc, Stack<Integer> versions) {
+ migrateSteps(doc, versions, stepsNode -> {
+ for (var node : stepsNode.getValue()) {
+ var step = (MappingNode) node;
+ if (!"BuildImageStep".equals(getStepType(step)))
+ continue;
+ for (var it = step.getValue().iterator(); it.hasNext();) {
+ var tuple = it.next();
+ if (((ScalarNode) tuple.getKeyNode()).getValue().equals("moreOptions")) {
+ it.remove();
+ }
+ }
+ }
+ });
+ }
+
}
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java
index 6d0440c531..8e284f7995 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/BuildImageStep.java
@@ -18,7 +18,6 @@ import io.onedev.server.annotation.Path;
import io.onedev.server.annotation.Editable;
import io.onedev.server.annotation.Interpolative;
import io.onedev.server.annotation.NoSpace;
-import io.onedev.server.annotation.ReservedOptions;
import io.onedev.server.buildspec.BuildSpec;
import io.onedev.server.buildspec.param.ParamCombination;
import io.onedev.server.model.Build;
@@ -43,9 +42,7 @@ public class BuildImageStep extends Step {
private List<RegistryLogin> registryLogins = new ArrayList<>();
private String platforms;
-
- private String moreOptions;
-
+
@Editable(order=100, description="Optionally specify build path relative to <a href='https://docs.onedev.io/concepts#job-workdir' target='_blank'>job working directory</a>. "
+ "Leave empty to use job working directory itself")
@Interpolative(variableSuggester="suggestVariables")
@@ -104,18 +101,6 @@ public class BuildImageStep extends Step {
this.platforms = platforms;
}
- @Editable(order=1400, group = "More Settings", description="Optionally specify additional options for " +
- "buildx build command")
- @Interpolative(variableSuggester="suggestVariables")
- @ReservedOptions({"--builder", "(--builder)=.*", "--platform", "(--platform)=.*", "--push", "-f", "--file", "(-f|--file)=.*", "-t", "--tag", "(-t|--tag)=.*", "-o", "--output", "(-o|--output)=.*"})
- public String getMoreOptions() {
- return moreOptions;
- }
-
- public void setMoreOptions(String moreOptions) {
- this.moreOptions = moreOptions;
- }
-
static List<InputSuggestion> suggestVariables(String matchWith) {
return BuildSpec.suggestVariables(matchWith, true, true, false);
}
@@ -124,7 +109,7 @@ public class BuildImageStep extends Step {
public StepFacade getFacade(Build build, JobExecutor jobExecutor, String jobToken, ParamCombination paramCombination) {
var registryLogins = getRegistryLogins().stream().map(it->it.getFacade(build)).collect(toList());
return new BuildImageFacade(getBuildPath(), getDockerfile(), getOutput().getFacade(),
- registryLogins, getPlatforms(), getMoreOptions());
+ registryLogins, getPlatforms());
}
@Override
diff --git a/server-core/src/test/java/io/onedev/server/buildspec/step/BuildImageStepTest.java b/server-core/src/test/java/io/onedev/server/buildspec/step/BuildImageStepTest.java
new file mode 100644
index 0000000000..a61b9ee668
--- /dev/null
+++ b/server-core/src/test/java/io/onedev/server/buildspec/step/BuildImageStepTest.java
@@ -0,0 +1,64 @@
+package io.onedev.server.buildspec.step;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.when;
+
+import org.junit.jupiter.api.Test;
+
+import io.onedev.commons.utils.ExplicitException;
+import io.onedev.commons.loader.AppLoader;
+import io.onedev.commons.loader.AppLoaderMocker;
+import io.onedev.commons.loader.ImplementationRegistry;
+import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.data.migration.VersionedYamlDoc;
+
+class BuildImageStepTest extends AppLoaderMocker {
+ @Override
+ protected void setup() {
+ when(AppLoader.getInstance(ImplementationRegistry.class)).thenReturn(new ImplementationRegistry() {
+ @Override
+ public <T> java.util.Collection<Class<? extends T>> getImplementations(Class<T> type) {
+ var implementations = new java.util.ArrayList<Class<? extends T>>();
+ if (type.isAssignableFrom(BuildImageStep.class))
+ implementations.add(BuildImageStep.class.asSubclass(type));
+ return implementations;
+ }
+ });
+ }
+
+ @Override
+ protected void teardown() { }
+
+ private VersionedYamlDoc document(String section, String option) {
+ return VersionedYamlDoc.fromYaml("""
+ version: 54
+ %s:
+ - name: image
+ steps:
+ - type: BuildImageStep
+ name: build
+ moreOptions: %s
+ """.formatted(section, option));
+ }
+
+ @Test
+ void requiresAdministratorMigrationOfLegacyOptionsInJobsAndTemplates() throws Exception {
+ for (var section : java.util.List.of("jobs", "stepTemplates")) {
+ var error = assertThrows(RuntimeException.class,
+ () -> document(section, "--secret id=x,source=/host/file").toBean(BuildSpec.class));
+ var explicit = io.onedev.commons.utils.ExceptionUtils.find(error, ExplicitException.class);
+ assertNotNull(explicit);
+ assertTrue(explicit.getMessage().contains("Image Build Options"));
+ }
+ }
+
+ @Test
+ void migratesEmptyLegacyOptionsAndRemovesStepSetting() {
+ for (var value : java.util.List.of("null", "''")) {
+ BuildSpec spec = document("jobs", value).toBean(BuildSpec.class);
+ assertInstanceOf(BuildImageStep.class, spec.getJobs().get(0).getSteps().get(0));
+ assertFalse(VersionedYamlDoc.fromBean(spec).toYaml().contains("moreOptions"));
+ }
+ assertThrows(NoSuchMethodException.class, () -> BuildImageStep.class.getMethod("getMoreOptions"));
+ }
+}
diff --git a/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java b/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
index 068ec9248c..bdd57e4ddf 100644
--- a/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
@@ -109,7 +109,7 @@ public class RemoteDockerExecutor extends ServerDockerExecutor {
var dockerSettings = new JobDockerSettings(isMountDockerSock(), getDockerSockPath(),
getCpuLimit(), getMemoryLimit(), getRunOptions(), registryLogins,
- isAlwaysPullImage(), getDockerBuilder(), getNetworkOptions());
+ isAlwaysPullImage(), getDockerBuilder(), getNetworkOptions(), getBuildOptions());
DockerJobData jobData = new DockerJobData(jobToken, getName(), jobContext.getProjectPath(),
jobContext.getProjectId(), jobContext.getRefName(), jobContext.getCommitId().name(),
jobContext.getBuildNumber(), jobContext.getSubmitSequence(), jobContext.getActions(),
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 5bffa906cc..e40590a30a 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
@@ -96,6 +96,8 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
private List<RegistryLogin> registryLogins = new ArrayList<>();
private String runOptions;
+
+ private String buildOptions;
private boolean alwaysPullImage = true;
@@ -245,6 +247,17 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
this.runOptions = runOptions;
}
+ @Editable(order=50060, name="Image Build Options", group="More Settings", description="Optionally specify additional "
+ + "docker buildx build options for image build steps using this executor. "
+ + "Separate options with spaces and quote values containing spaces")
+ public String getBuildOptions() {
+ return buildOptions;
+ }
+
+ public void setBuildOptions(String buildOptions) {
+ this.buildOptions = buildOptions;
+ }
+
@Editable(order=50075, group="More Settings", description = "Optionally specify docker options to create network. " +
"Multiple options should be separated by space, and single option containing spaces should be quoted")
@ReservedOptions({"-d", "(--driver)=.*"})
@@ -482,7 +495,7 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
var docker = newDocker();
var registryLogins = merge(buildImageFacade.getRegistryLogins(), getRegistryLogins(jobToken));
callWithRegistryLogins(docker, registryLogins, () -> {
- JobUtils.buildImage(docker, getDockerBuilder(), buildImageFacade, buildDir,
+ JobUtils.buildImage(docker, getDockerBuilder(), getBuildOptions(), buildImageFacade, buildDir,
isAlwaysPullImage(), jobLogger);
return null;
});
diff --git a/server-product/system/incompatibilities/incompatibilities.md b/server-product/system/incompatibilities/incompatibilities.md
index 8b2545cb59..f77fabbca5 100644
--- a/server-product/system/incompatibilities/incompatibilities.md
+++ b/server-product/system/incompatibilities/incompatibilities.md
@@ -1,3 +1,11 @@
+# 16.8.4
+
+### CI/CD
+
+The `More Options` setting (`moreOptions` in build specs) of the build image step has been moved to `Image Build Options` under the Docker job executor's `More Settings`. These options are now controlled by administrators, as they can allow access to files on the executor host.
+
+Existing step options are removed when build specs are migrated and are not copied to executors automatically. Before upgrading, record any options you need to retain and ask an administrator to configure them on the appropriate Docker job executor after upgrading. Executor options apply to all build image steps using that executor.
+
# 16.8.0
### CI/CD