From 4f5ec9994c64fc1e75d425250fa8ea1b4cd105f8 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 18 Dec 2024 14:00:12 +0100 Subject: [PATCH] pkg/reexec: deprecate and migrate to github.com/moby/sys/reexec Signed-off-by: Sebastiaan van Stijn --- builder/dockerfile/copy_windows.go | 2 +- builder/dockerfile/evaluator_test.go | 2 +- builder/remotecontext/tarsum_test.go | 2 +- cmd/dockerd/daemon_linux_test.go | 2 +- cmd/dockerd/docker.go | 2 +- cmd/dockerd/main_linux_test.go | 2 +- daemon/graphdriver/windows/windows.go | 2 +- libnetwork/libnetwork_linux_test.go | 2 +- libnetwork/sandbox_externalkey_unix.go | 2 +- pkg/chrootarchive/archive_unix_nolinux.go | 2 +- .../archive_unix_nolinux_test.go | 2 +- pkg/reexec/reexec_deprecated.go | 41 ++++ pkg/reexec/reexec_test.go | 69 ------ vendor.mod | 1 + vendor.sum | 2 + vendor/github.com/moby/sys/reexec/LICENSE | 202 ++++++++++++++++++ .../github.com/moby/sys}/reexec/reexec.go | 0 .../moby/sys}/reexec/reexec_linux.go | 0 .../moby/sys}/reexec/reexec_other.go | 0 vendor/modules.txt | 3 + 20 files changed, 260 insertions(+), 80 deletions(-) create mode 100644 pkg/reexec/reexec_deprecated.go delete mode 100644 pkg/reexec/reexec_test.go create mode 100644 vendor/github.com/moby/sys/reexec/LICENSE rename {pkg => vendor/github.com/moby/sys}/reexec/reexec.go (100%) rename {pkg => vendor/github.com/moby/sys}/reexec/reexec_linux.go (100%) rename {pkg => vendor/github.com/moby/sys}/reexec/reexec_other.go (100%) diff --git a/builder/dockerfile/copy_windows.go b/builder/dockerfile/copy_windows.go index bca088da6e..a271a33ad1 100644 --- 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 index bf31bd3bc5..48076906ba 100644 --- 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 index 49cbe72b21..e564541a32 100644 --- 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 index 5af8368cab..fb46b48cd3 100644 --- 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 index 29f7acee9f..068be1a945 100644 --- 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 index cab0914af6..ddf4c122cf 100644 --- 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 index 5cc49b506b..9000e81a9a 100644 --- 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 index 8c1dca6635..d6fda6b73f 100644 --- 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 index cadb020140..846512c372 100644 --- 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 index 13e557b128..8689573d94 100644 --- 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 index a051814845..307a30f015 100644 --- 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 new file mode 100644 index 0000000000..31155cce52 --- /dev/null +++ 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 deleted file mode 100644 index 0230cad585..0000000000 --- a/pkg/reexec/reexec_test.go +++ /dev/null @@ -1,69 +0,0 @@ -package reexec - -import ( - "os" - "os/exec" - "testing" -) - -const testReExec = "test-reexec" - -func init() { - Register(testReExec, func() { - panic("Return Error") - }) - Init() -} - -func TestRegister(t *testing.T) { - defer func() { - if r := recover(); r != nil { - const expected = `reexec func already registered under name "test-reexec"` - if r != expected { - t.Errorf("got %q, want %q", r, expected) - } - } - }() - Register(testReExec, func() {}) -} - -func TestCommand(t *testing.T) { - cmd := Command(testReExec) - w, err := cmd.StdinPipe() - if err != nil { - t.Fatalf("Error on pipe creation: %v", err) - } - defer w.Close() - - err = cmd.Start() - if err != nil { - t.Fatalf("Error on re-exec cmd: %v", err) - } - err = cmd.Wait() - const expected = "exit status 2" - if err == nil || err.Error() != expected { - t.Fatalf("got %v, want %v", err, expected) - } -} - -func TestNaiveSelf(t *testing.T) { - if os.Getenv("TEST_CHECK") == "1" { - os.Exit(2) - } - cmd := exec.Command(naiveSelf(), "-test.run=TestNaiveSelf") - cmd.Env = append(os.Environ(), "TEST_CHECK=1") - err := cmd.Start() - if err != nil { - t.Fatalf("Unable to start command: %v", err) - } - err = cmd.Wait() - const expected = "exit status 2" - if err == nil || err.Error() != expected { - t.Fatalf("got %v, want %v", err, expected) - } - - os.Args[0] = "mkdir" - if naiveSelf() == os.Args[0] { - t.Fatalf("Expected naiveSelf to resolve the location of mkdir") - } -} diff --git a/vendor.mod b/vendor.mod index 7c5a70a990..610308a98d 100644 --- 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 index 634a68a4a0..e3d2856d60 100644 --- 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 new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/vendor/github.com/moby/sys/reexec/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/pkg/reexec/reexec.go b/vendor/github.com/moby/sys/reexec/reexec.go similarity index 100% rename from pkg/reexec/reexec.go rename to vendor/github.com/moby/sys/reexec/reexec.go diff --git a/pkg/reexec/reexec_linux.go b/vendor/github.com/moby/sys/reexec/reexec_linux.go similarity index 100% rename from pkg/reexec/reexec_linux.go rename to vendor/github.com/moby/sys/reexec/reexec_linux.go diff --git a/pkg/reexec/reexec_other.go b/vendor/github.com/moby/sys/reexec/reexec_other.go similarity index 100% rename from pkg/reexec/reexec_other.go rename to vendor/github.com/moby/sys/reexec/reexec_other.go diff --git a/vendor/modules.txt b/vendor/modules.txt index 374f681ebf..32c2145f02 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -954,6 +954,9 @@ github.com/moby/sys/mount # github.com/moby/sys/mountinfo v0.7.2 ## explicit; go 1.17 github.com/moby/sys/mountinfo +# github.com/moby/sys/reexec v0.1.0 +## explicit; go 1.18 +github.com/moby/sys/reexec # github.com/moby/sys/sequential v0.6.0 ## explicit; go 1.17 github.com/moby/sys/sequential