Add experimental way to set a target platform when building

Add an --experimental-platform flag to the do command to allow
overriding the default auto-detected build platform until we find the
time to think about the definitive multi-platform builds UX

Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
This commit is contained in:
Marcos Lilljedahl 2022-04-05 18:17:33 -03:00
parent 7d2f279c59
commit d80acf805b
9 changed files with 44 additions and 116 deletions

View File

@ -44,6 +44,8 @@ type Config struct {
CacheExports []bk.CacheOptionsEntry CacheExports []bk.CacheOptionsEntry
CacheImports []bk.CacheOptionsEntry CacheImports []bk.CacheOptionsEntry
TargetPlatform *specs.Platform
} }
func New(ctx context.Context, host string, cfg Config) (*Client, error) { func New(ctx context.Context, host string, cfg Config) (*Client, error) {
@ -81,8 +83,9 @@ func (c *Client) Do(ctx context.Context, pctx *plancontext.Context, fn DoFunc) e
lg := log.Ctx(ctx) lg := log.Ctx(ctx)
eg, gctx := errgroup.WithContext(ctx) eg, gctx := errgroup.WithContext(ctx)
// if platform is set through plan config, skip detection. if c.cfg.TargetPlatform != nil {
if !pctx.Platform.IsSet() { pctx.Platform.Set(*c.cfg.TargetPlatform)
} else {
p, err := c.detectPlatform(ctx) p, err := c.detectPlatform(ctx)
if err != nil { if err != nil {
return err return err

View File

@ -6,7 +6,9 @@ import (
"strings" "strings"
"cuelang.org/go/cue" "cuelang.org/go/cue"
"github.com/containerd/containerd/platforms"
"github.com/docker/buildx/util/buildflags" "github.com/docker/buildx/util/buildflags"
specs "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"github.com/spf13/viper" "github.com/spf13/viper"
"go.dagger.io/dagger/client" "go.dagger.io/dagger/client"
@ -95,10 +97,21 @@ func NewClient(ctx context.Context) *client.Client {
lg.Fatal().Err(err).Msg("unable to parse --cache-from options") lg.Fatal().Err(err).Msg("unable to parse --cache-from options")
} }
ep := viper.GetString("experimental-platform")
var p *specs.Platform
if len(ep) > 0 {
pp, err := platforms.Parse(ep)
if err != nil {
lg.Fatal().Err(err).Msg("invalid value for --experimental-platform")
}
p = &pp
}
cl, err := client.New(ctx, "", client.Config{ cl, err := client.New(ctx, "", client.Config{
CacheExports: cacheExports, CacheExports: cacheExports,
CacheImports: cacheImports, CacheImports: cacheImports,
NoCache: viper.GetBool("no-cache"), NoCache: viper.GetBool("no-cache"),
TargetPlatform: p,
}) })
if err != nil { if err != nil {
lg.Fatal().Err(err).Msg("unable to create client") lg.Fatal().Err(err).Msg("unable to create client")

View File

@ -157,6 +157,7 @@ func init() {
doCmd.Flags().StringArrayP("with", "w", []string{}, "") doCmd.Flags().StringArrayP("with", "w", []string{}, "")
doCmd.Flags().StringP("plan", "p", ".", "Path to plan (defaults to current directory)") doCmd.Flags().StringP("plan", "p", ".", "Path to plan (defaults to current directory)")
doCmd.Flags().Bool("no-cache", false, "Disable caching") doCmd.Flags().Bool("no-cache", false, "Disable caching")
doCmd.Flags().String("experimental-platform", "", "Set target build platform (experimental)")
doCmd.Flags().StringArray("cache-to", []string{}, doCmd.Flags().StringArray("cache-to", []string{},
"Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)") "Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)")
doCmd.Flags().StringArray("cache-from", []string{}, doCmd.Flags().StringArray("cache-from", []string{},

View File

@ -25,7 +25,3 @@ func (c *platformContext) SetString(platform string) error {
func (c *platformContext) Set(p specs.Platform) { func (c *platformContext) Set(p specs.Platform) {
c.platform = &p c.platform = &p
} }
func (c *platformContext) IsSet() bool {
return c.platform != nil
}

View File

@ -228,15 +228,17 @@ setup() {
} }
@test "plan/platform" { @test "plan/platform" {
cd "$TESTDIR" cd "$TESTDIR"
# Run with amd64 platform # Run with invalid platform format
run "$DAGGER" "do" -p./plan/platform/config_platform_linux_amd64.cue verify run "$DAGGER" "do" --experimental-platform invalid -p./plan/platform/platform.cue test
# Run with arm64 platform
run "$DAGGER" "do" -p./plan/platform/config_platform_linux_arm64.cue verify
# Run with invalid platform
run "$DAGGER" "do" -p./plan/platform/config_platform_failure_invalid_platform.cue verify
assert_failure assert_failure
assert_output --partial "unknown operating system or architecture: invalid argument"
# Run with non-existing platform
run "$DAGGER" "do" --experimental-platform invalid/invalid -p./plan/platform/platform.cue test
assert_failure
assert_output --partial "no match for platform in manifest"
} }

View File

@ -1,33 +0,0 @@
package main
import (
"dagger.io/dagger"
"dagger.io/dagger/core"
)
dagger.#Plan & {
platform: "linux/unknown"
actions: {
image: core.#Pull & {
source: "alpine:3.15.0"
}
writeArch: core.#Exec & {
input: image.output
always: true
args: [
"sh", "-c", #"""
echo -n $(uname -m) >> /arch.txt
"""#,
]
}
verify: core.#ReadFile & {
input: writeArch.output
path: "/arch.txt"
} & {
contents: "s390x"
}
}
}

View File

@ -1,33 +0,0 @@
package main
import (
"dagger.io/dagger"
"dagger.io/dagger/core"
)
dagger.#Plan & {
platform: "linux/amd64"
actions: {
image: core.#Pull & {
source: "alpine:3.15.0"
}
writeArch: core.#Exec & {
input: image.output
always: true
args: [
"sh", "-c", #"""
echo -n $(uname -m) >> /arch.txt
"""#,
]
}
verify: core.#ReadFile & {
input: writeArch.output
path: "/arch.txt"
} & {
contents: "x86_64"
}
}
}

View File

@ -1,33 +0,0 @@
package main
import (
"dagger.io/dagger"
"dagger.io/dagger/core"
)
dagger.#Plan & {
platform: "linux/arm64"
actions: {
image: core.#Pull & {
source: "alpine:3.15.0"
}
writeArch: core.#Exec & {
input: image.output
always: true
args: [
"sh", "-c", #"""
echo -n $(uname -m) >> /arch.txt
"""#,
]
}
verify: core.#ReadFile & {
input: writeArch.output
path: "/arch.txt"
} & {
contents: "aarch64"
}
}
}

View File

@ -0,0 +1,12 @@
package main
import (
"dagger.io/dagger"
"dagger.io/dagger/core"
)
dagger.#Plan & {
actions: test: image: core.#Pull & {
source: "alpine:3.15.0"
}
}