Skip to content

Commit a0591af

Browse files
aledbfclaude
andcommitted
fix(docker): pass build args in the reference's order
Config build.args reached docker build from a Go map, so their --build-arg order changed from run to run. They now follow the order TS gives them (Object.keys: integer keys ascending, then the others as declared, base config then override). The Features build args (_DEV_CONTAINERS_BASE_IMAGE, _DEV_CONTAINERS_IMAGE_USER, _DEV_CONTAINERS_FEATURE_CONTENT_SOURCE) keep TS's order in the image build and the Compose override, and the updateUID build passes BASE_IMAGE, REMOTE_USER, NEW_UID, NEW_GID, IMAGE_USER in that order. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 3f5d6e5 commit a0591af

14 files changed

Lines changed: 138 additions & 21 deletions

‎docs/parity/parity-matrix.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3939,6 +3939,28 @@ initial_cases:
39393939
class: build-runtime
39403940
current_status: match
39413941

3942+
- id: build.dockerfile-build-args-order-success
3943+
lane: runtime
3944+
command: build
3945+
priority: p1
3946+
docker_required: true
3947+
setup_cmd: |
3948+
D=/tmp/parity-${PARITY_CASE_ID}-${PARITY_SIDE}
3949+
rm -rf $D && mkdir -p $D/ws/.devcontainer
3950+
printf 'FROM alpine:3\n' > $D/ws/.devcontainer/Dockerfile
3951+
printf '%s' '{"build":{"dockerfile":"Dockerfile","args":{"ZED":"1","10":"2","ALPHA":"3","2":"4"}}}' > $D/ws/.devcontainer/devcontainer.json
3952+
printf '%s\n' '#!/bin/sh' "echo \"\$*\" >> $D/docker.log" "exec $(command -v docker) \"\$@\"" > $D/docker
3953+
chmod +x $D/docker
3954+
echo WORKSPACE=$D/ws
3955+
echo DOCKER_WRAP=$D/docker
3956+
ts_cmd: "build --workspace-folder ${WORKSPACE} --docker-path ${DOCKER_WRAP} --image-name parity-${PARITY_CASE_ID}-${PARITY_SIDE}"
3957+
verify_cmd: "grep -o -E -- '--build-arg (ZED|10|ALPHA|2)=[0-9]+' /tmp/parity-${PARITY_CASE_ID}-${PARITY_SIDE}/docker.log"
3958+
cleanup_cmd: "docker rmi -f parity-${PARITY_CASE_ID}-${PARITY_SIDE} >/dev/null 2>&1; rm -rf /tmp/parity-${PARITY_CASE_ID}-${PARITY_SIDE}; true"
3959+
asserts: [exit_code, stdout_normalized]
3960+
class: build-runtime
3961+
current_status: match
3962+
notes: "The docker CLI is a wrapper that logs its arguments; verify_cmd lists the build's --build-arg values for build.args. TS passes them in Object.keys order: the integer keys ascending (2, 10), then the others as declared (ZED, ALPHA). Go used to pass them in Go map order, which changes from run to run."
3963+
39423964
- id: build.dockerfile-multi-image-success
39433965
lock: feature-content-image
39443966
lane: runtime

