Rename Fs fields to fs

Signed-off-by: Michael Crosby <[email protected]>

Author: crosbymichael

Diff for: PRINCIPLES.md

@@ -8,7 +8,7 @@ In the design and development of libcontainer we try to follow these principles:
 * Less code is better.
 * Fewer components are better. Do you really need to add one more class?
 * 50 lines of straightforward, readable code is better than 10 lines of magic that nobody can understand.
-* Don't do later what you can do now. "//FIXME: refactor" is not acceptable in new code.
+* Don't do later what you can do now. "//TODO: refactor" is not acceptable in new code.
 * When hesitating between two options, choose the one that is easier to reverse.
 * "No" is temporary; "Yes" is forever. If you're not sure about a new feature, say no. You can change your mind later.
 * Containers must be portable to the greatest possible number of machines. Be suspicious of any change which makes machines less interchangeable.

Diff for: cgroups/fs/apply_raw.go

@@ -83,7 +83,7 @@ func (m *Manager) Apply(pid int) error {
 		if err := sys.Set(d); err != nil {
 			return err
 		}
-		// FIXME: Apply should, ideally, be reentrant or be broken up into a separate
+		// TODO: Apply should, ideally, be reentrant or be broken up into a separate
 		// create and join phase so that the cgroup hierarchy for a container can be
 		// created then join consists of writing the process pids to cgroup.procs
 		p, err := d.path(name)

Diff for: configs/config.go

@@ -26,22 +26,22 @@ type Config struct {
 	// This is required when using read only root filesystems. In these cases, a read/writeable path can be (bind) mounted somewhere inside the root filesystem to act as pivot.
 	PivotDir string `json:"pivot_dir,omitempty"`
 
-	// ReadonlyFs will remount the container's rootfs as readonly where only externally mounted
-	// bind mounts are writtable
-	ReadonlyFs bool `json:"readonly_fs,omitempty"`
+	// Path to a directory containing the container's root filesystem.
+	Rootfs string `json:"rootfs,omitempty"`
+
+	// Readonlyfs will remount the container's rootfs as readonly where only externally mounted
+	// bind mounts are writtable.
+	Readonlyfs bool `json:"readonlyfs,omitempty"`
 
 	// Mounts specify additional source and destination paths that will be mounted inside the container's
 	// rootfs and mount namespace if specified
 	Mounts []*Mount `json:"mounts,omitempty"`
 
 	// The device nodes that should be automatically created within the container upon container start.  Note, make sure that the node is marked as allowed in the cgroup as well!
-	DeviceNodes []*Device `json:"device_nodes,omitempty"`
+	Devices []*Device `json:"devices,omitempty"`
 
 	MountLabel string `json:"mount_label,omitempty"`
 
-	// Pathname to container's root filesystem
-	RootFs string `json:"root_fs,omitempty"`
-
 	// Hostname optionally sets the container's hostname if provided
 	Hostname string `json:"hostname,omitempty"`
 

Diff for: configs/config_test.go

@@ -114,7 +114,7 @@ func TestConfigJsonFormat(t *testing.T) {
 	}
 
 	for _, d := range DefaultSimpleDevices {
-		if !containsDevice(d, container.DeviceNodes) {
+		if !containsDevice(d, container.Devices) {
 			t.Logf("expected device configuration for %s", d.Path)
 			t.Fail()
 		}
@@ -163,3 +163,69 @@ func TestRemoveNamespace(t *testing.T) {
 		t.Fatalf("namespaces should have 0 items but reports %d", len(ns))
 	}
 }
+
+func TestHostUIDNoUSERNS(t *testing.T) {
+	config := &Config{
+		Namespaces: Namespaces{},
+	}
+	uid, err := config.HostUID()
+	if err != nil {
+		t.Fatal(err)
+	}
+	if uid != 0 {
+		t.Fatal("expected uid 0 with no USERNS but received %d", uid)
+	}
+}
+
+func TestHostUIDWithUSERNS(t *testing.T) {
+	config := &Config{
+		Namespaces: Namespaces{{Type: NEWUSER}},
+		UidMappings: []IDMap{
+			{
+				ContainerID: 0,
+				HostID:      1000,
+				Size:        1,
+			},
+		},
+	}
+	uid, err := config.HostUID()
+	if err != nil {
+		t.Fatal(err)
+	}
+	if uid != 1000 {
+		t.Fatal("expected uid 1000 with no USERNS but received %d", uid)
+	}
+}
+
+func TestHostGIDNoUSERNS(t *testing.T) {
+	config := &Config{
+		Namespaces: Namespaces{},
+	}
+	uid, err := config.HostGID()
+	if err != nil {
+		t.Fatal(err)
+	}
+	if uid != 0 {
+		t.Fatal("expected gid 0 with no USERNS but received %d", uid)
+	}
+}
+
+func TestHostGIDWithUSERNS(t *testing.T) {
+	config := &Config{
+		Namespaces: Namespaces{{Type: NEWUSER}},
+		GidMappings: []IDMap{
+			{
+				ContainerID: 0,
+				HostID:      1000,
+				Size:        1,
+			},
+		},
+	}
+	uid, err := config.HostGID()
+	if err != nil {
+		t.Fatal(err)
+	}
+	if uid != 1000 {
+		t.Fatal("expected gid 1000 with no USERNS but received %d", uid)
+	}
+}

Diff for: configs/device.go

@@ -10,19 +10,29 @@ const (
 )
 
 type Device struct {
+	// Device type, block, char, etc.
 	Type rune `json:"type,omitempty"`
-	// It is fine if this is an empty string in the case that you are using Wildcards
+
+	// Path to the device.
 	Path string `json:"path,omitempty"`
-	// Use the wildcard constant for wildcards.
+
+	// Major is the device's major number.
 	Major int64 `json:"major,omitempty"`
-	// Use the wildcard constant for wildcards.
+
+	// Minor is the device's minor number.
 	Minor int64 `json:"minor,omitempty"`
-	// Typically just "rwm"
+
+	// Cgroup permissions format, rwm.
 	Permissions string `json:"permissions,omitempty"`
-	// The permission bits of the file's mode
+
+	// FileMode permission bits for the device.
 	FileMode os.FileMode `json:"file_mode,omitempty"`
-	Uid      uint32      `json:"uid,omitempty"`
-	Gid      uint32      `json:"gid,omitempty"`
+
+	// Uid of the device.
+	Uid uint32 `json:"uid,omitempty"`
+
+	// Gid of the device.
+	Gid uint32 `json:"gid,omitempty"`
 }
 
 func (d *Device) CgroupString() string {

Diff for: configs/mount.go

@@ -52,7 +52,7 @@ func (m *Mount) bindMount(rootfs, mountLabel string) error {
 		return err
 	}
 
-	// FIXME: (crosbymichael) This does not belong here and should be done a layer above
+	// TODO: (crosbymichael) This does not belong here and should be done a layer above
 	dest, err = symlink.FollowSymlinkInScope(dest, rootfs)
 	if err != nil {
 		return err
@@ -94,7 +94,7 @@ func (m *Mount) tmpfsMount(rootfs, mountLabel string) error {
 		dest = filepath.Join(rootfs, m.Destination)
 	)
 
-	// FIXME: (crosbymichael) This does not belong here and should be done a layer above
+	// TODO: (crosbymichael) This does not belong here and should be done a layer above
 	if dest, err = symlink.FollowSymlinkInScope(dest, rootfs); err != nil {
 		return err
 	}

Diff for: configs/network.go

@@ -20,12 +20,12 @@ type Network struct {
 	// Address contains the IPv4 and mask to set on the network interface
 	Address string `json:"address,omitempty"`
 
-	// IPv6Address contains the IPv6 and mask to set on the network interface
-	IPv6Address string `json:"ipv6_address,omitempty"`
-
 	// Gateway sets the gateway address that is used as the default for the interface
 	Gateway string `json:"gateway,omitempty"`
 
+	// IPv6Address contains the IPv6 and mask to set on the network interface
+	IPv6Address string `json:"ipv6_address,omitempty"`
+
 	// IPv6Gateway sets the ipv6 gateway address that is used as the default for the interface
 	IPv6Gateway string `json:"ipv6_gateway,omitempty"`
 

Diff for: devices/devices.go

@@ -60,10 +60,10 @@ func DeviceFromPath(path, permissions string) (*configs.Device, error) {
 }
 
 func HostDevices() ([]*configs.Device, error) {
-	return getDeviceNodes("/dev")
+	return getDevices("/dev")
 }
 
-func getDeviceNodes(path string) ([]*configs.Device, error) {
+func getDevices(path string) ([]*configs.Device, error) {
 	files, err := ioutilReadDir(path)
 	if err != nil {
 		return nil, err
@@ -76,7 +76,7 @@ func getDeviceNodes(path string) ([]*configs.Device, error) {
 			case "pts", "shm", "fd", "mqueue":
 				continue
 			default:
-				sub, err := getDeviceNodes(filepath.Join(path, f.Name()))
+				sub, err := getDevices(filepath.Join(path, f.Name()))
 				if err != nil {
 					return nil, err
 				}

Diff for: integration/exec_test.go

@@ -27,7 +27,7 @@ func testExecPS(t *testing.T, userns bool) {
 		return
 	}
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -65,7 +65,7 @@ func TestIPCPrivate(t *testing.T) {
 		return
 	}
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -96,7 +96,7 @@ func TestIPCHost(t *testing.T) {
 		return
 	}
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -128,7 +128,7 @@ func TestIPCJoinPath(t *testing.T) {
 		return
 	}
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -161,7 +161,7 @@ func TestIPCBadPath(t *testing.T) {
 		return
 	}
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -181,7 +181,7 @@ func TestRlimit(t *testing.T) {
 		return
 	}
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -232,7 +232,7 @@ func TestEnter(t *testing.T) {
 	}
 	defer os.RemoveAll(root)
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -335,7 +335,7 @@ func TestFreeze(t *testing.T) {
 	}
 	defer os.RemoveAll(root)
 
-	rootfs, err := newRootFs()
+	rootfs, err := newRootfs()
 	if err != nil {
 		t.Fatal(err)
 	}

Diff for: integration/template_test.go

@@ -12,7 +12,7 @@ import (
 // and the default setup for devices
 func newTemplateConfig(rootfs string) *configs.Config {
 	return &configs.Config{
-		RootFs: rootfs,
+		Rootfs: rootfs,
 		Capabilities: []string{
 			"CHOWN",
 			"DAC_OVERRIDE",
@@ -43,7 +43,7 @@ func newTemplateConfig(rootfs string) *configs.Config {
 			AllowedDevices:  configs.DefaultAllowedDevices,
 		},
 
-		DeviceNodes: configs.DefaultAutoCreatedDevices,
+		Devices: configs.DefaultAutoCreatedDevices,
 		Hostname:    "integration",
 		Env: []string{
 			"HOME=/root",

Diff for: integration/utils_test.go

@@ -29,7 +29,7 @@ type stdBuffers struct {
 }
 
 func writeConfig(config *configs.Config) error {
-	f, err := os.OpenFile(filepath.Join(config.RootFs, "container.json"), os.O_CREATE|os.O_RDWR|os.O_TRUNC, 0700)
+	f, err := os.OpenFile(filepath.Join(config.Rootfs, "container.json"), os.O_CREATE|os.O_RDWR|os.O_TRUNC, 0700)
 	if err != nil {
 		return err
 	}
@@ -51,8 +51,8 @@ func loadConfig() (*configs.Config, error) {
 	return container, nil
 }
 
-// newRootFs creates a new tmp directory and copies the busybox root filesystem
-func newRootFs() (string, error) {
+// newRootfs creates a new tmp directory and copies the busybox root filesystem
+func newRootfs() (string, error) {
 	dir, err := ioutil.TempDir("", "")
 	if err != nil {
 		return "", err