-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Allow copa to use buildkit from dockerd
This changes the default to attempt to connect to docker's built-in buildkit instance. If the built-in instance is not capable of supporting the features required for copy it will log the issue and fallback to the default buildkit buildkit address. Also happens to check if the configured buildkit instance supports what is required. Signed-off-by: Brian Goff <[email protected]>
- Loading branch information
Showing
6 changed files
with
270 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| package buildkit | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "net" | ||
| "path/filepath" | ||
| "testing" | ||
| "time" | ||
|
|
||
| controlapi "github.com/moby/buildkit/api/services/control" | ||
| types "github.com/moby/buildkit/api/types" | ||
| gateway "github.com/moby/buildkit/frontend/gateway/pb" | ||
| "github.com/moby/buildkit/util/apicaps" | ||
| caps "github.com/moby/buildkit/util/apicaps/pb" | ||
| "google.golang.org/grpc" | ||
| ) | ||
|
|
||
| type mockControlServer struct { | ||
| controlapi.ControlServer | ||
| } | ||
|
|
||
| func (s *mockControlServer) ListWorkers(context.Context, *controlapi.ListWorkersRequest) (*controlapi.ListWorkersResponse, error) { | ||
| return &controlapi.ListWorkersResponse{ | ||
| Record: []*types.WorkerRecord{}, | ||
| }, nil | ||
| } | ||
|
|
||
| func (s *mockControlServer) Session(controlapi.Control_SessionServer) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (s *mockControlServer) Status(*controlapi.StatusRequest, controlapi.Control_StatusServer) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (s *mockControlServer) Solve(context.Context, *controlapi.SolveRequest) (*controlapi.SolveResponse, error) { | ||
| return &controlapi.SolveResponse{}, nil | ||
| } | ||
|
|
||
| type mockLLBBridgeServer struct { | ||
| gateway.LLBBridgeServer | ||
| caps []caps.APICap | ||
| } | ||
|
|
||
| func (m *mockLLBBridgeServer) Ping(context.Context, *gateway.PingRequest) (*gateway.PongResponse, error) { | ||
| return &gateway.PongResponse{ | ||
| FrontendAPICaps: m.caps, | ||
| LLBCaps: m.caps, | ||
| }, nil | ||
| } | ||
|
|
||
| func (m *mockLLBBridgeServer) Solve(context.Context, *gateway.SolveRequest) (*gateway.SolveResponse, error) { | ||
| return &gateway.SolveResponse{}, nil | ||
| } | ||
|
|
||
| func makeCapList(capIDs ...apicaps.CapID) []caps.APICap { | ||
| var ( | ||
| ls apicaps.CapList | ||
| caps = make([]apicaps.Cap, 0, len(capIDs)) | ||
| ) | ||
|
|
||
| for _, id := range capIDs { | ||
| caps = append(caps, apicaps.Cap{ | ||
| ID: id, | ||
| Enabled: true, | ||
| }) | ||
| } | ||
|
|
||
| ls.Init(caps...) | ||
| return ls.All() | ||
| } | ||
|
|
||
| func newMockBuildkitAPI(t *testing.T, caps ...apicaps.CapID) string { | ||
| tmp := t.TempDir() | ||
| l, err := net.Listen("unix", filepath.Join(tmp, "buildkitd.sock")) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| t.Cleanup(func() { l.Close() }) | ||
|
|
||
| srv := grpc.NewServer() | ||
| t.Cleanup(srv.Stop) | ||
|
|
||
| capList := makeCapList(caps...) | ||
| gateway.RegisterLLBBridgeServer(srv, &mockLLBBridgeServer{ | ||
| LLBBridgeServer: &gateway.UnimplementedLLBBridgeServer{}, | ||
| caps: capList, | ||
| }) | ||
|
|
||
| go srv.Serve(l) | ||
|
|
||
| control := &mockControlServer{ | ||
| ControlServer: &controlapi.UnimplementedControlServer{}, | ||
| } | ||
| controlapi.RegisterControlServer(srv, control) | ||
|
|
||
| return l.Addr().String() | ||
| } | ||
|
|
||
| func unwrapErrors(err error) []error { | ||
| // `errors.Unwrap` uses this interface | ||
| // buildkit errors may be wrapped in this | ||
| type stdUnwrap interface { | ||
| Unwrap() error | ||
| } | ||
|
|
||
| // The type used by `errors.Join` uses this interface | ||
| type joinedUnwrap interface { | ||
| Unwrap() []error | ||
| } | ||
|
|
||
| var out []error | ||
| switch v := err.(type) { | ||
| case stdUnwrap: | ||
| return unwrapErrors(v.Unwrap()) | ||
| case joinedUnwrap: | ||
| for _, e := range v.Unwrap() { | ||
| // multiple calls to `errors.Join` may result in nested wraps, so recurse on those errors | ||
| out = append(out, unwrapErrors(e)...) | ||
| } | ||
| default: | ||
| out = append(out, err) | ||
| } | ||
|
|
||
| return out | ||
| } | ||
|
|
||
| func checkMissingCapsError(t *testing.T, err error, caps ...apicaps.CapID) { | ||
| t.Helper() | ||
| lsErr := unwrapErrors(err) | ||
| found := make(map[apicaps.CapID]bool, len(caps)) | ||
| for _, err := range lsErr { | ||
| check := &apicaps.CapError{} | ||
| if errors.As(err, &check) { | ||
| found[check.ID] = true | ||
| } | ||
| } | ||
| if len(found) != len(caps) { | ||
| t.Errorf("expected %d errors, got: %d", len(caps), len(found)) | ||
| t.Error(lsErr) | ||
| } | ||
| } | ||
|
|
||
| func TestNewClient(t *testing.T) { | ||
| ctx := context.Background() | ||
|
|
||
| t.Run("custom buildkit addr", func(t *testing.T) { | ||
| t.Run("missing caps", func(t *testing.T) { | ||
| t.Parallel() | ||
| addr := newMockBuildkitAPI(t) | ||
| ctxT, cancel := context.WithTimeout(ctx, time.Second) | ||
| client, err := NewClient(ctxT, "unix://"+addr) | ||
| cancel() | ||
| defer func() { | ||
| if client != nil { | ||
| client.Close() | ||
| } | ||
| }() | ||
| if !errors.Is(err, errMissingCap) { | ||
| t.Fatalf("expected error %q, got: %s", errMissingCap, err) | ||
| } | ||
| checkMissingCapsError(t, err, requiredCaps...) | ||
| }) | ||
| t.Run("with caps", func(t *testing.T) { | ||
| t.Parallel() | ||
| addr := newMockBuildkitAPI(t, requiredCaps...) | ||
|
|
||
| ctxT, cancel := context.WithTimeout(ctx, time.Second) | ||
| defer cancel() | ||
| client, err := NewClient(ctxT, "unix://"+addr) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| client.Close() | ||
| }) | ||
| }) | ||
|
|
||
| // TODO: Test with defaults, but then we need to control those socket paths. | ||
| // I considered doing this in a chroot, but it is fairly complicated to do so and requires root privileges anyway (or CAP_SYS_CHROOT). | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters