pkg/containerfs: drop ContainerFS type alias

corhere · corhere · commit 9ce2b30b817a · 2022-09-23T16:56:53.000-04:00
Signed-off-by: Cory Snider &lt;csnider@mirantis.com&gt;
diff --git a/builder/builder.go b/builder/builder.go
@@ -14,7 +14,6 @@ import (
 	containerpkg "github.com/docker/docker/container"
 	"github.com/docker/docker/image"
 	"github.com/docker/docker/layer"
-	"github.com/docker/docker/pkg/containerfs"
 )
 
 const (
@@ -26,7 +25,7 @@ const (
 // instructions in the builder.
 type Source interface {
 	// Root returns root path for accessing source
-	Root() containerfs.ContainerFS
+	Root() string
 	// Close allows to signal that the filesystem tree won't be used anymore.
 	// For Context implementations using a temporary directory, it is recommended to
 	// delete the temporary directory in Close().
@@ -110,6 +109,6 @@ type ROLayer interface {
 // RWLayer is active layer that can be read/modified
 type RWLayer interface {
 	Release() error
-	Root() containerfs.ContainerFS
+	Root() string
 	Commit() (ROLayer, error)
 }
diff --git a/builder/dockerfile/copy.go b/builder/dockerfile/copy.go
@@ -38,7 +38,7 @@ type pathCache interface {
 // copyInfo is a data object which stores the metadata about each source file in
 // a copyInstruction
 type copyInfo struct {
-	root         containerfs.ContainerFS
+	root         string
 	path         string
 	hash         string
 	noDecompress bool
diff --git a/builder/dockerfile/internals_test.go b/builder/dockerfile/internals_test.go
@@ -14,7 +14,6 @@ import (
 	"github.com/docker/docker/image"
 	"github.com/docker/docker/layer"
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/go-connections/nat"
 	"github.com/opencontainers/go-digest"
 	"gotest.tools/v3/assert"
@@ -183,8 +182,8 @@ func TestDeepCopyRunConfig(t *testing.T) {
 
 type MockRWLayer struct{}
 
-func (l *MockRWLayer) Release() error                { return nil }
-func (l *MockRWLayer) Root() containerfs.ContainerFS { return "" }
+func (l *MockRWLayer) Release() error { return nil }
+func (l *MockRWLayer) Root() string   { return "" }
 func (l *MockRWLayer) Commit() (builder.ROLayer, error) {
 	return &MockROLayer{
 		diffID: layer.DiffID(digest.Digest("sha256:1234")),
diff --git a/builder/dockerfile/mockbackend_test.go b/builder/dockerfile/mockbackend_test.go
@@ -13,7 +13,6 @@ import (
 	containerpkg "github.com/docker/docker/container"
 	"github.com/docker/docker/image"
 	"github.com/docker/docker/layer"
-	"github.com/docker/docker/pkg/containerfs"
 )
 
 // MockBackend implements the builder.Backend interface for unit testing
@@ -143,6 +142,6 @@ func (l *mockRWLayer) Commit() (builder.ROLayer, error) {
 	return nil, nil
 }
 
-func (l *mockRWLayer) Root() containerfs.ContainerFS {
+func (l *mockRWLayer) Root() string {
 	return ""
 }
diff --git a/builder/remotecontext/archive.go b/builder/remotecontext/archive.go
@@ -15,7 +15,7 @@ import (
 )
 
 type archiveContext struct {
-	root containerfs.ContainerFS
+	root string
 	sums tarsum.FileInfoSums
 }
 
@@ -82,7 +82,7 @@ func FromArchive(tarStream io.Reader) (builder.Source, error) {
 	return tsc, nil
 }
 
-func (c *archiveContext) Root() containerfs.ContainerFS {
+func (c *archiveContext) Root() string {
 	return c.root
 }
 
@@ -115,7 +115,7 @@ func (c *archiveContext) Hash(path string) (string, error) {
 	return path, nil // backwards compat TODO: see if really needed
 }
 
-func normalize(path string, root containerfs.ContainerFS) (cleanPath, fullPath string, err error) {
+func normalize(path string, root string) (cleanPath, fullPath string, err error) {
 	cleanPath = filepath.Clean(string(filepath.Separator) + path)[1:]
 	fullPath, err = containerfs.ResolveScopedPath(root, path)
 	if err != nil {
diff --git a/builder/remotecontext/detect_test.go b/builder/remotecontext/detect_test.go
@@ -9,7 +9,6 @@ import (
 	"testing"
 
 	"github.com/docker/docker/builder"
-	"github.com/docker/docker/pkg/containerfs"
 )
 
 const (
@@ -105,14 +104,14 @@ func TestProcessShouldLeaveAllFiles(t *testing.T) {
 
 // TODO: remove after moving to a separate pkg
 type stubRemote struct {
-	root containerfs.ContainerFS
+	root string
 }
 
 func (r *stubRemote) Hash(path string) (string, error) {
 	return "", errors.New("not implemented")
 }
 
-func (r *stubRemote) Root() containerfs.ContainerFS {
+func (r *stubRemote) Root() string {
 	return r.root
 }
 func (r *stubRemote) Close() error {
diff --git a/builder/remotecontext/lazycontext.go b/builder/remotecontext/lazycontext.go
@@ -8,27 +8,26 @@ import (
 	"strings"
 
 	"github.com/docker/docker/builder"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/pools"
 	"github.com/pkg/errors"
 )
 
 // NewLazySource creates a new LazyContext. LazyContext defines a hashed build
 // context based on a root directory. Individual files are hashed first time
 // they are asked. It is not safe to call methods of LazyContext concurrently.
-func NewLazySource(root containerfs.ContainerFS) (builder.Source, error) {
+func NewLazySource(root string) (builder.Source, error) {
 	return &lazySource{
 		root: root,
 		sums: make(map[string]string),
 	}, nil
 }
 
 type lazySource struct {
-	root containerfs.ContainerFS
+	root string
 	sums map[string]string
 }
 
-func (c *lazySource) Root() containerfs.ContainerFS {
+func (c *lazySource) Root() string {
 	return c.root
 }
 
@@ -88,7 +87,7 @@ func (c *lazySource) prepareHash(relPath string, fi os.FileInfo) (string, error)
 
 // Rel makes a path relative to base path. Same as `filepath.Rel` but can also
 // handle UUID paths in windows.
-func Rel(basepath containerfs.ContainerFS, targpath string) (string, error) {
+func Rel(basepath string, targpath string) (string, error) {
 	// filepath.Rel can't handle UUID paths in windows
 	if runtime.GOOS == "windows" {
 		pfx := basepath + `\`
diff --git a/builder/remotecontext/tarsum.go b/builder/remotecontext/tarsum.go
@@ -5,7 +5,6 @@ import (
 	"path/filepath"
 	"sync"
 
-	"github.com/docker/docker/pkg/containerfs"
 	iradix "github.com/hashicorp/go-immutable-radix"
 	"github.com/opencontainers/go-digest"
 	"github.com/pkg/errors"
@@ -19,7 +18,7 @@ type hashed interface {
 // CachableSource is a source that contains cache records for its contents
 type CachableSource struct {
 	mu   sync.Mutex
-	root containerfs.ContainerFS
+	root string
 	tree *iradix.Tree
 	txn  *iradix.Txn
 }
@@ -145,7 +144,7 @@ func (cs *CachableSource) Hash(path string) (string, error) {
 }
 
 // Root returns a root directory for the source
-func (cs *CachableSource) Root() containerfs.ContainerFS {
+func (cs *CachableSource) Root() string {
 	return cs.root
 }
 
diff --git a/container/container.go b/container/container.go
@@ -61,10 +61,10 @@ type ExitStatus struct {
 type Container struct {
 	StreamConfig *stream.Config
 	// embed for Container to support states directly.
-	*State          `json:"State"`          // Needed for Engine API version <= 1.11
-	Root            string                  `json:"-"` // Path to the "home" of the container, including metadata.
-	BaseFS          containerfs.ContainerFS `json:"-"` // interface containing graphdriver mount
-	RWLayer         layer.RWLayer           `json:"-"`
+	*State          `json:"State"` // Needed for Engine API version <= 1.11
+	Root            string         `json:"-"` // Path to the "home" of the container, including metadata.
+	BaseFS          string         `json:"-"` // Path to the graphdriver mountpoint
+	RWLayer         layer.RWLayer  `json:"-"`
 	ID              string
 	Created         time.Time
 	Managed         bool
diff --git a/daemon/daemon_unix.go b/daemon/daemon_unix.go
@@ -38,7 +38,6 @@ import (
 	"github.com/docker/docker/libnetwork/options"
 	lntypes "github.com/docker/docker/libnetwork/types"
 	"github.com/docker/docker/opts"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/parsers"
 	"github.com/docker/docker/pkg/parsers/kernel"
@@ -1072,8 +1071,8 @@ func removeDefaultBridgeInterface() {
 	}
 }
 
-func setupInitLayer(idMapping idtools.IdentityMapping) func(containerfs.ContainerFS) error {
-	return func(initPath containerfs.ContainerFS) error {
+func setupInitLayer(idMapping idtools.IdentityMapping) func(string) error {
+	return func(initPath string) error {
 		return initlayer.Setup(initPath, idMapping.RootPair())
 	}
 }
diff --git a/daemon/daemon_windows.go b/daemon/daemon_windows.go
@@ -23,7 +23,6 @@ import (
 	winlibnetwork "github.com/docker/docker/libnetwork/drivers/windows"
 	"github.com/docker/docker/libnetwork/netlabel"
 	"github.com/docker/docker/libnetwork/options"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/parsers"
 	"github.com/docker/docker/pkg/parsers/operatingsystem"
@@ -64,7 +63,7 @@ func (daemon *Daemon) parseSecurityOpt(container *container.Container, hostConfi
 	return nil
 }
 
-func setupInitLayer(idMapping idtools.IdentityMapping) func(containerfs.ContainerFS) error {
+func setupInitLayer(idMapping idtools.IdentityMapping) func(string) error {
 	return nil
 }
 
diff --git a/daemon/graphdriver/aufs/aufs.go b/daemon/graphdriver/aufs/aufs.go
@@ -351,7 +351,7 @@ func atomicRemove(source string) error {
 
 // Get returns the rootfs path for the id.
 // This will mount the dir at its given path
-func (a *Driver) Get(id, mountLabel string) (containerfs.ContainerFS, error) {
+func (a *Driver) Get(id, mountLabel string) (string, error) {
 	a.locker.Lock(id)
 	defer a.locker.Unlock(id)
 	parents, err := a.getParentLayerPaths(id)
diff --git a/daemon/graphdriver/btrfs/btrfs.go b/daemon/graphdriver/btrfs/btrfs.go
@@ -627,7 +627,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get the requested filesystem id.
-func (d *Driver) Get(id, mountLabel string) (containerfs.ContainerFS, error) {
+func (d *Driver) Get(id, mountLabel string) (string, error) {
 	dir := d.subvolumesDirID(id)
 	st, err := os.Stat(dir)
 	if err != nil {
diff --git a/daemon/graphdriver/devmapper/driver.go b/daemon/graphdriver/devmapper/driver.go
@@ -10,7 +10,6 @@ import (
 	"strconv"
 
 	"github.com/docker/docker/daemon/graphdriver"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/devicemapper"
 	"github.com/docker/docker/pkg/idtools"
 	units "github.com/docker/go-units"
@@ -175,7 +174,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get mounts a device with given id into the root filesystem
-func (d *Driver) Get(id, mountLabel string) (containerfs.ContainerFS, error) {
+func (d *Driver) Get(id, mountLabel string) (string, error) {
 	d.locker.Lock(id)
 	defer d.locker.Unlock(id)
 	mp := path.Join(d.home, "mnt", id)
diff --git a/daemon/graphdriver/driver.go b/daemon/graphdriver/driver.go
@@ -7,7 +7,6 @@ import (
 	"strings"
 
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/plugingetter"
 	"github.com/pkg/errors"
@@ -60,7 +59,7 @@ type ProtoDriver interface {
 	// Get returns the mountpoint for the layered filesystem referred
 	// to by this id. You can optionally specify a mountLabel or "".
 	// Returns the absolute path to the mounted layered filesystem.
-	Get(id, mountLabel string) (fs containerfs.ContainerFS, err error)
+	Get(id, mountLabel string) (fs string, err error)
 	// Put releases the system resources for the specified id,
 	// e.g, unmounting layered filesystem.
 	Put(id string) error
diff --git a/daemon/graphdriver/fuse-overlayfs/fuseoverlayfs.go b/daemon/graphdriver/fuse-overlayfs/fuseoverlayfs.go
@@ -303,7 +303,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get creates and mounts the required file system for the given id and returns the mount path.
-func (d *Driver) Get(id, mountLabel string) (_ containerfs.ContainerFS, retErr error) {
+func (d *Driver) Get(id, mountLabel string) (_ string, retErr error) {
 	d.locker.Lock(id)
 	defer d.locker.Unlock(id)
 	dir := d.dir(id)
diff --git a/daemon/graphdriver/overlay/overlay.go b/daemon/graphdriver/overlay/overlay.go
@@ -339,7 +339,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get creates and mounts the required file system for the given id and returns the mount path.
-func (d *Driver) Get(id, mountLabel string) (_ containerfs.ContainerFS, err error) {
+func (d *Driver) Get(id, mountLabel string) (_ string, err error) {
 	d.locker.Lock(id)
 	defer d.locker.Unlock(id)
 	dir := d.dir(id)
diff --git a/daemon/graphdriver/overlay2/overlay.go b/daemon/graphdriver/overlay2/overlay.go
@@ -513,7 +513,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get creates and mounts the required file system for the given id and returns the mount path.
-func (d *Driver) Get(id, mountLabel string) (_ containerfs.ContainerFS, retErr error) {
+func (d *Driver) Get(id, mountLabel string) (_ string, retErr error) {
 	d.locker.Lock(id)
 	defer d.locker.Unlock(id)
 	dir := d.dir(id)
diff --git a/daemon/graphdriver/proxy.go b/daemon/graphdriver/proxy.go
@@ -6,7 +6,6 @@ import (
 	"io"
 
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/plugingetter"
 	"github.com/docker/docker/pkg/plugins"
@@ -128,7 +127,7 @@ func (d *graphDriverProxy) Remove(id string) error {
 	return nil
 }
 
-func (d *graphDriverProxy) Get(id, mountLabel string) (containerfs.ContainerFS, error) {
+func (d *graphDriverProxy) Get(id, mountLabel string) (string, error) {
 	args := &graphDriverRequest{
 		ID:         id,
 		MountLabel: mountLabel,
diff --git a/daemon/graphdriver/vfs/driver.go b/daemon/graphdriver/vfs/driver.go
@@ -185,7 +185,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get returns the directory for the given id.
-func (d *Driver) Get(id, mountLabel string) (containerfs.ContainerFS, error) {
+func (d *Driver) Get(id, mountLabel string) (string, error) {
 	dir := d.dir(id)
 	if st, err := os.Stat(dir); err != nil {
 		return "", err
diff --git a/daemon/graphdriver/windows/windows.go b/daemon/graphdriver/windows/windows.go
@@ -27,7 +27,6 @@ import (
 	"github.com/Microsoft/hcsshim/osversion"
 	"github.com/docker/docker/daemon/graphdriver"
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/ioutils"
 	"github.com/docker/docker/pkg/longpath"
@@ -393,7 +392,7 @@ func (d *Driver) GetLayerPath(id string) (string, error) {
 }
 
 // Get returns the rootfs path for the id. This will mount the dir at its given path.
-func (d *Driver) Get(id, mountLabel string) (containerfs.ContainerFS, error) {
+func (d *Driver) Get(id, mountLabel string) (string, error) {
 	logrus.Debugf("WindowsGraphDriver Get() id %s mountLabel %s", id, mountLabel)
 	var dir string
 
diff --git a/daemon/graphdriver/zfs/zfs.go b/daemon/graphdriver/zfs/zfs.go
@@ -14,7 +14,6 @@ import (
 	"time"
 
 	"github.com/docker/docker/daemon/graphdriver"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/idtools"
 	"github.com/docker/docker/pkg/parsers"
 	zfs "github.com/mistifyio/go-zfs"
@@ -363,7 +362,7 @@ func (d *Driver) Remove(id string) error {
 }
 
 // Get returns the mountpoint for the given id after creating the target directories if necessary.
-func (d *Driver) Get(id, mountLabel string) (_ containerfs.ContainerFS, retErr error) {
+func (d *Driver) Get(id, mountLabel string) (_ string, retErr error) {
 	d.locker.Lock(id)
 	defer d.locker.Unlock(id)
 	mountpoint := d.mountPath(id)
diff --git a/daemon/images/image_builder.go b/daemon/images/image_builder.go
@@ -14,7 +14,6 @@ import (
 	"github.com/docker/docker/errdefs"
 	"github.com/docker/docker/image"
 	"github.com/docker/docker/layer"
-	"github.com/docker/docker/pkg/containerfs"
 	"github.com/docker/docker/pkg/progress"
 	"github.com/docker/docker/pkg/streamformatter"
 	"github.com/docker/docker/pkg/stringid"
@@ -83,10 +82,10 @@ type rwLayer struct {
 	released   bool
 	layerStore layer.Store
 	rwLayer    layer.RWLayer
-	fs         containerfs.ContainerFS
+	fs         string
 }
 
-func (l *rwLayer) Root() containerfs.ContainerFS {
+func (l *rwLayer) Root() string {
 	return l.fs
 }
 
diff --git a/daemon/initlayer/setup_unix.go b/daemon/initlayer/setup_unix.go
diff --git a/layer/layer.go b/layer/layer.go
diff --git a/layer/layer_test.go b/layer/layer_test.go
diff --git a/layer/mount_test.go b/layer/mount_test.go
diff --git a/layer/mounted_layer.go b/layer/mounted_layer.go
diff --git a/pkg/containerfs/containerfs.go b/pkg/containerfs/containerfs.go

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@ import (`
`13`	`13`	`containerpkg "github.com/docker/docker/container"`
`14`	`14`	`"github.com/docker/docker/image"`
`15`	`15`	`"github.com/docker/docker/layer"`
`16`		`- "github.com/docker/docker/pkg/containerfs"`
`17`	`16`	`)`
`18`	`17`
`19`	`18`	`// MockBackend implements the builder.Backend interface for unit testing`
`@@ -143,6 +142,6 @@ func (l *mockRWLayer) Commit() (builder.ROLayer, error) {`
`143`	`142`	`return nil, nil`
`144`	`143`	`}`
`145`	`144`
`146`		`-func (l *mockRWLayer) Root() containerfs.ContainerFS {`
	`145`	`+func (l *mockRWLayer) Root() string {`
`147`	`146`	`return ""`
`148`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import (`
`15`	`15`	`)`
`16`	`16`
`17`	`17`	`type archiveContext struct {`
`18`		`- root containerfs.ContainerFS`
	`18`	`+ root string`
`19`	`19`	`sums tarsum.FileInfoSums`
`20`	`20`	`}`
`21`	`21`
`@@ -82,7 +82,7 @@ func FromArchive(tarStream io.Reader) (builder.Source, error) {`
`82`	`82`	`return tsc, nil`
`83`	`83`	`}`
`84`	`84`
`85`		`-func (c *archiveContext) Root() containerfs.ContainerFS {`
	`85`	`+func (c *archiveContext) Root() string {`
`86`	`86`	`return c.root`
`87`	`87`	`}`
`88`	`88`
`@@ -115,7 +115,7 @@ func (c *archiveContext) Hash(path string) (string, error) {`
`115`	`115`	`return path, nil // backwards compat TODO: see if really needed`
`116`	`116`	`}`
`117`	`117`
`118`		`-func normalize(path string, root containerfs.ContainerFS) (cleanPath, fullPath string, err error) {`
	`118`	`+func normalize(path string, root string) (cleanPath, fullPath string, err error) {`
`119`	`119`	`cleanPath = filepath.Clean(string(filepath.Separator) + path)[1:]`
`120`	`120`	`fullPath, err = containerfs.ResolveScopedPath(root, path)`
`121`	`121`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ import (`
`9`	`9`	`"testing"`
`10`	`10`
`11`	`11`	`"github.com/docker/docker/builder"`
`12`		`- "github.com/docker/docker/pkg/containerfs"`
`13`	`12`	`)`
`14`	`13`
`15`	`14`	`const (`
`@@ -105,14 +104,14 @@ func TestProcessShouldLeaveAllFiles(t *testing.T) {`
`105`	`104`
`106`	`105`	`// TODO: remove after moving to a separate pkg`
`107`	`106`	`type stubRemote struct {`
`108`		`- root containerfs.ContainerFS`
	`107`	`+ root string`
`109`	`108`	`}`
`110`	`109`
`111`	`110`	`func (r *stubRemote) Hash(path string) (string, error) {`
`112`	`111`	`return "", errors.New("not implemented")`
`113`	`112`	`}`
`114`	`113`
`115`		`-func (r *stubRemote) Root() containerfs.ContainerFS {`
	`114`	`+func (r *stubRemote) Root() string {`
`116`	`115`	`return r.root`
`117`	`116`	`}`
`118`	`117`	`func (r *stubRemote) Close() error {`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@ import (`
`38`	`38`	`"github.com/docker/docker/libnetwork/options"`
`39`	`39`	`lntypes "github.com/docker/docker/libnetwork/types"`
`40`	`40`	`"github.com/docker/docker/opts"`
`41`		`- "github.com/docker/docker/pkg/containerfs"`
`42`	`41`	`"github.com/docker/docker/pkg/idtools"`
`43`	`42`	`"github.com/docker/docker/pkg/parsers"`
`44`	`43`	`"github.com/docker/docker/pkg/parsers/kernel"`
`@@ -1072,8 +1071,8 @@ func removeDefaultBridgeInterface() {`
`1072`	`1071`	`}`
`1073`	`1072`	`}`
`1074`	`1073`
`1075`		`-func setupInitLayer(idMapping idtools.IdentityMapping) func(containerfs.ContainerFS) error {`
`1076`		`- return func(initPath containerfs.ContainerFS) error {`
	`1074`	`+func setupInitLayer(idMapping idtools.IdentityMapping) func(string) error {`
	`1075`	`+ return func(initPath string) error {`
`1077`	`1076`	`return initlayer.Setup(initPath, idMapping.RootPair())`
`1078`	`1077`	`}`
`1079`	`1078`	`}`