chore: move host-config and endpoint settings to a specific modifiers

container.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/network"
 	"github.com/docker/docker/pkg/archive"
 	"github.com/docker/go-connections/nat"
 
@@ -94,36 +95,39 @@ type ContainerFile struct {
 // ContainerRequest represents the parameters used to get a running container
 type ContainerRequest struct {
 	FromDockerfile
-	Image           string
-	Entrypoint      []string
-	Env             map[string]string
-	ExposedPorts    []string // allow specifying protocol info
-	Cmd             []string
-	Labels          map[string]string
-	Mounts          ContainerMounts
-	Tmpfs           map[string]string
-	RegistryCred    string
-	WaitingFor      wait.Strategy
-	Name            string // for specifying container name
-	Hostname        string
-	ExtraHosts      []string
-	Privileged      bool                // for starting privileged container
-	Networks        []string            // for specifying network names
-	NetworkAliases  map[string][]string // for specifying network aliases
-	NetworkMode     container.NetworkMode
-	Resources       container.Resources
-	Files           []ContainerFile   // files which will be copied when container starts
-	User            string            // for specifying uid:gid
-	SkipReaper      bool              // indicates whether we skip setting up a reaper for this
-	ReaperImage     string            // Deprecated: use WithImageName ContainerOption instead. Alternative reaper image
-	ReaperOptions   []ContainerOption // options for the reaper
-	AutoRemove      bool              // if set to true, the container will be removed from the host when stopped
-	AlwaysPullImage bool              // Always pull image
-	ImagePlatform   string            // ImagePlatform describes the platform which the image runs on.
-	Binds           []string
-	ShmSize         int64    // Amount of memory shared with the host (in bytes)
-	CapAdd          []string // Add Linux capabilities
-	CapDrop         []string // Drop Linux capabilities
+	Image                   string
+	Entrypoint              []string
+	Env                     map[string]string
+	ExposedPorts            []string // allow specifying protocol info
+	Cmd                     []string
+	Labels                  map[string]string
+	Mounts                  ContainerMounts
+	Tmpfs                   map[string]string
+	RegistryCred            string
+	WaitingFor              wait.Strategy
+	Name                    string // for specifying container name
+	Hostname                string
+	ExtraHosts              []string                                   // Deprecated: Use HostConfigModifier instead
+	Privileged              bool                                       // For starting privileged container
+	Networks                []string                                   // for specifying network names
+	NetworkAliases          map[string][]string                        // for specifying network aliases
+	NetworkMode             container.NetworkMode                      // Deprecated: Use HostConfigModifier instead
+	Resources               container.Resources                        // Deprecated: Use HostConfigModifier instead
+	Files                   []ContainerFile                            // files which will be copied when container starts
+	User                    string                                     // for specifying uid:gid
+	SkipReaper              bool                                       // indicates whether we skip setting up a reaper for this
+	ReaperImage             string                                     // Deprecated: use WithImageName ContainerOption instead. Alternative reaper image
+	ReaperOptions           []ContainerOption                          // options for the reaper
+	AutoRemove              bool                                       // Deprecated: Use HostConfigModifier instead. If set to true, the container will be removed from the host when stopped
+	AlwaysPullImage         bool                                       // Always pull image
+	ImagePlatform           string                                     // ImagePlatform describes the platform which the image runs on.
+	Binds                   []string                                   // Deprecated: Use HostConfigModifier instead
+	ShmSize                 int64                                      // Amount of memory shared with the host (in bytes)
+	CapAdd                  []string                                   // Deprecated: Use HostConfigModifier instead. Add Linux capabilities
+	CapDrop                 []string                                   // Deprecated: Use HostConfigModifier instead. Drop Linux capabilities
+	ConfigModifier          func(*container.Config)                    // Modifier for the config before container creation
+	HostConfigModifier      func(*container.HostConfig)                // Modifier for the host config before container creation
+	EnpointSettingsModifier func(map[string]*network.EndpointSettings) // Modifier for the network settings before container creation
 }
 
 type (

docker.go

@@ -1055,76 +1055,30 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
 		}
 	}
 
-	exposedPorts := req.ExposedPorts
-	if len(exposedPorts) == 0 && !req.NetworkMode.IsContainer() {
-		image, _, err := p.client.ImageInspectWithRaw(ctx, tag)
-		if err != nil {
-			return nil, err
-		}
-		for p := range image.ContainerConfig.ExposedPorts {
-			exposedPorts = append(exposedPorts, string(p))
-		}
-	}
-
-	exposedPortSet, exposedPortMap, err := nat.ParsePortSpecs(exposedPorts)
-	if err != nil {
-		return nil, err
-	}
-
 	dockerInput := &container.Config{
-		Entrypoint:   req.Entrypoint,
-		Image:        tag,
-		Env:          env,
-		ExposedPorts: exposedPortSet,
-		Labels:       req.Labels,
-		Cmd:          req.Cmd,
-		Hostname:     req.Hostname,
-		User:         req.User,
+		Entrypoint: req.Entrypoint,
+		Image:      tag,
+		Env:        env,
+		Labels:     req.Labels,
+		Cmd:        req.Cmd,
+		Hostname:   req.Hostname,
+		User:       req.User,
 	}
 
