pkg/reexec: deprecate and migrate to github.com/moby/sys/reexec

thaJeztah · thaJeztah · commit 4f5ec9994c64 · 2024-12-19T10:12:58.000+01:00
Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/builder/dockerfile/copy_windows.go b/builder/dockerfile/copy_windows.go
@@ -8,8 +8,8 @@ import (
 
 	winio "github.com/Microsoft/go-winio"
 	"github.com/docker/docker/pkg/idtools"
-	"github.com/docker/docker/pkg/reexec"
 	"github.com/docker/docker/pkg/system"
+	"github.com/moby/sys/reexec"
 	"github.com/pkg/errors"
 	"golang.org/x/sys/windows"
 )
diff --git a/builder/dockerfile/evaluator_test.go b/builder/dockerfile/evaluator_test.go
@@ -8,8 +8,8 @@ import (
 
 	"github.com/docker/docker/builder/remotecontext"
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/reexec"
 	"github.com/moby/buildkit/frontend/dockerfile/instructions"
+	"github.com/moby/sys/reexec"
 	"gotest.tools/v3/assert"
 	is "gotest.tools/v3/assert/cmp"
 	"gotest.tools/v3/skip"
diff --git a/builder/remotecontext/tarsum_test.go b/builder/remotecontext/tarsum_test.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/docker/docker/builder"
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/reexec"
+	"github.com/moby/sys/reexec"
 	"github.com/pkg/errors"
 	"gotest.tools/v3/skip"
 )
diff --git a/cmd/dockerd/daemon_linux_test.go b/cmd/dockerd/daemon_linux_test.go
@@ -9,7 +9,7 @@ import (
 	"testing"
 
 	"github.com/docker/docker/daemon/config"
-	"github.com/docker/docker/pkg/reexec"
+	"github.com/moby/sys/reexec"
 	"golang.org/x/sys/unix"
 	"gotest.tools/v3/assert"
 )
