Merge pull request moby#3866 from jedevc/public-integration-workers

jedevc · web-flow · commit fec5a04d16be · 2023-05-15T10:12:55.000+01:00
diff --git a/util/testutil/integration/containerd.go b/util/testutil/integration/containerd.go
@@ -18,9 +18,9 @@ import (
 )
 
 func InitContainerdWorker() {
-	Register(&containerd{
-		name:       "containerd",
-		containerd: "containerd",
+	Register(&Containerd{
+		ID:         "containerd",
+		Containerd: "containerd",
 	})
 	// defined in Dockerfile
 	// e.g. `containerd-1.1=/opt/containerd-1.1/bin,containerd-42.0=/opt/containerd-42.0/bin`
@@ -32,11 +32,11 @@ func InitContainerdWorker() {
 				panic(errors.Errorf("unexpected BUILDKIT_INTEGRATION_CONTAINERD_EXTRA: %q", s))
 			}
 			name, bin := pair[0], pair[1]
-			Register(&containerd{
-				name:       name,
-				containerd: filepath.Join(bin, "containerd"),
+			Register(&Containerd{
+				ID:         name,
+				Containerd: filepath.Join(bin, "containerd"),
 				// override PATH to make sure that the expected version of the shim binary is used
-				extraEnv: []string{fmt.Sprintf("PATH=%s:%s", bin, os.Getenv("PATH"))},
+				ExtraEnv: []string{fmt.Sprintf("PATH=%s:%s", bin, os.Getenv("PATH"))},
 			})
 		}
 	}
@@ -48,44 +48,44 @@ func InitContainerdWorker() {
 			bklog.L.Fatalf("unexpected BUILDKIT_INTEGRATION_ROOTLESS_IDPAIR: %q", s)
 		}
 		if rootlessSupported(uid) {
-			Register(&containerd{
-				name:        "containerd-rootless",
-				containerd:  "containerd",
-				uid:         uid,
-				gid:         gid,
-				snapshotter: "native", // TODO: test with fuse-overlayfs as well, or automatically determine snapshotter
+			Register(&Containerd{
+				ID:          "containerd-rootless",
+				Containerd:  "containerd",
+				UID:         uid,
+				GID:         gid,
+				Snapshotter: "native", // TODO: test with fuse-overlayfs as well, or automatically determine snapshotter
 			})
 		}
 	}
 
 	if s := os.Getenv("BUILDKIT_INTEGRATION_SNAPSHOTTER"); s != "" {
-		Register(&containerd{
-			name:        fmt.Sprintf("containerd-snapshotter-%s", s),
-			containerd:  "containerd",
-			snapshotter: s,
+		Register(&Containerd{
+			ID:          fmt.Sprintf("containerd-snapshotter-%s", s),
+			Containerd:  "containerd",
+			Snapshotter: s,
 		})
 	}
 }
 
-type containerd struct {
-	name        string
-	containerd  string
-	snapshotter string
-	uid         int
-	gid         int
-	extraEnv    []string // e.g. "PATH=/opt/containerd-1.4/bin:/usr/bin:..."
+type Containerd struct {
+	ID          string
+	Containerd  string
+	Snapshotter string
+	UID         int
+	GID         int
+	ExtraEnv    []string // e.g. "PATH=/opt/containerd-1.4/bin:/usr/bin:..."
 }
 
-func (c *containerd) Name() string {
-	return c.name
+func (c *Containerd) Name() string {
+	return c.ID
 }
 
-func (c *containerd) Rootless() bool {
-	return c.uid != 0
+func (c *Containerd) Rootless() bool {
+	return c.UID != 0
 }
 
-func (c *containerd) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl func() error, err error) {
-	if err := lookupBinary(c.containerd); err != nil {
+func (c *Containerd) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl func() error, err error) {
+	if err := lookupBinary(c.Containerd); err != nil {
 		return nil, nil, err
 	}
 	if err := lookupBinary("buildkitd"); err != nil {
@@ -106,9 +106,9 @@ func (c *containerd) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl
 	}()
 
 	rootless := false
-	if c.uid != 0 {
-		if c.gid == 0 {
-			return nil, nil, errors.Errorf("unsupported id pair: uid=%d, gid=%d", c.uid, c.gid)
+	if c.UID != 0 {
+		if c.GID == 0 {
+			return nil, nil, errors.Errorf("unsupported id pair: uid=%d, gid=%d", c.UID, c.GID)
 		}
 		rootless = true
 	}
@@ -118,7 +118,7 @@ func (c *containerd) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl
 		return nil, nil, err
 	}
 	if rootless {
-		if err := os.Chown(tmpdir, c.uid, c.gid); err != nil {
+		if err := os.Chown(tmpdir, c.UID, c.GID); err != nil {
 			return nil, nil, err
 		}
 	}
@@ -141,10 +141,10 @@ disabled_plugins = ["cri"]
 `, filepath.Join(tmpdir, "root"), filepath.Join(tmpdir, "state"), address, filepath.Join(tmpdir, "debug.sock"))
 
 	var snBuildkitdArgs []string
-	if c.snapshotter != "" {
+	if c.Snapshotter != "" {
 		snBuildkitdArgs = append(snBuildkitdArgs,
-			fmt.Sprintf("--containerd-worker-snapshotter=%s", c.snapshotter))
-		if c.snapshotter == "stargz" {
+			fmt.Sprintf("--containerd-worker-snapshotter=%s", c.Snapshotter))
+		if c.Snapshotter == "stargz" {
 			snPath, snCl, err := runStargzSnapshotter(cfg)
 			if err != nil {
 				return nil, nil, err
@@ -165,21 +165,21 @@ disabled_plugins = ["cri"]
 		return nil, nil, err
 	}
 
-	containerdArgs := []string{c.containerd, "--config", configFile}
+	containerdArgs := []string{c.Containerd, "--config", configFile}
 	rootlessKitState := filepath.Join(tmpdir, "rootlesskit-containerd")
 	if rootless {
-		containerdArgs = append(append([]string{"sudo", "-u", fmt.Sprintf("#%d", c.uid), "-i",
+		containerdArgs = append(append([]string{"sudo", "-u", fmt.Sprintf("#%d", c.UID), "-i",
 			fmt.Sprintf("CONTAINERD_ROOTLESS_ROOTLESSKIT_STATE_DIR=%s", rootlessKitState),
 			// Integration test requires the access to localhost of the host network namespace.
 			// TODO: remove these configurations
 			"CONTAINERD_ROOTLESS_ROOTLESSKIT_NET=host",
 			"CONTAINERD_ROOTLESS_ROOTLESSKIT_PORT_DRIVER=none",
 			"CONTAINERD_ROOTLESS_ROOTLESSKIT_FLAGS=--mtu=0",
-		}, c.extraEnv...), "containerd-rootless.sh", "-c", configFile)
+		}, c.ExtraEnv...), "containerd-rootless.sh", "-c", configFile)
 	}
 
 	cmd := exec.Command(containerdArgs[0], containerdArgs[1:]...) //nolint:gosec // test utility
-	cmd.Env = append(os.Environ(), c.extraEnv...)
+	cmd.Env = append(os.Environ(), c.ExtraEnv...)
 
 	ctdStop, err := startCmd(cmd, cfg.Logs)
 	if err != nil {
@@ -199,8 +199,8 @@ disabled_plugins = ["cri"]
 		"--containerd-worker-labels=org.mobyproject.buildkit.worker.sandbox=true", // Include use of --containerd-worker-labels to trigger https://github.com/moby/buildkit/pull/603
 	}, snBuildkitdArgs...)
 
-	if runtime.GOOS != "windows" && c.snapshotter != "native" {
-		c.extraEnv = append(c.extraEnv, "BUILDKIT_DEBUG_FORCE_OVERLAY_DIFF=true")
+	if runtime.GOOS != "windows" && c.Snapshotter != "native" {
+		c.ExtraEnv = append(c.ExtraEnv, "BUILDKIT_DEBUG_FORCE_OVERLAY_DIFF=true")
 	}
 	if rootless {
 		pidStr, err := os.ReadFile(filepath.Join(rootlessKitState, "child_pid"))
@@ -211,11 +211,11 @@ disabled_plugins = ["cri"]
 		if err != nil {
 			return nil, nil, err
 		}
-		buildkitdArgs = append([]string{"sudo", "-u", fmt.Sprintf("#%d", c.uid), "-i", "--", "exec",
+		buildkitdArgs = append([]string{"sudo", "-u", fmt.Sprintf("#%d", c.UID), "-i", "--", "exec",
 			"nsenter", "-U", "--preserve-credentials", "-m", "-t", fmt.Sprintf("%d", pid)},
 			append(buildkitdArgs, "--containerd-worker-snapshotter=native")...)
 	}
-	buildkitdSock, stop, err := runBuildkitd(ctx, cfg, buildkitdArgs, cfg.Logs, c.uid, c.gid, c.extraEnv)
+	buildkitdSock, stop, err := runBuildkitd(ctx, cfg, buildkitdArgs, cfg.Logs, c.UID, c.GID, c.ExtraEnv)
 	if err != nil {
 		printLogs(cfg.Logs, log.Println)
 		return nil, nil, err
@@ -226,7 +226,7 @@ disabled_plugins = ["cri"]
 		address:           buildkitdSock,
 		containerdAddress: address,
 		rootless:          rootless,
-		snapshotter:       c.snapshotter,
+		snapshotter:       c.Snapshotter,
 	}, cl, nil
 }
 
diff --git a/util/testutil/integration/dockerd.go b/util/testutil/integration/dockerd.go
@@ -19,10 +19,10 @@ import (
 
 // InitDockerdWorker registers a dockerd worker with the global registry.
 func InitDockerdWorker() {
-	Register(&moby{
-		name:     "dockerd",
-		rootless: false,
-		unsupported: []string{
+	Register(&Moby{
+		ID:         "dockerd",
+		IsRootless: false,
+		Unsupported: []string{
 			FeatureCacheExport,
 			FeatureCacheImport,
 			FeatureCacheBackendAzblob,
@@ -42,31 +42,35 @@ func InitDockerdWorker() {
 			FeatureCNINetwork,
 		},
 	})
-	Register(&moby{
-		name:     "dockerd-containerd",
-		rootless: false,
-		unsupported: []string{
+	Register(&Moby{
+		ID:                    "dockerd-containerd",
+		IsRootless:            false,
+		ContainerdSnapshotter: true,
+		Unsupported: []string{
 			FeatureSecurityMode,
 			FeatureCNINetwork,
 		},
 	})
 }
 
-type moby struct {
-	name        string
-	rootless    bool
-	unsupported []string
+type Moby struct {
+	ID         string
+	IsRootless bool
+
+	ContainerdSnapshotter bool
+
+	Unsupported []string
 }
 
-func (c moby) Name() string {
-	return c.name
+func (c Moby) Name() string {
+	return c.ID
 }
 
-func (c moby) Rootless() bool {
-	return c.rootless
+func (c Moby) Rootless() bool {
+	return c.IsRootless
 }
 
-func (c moby) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl func() error, err error) {
+func (c Moby) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl func() error, err error) {
 	if err := requireRoot(); err != nil {
 		return nil, nil, err
 	}
@@ -78,7 +82,7 @@ func (c moby) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl func()
 
 	dcfg := dockerd.Config{
 		Features: map[string]bool{
-			"containerd-snapshotter": c.name == "dockerd-containerd",
+			"containerd-snapshotter": c.ContainerdSnapshotter,
 		},
 	}
 	if reg, ok := bkcfg.Registries["docker.io"]; ok && len(reg.Mirrors) > 0 {
@@ -208,9 +212,10 @@ func (c moby) New(ctx context.Context, cfg *BackendConfig) (b Backend, cl func()
 
 	return backend{
 		address:             "unix://" + listener.Addr().String(),
-		rootless:            c.rootless,
+		dockerAddress:       d.Sock(),
+		rootless:            c.IsRootless,
 		isDockerd:           true,
-		unsupportedFeatures: c.unsupported,
+		unsupportedFeatures: c.Unsupported,
 	}, cl, nil
 }
 
diff --git a/util/testutil/integration/oci.go b/util/testutil/integration/oci.go
@@ -12,7 +12,7 @@ import (
 )
 
 func InitOCIWorker() {
-	Register(&oci{})
+	Register(&OCI{ID: "oci"})
 
 	// the rootless uid is defined in Dockerfile
 	if s := os.Getenv("BUILDKIT_INTEGRATION_ROOTLESS_IDPAIR"); s != "" {
@@ -21,36 +21,31 @@ func InitOCIWorker() {
 			bklog.L.Fatalf("unexpected BUILDKIT_INTEGRATION_ROOTLESS_IDPAIR: %q", s)
 		}
 		if rootlessSupported(uid) {
-			Register(&oci{uid: uid, gid: gid})
+			Register(&OCI{ID: "oci-rootless", UID: uid, GID: gid})
 		}
 	}
 
 	if s := os.Getenv("BUILDKIT_INTEGRATION_SNAPSHOTTER"); s != "" {
-		Register(&oci{snapshotter: s})
+		Register(&OCI{ID: "oci-snapshotter-" + s, Snapshotter: s})
 	}
 }
 
-type oci struct {
-	uid         int
-	gid         int
-	snapshotter string
+type OCI struct {
+	ID          string
+	UID         int
+	GID         int
+	Snapshotter string
 }
 
-func (s *oci) Name() string {
-	if s.uid != 0 {
-		return "oci-rootless"
-	}
-	if s.snapshotter != "" {
-		return fmt.Sprintf("oci-snapshotter-%s", s.snapshotter)
-	}
-	return "oci"
+func (s *OCI) Name() string {
+	return s.ID
 }
 
-func (s *oci) Rootless() bool {
-	return s.uid != 0
+func (s *OCI) Rootless() bool {
+	return s.UID != 0
 }
 
-func (s *oci) New(ctx context.Context, cfg *BackendConfig) (Backend, func() error, error) {
+func (s *OCI) New(ctx context.Context, cfg *BackendConfig) (Backend, func() error, error) {
 	if err := lookupBinary("buildkitd"); err != nil {
 		return nil, nil, err
 	}
@@ -60,32 +55,32 @@ func (s *oci) New(ctx context.Context, cfg *BackendConfig) (Backend, func() erro
 	// Include use of --oci-worker-labels to trigger https://github.com/moby/buildkit/pull/603
 	buildkitdArgs := []string{"buildkitd", "--oci-worker=true", "--containerd-worker=false", "--oci-worker-gc=false", "--oci-worker-labels=org.mobyproject.buildkit.worker.sandbox=true"}
 
-	if s.snapshotter != "" {
+	if s.Snapshotter != "" {
 		buildkitdArgs = append(buildkitdArgs,
-			fmt.Sprintf("--oci-worker-snapshotter=%s", s.snapshotter))
+			fmt.Sprintf("--oci-worker-snapshotter=%s", s.Snapshotter))
 	}
 
-	if s.uid != 0 {
-		if s.gid == 0 {
-			return nil, nil, errors.Errorf("unsupported id pair: uid=%d, gid=%d", s.uid, s.gid)
+	if s.UID != 0 {
+		if s.GID == 0 {
+			return nil, nil, errors.Errorf("unsupported id pair: uid=%d, gid=%d", s.UID, s.GID)
 		}
 		// TODO: make sure the user exists and subuid/subgid are configured.
-		buildkitdArgs = append([]string{"sudo", "-u", fmt.Sprintf("#%d", s.uid), "-i", "--", "exec", "rootlesskit"}, buildkitdArgs...)
+		buildkitdArgs = append([]string{"sudo", "-u", fmt.Sprintf("#%d", s.UID), "-i", "--", "exec", "rootlesskit"}, buildkitdArgs...)
 	}
 
 	var extraEnv []string
-	if runtime.GOOS != "windows" && s.snapshotter != "native" {
+	if runtime.GOOS != "windows" && s.Snapshotter != "native" {
 		extraEnv = append(extraEnv, "BUILDKIT_DEBUG_FORCE_OVERLAY_DIFF=true")
 	}
-	buildkitdSock, stop, err := runBuildkitd(ctx, cfg, buildkitdArgs, cfg.Logs, s.uid, s.gid, extraEnv)
+	buildkitdSock, stop, err := runBuildkitd(ctx, cfg, buildkitdArgs, cfg.Logs, s.UID, s.GID, extraEnv)
 	if err != nil {
 		printLogs(cfg.Logs, log.Println)
 		return nil, nil, err
 	}
 
 	return backend{
 		address:     buildkitdSock,
-		rootless:    s.uid != 0,
-		snapshotter: s.snapshotter,
+		rootless:    s.UID != 0,
+		snapshotter: s.Snapshotter,
 	}, stop, nil
 }
diff --git a/util/testutil/integration/run.go b/util/testutil/integration/run.go
@@ -35,6 +35,7 @@ func init() {
 // Backend is the minimal interface that describes a testing backend.
 type Backend interface {
 	Address() string
+	DockerAddress() string
 	ContainerdAddress() string
 	Rootless() bool
 	Snapshotter() string
diff --git a/util/testutil/integration/sandbox.go b/util/testutil/integration/sandbox.go