-	// prepare mounts
-	mounts := mapToDockerMounts(req.Mounts)
-
 	hostConfig := &container.HostConfig{
-		ExtraHosts:   req.ExtraHosts,
-		PortBindings: exposedPortMap,
-		Binds:        req.Binds,
-		Mounts:       mounts,
-		Tmpfs:        req.Tmpfs,
-		AutoRemove:   req.AutoRemove,
-		Privileged:   req.Privileged,
-		NetworkMode:  req.NetworkMode,
-		Resources:    req.Resources,
-		ShmSize:      req.ShmSize,
-		CapAdd:       req.CapAdd,
-		CapDrop:      req.CapDrop,
-	}
-
-	endpointConfigs := map[string]*network.EndpointSettings{}
-
-	// #248: Docker allows only one network to be specified during container creation
-	// If there is more than one network specified in the request container should be attached to them
-	// once it is created. We will take a first network if any specified in the request and use it to create container
-	if len(req.Networks) > 0 {
-		attachContainerTo := req.Networks[0]
-
-		nw, err := p.GetNetwork(ctx, NetworkRequest{
-			Name: attachContainerTo,
-		})
-		if err == nil {
-			endpointSetting := network.EndpointSettings{
-				Aliases:   req.NetworkAliases[attachContainerTo],
-				NetworkID: nw.ID,
-			}
-			endpointConfigs[attachContainerTo] = &endpointSetting
-		}
+		Privileged: req.Privileged,
+		ShmSize:    req.ShmSize,
+		Tmpfs:      req.Tmpfs,
 	}
 
-	networkingConfig := network.NetworkingConfig{
-		EndpointsConfig: endpointConfigs,
+	networkingConfig := &network.NetworkingConfig{}
+
+	err = p.preCreateContainerHook(ctx, req, dockerInput, hostConfig, networkingConfig)
+	if err != nil {
+		return nil, err
 	}
 
-	resp, err := p.client.ContainerCreate(ctx, dockerInput, hostConfig, &networkingConfig, platform, req.Name)
+	resp, err := p.client.ContainerCreate(ctx, dockerInput, hostConfig, networkingConfig, platform, req.Name)
 	if err != nil {
 		return nil, err
 	}

docker_test.go

@@ -140,15 +140,17 @@ func TestContainerWithHostNetworkOptions(t *testing.T) {
 	gcr := GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image:       nginxAlpineImage,
-			Privileged:  true,
-			SkipReaper:  true,
-			NetworkMode: "host",
-			Mounts:      Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			Image:      nginxAlpineImage,
+			SkipReaper: true,
+			Mounts:     Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
 			ExposedPorts: []string{
 				nginxHighPort,
 			},
+			Privileged: true,
 			WaitingFor: wait.ForListeningPort(nginxHighPort),
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.NetworkMode = "host"
+			},
 		},
 		Started: true,
 	}
@@ -208,10 +210,12 @@ func TestContainerWithNetworkModeAndNetworkTogether(t *testing.T) {
 	gcr := GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image:       nginxImage,
-			SkipReaper:  true,
-			NetworkMode: "host",
-			Networks:    []string{"new-network"},
+			Image:      nginxImage,
+			SkipReaper: true,
+			Networks:   []string{"new-network"},
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.NetworkMode = "host"
+			},
 		},
 		Started: true,
 	}
@@ -235,11 +239,13 @@ func TestContainerWithHostNetworkOptionsAndWaitStrategy(t *testing.T) {
 	gcr := GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image:       nginxAlpineImage,
-			SkipReaper:  true,
-			NetworkMode: "host",
-			WaitingFor:  wait.ForListeningPort(nginxHighPort),
-			Mounts:      Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			Image:      nginxAlpineImage,
+			SkipReaper: true,
+			WaitingFor: wait.ForListeningPort(nginxHighPort),
+			Mounts:     Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.NetworkMode = "host"
+			},
 		},
 		Started: true,
 	}
@@ -271,11 +277,13 @@ func TestContainerWithHostNetworkAndEndpoint(t *testing.T) {
 	gcr := GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image:       nginxAlpineImage,
-			SkipReaper:  true,
-			NetworkMode: "host",
-			WaitingFor:  wait.ForListeningPort(nginxHighPort),
-			Mounts:      Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			Image:      nginxAlpineImage,
+			SkipReaper: true,
+			WaitingFor: wait.ForListeningPort(nginxHighPort),
+			Mounts:     Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.NetworkMode = "host"
+			},
 		},
 		Started: true,
 	}
