From 8f576e579024eae301eef1fc04402352648df1f2 Mon Sep 17 00:00:00 2001 From: Tonis Tiigi Date: Fri, 8 Mar 2024 12:20:00 -0800 Subject: [PATCH 1/2] remote: fix connhelpers with custom dialer With the new dial-stdio command the dialer is split from `Client` function in order to access it directly. This breaks the custom connhelpers functionality as support for connhelpers is a feature of the default dialer. If client defines a custom dialer then only it is used without extra modifications. This means that remote driver dialer needs to detect the connhelpers on its own. Signed-off-by: Tonis Tiigi --- driver/remote/driver.go | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/driver/remote/driver.go b/driver/remote/driver.go index 5f51e8f071b..0dc676cf36b 100644 --- a/driver/remote/driver.go +++ b/driver/remote/driver.go @@ -13,6 +13,7 @@ import ( util "github.com/docker/buildx/driver/remote/util" "github.com/docker/buildx/util/progress" "github.com/moby/buildkit/client" + "github.com/moby/buildkit/client/connhelper" "github.com/moby/buildkit/util/tracing/detect" "github.com/pkg/errors" ) @@ -95,7 +96,16 @@ func (d *Driver) Client(ctx context.Context) (*client.Client, error) { } func (d *Driver) Dial(ctx context.Context) (net.Conn, error) { - network, addr, ok := strings.Cut(d.InitConfig.EndpointAddr, "://") + addr := d.InitConfig.EndpointAddr + ch, err := connhelper.GetConnectionHelper(addr) + if err != nil { + return nil, err + } + if ch != nil { + return ch.ContextDialer(ctx, addr) + } + + network, addr, ok := strings.Cut(addr, "://") if !ok { return nil, errors.Errorf("invalid endpoint address: %s", d.InitConfig.EndpointAddr) } From b1490ed5ce6fc62b3731abeae8c7103f2a71e512 Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Sat, 9 Mar 2024 17:02:52 +0100 Subject: [PATCH 2/2] tests: create remote with container helper Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com> --- builder/node.go | 2 +- driver/driver.go | 14 +++++++++ driver/kubernetes/factory.go | 6 ++-- driver/kubernetes/factory_test.go | 2 +- tests/create.go | 51 +++++++++++++++++++++++++++++++ 5 files changed, 70 insertions(+), 5 deletions(-) diff --git a/builder/node.go b/builder/node.go index 14f6ec1d234..64a990fcf31 100644 --- a/builder/node.go +++ b/builder/node.go @@ -142,7 +142,7 @@ func (b *Builder) LoadNodes(ctx context.Context, opts ...LoadNodesOption) (_ []N } } - d, err := driver.GetDriver(ctx, "buildx_buildkit_"+n.Name, factory, n.Endpoint, dockerapi, imageopt.Auth, kcc, n.BuildkitdFlags, n.Files, n.DriverOpts, n.Platforms, b.opts.contextPathHash, lno.dialMeta) + d, err := driver.GetDriver(ctx, driver.BuilderName(n.Name), factory, n.Endpoint, dockerapi, imageopt.Auth, kcc, n.BuildkitdFlags, n.Files, n.DriverOpts, n.Platforms, b.opts.contextPathHash, lno.dialMeta) if err != nil { node.Err = err return nil diff --git a/driver/driver.go b/driver/driver.go index 6d3c546737c..da49b75f66e 100644 --- a/driver/driver.go +++ b/driver/driver.go @@ -4,6 +4,7 @@ import ( "context" "io" "net" + "strings" "github.com/docker/buildx/store" "github.com/docker/buildx/util/progress" @@ -67,6 +68,19 @@ type Driver interface { Config() InitConfig } +const builderNamePrefix = "buildx_buildkit_" + +func BuilderName(name string) string { + return builderNamePrefix + name +} + +func ParseBuilderName(name string) (string, error) { + if !strings.HasPrefix(name, builderNamePrefix) { + return "", errors.Errorf("invalid builder name %q, must have %q prefix", name, builderNamePrefix) + } + return strings.TrimPrefix(name, builderNamePrefix), nil +} + func Boot(ctx, clientContext context.Context, d *DriverHandle, pw progress.Writer) (*client.Client, error) { try := 0 for { diff --git a/driver/kubernetes/factory.go b/driver/kubernetes/factory.go index 56384dbfbf4..c6e2e48e444 100644 --- a/driver/kubernetes/factory.go +++ b/driver/kubernetes/factory.go @@ -244,10 +244,10 @@ func (f *factory) AllowsInstances() bool { // eg. "buildx_buildkit_loving_mendeleev0" -> "loving-mendeleev0" func buildxNameToDeploymentName(bx string) (string, error) { // TODO: commands.util.go should not pass "buildx_buildkit_" prefix to drivers - if !strings.HasPrefix(bx, "buildx_buildkit_") { - return "", errors.Errorf("expected a string with \"buildx_buildkit_\", got %q", bx) + s, err := driver.ParseBuilderName(bx) + if err != nil { + return "", err } - s := strings.TrimPrefix(bx, "buildx_buildkit_") s = strings.ReplaceAll(s, "_", "-") return s, nil } diff --git a/driver/kubernetes/factory_test.go b/driver/kubernetes/factory_test.go index 605be96e1aa..9b6224bd274 100644 --- a/driver/kubernetes/factory_test.go +++ b/driver/kubernetes/factory_test.go @@ -29,7 +29,7 @@ func TestFactory_processDriverOpts(t *testing.T) { } cfg := driver.InitConfig{ - Name: "buildx_buildkit_test", + Name: driver.BuilderName("test"), KubeClientConfig: &kcc, } f := factory{} diff --git a/tests/create.go b/tests/create.go index a37fa3da902..1a2757fcad5 100644 --- a/tests/create.go +++ b/tests/create.go @@ -1,9 +1,13 @@ package tests import ( + "fmt" + "os" "strings" "testing" + "github.com/docker/buildx/driver" + "github.com/moby/buildkit/identity" "github.com/moby/buildkit/util/testutil/integration" "github.com/stretchr/testify/require" ) @@ -18,6 +22,7 @@ func createCmd(sb integration.Sandbox, opts ...cmdOpt) (string, error) { var createTests = []func(t *testing.T, sb integration.Sandbox){ testCreateMemoryLimit, testCreateRestartAlways, + testCreateRemoteContainer, } func testCreateMemoryLimit(t *testing.T, sb integration.Sandbox) { @@ -57,3 +62,49 @@ func testCreateRestartAlways(t *testing.T, sb integration.Sandbox) { require.NoError(t, err, out) builderName = strings.TrimSpace(out) } + +func testCreateRemoteContainer(t *testing.T, sb integration.Sandbox) { + if sb.Name() != "docker" { + t.Skip("skipping test for non-docker workers") + } + + ctnBuilderName := "ctn-builder-" + identity.NewID() + remoteBuilderName := "remote-builder-" + identity.NewID() + var hasCtnBuilder, hasRemoteBuilder bool + t.Cleanup(func() { + if hasCtnBuilder { + out, err := rmCmd(sb, withArgs(ctnBuilderName)) + require.NoError(t, err, out) + } + if hasRemoteBuilder { + out, err := rmCmd(sb, withArgs(remoteBuilderName)) + require.NoError(t, err, out) + } + }) + + out, err := createCmd(sb, withArgs("--driver", "docker-container", "--name", ctnBuilderName)) + require.NoError(t, err, out) + hasCtnBuilder = true + + out, err = inspectCmd(sb, withArgs("--bootstrap", ctnBuilderName)) + require.NoError(t, err, out) + + cmd := dockerCmd(sb, withArgs("container", "inspect", fmt.Sprintf("%s0", driver.BuilderName(ctnBuilderName)))) + cmd.Stderr = os.Stderr + require.NoError(t, cmd.Run()) + + out, err = createCmd(sb, withArgs("--driver", "remote", "--name", remoteBuilderName, fmt.Sprintf("docker-container://%s0", driver.BuilderName(ctnBuilderName)))) + require.NoError(t, err, out) + hasRemoteBuilder = true + + out, err = inspectCmd(sb, withArgs(remoteBuilderName)) + require.NoError(t, err, out) + + for _, line := range strings.Split(out, "\n") { + if v, ok := strings.CutPrefix(line, "Status:"); ok { + require.Equal(t, strings.TrimSpace(v), "running") + return + } + } + require.Fail(t, "remote builder is not running") +}