add comments and refactor

Signed-off-by: Arjun Raja Yogidas <[email protected]>

Author: coderbirju

cmd/nerdctl/container/container_inspect_linux_test.go

@@ -19,6 +19,7 @@ package container
 import (
 	"fmt"
 	"os"
+	"slices"
 	"strings"
 	"testing"
 
@@ -268,8 +269,8 @@ func TestContainerInspectHostConfig(t *testing.T) {
 	assert.Equal(t, uint16(500), inspect.HostConfig.BlkioWeight)
 	assert.Equal(t, uint64(1024), inspect.HostConfig.CPUShares)
 	assert.Equal(t, int64(100000), inspect.HostConfig.CPUQuota)
-	assert.Assert(t, contains(inspect.HostConfig.GroupAdd, "1000"), "Expected '1000' to be in GroupAdd")
-	assert.Assert(t, contains(inspect.HostConfig.GroupAdd, "2000"), "Expected '2000' to be in GroupAdd")
+	assert.Assert(t, slices.Contains(inspect.HostConfig.GroupAdd, "1000"), "Expected '1000' to be in GroupAdd")
+	assert.Assert(t, slices.Contains(inspect.HostConfig.GroupAdd, "2000"), "Expected '2000' to be in GroupAdd")
 	expectedExtraHosts := []string{"host1:10.0.0.1", "host2:10.0.0.2"}
 	assert.DeepEqual(t, expectedExtraHosts, inspect.HostConfig.ExtraHosts)
 	assert.Equal(t, "host", inspect.HostConfig.IpcMode)
@@ -288,10 +289,12 @@ func TestContainerInspectHostConfigDefaults(t *testing.T) {
 
 	var hc hostConfigValues
 
+	// Hostconfig default values differ with Docker.
+	// This is because we directly retrieve the configured values instead of using preset defaults.
 	if testutil.GetTarget() == testutil.Docker {
 		hc.Driver = ""
 		hc.GroupAddSize = 0
-		hc.ShmSize = int64(67108864)
+		hc.ShmSize = int64(67108864) // Docker default 64M
 		hc.Runtime = "runc"
 	} else {
 		hc.GroupAddSize = 10
@@ -453,15 +456,6 @@ func TestContainerInspectDevices(t *testing.T) {
 	assert.DeepEqual(t, expectedDevices, inspect.HostConfig.Devices)
 }
 
-func contains(slice []string, item string) bool {
-	for _, s := range slice {
-		if s == item {
-			return true
-		}
-	}
-	return false
-}
-
 type hostConfigValues struct {
 	Driver       string
 	ShmSize      int64

pkg/inspecttypes/dockercompat/dockercompat.go

@@ -138,33 +138,48 @@ type Container struct {
 // From https://github.com/moby/moby/blob/8dbd90ec00daa26dc45d7da2431c965dec99e8b4/api/types/container/host_config.go#L391
 // HostConfig the non-portable Config structure of a container.
 type HostConfig struct {
-	ExtraHosts      []string          // List of extra hosts
-	PortBindings    nat.PortMap       // Port mapping between the exposed port (container) and the host
-	LogConfig       LoggerLogConfig   // Configuration of the logs for this container
-	BlkioWeight     uint16            // Block IO weight (relative weight vs. other containers)
-	CPUSetMems      string            `json:"CpusetMems"` // CpusetMems 0-2, 0,1
-	CPUSetCPUs      string            `json:"CpusetCpus"` // CpusetCpus 0-2, 0,1
-	CPUQuota        int64             `json:"CpuQuota"`   // CPU CFS (Completely Fair Scheduler) quota
-	CPUShares       uint64            `json:"CpuShares"`  // CPU shares (relative weight vs. other containers)
-	ContainerIDFile string            // File (path) where the containerId is written
-	GroupAdd        []string          // GroupAdd specifies additional groups to join
-	IpcMode         string            `json:"IpcMode"` // IPC namespace to use for the container
-	CgroupnsMode    string            // Cgroup namespace mode to use for the container
-	Memory          int64             // Memory limit (in bytes)
-	MemorySwap      int64             // Total memory usage (memory + swap); set `-1` to enable unlimited swap
-	OomKillDisable  bool              // specifies whether to disable OOM Killer
-	DNS             []string          `json:"Dns"`        // List of DNS server to lookup
-	DNSOptions      []string          `json:"DnsOptions"` // List of DNSOption to look for
-	DNSSearch       []string          `json:"DnsSearch"`  // List of DNSSearch to look for
-	OomScoreAdj     int               // specifies the tune container’s OOM preferences (-1000 to 1000, rootless: 100 to 1000)
-	ReadonlyRootfs  bool              // Is the container root filesystem in read-only
-	UTSMode         string            // UTS namespace to use for the container
-	ShmSize         int64             // Size of /dev/shm in bytes. The size must be greater than 0.
-	Sysctls         map[string]string // List of Namespaced sysctls used for the container
-	Runtime         string            // Runtime to use with this container
-	Devices         []DeviceMapping   // List of devices to map inside the container
-	PidMode         string            // PID namespace to use for the container
-	Tmpfs           map[string]string `json:"Tmpfs,omitempty"` // List of tmpfs (mounts) used for the container
+	// Binds           []string      // List of volume bindings for this container
+	ContainerIDFile string          // File (path) where the containerId is written
+	LogConfig       LoggerLogConfig // Configuration of the logs for this container
+	// NetworkMode     NetworkMode   // Network mode to use for the container
+	PortBindings nat.PortMap // Port mapping between the exposed port (container) and the host
+	// RestartPolicy   RestartPolicy // Restart policy to be used for the container
+	// AutoRemove      bool          // Automatically remove container when it exits
+	// VolumeDriver    string        // Name of the volume driver used to mount volumes
+	// VolumesFrom     []string      // List of volumes to take from other container
+	// CapAdd          strslice.StrSlice // List of kernel capabilities to add to the container
+	// CapDrop         strslice.StrSlice // List of kernel capabilities to remove from the container
+
+	CgroupnsMode string   // Cgroup namespace mode to use for the container
+	DNS          []string `json:"Dns"`        // List of DNS server to lookup
+	DNSOptions   []string `json:"DnsOptions"` // List of DNSOption to look for
+	DNSSearch    []string `json:"DnsSearch"`  // List of DNSSearch to look for
+	ExtraHosts   []string // List of extra hosts
+	GroupAdd     []string // GroupAdd specifies additional groups to join
+	IpcMode      string   `json:"IpcMode"` // IPC namespace to use for the container
+	// Cgroup          CgroupSpec        // Cgroup to use for the container
+	OomScoreAdj int    // specifies the tune container’s OOM preferences (-1000 to 1000, rootless: 100 to 1000)
+	PidMode     string // PID namespace to use for the container
+	// Privileged      bool              // Is the container in privileged mode
+	// PublishAllPorts bool              // Should docker publish all exposed port for the container
+	ReadonlyRootfs bool // Is the container root filesystem in read-only
+	// SecurityOpt     []string          // List of string values to customize labels for MLS systems, such as SELinux.
+	Tmpfs   map[string]string `json:"Tmpfs,omitempty"` // List of tmpfs (mounts) used for the container
+	UTSMode string            // UTS namespace to use for the container
+	// UsernsMode      UsernsMode        // The user namespace to use for the container
+	ShmSize int64             // Size of /dev/shm in bytes. The size must be greater than 0.
+	Sysctls map[string]string // List of Namespaced sysctls used for the container
+	Runtime string            // Runtime to use with this container
+
+	BlkioWeight    uint16          // Block IO weight (relative weight vs. other containers)
+	CPUSetMems     string          `json:"CpusetMems"` // CpusetMems 0-2, 0,1
+	CPUSetCPUs     string          `json:"CpusetCpus"` // CpusetCpus 0-2, 0,1
+	CPUQuota       int64           `json:"CpuQuota"`   // CPU CFS (Completely Fair Scheduler) quota
+	CPUShares      uint64          `json:"CpuShares"`  // CPU shares (relative weight vs. other containers)
+	Memory         int64           // Memory limit (in bytes)
+	MemorySwap     int64           // Total memory usage (memory + swap); set `-1` to enable unlimited swap
+	OomKillDisable bool            // specifies whether to disable OOM Killer
+	Devices        []DeviceMapping // List of devices to map inside the container
 }
 
 // From https://github.com/moby/moby/blob/v20.10.1/api/types/types.go#L416-L427

pkg/labels/labels.go

@@ -113,6 +113,6 @@ const (
 	// HostConfigLabel sets the dockercompat host config values
 	HostConfigLabel = Prefix + "host-config"
 
-	// DNSSettings sets the dockercompat Dns config values
+	// DNSSettings sets the dockercompat DNS config values
 	DNSSetting = Prefix + "dns"
 )