Skip to content

bake: use singular keys for --set overrides #4089

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

Open
crazy-max wants to merge 1 commit into
base: master
Choose a base branch
from
+247 −57
Open

bake: use singular keys for --set overrides #4089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
105 changes: 81 additions & 24 deletions bake/bake.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,8 +657,35 @@ func (c Config) newOverrides(v []string) (map[string]map[string]Override, error)
return nil, errors.Errorf("invalid override key %s, expected target.name", skey)
}

// Normalize aliases so they share replacement and append semantics.
switch keys[1] {
case "annotations":
keys[1] = "annotation"
case "args":
keys[1] = "arg"
case "entitlements":
keys[1] = "entitlement"
case "extra-hosts":
keys[1] = "extra-host"
case "labels":
keys[1] = "label"
case "platforms":
keys[1] = "platform"
case "resources":
keys[1] = "resource"
case "tags":
keys[1] = "tag"
case "ulimits":
keys[1] = "ulimit"
case "secrets":
if len(keys) != 2 {
return nil, errors.Errorf("invalid key %s, secret does not support subkeys", parts[0])
}
keys[1] = "secret"
}

pattern := keys[0]
if len(parts) != 2 && keys[1] != "args" {
if len(parts) != 2 && keys[1] != "arg" {
return nil, errors.Errorf("invalid override %s, expected target.name=value", v)
}

Expand All @@ -680,22 +707,37 @@ func (c Config) newOverrides(v []string) (map[string]map[string]Override, error)
// IMPORTANT: if you add more fields here, do not forget to update
// docs/reference/buildx_bake.md (--set) and https://docs.docker.com/build/bake/overrides/
switch keys[1] {
case "output", "cache-to", "cache-from", "tags", "platform", "secrets", "ssh", "attest", "entitlements", "annotations", "policy", "ulimits", "no-cache-filter":
case "output", "cache-to", "cache-from", "tag", "platform", "ssh", "attest", "entitlement", "annotation", "policy", "ulimit", "no-cache-filter":
if len(keys) != 2 {
return nil, errors.Errorf("invalid key %s, %s does not support subkeys", parts[0], keys[1])
}
if len(parts) == 2 {
override.Append = appendTo
override.ArrValue = append(override.ArrValue, parts[1])
}
case "resources", "secret":
case "secret":
if len(keys) == 2 {
if len(parts) == 2 {
override.Append = appendTo
override.ArrValue = append(override.ArrValue, parts[1])
}
break
}
if appendTo {
return nil, errors.Errorf("invalid key %s, secret does not support append", parts[0])
}
override.Value = parts[1]
case "resource":
if len(keys) != 3 {
return nil, errors.Errorf("invalid key %s, %s requires name", parts[0], keys[1])
}
if appendTo {
return nil, errors.Errorf("invalid key %s, %s does not support append", parts[0], keys[1])
}
override.Value = parts[1]
case "args":
case "arg":
if len(keys) != 3 {
return nil, errors.Errorf("invalid key %s, args requires name", parts[0])
return nil, errors.Errorf("invalid key %s, arg requires name", parts[0])
}
if len(parts) < 2 && envLookupAllowed() {
v, ok := os.LookupEnv(keys[2])
Expand All @@ -704,12 +746,23 @@ func (c Config) newOverrides(v []string) (map[string]map[string]Override, error)
}
override.Value = v
}
fallthrough
case "contexts":
if len(parts) == 2 {
override.Value = parts[1]
}
case "contexts", "label", "extra-host":
if len(keys) != 3 {
return nil, errors.Errorf("invalid key %s, contexts requires name", parts[0])
return nil, errors.Errorf("invalid key %s, %s requires name", parts[0], keys[1])
}
if len(parts) == 2 {
override.Value = parts[1]
}
case "context", "dockerfile", "target", "call", "no-cache", "shm-size", "network", "pull", "push", "load":
if len(keys) != 2 {
return nil, errors.Errorf("invalid key %s, %s does not support subkeys", parts[0], keys[1])
}
if len(parts) == 2 {
override.Value = parts[1]
}
fallthrough
default:
if len(parts) == 2 {
override.Value = parts[1]
Expand Down Expand Up @@ -1165,9 +1218,9 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
t.Context = &value
case "dockerfile":
t.Dockerfile = &value
case "args":
case "arg", "args":
if len(keys) != 2 {
return errors.Errorf("invalid format for args, expecting args.<name>=<value>")
return errors.Errorf("invalid format for arg, expecting arg.<name>=<value>")
}
if t.Args == nil {
t.Args = map[string]*string{}
Expand All @@ -1181,15 +1234,15 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
t.Contexts = map[string]string{}
}
t.Contexts[keys[1]] = value
case "labels":
case "label", "labels":
if len(keys) != 2 {
return errors.Errorf("invalid format for labels, expecting labels.<name>=<value>")
return errors.Errorf("invalid format for label, expecting label.<name>=<value>")
}
if t.Labels == nil {
t.Labels = map[string]*string{}
}
t.Labels[keys[1]] = &value
case "tags":
case "tag", "tags":
if o.Append {
t.Tags = append(t.Tags, o.ArrValue...)
} else {
Expand Down Expand Up @@ -1245,11 +1298,15 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
case "call":
t.Call = &value
case "secret":
if len(keys) != 2 {
return errors.Errorf("invalid format for secret, expecting secret.<id>=<value>")
if len(keys) == 2 {
secretOverrides[keys[1]] = o
break
}
secretOverrides[keys[1]] = o
fallthrough
case "secrets":
if len(keys) != 1 {
return errors.Errorf("invalid format for secret, expecting secret.<id>=<value>")
}
secrets, err := parseArrValue[buildflags.Secret](o.ArrValue)
if err != nil {
return errors.Wrap(err, "invalid value for outputs")
Expand Down Expand Up @@ -1296,7 +1353,7 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
ent.FSWrite = append(ent.FSWrite, o.Destination)
}
}
case "entitlements":
case "entitlement", "entitlements":
t.Entitlements = append(t.Entitlements, o.ArrValue...)
for _, v := range o.ArrValue {
if v == string(EntitlementKeyNetworkHost) {
Expand All @@ -1305,7 +1362,7 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
ent.SecurityInsecure = true
}
}
case "annotations":
case "annotation", "annotations":
t.Annotations = append(t.Annotations, o.ArrValue...)
case "attest":
attest, err := parseArrValue[buildflags.Attest](o.ArrValue)
Expand All @@ -1327,15 +1384,15 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
}
case "shm-size":
t.ShmSize = &value
case "ulimits":
case "ulimit", "ulimits":
if o.Append {
t.Ulimits = append(t.Ulimits, o.ArrValue...)
} else {
t.Ulimits = o.ArrValue
}
case "resources":
case "resource", "resources":
if len(keys) != 2 {
return errors.Errorf("invalid format for resources, expecting resources.<name>=<value>")
return errors.Errorf("invalid format for resource, expecting resource.<name>=<value>")
}
if t.Resources == nil {
t.Resources = &buildflags.ResourcesConfig{}
Expand Down Expand Up @@ -1363,9 +1420,9 @@ func (t *Target) AddOverrides(overrides map[string]Override, ent *EntitlementCon
return errors.Errorf("invalid value %s for boolean key load", value)
}
t.Outputs = setLoadOverride(t.Outputs, load)
case "extra-hosts":
case "extra-host", "extra-hosts":
if len(keys) != 2 {
return errors.Errorf("invalid format for extra-hosts, expecting extra-hosts.<hostname>=<ip>")
return errors.Errorf("invalid format for extra-host, expecting extra-host.<hostname>=<ip>")
}
if t.ExtraHosts == nil {
t.ExtraHosts = map[string]*string{}
Expand Down
114 changes: 111 additions & 3 deletions bake/bake_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,51 @@ target "webapp" {
require.Equal(t, []string{"webapp"}, g["default"].Targets)
})

t.Run("AnnotationAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.annotation=index,manifest:org.opencontainers.image.vendor=docker"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, []string{"index,manifest:org.opencontainers.image.authors=dvdksn", "index,manifest:org.opencontainers.image.vendor=docker"}, m["webapp"].Annotations)
})

t.Run("ArgAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.arg.MY_VAR=value"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, ptrstr("value"), m["webapp"].Args["MY_VAR"])
})

