package tests import ( "encoding/json" "fmt" "os" "path/filepath" "testing" "github.com/containerd/continuity/fs/fstest" "github.com/docker/buildx/util/gitutil" "github.com/moby/buildkit/identity" provenancetypes "github.com/moby/buildkit/solver/llbsolver/provenance/types" "github.com/moby/buildkit/util/contentutil" "github.com/moby/buildkit/util/testutil" "github.com/moby/buildkit/util/testutil/integration" "github.com/pkg/errors" "github.com/stretchr/testify/require" ) func bakeCmd(sb integration.Sandbox, opts ...cmdOpt) (string, error) { opts = append([]cmdOpt{withArgs("bake", "--progress=quiet")}, opts...) cmd := buildxCmd(sb, opts...) out, err := cmd.CombinedOutput() return string(out), err } var bakeTests = []func(t *testing.T, sb integration.Sandbox){ testBakeLocal, testBakeLocalMulti, testBakeRemote, testBakeRemoteAuth, testBakeRemoteCmdContext, testBakeRemoteLocalOverride, testBakeLocalCwdOverride, testBakeRemoteCmdContextOverride, testBakeRemoteContextSubdir, testBakeRemoteCmdContextEscapeRoot, testBakeRemoteCmdContextEscapeRelative, testBakeRemoteDockerfileCwd, testBakeRemoteLocalContextRemoteDockerfile, testBakeEmpty, testBakeShmSize, testBakeUlimits, testBakeMetadata, testBakeMultiExporters, testBakeLoadPush, } func testBakeLocal(t *testing.T, sb integration.Sandbox) { dockerfile := []byte(` FROM scratch COPY foo /foo `) bakefile := []byte(` target "default" { } `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), fstest.CreateFile("foo", []byte("foo"), 0600), ) dirDest := t.TempDir() cmd := buildxCmd(sb, withDir(dir), withArgs("bake", "--progress=plain", "--set", "*.output=type=local,dest="+dirDest)) out, err := cmd.CombinedOutput() require.NoError(t, err, string(out)) require.Contains(t, string(out), `#1 [internal] load local bake definitions`) require.Contains(t, string(out), `#1 reading docker-bake.hcl`) require.FileExists(t, filepath.Join(dirDest, "foo")) } func testBakeLocalMulti(t *testing.T, sb integration.Sandbox) { dockerfile := []byte(` FROM scratch COPY foo /foo `) bakefile := []byte(` target "default" { } `) composefile := []byte(` services: app: build: {} `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("compose.yaml", composefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), fstest.CreateFile("foo", []byte("foo"), 0600), ) dirDest := t.TempDir() cmd := buildxCmd(sb, withDir(dir), withArgs("bake", "--progress=plain", "--set", "*.output=type=local,dest="+dirDest)) dt, err := cmd.CombinedOutput() require.NoError(t, err, string(dt)) require.Contains(t, string(dt), `#1 [internal] load local bake definitions`) require.Contains(t, string(dt), `#1 reading compose.yaml`) require.Contains(t, string(dt), `#1 reading docker-bake.hcl`) require.FileExists(t, filepath.Join(dirDest, "foo")) dirDest2 := t.TempDir() out, err := bakeCmd(sb, withDir(dir), withArgs("--file", "cwd://docker-bake.hcl", "--set", "*.output=type=local,dest="+dirDest2)) require.NoError(t, err, out) require.FileExists(t, filepath.Join(dirDest2, "foo")) } func testBakeRemote(t *testing.T, sb integration.Sandbox) { bakefile := []byte(` target "default" { dockerfile-inline = < /shmsize FROM scratch COPY --from=build /shmsize / `) bakefile := []byte(` target "default" { shm-size = "128m" } `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), ) dirDest := t.TempDir() out, err := bakeCmd( sb, withDir(dir), withArgs("--set", "*.output=type=local,dest="+dirDest), ) require.NoError(t, err, out) dt, err := os.ReadFile(filepath.Join(dirDest, "shmsize")) require.NoError(t, err) require.Contains(t, string(dt), `size=131072k`) } func testBakeUlimits(t *testing.T, sb integration.Sandbox) { dockerfile := []byte(` FROM busybox AS build RUN ulimit -n > first > /ulimit FROM scratch COPY --from=build /ulimit / `) bakefile := []byte(` target "default" { ulimits = ["nofile=1024:1024"] } `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), ) dirDest := t.TempDir() out, err := bakeCmd( sb, withDir(dir), withArgs("--set", "*.output=type=local,dest="+dirDest), ) require.NoError(t, err, out) dt, err := os.ReadFile(filepath.Join(dirDest, "ulimit")) require.NoError(t, err) require.Contains(t, string(dt), `1024`) } func testBakeMetadata(t *testing.T, sb integration.Sandbox) { t.Run("max", func(t *testing.T) { bakeMetadata(t, sb, "max") }) t.Run("min", func(t *testing.T) { bakeMetadata(t, sb, "min") }) t.Run("disabled", func(t *testing.T) { bakeMetadata(t, sb, "disabled") }) } func bakeMetadata(t *testing.T, sb integration.Sandbox, metadataMode string) { dockerfile := []byte(` FROM scratch COPY foo /foo `) bakefile := []byte(` target "default" { } `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), fstest.CreateFile("foo", []byte("foo"), 0600), ) dirDest := t.TempDir() outFlag := "default.output=type=docker" if sb.DockerAddress() == "" { // there is no Docker atm to load the image outFlag += ",dest=" + dirDest + "/image.tar" } cmd := buildxCmd( sb, withDir(dir), withArgs("bake", "--metadata-file", filepath.Join(dirDest, "md.json"), "--set", outFlag), withEnv("BUILDX_METADATA_PROVENANCE="+metadataMode), ) out, err := cmd.CombinedOutput() require.NoError(t, err, out) dt, err := os.ReadFile(filepath.Join(dirDest, "md.json")) require.NoError(t, err) type mdT struct { Default struct { BuildRef string `json:"buildx.build.ref"` BuildProvenance map[string]interface{} `json:"buildx.build.provenance"` } `json:"default"` } var md mdT err = json.Unmarshal(dt, &md) require.NoError(t, err) require.NotEmpty(t, md.Default.BuildRef) if metadataMode == "disabled" { require.Empty(t, md.Default.BuildProvenance) return } require.NotEmpty(t, md.Default.BuildProvenance) dtprv, err := json.Marshal(md.Default.BuildProvenance) require.NoError(t, err) var prv provenancetypes.ProvenancePredicate require.NoError(t, json.Unmarshal(dtprv, &prv)) require.Equal(t, provenancetypes.BuildKitBuildType, prv.BuildType) } func testBakeMultiExporters(t *testing.T, sb integration.Sandbox) { if !isDockerContainerWorker(sb) { t.Skip("only testing with docker-container worker") } skipNoCompatBuildKit(t, sb, ">= 0.13.0-0", "multi exporters") registry, err := sb.NewRegistry() if errors.Is(err, integration.ErrRequirements) { t.Skip(err.Error()) } require.NoError(t, err) targetReg := registry + "/buildx/registry:latest" targetStore := "buildx:local-" + identity.NewID() t.Cleanup(func() { cmd := dockerCmd(sb, withArgs("image", "rm", targetStore)) cmd.Stderr = os.Stderr require.NoError(t, cmd.Run()) }) dockerfile := []byte(` FROM scratch COPY foo /foo `) bakefile := []byte(` target "default" { } `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), fstest.CreateFile("foo", []byte("foo"), 0600), ) outputs := []string{ "--set", fmt.Sprintf("*.output=type=image,name=%s,push=true", targetReg), "--set", fmt.Sprintf("*.output=type=docker,name=%s", targetStore), "--set", fmt.Sprintf("*.output=type=oci,dest=%s/result", dir), } cmd := buildxCmd(sb, withDir(dir), withArgs("bake"), withArgs(outputs...)) outb, err := cmd.CombinedOutput() require.NoError(t, err, string(outb)) // test registry desc, provider, err := contentutil.ProviderFromRef(targetReg) require.NoError(t, err) _, err = testutil.ReadImages(sb.Context(), provider, desc) require.NoError(t, err) // test docker store cmd = dockerCmd(sb, withArgs("image", "inspect", targetStore)) cmd.Stderr = os.Stderr require.NoError(t, cmd.Run()) // test oci _, err = os.ReadFile(fmt.Sprintf("%s/result", dir)) require.NoError(t, err) // TODO: test metadata file when supported by multi exporters https://github.com/docker/buildx/issues/2181 } func testBakeLoadPush(t *testing.T, sb integration.Sandbox) { if !isDockerContainerWorker(sb) { t.Skip("only testing with docker-container worker") } skipNoCompatBuildKit(t, sb, ">= 0.13.0-0", "multi exporters") registry, err := sb.NewRegistry() if errors.Is(err, integration.ErrRequirements) { t.Skip(err.Error()) } require.NoError(t, err) target := registry + "/buildx/registry:" + identity.NewID() t.Cleanup(func() { cmd := dockerCmd(sb, withArgs("image", "rm", target)) cmd.Stderr = os.Stderr require.NoError(t, cmd.Run()) }) dockerfile := []byte(` FROM scratch COPY foo /foo `) bakefile := []byte(` target "default" { } `) dir := tmpdir( t, fstest.CreateFile("docker-bake.hcl", bakefile, 0600), fstest.CreateFile("Dockerfile", dockerfile, 0600), fstest.CreateFile("foo", []byte("foo"), 0600), ) cmd := buildxCmd(sb, withDir(dir), withArgs("bake", "--push", "--load", fmt.Sprintf("--set=*.tags=%s", target))) outb, err := cmd.CombinedOutput() require.NoError(t, err, string(outb)) // test registry desc, provider, err := contentutil.ProviderFromRef(target) require.NoError(t, err) _, err = testutil.ReadImages(sb.Context(), provider, desc) require.NoError(t, err) // test docker store cmd = dockerCmd(sb, withArgs("image", "inspect", target)) cmd.Stderr = os.Stderr require.NoError(t, cmd.Run()) // TODO: test metadata file when supported by multi exporters https://github.com/docker/buildx/issues/2181 }