chore!: rename EnpointSettingsModifier to EndpointSettingsModifier

NathanBaulch · web-flow · commit 8b5211f88a6d · 2025-01-14T18:00:21.000+01:00
diff --git a/container.go b/container.go
@@ -128,44 +128,44 @@ func (c *ContainerFile) validate() error {
 // ContainerRequest represents the parameters used to get a running container
 type ContainerRequest struct {
 	FromDockerfile
-	HostAccessPorts         []int
-	Image                   string
-	ImageSubstitutors       []ImageSubstitutor
-	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 // Deprecated: Testcontainers will detect registry credentials automatically
-	WaitingFor              wait.Strategy
-	Name                    string // for specifying container name
-	Hostname                string
-	WorkingDir              string                                     // specify the working directory of the container
-	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                                       // Deprecated: The reaper is globally controlled by the .testcontainers.properties file or the TESTCONTAINERS_RYUK_DISABLED environment variable
-	ReaperImage             string                                     // Deprecated: use WithImageName ContainerOption instead. Alternative reaper image
-	ReaperOptions           []ContainerOption                          // Deprecated: the reaper is configured at the properties level, for an entire test session
-	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
-	LifecycleHooks          []ContainerLifecycleHooks                  // define hooks to be executed during container lifecycle
-	LogConsumerCfg          *LogConsumerConfig                         // define the configuration for the log producer and its log consumers to follow the logs
+	HostAccessPorts          []int
+	Image                    string
+	ImageSubstitutors        []ImageSubstitutor
+	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 // Deprecated: Testcontainers will detect registry credentials automatically
+	WaitingFor               wait.Strategy
+	Name                     string // for specifying container name
+	Hostname                 string
+	WorkingDir               string                                     // specify the working directory of the container
+	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                                       // Deprecated: The reaper is globally controlled by the .testcontainers.properties file or the TESTCONTAINERS_RYUK_DISABLED environment variable
+	ReaperImage              string                                     // Deprecated: use WithImageName ContainerOption instead. Alternative reaper image
+	ReaperOptions            []ContainerOption                          // Deprecated: the reaper is configured at the properties level, for an entire test session
+	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
+	EndpointSettingsModifier func(map[string]*network.EndpointSettings) // Modifier for the network settings before container creation
+	LifecycleHooks           []ContainerLifecycleHooks                  // define hooks to be executed during container lifecycle
+	LogConsumerCfg           *LogConsumerConfig                         // define the configuration for the log producer and its log consumers to follow the logs
 }
 
 // sessionID returns the session ID for the container request.
diff --git a/lifecycle.go b/lifecycle.go
@@ -555,8 +555,8 @@ func (p *DockerProvider) preCreateContainerHook(ctx context.Context, req Contain
 	}
 	req.HostConfigModifier(hostConfig)
 
-	if req.EnpointSettingsModifier != nil {
-		req.EnpointSettingsModifier(endpointSettings)
+	if req.EndpointSettingsModifier != nil {
+		req.EndpointSettingsModifier(endpointSettings)
 	}
 
 	networkingConfig.EndpointsConfig = endpointSettings
diff --git a/lifecycle_test.go b/lifecycle_test.go
@@ -57,7 +57,7 @@ func TestPreCreateModifierHook(t *testing.T) {
 					},
 				}
 			},
-			EnpointSettingsModifier: func(endpointSettings map[string]*network.EndpointSettings) {
+			EndpointSettingsModifier: func(endpointSettings map[string]*network.EndpointSettings) {
 				endpointSettings["a"] = &network.EndpointSettings{
 					Aliases: []string{"b"},
 					Links:   []string{"link1", "link2"},
diff --git a/options.go b/options.go
@@ -53,7 +53,7 @@ func WithConfigModifier(modifier func(config *container.Config)) CustomizeReques
 // WithEndpointSettingsModifier allows to override the default endpoint settings
 func WithEndpointSettingsModifier(modifier func(settings map[string]*network.EndpointSettings)) CustomizeRequestOption {
 	return func(req *GenericContainerRequest) error {
-		req.EnpointSettingsModifier = modifier
+		req.EndpointSettingsModifier = modifier
 
 		return nil
 	}
diff --git a/reaper_test.go b/reaper_test.go
@@ -53,8 +53,8 @@ func (m *mockReaperProvider) RunContainer(ctx context.Context, req ContainerRequ
 	}
 	req.HostConfigModifier(m.hostConfig)
 
-	if req.EnpointSettingsModifier != nil {
-		req.EnpointSettingsModifier(m.endpointSettings)
+	if req.EndpointSettingsModifier != nil {
+		req.EndpointSettingsModifier(m.endpointSettings)
 	}
 
 	// we're only interested in the request, so instead of mocking the Docker client

Original file line number	Diff line number	Diff line change
`@@ -555,8 +555,8 @@ func (p *DockerProvider) preCreateContainerHook(ctx context.Context, req Contain`
`555`	`555`	`}`
`556`	`556`	`req.HostConfigModifier(hostConfig)`
`557`	`557`
`558`		`- if req.EnpointSettingsModifier != nil {`
`559`		`- req.EnpointSettingsModifier(endpointSettings)`
	`558`	`+ if req.EndpointSettingsModifier != nil {`
	`559`	`+ req.EndpointSettingsModifier(endpointSettings)`
`560`	`560`	`}`
`561`	`561`
`562`	`562`	`networkingConfig.EndpointsConfig = endpointSettings`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func TestPreCreateModifierHook(t *testing.T) {`
`57`	`57`	`},`
`58`	`58`	`}`
`59`	`59`	`},`
`60`		`- EnpointSettingsModifier: func(endpointSettings map[string]*network.EndpointSettings) {`
	`60`	`+ EndpointSettingsModifier: func(endpointSettings map[string]*network.EndpointSettings) {`
`61`	`61`	`endpointSettings["a"] = &network.EndpointSettings{`
`62`	`62`	`Aliases: []string{"b"},`
`63`	`63`	`Links: []string{"link1", "link2"},`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func WithConfigModifier(modifier func(config *container.Config)) CustomizeReques`
`53`	`53`	`// WithEndpointSettingsModifier allows to override the default endpoint settings`
`54`	`54`	`func WithEndpointSettingsModifier(modifier func(settings map[string]*network.EndpointSettings)) CustomizeRequestOption {`
`55`	`55`	`return func(req *GenericContainerRequest) error {`
`56`		`- req.EnpointSettingsModifier = modifier`
	`56`	`+ req.EndpointSettingsModifier = modifier`
`57`	`57`
`58`	`58`	`return nil`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,8 @@ func (m *mockReaperProvider) RunContainer(ctx context.Context, req ContainerRequ`
`53`	`53`	`}`
`54`	`54`	`req.HostConfigModifier(m.hostConfig)`
`55`	`55`
`56`		`- if req.EnpointSettingsModifier != nil {`
`57`		`- req.EnpointSettingsModifier(m.endpointSettings)`
	`56`	`+ if req.EndpointSettingsModifier != nil {`
	`57`	`+ req.EndpointSettingsModifier(m.endpointSettings)`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`// we're only interested in the request, so instead of mocking the Docker client`