t.Run("ArgAliasFromEnv", func(t *testing.T) {
key := "VAR_FROM_ENV" + t.Name()
t.Setenv(key, "value")
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.arg." + key}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, ptrstr("value"), m["webapp"].Args[key])
})

t.Run("ArgNameRequired", func(t *testing.T) {
_, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.arg=value"}, nil, nil, &EntitlementConf{})
require.EqualError(t, err, "invalid key webapp.arg, arg requires name")
})

t.Run("EntitlementAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.entitlements=security.insecure", "webapp.entitlement=network.host"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, []string{"security.insecure", "network.host"}, m["webapp"].Entitlements)
})

t.Run("ExtraHostAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.extra-hosts.legacy.example.com=127.0.0.2", "webapp.extra-host.example.com=127.0.0.1"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, ptrstr("127.0.0.2"), m["webapp"].ExtraHosts["legacy.example.com"])
require.Equal(t, ptrstr("127.0.0.1"), m["webapp"].ExtraHosts["example.com"])
})

t.Run("LabelAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.labels.com.example.legacy=old", "webapp.label.com.example.foo=bar"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, ptrstr("old"), m["webapp"].Labels["com.example.legacy"])
require.Equal(t, ptrstr("bar"), m["webapp"].Labels["com.example.foo"])
})

