package llbtest import ( "context" "strings" "testing" "github.com/containerd/platforms" "github.com/moby/buildkit/client/llb" "github.com/moby/buildkit/solver" "github.com/moby/buildkit/solver/llbsolver" "github.com/moby/buildkit/solver/pb" "github.com/moby/buildkit/util/system" ocispecs "github.com/opencontainers/image-spec/specs-go/v1" "github.com/stretchr/testify/require" ) func TestCustomPlatform(t *testing.T) { t.Parallel() s := llb.Image("foo", llb.LinuxArmhf). Run(llb.Shlex("baz")). Run(llb.Shlex("bar")). Run(llb.Shlex("bax"), llb.Windows). Run(llb.Shlex("bay")) def, err := s.Marshal(context.TODO()) require.NoError(t, err) e, err := llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) require.Equal(t, 5, depth(e)) expected := ocispecs.Platform{OS: "windows", Architecture: "amd64"} require.Equal(t, expected, platform(e)) e = parent(e, 0) require.Equal(t, expected, platform(e)) e = parent(e, 0) expected = ocispecs.Platform{OS: "linux", Architecture: "arm", Variant: "v7"} require.Equal(t, expected, platform(e)) e = parent(e, 0) require.Equal(t, expected, platform(e)) require.Equal(t, []string{"baz"}, args(e)) e = parent(e, 0) require.Equal(t, expected, platform(e)) require.Equal(t, "docker-image://docker.io/library/foo:latest", id(e)) } func TestDefaultPlatform(t *testing.T) { t.Parallel() s := llb.Image("foo").Run(llb.Shlex("bar")) def, err := s.Marshal(context.TODO()) require.NoError(t, err) e, err := llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) require.Equal(t, 2, depth(e)) // needs extra normalize for default spec // https://github.com/moby/buildkit/pull/2427#issuecomment-952301867 expected := platforms.Normalize(platforms.DefaultSpec()) require.Equal(t, expected, platform(e)) require.Equal(t, []string{"bar"}, args(e)) e = parent(e, 0) require.Equal(t, expected, platform(e)) require.Equal(t, "docker-image://docker.io/library/foo:latest", id(e)) } func TestPlatformOnMarshal(t *testing.T) { t.Parallel() s := llb.Image("image1").Run(llb.Shlex("bar")) def, err := s.Marshal(context.TODO(), llb.Windows) require.NoError(t, err) e, err := llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) expected := ocispecs.Platform{OS: "windows", Architecture: "amd64"} require.Equal(t, expected, platform(e)) e = parent(e, 0) require.Equal(t, expected, platform(e)) require.Equal(t, "docker-image://docker.io/library/image1:latest", id(e)) } func TestPlatformMixed(t *testing.T) { t.Parallel() s1 := llb.Image("image1").Run(llb.Shlex("cmd-main")) s2 := llb.Image("image2", llb.LinuxArmel).Run(llb.Shlex("cmd-sub")) s1.AddMount("/mnt", s2.Root()) def, err := s1.Marshal(context.TODO(), llb.LinuxAmd64) require.NoError(t, err) e, err := llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) require.Equal(t, 4, depth(e)) expectedAmd := ocispecs.Platform{OS: "linux", Architecture: "amd64"} require.Equal(t, []string{"cmd-main"}, args(e)) require.Equal(t, expectedAmd, platform(e)) e1 := mount(e, "/") require.Equal(t, "docker-image://docker.io/library/image1:latest", id(e1)) require.Equal(t, expectedAmd, platform(e1)) expectedArm := ocispecs.Platform{OS: "linux", Architecture: "arm", Variant: "v6"} e2 := mount(e, "/mnt") require.Equal(t, []string{"cmd-sub"}, args(e2)) require.Equal(t, expectedArm, platform(e2)) e2 = parent(e2, 0) require.Equal(t, "docker-image://docker.io/library/image2:latest", id(e2)) require.Equal(t, expectedArm, platform(e2)) } func TestFallbackPath(t *testing.T) { t.Parallel() // With no caps we expect no PATH but also no requirement for // the cap. def, err := llb.Scratch().Run(llb.Shlex("cmd")).Marshal(context.TODO(), llb.LinuxAmd64) require.NoError(t, err) e, err := llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) require.False(t, def.Metadata[e.Vertex.Digest()].Caps[pb.CapExecMetaSetsDefaultPath]) _, ok := getenv(e, "PATH") require.False(t, ok) // For an empty capset we expect a system-specific default PATH, and // no requirement for the cap. cs := pb.Caps.CapSet(nil) require.Error(t, cs.Supports(pb.CapExecMetaSetsDefaultPath)) def, err = llb.Scratch().Run(llb.Shlex("cmd")).Marshal(context.TODO(), llb.LinuxAmd64, llb.WithCaps(cs)) require.NoError(t, err) e, err = llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) require.False(t, def.Metadata[e.Vertex.Digest()].Caps[pb.CapExecMetaSetsDefaultPath]) v, ok := getenv(e, "PATH") require.True(t, ok) require.Equal(t, system.DefaultPathEnvUnix, v) // All capabilities, including pb.CapExecMetaSetsDefaultPath, // so should get no PATH (not present at all, rather than // present and empty), but also require the cap. cs = pb.Caps.CapSet(pb.Caps.All()) require.NoError(t, cs.Supports(pb.CapExecMetaSetsDefaultPath)) def, err = llb.Scratch().Run(llb.Shlex("cmd")).Marshal(context.TODO(), llb.LinuxAmd64, llb.WithCaps(cs)) require.NoError(t, err) e, err = llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) require.True(t, def.Metadata[e.Vertex.Digest()].Caps[pb.CapExecMetaSetsDefaultPath]) _, ok = getenv(e, "PATH") require.False(t, ok) // If we provide a path it should not be touched, no matter // what caps we pass in. Whether the cap becomes required is // irrelevant. for _, cos := range [][]llb.ConstraintsOpt{ nil, {llb.WithCaps(pb.Caps.CapSet(nil))}, {llb.WithCaps(pb.Caps.CapSet(pb.Caps.All()))}, } { def, err = llb.Scratch().AddEnv("PATH", "foo").Run(llb.Shlex("cmd")).Marshal(context.TODO(), append(cos, llb.LinuxAmd64)...) require.NoError(t, err) e, err = llbsolver.Load(context.TODO(), def.ToPB(), nil) require.NoError(t, err) // pb.CapExecMetaSetsDefaultPath setting is irrelevant (and variable). v, ok = getenv(e, "PATH") require.True(t, ok) require.Equal(t, "foo", v) } } func toOp(e solver.Edge) *pb.Op { return e.Vertex.Sys().(*pb.Op) } func platform(e solver.Edge) ocispecs.Platform { p := toOp(e).Platform return ocispecs.Platform{ OS: p.OS, Architecture: p.Architecture, Variant: p.Variant, OSVersion: p.OSVersion, OSFeatures: p.OSFeatures, } } func depth(e solver.Edge) int { i := 1 for _, inp := range e.Vertex.Inputs() { i += depth(inp) } return i } func parent(e solver.Edge, i int) solver.Edge { return e.Vertex.Inputs()[i] } func id(e solver.Edge) string { return toOp(e).GetSource().Identifier } func args(e solver.Edge) []string { return toOp(e).GetExec().Meta.Args } func mount(e solver.Edge, target string) solver.Edge { op := toOp(e).GetExec() for _, m := range op.Mounts { if m.Dest == target { return e.Vertex.Inputs()[int(m.Input)] } } panic("could not find mount " + target) } func getenv(e solver.Edge, k string) (string, bool) { env := toOp(e).GetExec().Meta.Env k = k + "=" for _, e := range env { if after, ok := strings.CutPrefix(e, k); ok { return after, true } } return "", false }