diff --git a/cmd/dockerd/docker.go b/cmd/dockerd/docker.go
@@ -10,9 +10,9 @@ import (
 	"github.com/containerd/log"
 	"github.com/docker/docker/daemon/config"
 	"github.com/docker/docker/dockerversion"
-	"github.com/docker/docker/pkg/reexec"
 	"github.com/docker/docker/pkg/rootless"
 	"github.com/moby/buildkit/util/apicaps"
+	"github.com/moby/sys/reexec"
 	"github.com/moby/term"
 	"github.com/spf13/cobra"
 
diff --git a/cmd/dockerd/main_linux_test.go b/cmd/dockerd/main_linux_test.go
@@ -3,7 +3,7 @@ package main
 import (
 	"testing"
 
-	"github.com/docker/docker/pkg/reexec"
+	"github.com/moby/sys/reexec"
 )
 
 func TestMain(m *testing.M) {
diff --git a/daemon/graphdriver/windows/windows.go b/daemon/graphdriver/windows/windows.go
@@ -31,9 +31,9 @@ import (
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/ioutils"
 	"github.com/docker/docker/pkg/longpath"
-	"github.com/docker/docker/pkg/reexec"
 	"github.com/docker/docker/pkg/system"
 	"github.com/docker/go-units"
+	"github.com/moby/sys/reexec"
 	"github.com/pkg/errors"
 	"golang.org/x/sys/windows"
 )
diff --git a/libnetwork/libnetwork_linux_test.go b/libnetwork/libnetwork_linux_test.go
@@ -31,7 +31,7 @@ import (
 	"github.com/docker/docker/libnetwork/osl"
 	"github.com/docker/docker/libnetwork/types"
 	"github.com/docker/docker/pkg/plugins"
-	"github.com/docker/docker/pkg/reexec"
+	"github.com/moby/sys/reexec"
 	"github.com/pkg/errors"
 	"github.com/vishvananda/netns"
 	"golang.org/x/sync/errgroup"
diff --git a/libnetwork/sandbox_externalkey_unix.go b/libnetwork/sandbox_externalkey_unix.go
@@ -15,8 +15,8 @@ import (
 	"github.com/containerd/log"
 	"github.com/docker/docker/internal/otelutil"
 	"github.com/docker/docker/libnetwork/types"
-	"github.com/docker/docker/pkg/reexec"
 	"github.com/docker/docker/pkg/stringid"
+	"github.com/moby/sys/reexec"
 	"github.com/opencontainers/runtime-spec/specs-go"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/propagation"
diff --git a/pkg/chrootarchive/archive_unix_nolinux.go b/pkg/chrootarchive/archive_unix_nolinux.go
@@ -11,7 +11,7 @@ import (
 	"syscall"
 
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/reexec"
+	"github.com/moby/sys/reexec"
 	"github.com/pkg/errors"
 	"golang.org/x/sys/unix"
 )
diff --git a/pkg/chrootarchive/archive_unix_nolinux_test.go b/pkg/chrootarchive/archive_unix_nolinux_test.go
@@ -5,7 +5,7 @@ package chrootarchive // import "github.com/docker/docker/pkg/chrootarchive"
 import (
 	"testing"
 
-	"github.com/docker/docker/pkg/reexec"
+	"github.com/moby/sys/reexec"
 )
 
 func TestMain(m *testing.M) {
diff --git a/pkg/reexec/reexec_deprecated.go b/pkg/reexec/reexec_deprecated.go
@@ -0,0 +1,41 @@
+// Package reexec facilitates the busybox style reexec of a binary.
+//
+// Deprecated: this package is deprecated and moved to a separate module. Use [github.com/moby/sys/reexec] instead.
+package reexec
+
+import (
+	"os/exec"
+
+	"github.com/moby/sys/reexec"
+)
+
+// Register adds an initialization func under the specified name. It panics
+// if the given name is already registered.
+//
+// Deprecated: use [reexec.Register] instead.
+func Register(name string, initializer func()) {
+	reexec.Register(name, initializer)
+}
+
+// Init is called as the first part of the exec process and returns true if an
+// initialization function was called.
+//
+// Deprecated: use [reexec.Init] instead.
+func Init() bool {
+	return reexec.Init()
+}
+
+// Command returns an [*exec.Cmd] with its Path set to the path of the current
+// binary using the result of [Self].
+//
+// Deprecated: use [reexec.Command] instead.
+func Command(args ...string) *exec.Cmd {
+	return reexec.Command(args...)
+}
+
+// Self returns the path to the current process's binary.
+//
+// Deprecated: use [reexec.Self] instead.
+func Self() string {
+	return reexec.Self()
+}
diff --git a/pkg/reexec/reexec_test.go b/pkg/reexec/reexec_test.go
diff --git a/vendor.mod b/vendor.mod
@@ -72,6 +72,7 @@ require (
 	github.com/moby/swarmkit/v2 v2.0.0-20241017191044-e8ecf83ee08e
 	github.com/moby/sys/mount v0.3.4
 	github.com/moby/sys/mountinfo v0.7.2
+	github.com/moby/sys/reexec v0.1.0
 	github.com/moby/sys/sequential v0.6.0
 	github.com/moby/sys/signal v0.7.1
 	github.com/moby/sys/symlink v0.3.0
diff --git a/vendor.sum b/vendor.sum
@@ -382,6 +382,8 @@ github.com/moby/sys/mount v0.3.4 h1:yn5jq4STPztkkzSKpZkLcmjue+bZJ0u2AuQY1iNI1Ww=
 github.com/moby/sys/mount v0.3.4/go.mod h1:KcQJMbQdJHPlq5lcYT+/CjatWM4PuxKe+XLSVS4J6Os=
 github.com/moby/sys/mountinfo v0.7.2 h1:1shs6aH5s4o5H2zQLn796ADW1wMrIwHsyJ2v9KouLrg=
 github.com/moby/sys/mountinfo v0.7.2/go.mod h1:1YOa8w8Ih7uW0wALDUgT1dTTSBrZ+HiBLGws92L2RU4=
+github.com/moby/sys/reexec v0.1.0 h1:RrBi8e0EBTLEgfruBOFcxtElzRGTEUkeIFaVXgU7wok=
+github.com/moby/sys/reexec v0.1.0/go.mod h1:EqjBg8F3X7iZe5pU6nRZnYCMUTXoxsjiIfHup5wYIN8=
 github.com/moby/sys/sequential v0.6.0 h1:qrx7XFUd/5DxtqcoH1h438hF5TmOvzC/lspjy7zgvCU=
 github.com/moby/sys/sequential v0.6.0/go.mod h1:uyv8EUTrca5PnDsdMGXhZe6CCe8U/UiTWd+lL+7b/Ko=
 github.com/moby/sys/signal v0.7.1 h1:PrQxdvxcGijdo6UXXo/lU/TvHUWyPhj7UOpSo8tuvk0=
diff --git a/vendor/github.com/moby/sys/reexec/LICENSE b/vendor/github.com/moby/sys/reexec/LICENSE
diff --git a/vendor/github.com/moby/sys/reexec/reexec.go b/vendor/github.com/moby/sys/reexec/reexec.go
diff --git a/vendor/github.com/moby/sys/reexec/reexec_linux.go b/vendor/github.com/moby/sys/reexec/reexec_linux.go
diff --git a/vendor/github.com/moby/sys/reexec/reexec_other.go b/vendor/github.com/moby/sys/reexec/reexec_other.go
diff --git a/vendor/modules.txt b/vendor/modules.txt

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@ import (`
`8`	`8`
`9`	`9`	`winio "github.com/Microsoft/go-winio"`
`10`	`10`	`"github.com/docker/docker/pkg/idtools"`
`11`		`- "github.com/docker/docker/pkg/reexec"`
`12`	`11`	`"github.com/docker/docker/pkg/system"`
	`12`	`+ "github.com/moby/sys/reexec"`
`13`	`13`	`"github.com/pkg/errors"`
`14`	`14`	`"golang.org/x/sys/windows"`
`15`	`15`	`)`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`
`8`	`8`	`"github.com/docker/docker/builder"`
`9`	`9`	`"github.com/docker/docker/pkg/archive"`
`10`		`- "github.com/docker/docker/pkg/reexec"`
	`10`	`+ "github.com/moby/sys/reexec"`
`11`	`11`	`"github.com/pkg/errors"`
`12`	`12`	`"gotest.tools/v3/skip"`
`13`	`13`	`)`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"testing"`
`10`	`10`
`11`	`11`	`"github.com/docker/docker/daemon/config"`
`12`		`- "github.com/docker/docker/pkg/reexec"`
	`12`	`+ "github.com/moby/sys/reexec"`
`13`	`13`	`"golang.org/x/sys/unix"`
`14`	`14`	`"gotest.tools/v3/assert"`
`15`	`15`	`)`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ package main`
`3`	`3`	`import (`
`4`	`4`	`"testing"`
`5`	`5`
`6`		`- "github.com/docker/docker/pkg/reexec"`
	`6`	`+ "github.com/moby/sys/reexec"`
`7`	`7`	`)`
`8`	`8`
`9`	`9`	`func TestMain(m *testing.M) {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`"syscall"`
`12`	`12`
`13`	`13`	`"github.com/docker/docker/pkg/archive"`
`14`		`- "github.com/docker/docker/pkg/reexec"`
	`14`	`+ "github.com/moby/sys/reexec"`
`15`	`15`	`"github.com/pkg/errors"`
`16`	`16`	`"golang.org/x/sys/unix"`
`17`	`17`	`)`