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

thaJeztah · thaJeztah · commit 8437c567d89b · 2024-07-26T09:47:50.000+02:00
The userns package in libcontainer was integrated into the moby/sys/user module at commit [3778ae603c706494fd1e2c2faf83b406e38d687d][1]. This patch deprecates the containerd fork of that package, and adds it as an alias for the moby/sys/user/userns package. [1]: opencontainers/runc@3778ae6 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
diff --git a/cmd/containerd-shim-runc-v2/task/service.go b/cmd/containerd-shim-runc-v2/task/service.go
@@ -24,6 +24,8 @@ import (
 	"os"
 	"sync"
 
+	"github.com/moby/sys/user/userns"
+
 	"github.com/containerd/cgroups/v3"
 	"github.com/containerd/cgroups/v3/cgroup1"
 	cgroupsv2 "github.com/containerd/cgroups/v3/cgroup2"
@@ -44,7 +46,6 @@ import (
 	"github.com/containerd/containerd/v2/pkg/shutdown"
 	"github.com/containerd/containerd/v2/pkg/stdio"
 	"github.com/containerd/containerd/v2/pkg/sys/reaper"
-	"github.com/containerd/containerd/v2/pkg/userns"
 	"github.com/containerd/errdefs"
 	runcC "github.com/containerd/go-runc"
 	"github.com/containerd/log"
diff --git a/core/diff/apply/apply_linux.go b/core/diff/apply/apply_linux.go
@@ -23,12 +23,12 @@ import (
 	"os"
 	"strings"
 
+	"github.com/moby/sys/user/userns"
+	"golang.org/x/sys/unix"
+
 	"github.com/containerd/containerd/v2/core/mount"
 	"github.com/containerd/containerd/v2/pkg/archive"
-	"github.com/containerd/containerd/v2/pkg/userns"
 	"github.com/containerd/errdefs"
-
-	"golang.org/x/sys/unix"
 )
 
 func apply(ctx context.Context, mounts []mount.Mount, r io.Reader, sync bool) (retErr error) {
diff --git a/core/mount/mount_linux.go b/core/mount/mount_linux.go
@@ -28,8 +28,8 @@ import (
 	"strings"
 	"time"
 
-	"github.com/containerd/containerd/v2/pkg/userns"
 	"github.com/containerd/log"
+	"github.com/moby/sys/user/userns"
 	"golang.org/x/sys/unix"
 )
 
diff --git a/internal/cri/server/podsandbox/sandbox_run_linux.go b/internal/cri/server/podsandbox/sandbox_run_linux.go
@@ -23,6 +23,7 @@ import (
 	"strings"
 
 	"github.com/containerd/containerd/v2/pkg/oci"
+	"github.com/moby/sys/user/userns"
 	imagespec "github.com/opencontainers/image-spec/specs-go/v1"
 	runtimespec "github.com/opencontainers/runtime-spec/specs-go"
 	"github.com/opencontainers/selinux/go-selinux"
@@ -32,7 +33,6 @@ import (
 	"github.com/containerd/containerd/v2/core/snapshots"
 	"github.com/containerd/containerd/v2/internal/cri/annotations"
 	customopts "github.com/containerd/containerd/v2/internal/cri/opts"
-	"github.com/containerd/containerd/v2/pkg/userns"
 )
 
 func (c *Controller) sandboxContainerSpec(id string, config *runtime.PodSandboxConfig,
diff --git a/internal/cri/server/podsandbox/sandbox_run_linux_test.go b/internal/cri/server/podsandbox/sandbox_run_linux_test.go
@@ -22,6 +22,7 @@ import (
 	"strconv"
 	"testing"
 
+	"github.com/moby/sys/user/userns"
 	imagespec "github.com/opencontainers/image-spec/specs-go/v1"
 	runtimespec "github.com/opencontainers/runtime-spec/specs-go"
 	"github.com/opencontainers/selinux/go-selinux"
@@ -33,7 +34,6 @@ import (
 	"github.com/containerd/containerd/v2/internal/cri/annotations"
 	"github.com/containerd/containerd/v2/internal/cri/opts"
 	ostesting "github.com/containerd/containerd/v2/pkg/os/testing"
-	"github.com/containerd/containerd/v2/pkg/userns"
 )
 
 func getRunPodSandboxTestData() (*runtime.PodSandboxConfig, *imagespec.ImageConfig, func(*testing.T, string, *runtimespec.Spec)) {
diff --git a/internal/cri/server/service_linux.go b/internal/cri/server/service_linux.go
@@ -19,12 +19,12 @@ package server
 import (
 	"fmt"
 
+	"github.com/moby/sys/user/userns"
 	"github.com/opencontainers/selinux/go-selinux"
 	"tags.cncf.io/container-device-interface/pkg/cdi"
 
 	"github.com/containerd/containerd/v2/pkg/cap"
 	"github.com/containerd/containerd/v2/pkg/kernelversion"
-	"github.com/containerd/containerd/v2/pkg/userns"
 	"github.com/containerd/go-cni"
 	"github.com/containerd/log"
 )
diff --git a/pkg/archive/tar.go b/pkg/archive/tar.go
@@ -29,9 +29,10 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/moby/sys/user/userns"
+
 	"github.com/containerd/containerd/v2/pkg/archive/tarheader"
 	"github.com/containerd/containerd/v2/pkg/epoch"
-	"github.com/containerd/containerd/v2/pkg/userns"
 	"github.com/containerd/continuity/fs"
 	"github.com/containerd/log"
 )
diff --git a/pkg/archive/tar_unix.go b/pkg/archive/tar_unix.go
@@ -27,10 +27,11 @@ import (
 	"strings"
 	"syscall"
 
-	"github.com/containerd/containerd/v2/pkg/userns"
+	"github.com/moby/sys/user/userns"
+	"golang.org/x/sys/unix"
+
 	"github.com/containerd/continuity/fs"
 	"github.com/containerd/continuity/sysx"
-	"golang.org/x/sys/unix"
 )
 
 func chmodTarEntry(perm os.FileMode) os.FileMode {
diff --git a/pkg/oci/utils_unix.go b/pkg/oci/utils_unix.go
@@ -24,7 +24,7 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/containerd/containerd/v2/pkg/userns"
+	"github.com/moby/sys/user/userns"
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 	"golang.org/x/sys/unix"
 )
diff --git a/pkg/oci/utils_unix_test.go b/pkg/oci/utils_unix_test.go
@@ -25,9 +25,8 @@ import (
 	"runtime"
 	"testing"
 
+	"github.com/moby/sys/user/userns"
 	"github.com/stretchr/testify/assert"
-
-	"github.com/containerd/containerd/v2/pkg/userns"
 )
 
 func cleanupTest() {
diff --git a/pkg/sys/oom_linux.go b/pkg/sys/oom_linux.go
@@ -22,7 +22,7 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/containerd/containerd/v2/pkg/userns"
+	"github.com/moby/sys/user/userns"
 	"golang.org/x/sys/unix"
 )
 
diff --git a/pkg/sys/oom_linux_test.go b/pkg/sys/oom_linux_test.go
@@ -24,7 +24,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/containerd/containerd/v2/pkg/userns"
+	"github.com/moby/sys/user/userns"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
diff --git a/pkg/userns/userns_deprecated.go b/pkg/userns/userns_deprecated.go
@@ -1,5 +1,3 @@
-//go:build !linux
-
 /*
    Copyright The containerd Authors.
 
@@ -16,10 +14,16 @@
    limitations under the License.
 */
 
+// Deprecated: use github.com/moby/sys/user/userns
 package userns
 
-// RunningInUserNS is a stub for non-Linux systems
-// Always returns false
+import "github.com/moby/sys/user/userns"
+
+// RunningInUserNS detects whether we are currently running in a Linux
+// user namespace and memoizes the result. It returns false on non-Linux
+// platforms.
+//
+// Deprecated: use [userns.RunningInUserNS].
 func RunningInUserNS() bool {
-	return false
+	return userns.RunningInUserNS()
 }
diff --git a/pkg/userns/userns_linux.go b/pkg/userns/userns_linux.go
diff --git a/plugins/snapshots/overlay/overlayutils/check.go b/plugins/snapshots/overlay/overlayutils/check.go
@@ -24,11 +24,11 @@ import (
 	"path/filepath"
 	"syscall"
 
+	"github.com/moby/sys/user/userns"
 	"golang.org/x/sys/unix"
 
 	"github.com/containerd/containerd/v2/core/mount"
 	kernel "github.com/containerd/containerd/v2/pkg/kernelversion"
-	"github.com/containerd/containerd/v2/pkg/userns"
 	"github.com/containerd/continuity/fs"
 	"github.com/containerd/log"
 )
diff --git a/vendor/github.com/moby/sys/user/userns/userns.go b/vendor/github.com/moby/sys/user/userns/userns.go
diff --git a/vendor/github.com/moby/sys/user/userns/userns_linux.go b/vendor/github.com/moby/sys/user/userns/userns_linux.go
diff --git a/vendor/github.com/moby/sys/user/userns/userns_linux_fuzzer.go b/vendor/github.com/moby/sys/user/userns/userns_linux_fuzzer.go
diff --git a/vendor/github.com/moby/sys/user/userns/userns_unsupported.go b/vendor/github.com/moby/sys/user/userns/userns_unsupported.go
diff --git a/vendor/modules.txt b/vendor/modules.txt
@@ -367,6 +367,7 @@ github.com/moby/sys/symlink
 # github.com/moby/sys/user v0.2.0
 ## explicit; go 1.21
 github.com/moby/sys/user
+github.com/moby/sys/user/userns
 # github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd
 ## explicit
 github.com/modern-go/concurrent

Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,8 @@ import (`
`28`	`28`	`"strings"`
`29`	`29`	`"time"`
`30`	`30`
`31`		`- "github.com/containerd/containerd/v2/pkg/userns"`
`32`	`31`	`"github.com/containerd/log"`
	`32`	`+ "github.com/moby/sys/user/userns"`
`33`	`33`	`"golang.org/x/sys/unix"`
`34`	`34`	`)`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ import (`
`24`	`24`	`"os"`
`25`	`25`	`"path/filepath"`
`26`	`26`
`27`		`- "github.com/containerd/containerd/v2/pkg/userns"`
	`27`	`+ "github.com/moby/sys/user/userns"`
`28`	`28`	`specs "github.com/opencontainers/runtime-spec/specs-go"`
`29`	`29`	`"golang.org/x/sys/unix"`
`30`	`30`	`)`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,8 @@ import (`
`25`	`25`	`"runtime"`
`26`	`26`	`"testing"`
`27`	`27`
	`28`	`+ "github.com/moby/sys/user/userns"`
`28`	`29`	`"github.com/stretchr/testify/assert"`
`29`		`-`
`30`		`- "github.com/containerd/containerd/v2/pkg/userns"`
`31`	`30`	`)`
`32`	`31`
`33`	`32`	`func cleanupTest() {`