Skip to content

exporter: add session exporter capability #5907

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

Merged
crazy-max merged 1 commit into from
Apr 11, 2025
Merged

exporter: add session exporter capability #5907

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
709 changes: 360 additions & 349 deletions api/services/control/control.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions api/services/control/control.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ message SolveRequest {
bool Internal = 11; // Internal builds are not recorded in build history
moby.buildkit.v1.sourcepolicy.Policy SourcePolicy = 12;
repeated Exporter Exporters = 13;
bool EnableSessionExporter = 14;
}

message CacheOptions {
Expand Down
37 changes: 37 additions & 0 deletions api/services/control/control_vtproto.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

86 changes: 86 additions & 0 deletions client/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"os"
"path"
"path/filepath"
"runtime"
"strconv"
"strings"
"syscall"
Expand Down Expand Up @@ -46,6 +47,8 @@ import (
gatewaypb "github.com/moby/buildkit/frontend/gateway/pb"
"github.com/moby/buildkit/identity"
"github.com/moby/buildkit/session"
"github.com/moby/buildkit/session/exporter"
"github.com/moby/buildkit/session/exporter/exporterprovider"
"github.com/moby/buildkit/session/filesync"
"github.com/moby/buildkit/session/secrets/secretsprovider"
"github.com/moby/buildkit/session/sshforward/sshprovider"
Expand Down Expand Up @@ -114,6 +117,7 @@ var allTests = []func(t *testing.T, sb integration.Sandbox){
testUser,
testOCIExporter,
testOCIExporterContentStore,
testSessionExporter,
testWhiteoutParentDir,
testFrontendImageNaming,
testDuplicateWhiteouts,
Expand Down Expand Up @@ -2310,6 +2314,88 @@ func testOCILayoutSource(t *testing.T, sb integration.Sandbox) {
require.Equal(t, []byte("second"+newLine), dt)
}

func testSessionExporter(t *testing.T, sb integration.Sandbox) {
workers.CheckFeatureCompat(t, sb, workers.FeatureOCIExporter, workers.FeatureOCILayout)
c, err := New(context.TODO(), sb.Address())
require.NoError(t, err)
defer c.Close()

// make an image that is exported there
imgName := integration.UnixOrWindows("busybox:latest", "nanoserver:latest")
busybox := llb.Image(imgName)
st := integration.UnixOrWindows(
llb.Scratch(),
llb.Image(imgName),
)

run := func(cmd string) {
st = busybox.Run(llb.Shlex(cmd), llb.Dir("/wd")).AddMount("/wd", st)
}

cmdPrefix := integration.UnixOrWindows(
`sh -c "echo -n`,
`cmd /C "echo`,
)
run(fmt.Sprintf(`%s first > foo"`, cmdPrefix))
run(fmt.Sprintf(`%s second > bar"`, cmdPrefix))

def, err := st.Marshal(sb.Context())
require.NoError(t, err)

var attachable []session.Attachable
target := filesync.NewFSSyncTarget()

attachable = append(attachable, target)

outW := bytes.NewBuffer(nil)
exporterCalled := false
exporter := exporterprovider.New(func(ctx context.Context, md map[string][]byte) ([]*exporter.ExporterRequest, error) {
exporterCalled = true
target.Add(filesync.WithFSSync(0, fixedWriteCloser(nopWriteCloser{outW})))
return []*exporter.ExporterRequest{
{
Type: ExporterOCI,
Attrs: map[string]string{
"compression": "zstd",
},
},
}, nil
})
require.NoError(t, err)
attachable = append(attachable, exporter)

_, err = c.Solve(sb.Context(), def, SolveOpt{
EnableSessionExporter: true,
Session: attachable,
}, nil)
require.NoError(t, err)

require.True(t, exporterCalled)

// extract the tar stream to the directory as OCI layout
m, err := testutil.ReadTarToMap(outW.Bytes(), false)
require.NoError(t, err)

var index ocispecs.Index
err = json.Unmarshal(m[ocispecs.ImageIndexFile].Data, &index)
require.NoError(t, err)
require.Equal(t, 1, len(index.Manifests))
digest := index.Manifests[0].Digest

var mfst ocispecs.Manifest
err = json.Unmarshal(m[path.Join("blobs/sha256", digest.Hex())].Data, &mfst)
require.NoError(t, err)

if runtime.GOOS == "windows" {
mfst.Layers = mfst.Layers[1:] // skip base layer
}

require.Equal(t, 2, len(mfst.Layers))
for _, layer := range mfst.Layers {
require.Contains(t, layer.MediaType, "application/vnd.oci.image.layer.v1.tar+zstd")
}
}

func testOCILayoutPlatformSource(t *testing.T, sb integration.Sandbox) {
workers.CheckFeatureCompat(t, sb, workers.FeatureOCIExporter, workers.FeatureOCILayout)
requiresLinux(t)
Expand Down
2 changes: 2 additions & 0 deletions client/solve.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import (

type SolveOpt struct {
Exports []ExportEntry
EnableSessionExporter bool
LocalDirs map[string]string // Deprecated: use LocalMounts
LocalMounts map[string]fsutil.FS
OCIStores map[string]content.Store
Expand Down Expand Up @@ -270,6 +271,7 @@ func (c *Client) solve(ctx context.Context, def *llb.Definition, runGateway runG
Exporters: exports,
ExporterDeprecated: exportDeprecated,
ExporterAttrsDeprecated: exportAttrDeprecated,
EnableSessionExporter: opt.EnableSessionExporter,
Session: s.ID(),
Frontend: opt.Frontend,
FrontendAttrs: frontendAttrs,
Expand Down
5 changes: 3 additions & 2 deletions control/control.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,8 +514,9 @@ func (c *Controller) Solve(ctx context.Context, req *controlapi.SolveRequest) (*
FrontendInputs: req.FrontendInputs,
CacheImports: cacheImports,
}, llbsolver.ExporterRequest{
Exporters: expis,
CacheExporters: cacheExporters,
Exporters: expis,
CacheExporters: cacheExporters,
EnableSessionExporter: req.EnableSessionExporter,
}, entitlementsFromPB(req.Entitlements), procs, req.Internal, req.SourcePolicy)
if err != nil {
return nil, err
Expand Down
21 changes: 21 additions & 0 deletions session/exporter/exporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package exporter

import (
"context"

"github.com/moby/buildkit/session"
"github.com/pkg/errors"
)

func New(ctx context.Context, c session.Caller, result map[string][]byte) ([]*ExporterRequest, error) {
client := NewExporterClient(c.Conn())

res, err := client.FindExporters(ctx, &FindExportersRequest{
Metadata: result,
})
if err != nil {
return nil, errors.WithStack(err)
}

return res.Exporters, nil
}
Loading