t.Run("AttestOverride", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.attest=type=sbom"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
Expand Down Expand Up @@ -185,6 +230,16 @@ target "webapp" {
require.Equal(t, []string{"webapp"}, g["default"].Targets)
})

t.Run("ContextSubkeyInvalid", func(t *testing.T) {
_, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.context.foo=bar"}, nil, nil, &EntitlementConf{})
require.EqualError(t, err, "invalid key webapp.context.foo, context does not support subkeys")
})

t.Run("UnknownSubkey", func(t *testing.T) {
_, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.bogus.foo=bar"}, nil, nil, &EntitlementConf{})
require.EqualError(t, err, "unknown key: bogus")
})

t.Run("NoCacheOverride", func(t *testing.T) {
t.Parallel()
m, g, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.no-cache=false"}, nil, nil, &EntitlementConf{})
Expand Down Expand Up @@ -224,6 +279,23 @@ target "webapp" {
require.Equal(t, []string{"linux/arm64", "linux/riscv64"}, m["webapp"].Platforms)
})

t.Run("PlatformsAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.platforms=linux/arm64", "webapp.platform=linux/riscv64"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, []string{"linux/arm64", "linux/riscv64"}, m["webapp"].Platforms)
})

t.Run("TagAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.tags=example.com/foo", "webapp.tag+=example.com/bar"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, []string{"example.com/foo", "example.com/bar"}, m["webapp"].Tags)
})

t.Run("TagSubkeyInvalid", func(t *testing.T) {
_, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.tag.foo=bar"}, nil, nil, &EntitlementConf{})
require.EqualError(t, err, "invalid key webapp.tag.foo, tag does not support subkeys")
})

t.Run("SecretsOverride", func(t *testing.T) {
t.Setenv("FOO", "foo")
t.Setenv("BAR", "bar")
Expand All @@ -243,6 +315,36 @@ target "webapp" {
require.Equal(t, "BAR", m["webapp"].Secrets[1].ID)
})

t.Run("SecretAliasOverride", func(t *testing.T) {
t.Setenv("BAR", "bar")
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.secret=id=BAR,env=BAR"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Len(t, m["webapp"].Secrets, 1)
require.Equal(t, "BAR", m["webapp"].Secrets[0].ID)
})

t.Run("SecretAliasAppend", func(t *testing.T) {
t.Setenv("BAR", "bar")
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.secret+=id=BAR,env=BAR"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Len(t, m["webapp"].Secrets, 2)
require.Equal(t, "FOO", m["webapp"].Secrets[0].ID)
require.Equal(t, "BAR", m["webapp"].Secrets[1].ID)
})

t.Run("SecretAliasWithSourceOverride", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.secret=id=BAR,env=BAR", "webapp.secret.BAR=env=BAZ"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Len(t, m["webapp"].Secrets, 1)
require.Equal(t, "BAR", m["webapp"].Secrets[0].ID)
require.Equal(t, "BAZ", m["webapp"].Secrets[0].Env)
})

t.Run("SecretsSubkeyInvalid", func(t *testing.T) {
_, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.secrets.FOO=env=BAR"}, nil, nil, &EntitlementConf{})
require.EqualError(t, err, "invalid key webapp.secrets.FOO, secret does not support subkeys")
})

t.Run("SecretSourceOverrideEnv", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.secret.FOO=env=BAR"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
Expand Down Expand Up @@ -298,10 +400,10 @@ target "webapp" {
require.Equal(t, "host", *m["webapp"].NetworkMode)
})

t.Run("UlimitsOverride", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.ulimits=nofile=2048:2048"}, nil, nil, &EntitlementConf{})
t.Run("UlimitAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.ulimits=nofile=2048:2048", "webapp.ulimit=nproc=1024:1024"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, []string{"nofile=2048:2048"}, m["webapp"].Ulimits)
require.Equal(t, []string{"nofile=2048:2048", "nproc=1024:1024"}, m["webapp"].Ulimits)
})

t.Run("ResourceLimitsOverride", func(t *testing.T) {
Expand All @@ -319,6 +421,12 @@ target "webapp" {
require.Error(t, err)
})

t.Run("ResourceAlias", func(t *testing.T) {
m, _, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.resource.memory=512m"}, nil, nil, &EntitlementConf{})
require.NoError(t, err)
require.Equal(t, ptrstr("512m"), m["webapp"].Resources.Memory)
})

t.Run("PullOverride", func(t *testing.T) {
t.Parallel()
m, g, err := ReadTargets(ctx, []File{fp}, []string{"webapp"}, []string{"webapp.pull=false"}, nil, nil, &EntitlementConf{})
Expand Down
Loading
Loading