Properly pass through target platform

This makes sure that the requested target platform
is propagated everywhere it needs to be.

There are some room for improvements here.
For example, source packages really should not
depend on the target platform and we could get
away with using the native platform there.
These kinds of improvements will require some
code restructuring which is out of scope for this
change.

Signed-off-by: Brian Goff <[email protected]>

Author: cpuguy83

frontend/build.go

@@ -167,8 +167,12 @@ func BuildWithPlatformFromUIClient(ctx context.Context, client gwclient.Client,
 // image in the build context matching the image ref.
 //
 // This follows the behavior of of the dockerfile frontend.
-func GetBaseImage(sOpt dalec.SourceOpts, ref string) llb.State {
+func GetBaseImage(sOpt dalec.SourceOpts, ref string, opts ...llb.ConstraintsOpt) llb.State {
 	return llb.Scratch().Async(func(ctx context.Context, _ llb.State, c *llb.Constraints) (llb.State, error) {
+		for _, o := range opts {
+			o.SetConstraintsOption(c)
+		}
+
 		fromClient, err := sOpt.GetContext(ref, dalec.WithConstraint(c))
 		if err != nil {
 			return llb.Scratch(), err
@@ -177,7 +181,8 @@ func GetBaseImage(sOpt dalec.SourceOpts, ref string) llb.State {
 		if fromClient != nil {
 			return *fromClient, nil
 		}
-		return llb.Image(ref, llb.WithMetaResolver(sOpt.Resolver), dalec.WithConstraint(c)), nil
+
+		return llb.Image(ref, dalec.WithConstraint(c), llb.WithMetaResolver(sOpt.Resolver)), nil
 	})
 }
 

frontend/debug/handle_gomod.go

@@ -16,7 +16,7 @@ const keyGomodWorker = "context:gomod-worker"
 // Gomods outputs all the gomodule dependencies for the spec
 func Gomods(ctx context.Context, client gwclient.Client) (*client.Result, error) {
 	return frontend.BuildWithPlatform(ctx, client, func(ctx context.Context, client gwclient.Client, platform *ocispecs.Platform, spec *dalec.Spec, targetKey string) (gwclient.Reference, *dalec.DockerImageSpec, error) {
-		sOpt, err := frontend.SourceOptFromClient(ctx, client)
+		sOpt, err := frontend.SourceOptFromClient(ctx, client, platform)
 		if err != nil {
 			return nil, nil, err
 		}
@@ -34,7 +34,7 @@ func Gomods(ctx context.Context, client gwclient.Client) (*client.Result, error)
 				Run(llb.Shlex("apk add --no-cache go git ca-certificates patch")).Root()
 		}
 
-		st, err := spec.GomodDeps(sOpt, worker)
+		st, err := spec.GomodDeps(sOpt, worker, dalec.Platform(platform))
 		if err != nil {
 			return nil, nil, err
 		}

frontend/debug/handle_sources.go

@@ -14,7 +14,7 @@ import (
 // Sources is a handler that outputs all the sources.
 func Sources(ctx context.Context, client gwclient.Client) (*client.Result, error) {
 	return frontend.BuildWithPlatform(ctx, client, func(ctx context.Context, client gwclient.Client, platform *ocispecs.Platform, spec *dalec.Spec, targetKey string) (gwclient.Reference, *dalec.DockerImageSpec, error) {
-		sOpt, err := frontend.SourceOptFromClient(ctx, client)
+		sOpt, err := frontend.SourceOptFromClient(ctx, client, platform)
 		if err != nil {
 			return nil, nil, err
 		}
@@ -53,7 +53,7 @@ func Sources(ctx context.Context, client gwclient.Client) (*client.Result, error
 func PatchedSources(ctx context.Context, client gwclient.Client) (*client.Result, error) {
 	return frontend.BuildWithPlatform(ctx, client, func(ctx context.Context, client gwclient.Client, platform *ocispecs.Platform, spec *dalec.Spec, targetKey string) (gwclient.Reference, *dalec.DockerImageSpec, error) {
 		const keyPatchedSourcesWorker = "context:patched-sources-worker"
-		sOpt, err := frontend.SourceOptFromClient(ctx, client)
+		sOpt, err := frontend.SourceOptFromClient(ctx, client, platform)
 		if err != nil {
 			return nil, nil, err
 		}
@@ -69,12 +69,13 @@ func PatchedSources(ctx context.Context, client gwclient.Client) (*client.Result
 				Run(llb.Shlex("apk add --no-cache go git ca-certificates patch")).Root()
 		}
 
-		sources, err := dalec.Sources(spec, sOpt)
+		pc := dalec.Platform(platform)
+		sources, err := dalec.Sources(spec, sOpt, pc)
 		if err != nil {
 			return nil, nil, err
 		}
 
-		sources = dalec.PatchSources(worker, spec, sources)
+		sources = dalec.PatchSources(worker, spec, sources, pc)
 		if err != nil {
 			return nil, nil, err
 		}

frontend/gateway.go

@@ -13,6 +13,7 @@ import (
 	"github.com/moby/buildkit/solver/pb"
 	"github.com/moby/buildkit/util/bklog"
 	"github.com/opencontainers/go-digest"
+	ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/pkg/errors"
 )
 
@@ -55,12 +56,12 @@ func getDockerfile(ctx context.Context, client gwclient.Client, build *dalec.Sou
 // ForwarderFromClient creates a [dalec.ForwarderFunc] from a gateway client.
 // This is used for forwarding builds to other frontends in [dalec.Source2LLBGetter]
 func ForwarderFromClient(ctx context.Context, client gwclient.Client) dalec.ForwarderFunc {
-	return func(st llb.State, spec *dalec.SourceBuild) (llb.State, error) {
+	return func(st llb.State, spec *dalec.SourceBuild, opts ...llb.ConstraintsOpt) (llb.State, error) {
 		if spec == nil {
 			spec = &dalec.SourceBuild{}
 		}
 
-		def, err := st.Marshal(ctx)
+		def, err := st.Marshal(ctx, opts...)
 		if err != nil {
 			return llb.Scratch(), err
 		}
@@ -101,10 +102,11 @@ func GetBuildArg(client gwclient.Client, k string) (string, bool) {
 	return "", false
 }
 
-func SourceOptFromUIClient(ctx context.Context, c gwclient.Client, dc *dockerui.Client) dalec.SourceOpts {
+func SourceOptFromUIClient(ctx context.Context, c gwclient.Client, dc *dockerui.Client, platform *ocispecs.Platform) dalec.SourceOpts {
 	return dalec.SourceOpts{
-		Resolver: c,
-		Forward:  ForwarderFromClient(ctx, c),
+		TargetPlatform: platform,
+		Resolver:       c,
+		Forward:        ForwarderFromClient(ctx, c),
 		GetContext: func(ref string, opts ...llb.LocalOption) (*llb.State, error) {
 			if ref == dockerui.DefaultLocalNameContext {
 				return dc.MainContext(ctx, opts...)
@@ -114,6 +116,7 @@ func SourceOptFromUIClient(ctx context.Context, c gwclient.Client, dc *dockerui.
 				AsyncLocalOpts: func() []llb.LocalOption {
 					return opts
 				},
+				Platform: platform,
 			})
 			if err != nil {
 				return nil, err
@@ -127,12 +130,12 @@ func SourceOptFromUIClient(ctx context.Context, c gwclient.Client, dc *dockerui.
 	}
 }
 
-func SourceOptFromClient(ctx context.Context, c gwclient.Client) (dalec.SourceOpts, error) {
+func SourceOptFromClient(ctx context.Context, c gwclient.Client, platform *ocispecs.Platform) (dalec.SourceOpts, error) {
 	dc, err := dockerui.NewClient(c)
 	if err != nil {
 		return dalec.SourceOpts{}, err
 	}
-	return SourceOptFromUIClient(ctx, c, dc), nil
+	return SourceOptFromUIClient(ctx, c, dc, platform), nil
 }
 
 var (

frontend/test_runner.go

@@ -14,6 +14,7 @@ import (
 	"github.com/moby/buildkit/client/llb"
 	gwclient "github.com/moby/buildkit/frontend/gateway/client"
 	"github.com/moby/buildkit/identity"
+	ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/pkg/errors"
 )
 
@@ -31,7 +32,7 @@ const (
 )
 
 // Run tests runs the tests defined in the spec against the given target container.
-func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref gwclient.Reference, withTestDeps llb.StateOption, target string) error {
+func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref gwclient.Reference, withTestDeps llb.StateOption, target string, platform *ocispecs.Platform) error {
 	if skipVar := client.BuildOpts().Opts["build-arg:"+"DALEC_SKIP_TESTS"]; skipVar != "" {
 		skip, err := strconv.ParseBool(skipVar)
 		if err != nil {
@@ -67,7 +68,7 @@ func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref
 		return err
 	}
 
-	sOpt, err := SourceOptFromClient(ctx, client)
+	sOpt, err := SourceOptFromClient(ctx, client, platform)
 	if err != nil {
 		return err
 	}
@@ -76,6 +77,7 @@ func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref
 		st     llb.State
 		t      *dalec.TestSpec
 		stdios map[int]llb.State
+		opts   []llb.ConstraintsOpt
 	}
 
 	ctrWithDeps := ctr.With(withTestDeps)
@@ -93,7 +95,7 @@ func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref
 		pg := llb.ProgressGroup(identity.NewID(), "Test: "+path.Join(target, test.Name), false)
 
 		for _, sm := range test.Mounts {
-			st, err := sm.Spec.AsMount(internalMountSourceName, sOpt, pg)
+			st, err := sm.Spec.AsMount(internalMountSourceName, sOpt, pg, dalec.Platform(platform))
 			if err != nil {
 				return err
 			}
@@ -119,18 +121,18 @@ func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref
 				if step.Stdin != "" {
 					needsStdioMount = true
 					stepOpts = append(stepOpts, llb.AddEnv("STDIN_FILE", filepath.Join("/tmp", id, "stdin")))
-					ioSt = ioSt.File(llb.Mkfile("stdin", 0444, []byte(step.Stdin)))
+					ioSt = ioSt.File(llb.Mkfile("stdin", 0444, []byte(step.Stdin)), pg)
 				}
 				if !step.Stdout.IsEmpty() {
 					needsStdioMount = true
 					stepOpts = append(stepOpts, llb.AddEnv("STDOUT_FILE", path.Join("/tmp", id, "stdout")))
-					ioSt = ioSt.File(llb.Mkfile("stdout", 0664, nil))
+					ioSt = ioSt.File(llb.Mkfile("stdout", 0664, nil), pg)
 				}
 
 				if !step.Stderr.IsEmpty() {
 					needsStdioMount = true
 					stepOpts = append(stepOpts, llb.AddEnv("STDERR_FILE", path.Join("/tmp", id, "stderr")))
-					ioSt = ioSt.File(llb.Mkfile("stderr", 0664, nil))
+					ioSt = ioSt.File(llb.Mkfile("stderr", 0664, nil), pg)
 				}
 
 				cmd, err := shlex.Split(step.Command)
@@ -165,9 +167,9 @@ func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref
 				worker = est.Root()
 			}
 
-			runs = append(runs, testPair{st: worker, t: test, stdios: ios})
+			runs = append(runs, testPair{st: worker, t: test, stdios: ios, opts: []llb.ConstraintsOpt{pg, dalec.Platform(platform)}})
 		} else {
-			runs = append(runs, testPair{st: base, t: test})
+			runs = append(runs, testPair{st: base, t: test, opts: []llb.ConstraintsOpt{pg, dalec.Platform(platform)}})
 		}
 	}
 
@@ -177,7 +179,7 @@ func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref
 		pair := pair
 		wg.Add(1)
 		go func() {
-			if err := runTest(ctx, pair.t, pair.st, pair.stdios, client); err != nil {
+			if err := runTest(ctx, pair.t, pair.st, pair.stdios, client, pair.opts...); err != nil {
 				errs.Append(errors.Wrap(err, "FAILED: "+path.Join(target, pair.t.Name)))
 			}
 			wg.Done()
@@ -193,8 +195,8 @@ type frontendClient interface {
 	CurrentFrontend() (*llb.State, error)
 }
 
-func runTest(ctx context.Context, t *dalec.TestSpec, st llb.State, ios map[int]llb.State, client gwclient.Client) error {
-	def, err := st.Marshal(ctx)
+func runTest(ctx context.Context, t *dalec.TestSpec, st llb.State, ios map[int]llb.State, client gwclient.Client, opts ...llb.ConstraintsOpt) error {
+	def, err := st.Marshal(ctx, opts...)
 	if err != nil {
 		return err
 	}
@@ -245,7 +247,7 @@ func runTest(ctx context.Context, t *dalec.TestSpec, st llb.State, ios map[int]l
 	}
 
 	for i, st := range ios {
-		def, err := st.Marshal(ctx)
+		def, err := st.Marshal(ctx, opts...)
 		if err != nil {
 			outErr = stderrors.Join(errors.Wrap(err, "failed to marshal stdio state"))
 			continue

helpers.go

@@ -634,3 +634,12 @@ func BaseImageConfig(platform *ocispecs.Platform) *DockerImageSpec {
 
 	return img
 }
+
+// Platform returns a [llb.ConstraintsOpt] that sets the platform to the provided platform
+// If the platform is nil, the [llb.ConstraintOpt] is a no-op.
+func Platform(platform *ocispecs.Platform) llb.ConstraintsOpt {
+	if platform == nil {
+		return constraintsOptFunc(func(c *llb.Constraints) {})
+	}
+	return llb.Platform(*platform)
+}

source.go

@@ -15,6 +15,7 @@ import (
 	"github.com/moby/buildkit/frontend/dockerui"
 	"github.com/moby/buildkit/identity"
 	"github.com/moby/buildkit/util/gitutil"
+	ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/pkg/errors"
 )
 
@@ -225,12 +226,13 @@ var (
 
 type LLBGetter func(sOpts SourceOpts, opts ...llb.ConstraintsOpt) (llb.State, error)
 
-type ForwarderFunc func(llb.State, *SourceBuild) (llb.State, error)
+type ForwarderFunc func(llb.State, *SourceBuild, ...llb.ConstraintsOpt) (llb.State, error)
 
 type SourceOpts struct {
-	Resolver   llb.ImageMetaResolver
-	Forward    ForwarderFunc
-	GetContext func(string, ...llb.LocalOption) (*llb.State, error)
+	Resolver       llb.ImageMetaResolver
+	Forward        ForwarderFunc
+	GetContext     func(string, ...llb.LocalOption) (*llb.State, error)
+	TargetPlatform *ocispecs.Platform
 }
 
 func (s *Source) asState(name string, forMount bool, sOpt SourceOpts, opts ...llb.ConstraintsOpt) (llb.State, error) {

source_build.go

@@ -61,7 +61,7 @@ func (src *SourceBuild) AsState(name string, sOpt SourceOpts, opts ...llb.Constr
 		st = llb.Scratch()
 	}
 
-	st, err = sOpt.Forward(st, src)
+	st, err = sOpt.Forward(st, src, opts...)
 	if err != nil {
 		return llb.Scratch(), err
 	}

source_test.go

@@ -837,7 +837,7 @@ func getSourceOp(ctx context.Context, t *testing.T, src Source) []*pb.Op {
 		if src.Build.Source.Inline == nil || src.Build.Source.Inline.File == nil {
 			t.Fatal("Cannot test from a Dockerfile without inline content")
 		}
-		sOpt.Forward = func(_ llb.State, build *SourceBuild) (llb.State, error) {
+		sOpt.Forward = func(_ llb.State, build *SourceBuild, _ ...llb.ConstraintsOpt) (llb.State, error) {
 			// Note, we can't really test anything other than inline here because we don't have access to the actual buildkit client,
 			// so we can't extract extract the dockerfile from the input state (nor do we have any input state)
 			src := []byte(src.Build.Source.Inline.File.Contents)

targets/linux/deb/distro/pkg.go

@@ -170,20 +170,21 @@ func (cfg *Config) RunTests(ctx context.Context, client gwclient.Client, _ llb.S
 	}
 
 	withTestDeps := cfg.InstallTestDeps(sOpt, targetKey, spec, opts...)
-	err = frontend.RunTests(ctx, client, spec, ref, withTestDeps, targetKey)
+	err = frontend.RunTests(ctx, client, spec, ref, withTestDeps, targetKey, sOpt.TargetPlatform)
 	return ref, err
 }
 
 func (cfg *Config) HandleSourcePkg(ctx context.Context, client gwclient.Client) (*gwclient.Result, error) {
 	return frontend.BuildWithPlatform(ctx, client, func(ctx context.Context, client gwclient.Client, platform *ocispecs.Platform, spec *dalec.Spec, targetKey string) (gwclient.Reference, *dalec.DockerImageSpec, error) {
-		sOpt, err := frontend.SourceOptFromClient(ctx, client)
+		sOpt, err := frontend.SourceOptFromClient(ctx, client, platform)
 		if err != nil {
 			return nil, nil, err
 		}
 
 		pg := dalec.ProgressGroup(spec.Name)
+		pc := dalec.Platform(platform)
 
-		worker, err := cfg.Worker(sOpt, pg)
+		worker, err := cfg.Worker(sOpt, pg, pc)
 		if err != nil {
 			return nil, nil, err
 		}
@@ -201,7 +202,7 @@ func (cfg *Config) HandleSourcePkg(ctx context.Context, client gwclient.Client)
 			return nil, nil, err
 		}
 
-		st, err := deb.SourcePackage(ctx, sOpt, worker.With(extraPaths), spec, targetKey, versionID, cfg, pg)
+		st, err := deb.SourcePackage(ctx, sOpt, worker.With(extraPaths), spec, targetKey, versionID, cfg, pg, pc)
 		if err != nil {
 			return nil, nil, errors.Wrap(err, "error building source package")
 		}