‎internal/cli/compose_up.go‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -487,9 +487,7 @@ func (r *upRunner) buildAndExtendCompose(ctx context.Context, s composeStart, pe
487487
override.Context = emptyDir
488488
}
489489
override.BuildKitInlineCache = s.useBuildx
490-
for _, k := range sortedStringKeys(info.BuildArgs) {
491-
override.BuildArgs = append(override.BuildArgs, [2]string{k, info.BuildArgs[k]})
492-
}
490+
override.BuildArgs = orderedBuildArgs(info.BuildArgs, featureBuildArgOrder(info.BuildArgs))
493491
for _, k := range sortedStringKeys(info.BuildKitContexts) {
494492
v := info.BuildKitContexts[k]
495493
if v == "." {

‎internal/cli/compose_up_held_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -886,7 +886,7 @@ func TestBuildAndExtendComposeImageServiceWithFeatures(t *testing.T) {
886886
for _, want := range []string{
887887
"\n image: " + folderImageName(h.ws) + "\n",
888888
"\n context: " + emptyDir + "\n",
889-
"\n - _DEV_CONTAINERS_IMAGE_USER=vscode\n",
889+
"\n - _DEV_CONTAINERS_IMAGE_USER=vscode\n - _DEV_CONTAINERS_FEATURE_CONTENT_SOURCE=dev_container_feature_content_temp\n",
890890
} {
891891
if !strings.Contains(override, want) {
892892
t.Errorf("override lacks %q:\n%s", want, override)

‎internal/cli/dockerfile_build.go‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99

1010
"github.com/devcontainers/cli/internal/config"
1111
"github.com/devcontainers/cli/internal/docker"
12+
"github.com/devcontainers/cli/internal/features"
1213
"github.com/devcontainers/cli/internal/imagemeta"
1314
"github.com/devcontainers/cli/internal/log"
1415
)
@@ -156,7 +157,7 @@ func buildDockerfileImage(ctx context.Context, logger log.Logger, dockerClient *
156157
ContextPath: dockerContextPath(cfg),
157158
Tags: imageNames,
158159
Target: info.OverrideTarget,
159-
BuildArgs: configArgs,
160+
BuildArgs: orderedBuildArgs(configArgs, features.PropertyOrder(configArgs, cfg.BuildArgsOrder)),
160161
CacheFrom: cacheFrom,
161162
Labels: fb.Labels,
162163
NoCache: fb.NoCache,
@@ -182,6 +183,14 @@ func buildDockerfileImage(ctx context.Context, logger log.Logger, dockerClient *
182183
return nil
183184
}
184185

186+
func orderedBuildArgs(args map[string]string, keys []string) [][2]string {
187+
out := make([][2]string, 0, len(keys))
188+
for _, k := range keys {
189+
out = append(out, [2]string{k, args[k]})
190+
}
191+
return out
192+
}
193+
185194
func featureBuildArgOrder(args map[string]string) []string {
186195
var keys []string
187196
for _, k := range []string{"_DEV_CONTAINERS_BASE_IMAGE", "_DEV_CONTAINERS_IMAGE_USER", "_DEV_CONTAINERS_FEATURE_CONTENT_SOURCE"} {

‎internal/cli/dockerfile_build_held_test.go‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,28 @@ func TestBuildDockerfileWritesTheReferenceDockerfile(t *testing.T) {
372372
})
373373
}
374374

375+
func TestBuildDockerfileBuildArgOrder(t *testing.T) {
376+
res := dockerfileBuildRun{
377+
files: map[string]string{".devcontainer/Dockerfile": "FROM alpine AS dev\n"},
378+
config: config.DevContainer{
379+
Build: &config.Build{Dockerfile: "Dockerfile", Args: map[string]string{"MID": "5", "ALPHA": "4", "ZED": "3", "10": "2", "2": "1"}},
380+
BuildArgsOrder: []string{"ZED", "10", "ALPHA", "2", "MID", "ZED"},
381+
},
382+
useBuildx: true,
383+
}.run(t)
384+
if res.err != nil {
385+
t.Fatal(res.err)
386+
}
387+
wantArgs := dockerCall{"buildx", "build", "--load", "--build-arg", "BUILDKIT_INLINE_CACHE=1",
388+
"-f", res.path, "-t", "img", "--target", "dev_containers_target_stage",
389+
"--build-arg", "2=1", "--build-arg", "10=2", "--build-arg", "ZED=3", "--build-arg", "ALPHA=4", "--build-arg", "MID=5",
390+
"--build-arg", "_DEV_CONTAINERS_BASE_IMAGE=dev",
391+
filepath.Join(res.ws, ".devcontainer")}
392+
if !reflect.DeepEqual(res.build, wantArgs) {
393+
t.Errorf("build =\n%v\nwant\n%v", res.build, wantArgs)
394+
}
395+
}
396+
375397
func TestBuildDockerfileStage(t *testing.T) {
376398
t.Run("a configured target is the base stage, the Dockerfile kept", func(t *testing.T) {
377399
res := dockerfileBuildRun{

‎internal/cli/feature_install.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -706,7 +706,7 @@ func extendImageWithFeatures(
706706
ContextPath: tmpDir,
707707
Tags: tags,
708708
Target: buildInfo.OverrideTarget,
709-
BuildArgs: buildInfo.BuildArgs,
709+
BuildArgs: orderedBuildArgs(buildInfo.BuildArgs, featureBuildArgOrder(buildInfo.BuildArgs)),
710710
UseBuildx: useBuildx,
711711
NoCache: fbOpts.NoCache,
712712
CacheFrom: fbOpts.CacheFrom,

‎internal/cli/feature_install_held_test.go‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -656,6 +656,24 @@ func TestExtendImageWithFeaturesTags(t *testing.T) {
656656
}
657657
}
658658

659+
func TestExtendImageWithFeaturesBuildArgOrder(t *testing.T) {
660+
res := extendRun{useBuildx: true}.run(t)
661+
if res.err != nil {
662+
t.Fatal(res.err)
663+
}
664+
var got []string
665+
for i, a := range res.build {
666+
if a == "--build-arg" && i+1 < len(res.build) {
667+
got = append(got, res.build[i+1])
668+
}
669+
}
670+
want := []string{"BUILDKIT_INLINE_CACHE=1", "_DEV_CONTAINERS_BASE_IMAGE=base:latest", "_DEV_CONTAINERS_IMAGE_USER=root",
671+
"_DEV_CONTAINERS_FEATURE_CONTENT_SOURCE=" + imagemeta.ComposeFeatureContentImage}
672+
if !slices.Equal(got, want) {
673+
t.Errorf("build args = %v, want %v", got, want)
674+
}
675+
}
676+
659677
func TestExtendImageWithFeaturesUsesTheImageUser(t *testing.T) {
660678
for name, tc := range map[string]struct {
661679
config *dockerspec.DockerOCIImageConfig

‎internal/config/key_order_test.go‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,25 @@ func TestLoadKeepsContainerEnvAndFeatureOptionOrder(t *testing.T) {
5858
}
5959
}
6060
}
61+
62+
func TestLoadKeepsBuildArgsOrder(t *testing.T) {
63+
dir := t.TempDir()
64+
base := filepath.Join(dir, "devcontainer.json")
65+
override := filepath.Join(dir, "override.json")
66+
if err := os.WriteFile(base, []byte(`{
67+
// comment
68+
"build": {"dockerfile": "Dockerfile", "args": {"ZED": "1", "10": "a", "ALPHA": "2"}}
69+
}`), 0o644); err != nil {
70+
t.Fatal(err)
71+
}
72+
if err := os.WriteFile(override, []byte(`{"build": {"args": {"MID": "3", "ZED": "4"}}}`), 0o644); err != nil {
73+
t.Fatal(err)
74+
}
75+
res, err := LoadDevContainerConfig(dir, base, override)
76+
if err != nil {
77+
t.Fatal(err)
78+
}
79+
if want := []string{"ZED", "10", "ALPHA", "MID", "ZED"}; !slices.Equal(res.Config.BuildArgsOrder, want) {
80+
t.Errorf("BuildArgsOrder = %v, want %v", res.Config.BuildArgsOrder, want)
81+
}
82+
}

‎internal/config/loader.go‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ func LoadDevContainerConfigWithMounts(workspaceFolder, configPath, overrideConfi
211211
}
212212

213213
config.ConfigFilePath = configFilePath
214-
config.ContainerEnvOrder, config.FeatureOptionOrder = declaredOrder(docs)
214+
config.ContainerEnvOrder, config.FeatureOptionOrder, config.BuildArgsOrder = declaredOrder(docs)
215215

216216
return &LoadResult{
217217
Config: &config,
@@ -223,9 +223,10 @@ func LoadDevContainerConfigWithMounts(workspaceFolder, configPath, overrideConfi
223223
}, nil
224224
}
225225

226-
func declaredOrder(docs [][]byte) (containerEnv []string, featureOptions map[string][]string) {
226+
func declaredOrder(docs [][]byte) (containerEnv []string, featureOptions map[string][]string, buildArgs []string) {
227227
for _, data := range docs {
228228
containerEnv = append(containerEnv, jsonc.MemberNames(data, "containerEnv")...)
229+
buildArgs = append(buildArgs, jsonc.MemberNames(data, "build", "args")...)
229230
for _, id := range jsonc.MemberNames(data, "features") {
230231
if names := jsonc.MemberNames(data, "features", id); len(names) > 0 {
231232
if featureOptions == nil {
@@ -235,7 +236,7 @@ func declaredOrder(docs [][]byte) (containerEnv []string, featureOptions map[str
235236
}
236237
}
237238
}
238-
return containerEnv, featureOptions
239+
return containerEnv, featureOptions, buildArgs
239240
}
240241

241242
func deepMergeConfig(base, override map[string]any) map[string]any {

‎internal/config/types.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ type DevContainer struct {
5959

6060
ContainerEnvOrder []string `json:"-"`
6161
FeatureOptionOrder map[string][]string `json:"-"`
62+
BuildArgsOrder []string `json:"-"`
6263
}
6364

6465
type Customizations map[string]any

0 commit comments

Comments
 (0)