@@ -308,11 +316,13 @@ func TestContainerWithHostNetworkAndPortEndpoint(t *testing.T) {
 	gcr := GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image:       nginxAlpineImage,
-			SkipReaper:  true,
-			NetworkMode: "host",
-			WaitingFor:  wait.ForListeningPort(nginxHighPort),
-			Mounts:      Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			Image:      nginxAlpineImage,
+			SkipReaper: true,
+			WaitingFor: wait.ForListeningPort(nginxHighPort),
+			Mounts:     Mounts(BindMount(absPath, "/etc/nginx/conf.d/default.conf")),
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.NetworkMode = "host"
+			},
 		},
 		Started: true,
 	}
@@ -2302,8 +2312,10 @@ func TestDockerContainerResources(t *testing.T) {
 			Image:        nginxAlpineImage,
 			ExposedPorts: []string{nginxDefaultPort},
 			WaitingFor:   wait.ForListeningPort(nginxDefaultPort),
-			Resources: container.Resources{
-				Ulimits: expected,
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.Resources = container.Resources{
+					Ulimits: expected,
+				}
 			},
 		},
 		Started: true,
@@ -2388,7 +2400,9 @@ func TestContainerCapAdd(t *testing.T) {
 			Image:        nginxAlpineImage,
 			ExposedPorts: []string{nginxDefaultPort},
 			WaitingFor:   wait.ForListeningPort(nginxDefaultPort),
-			CapAdd:       []string{expected},
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.CapAdd = []string{expected}
+			},
 		},
 		Started: true,
 	})
@@ -2532,8 +2546,10 @@ func TestNetworkModeWithContainerReference(t *testing.T) {
 	nginxB, err := GenericContainer(ctx, GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image:       nginxAlpineImage,
-			NetworkMode: container.NetworkMode(networkMode),
+			Image: nginxAlpineImage,
+			HostConfigModifier: func(hc *container.HostConfig) {
+				hc.NetworkMode = container.NetworkMode(networkMode)
+			},
 		},
 		Started: true,
 	})

lifecycle.go

@@ -0,0 +1,88 @@
+package testcontainers
+
+import (
+	"context"
+
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/network"
+	"github.com/docker/go-connections/nat"
+)
+
+func (p *DockerProvider) preCreateContainerHook(ctx context.Context, req ContainerRequest, dockerInput *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig) error {
+	// prepare mounts
+	hostConfig.Mounts = mapToDockerMounts(req.Mounts)
+
+	endpointSettings := map[string]*network.EndpointSettings{}
+
+	// #248: Docker allows only one network to be specified during container creation
+	// If there is more than one network specified in the request container should be attached to them
+	// once it is created. We will take a first network if any specified in the request and use it to create container
+	if len(req.Networks) > 0 {
+		attachContainerTo := req.Networks[0]
+
+		nw, err := p.GetNetwork(ctx, NetworkRequest{
+			Name: attachContainerTo,
+		})
+		if err == nil {
+			aliases := []string{}
+			if _, ok := req.NetworkAliases[attachContainerTo]; ok {
+				aliases = req.NetworkAliases[attachContainerTo]
+			}
+			endpointSetting := network.EndpointSettings{
+				Aliases:   aliases,
+				NetworkID: nw.ID,
+			}
+			endpointSettings[attachContainerTo] = &endpointSetting
+		}
+	}
+
+	if req.ConfigModifier != nil {
+		req.ConfigModifier(dockerInput)
+	}
+
+	if req.HostConfigModifier == nil {
+		req.HostConfigModifier = defaultHostConfigModifier(req)
+	}
+	req.HostConfigModifier(hostConfig)
+
+	if req.EnpointSettingsModifier != nil {
+		req.EnpointSettingsModifier(endpointSettings)
+	}
+
+	networkingConfig.EndpointsConfig = endpointSettings
+
+	exposedPorts := req.ExposedPorts
+	// this check must be done after the pre-creation Modifiers are called, so the network mode is already set
+	if len(exposedPorts) == 0 && !hostConfig.NetworkMode.IsContainer() {
+		image, _, err := p.client.ImageInspectWithRaw(ctx, dockerInput.Image)
+		if err != nil {
+			return err
+		}
+		for p := range image.ContainerConfig.ExposedPorts {
+			exposedPorts = append(exposedPorts, string(p))
+		}
+	}
+
+	exposedPortSet, exposedPortMap, err := nat.ParsePortSpecs(exposedPorts)
+	if err != nil {
+		return err
+	}
+
+	dockerInput.ExposedPorts = exposedPortSet
+	hostConfig.PortBindings = exposedPortMap
+
+	return nil
+}
+
+// defaultHostConfigModifier provides a default modifier including the deprecated fields
+func defaultHostConfigModifier(req ContainerRequest) func(hostConfig *container.HostConfig) {
+	return func(hostConfig *container.HostConfig) {
+		hostConfig.AutoRemove = req.AutoRemove
+		hostConfig.CapAdd = req.CapAdd
+		hostConfig.CapDrop = req.CapDrop
+		hostConfig.Binds = req.Binds
+		hostConfig.ExtraHosts = req.ExtraHosts
+		hostConfig.NetworkMode = req.NetworkMode
+		hostConfig.Resources = req.Resources
+	}
+}