chore: support disabling reaper at the configuration level

compose_test.go

@@ -443,7 +443,7 @@ func TestLocalDockerComposeWithVolume(t *testing.T) {
 }
 
 func assertVolumeDoesNotExist(tb testing.TB, volumeName string) {
-	containerClient, _, _, err := NewDockerClient()
+	containerClient, _, err := newDockerClient()
 	if err != nil {
 		tb.Fatalf("Failed to get provider: %v", err)
 	}
@@ -468,7 +468,7 @@ func assertContainerEnvironmentVariables(
 	present map[string]string,
 	absent map[string]string,
 ) {
-	containerClient, _, _, err := NewDockerClient()
+	containerClient, _, err := newDockerClient()
 	if err != nil {
 		tb.Fatalf("Failed to get provider: %v", err)
 	}

container.go

@@ -12,6 +12,7 @@ import (
 	"github.com/docker/docker/pkg/archive"
 	"github.com/docker/go-connections/nat"
 
+	"github.com/testcontainers/testcontainers-go/internal/properties"
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
@@ -30,7 +31,7 @@ type ContainerProvider interface {
 	ReuseOrCreateContainer(context.Context, ContainerRequest) (Container, error) // reuses a container if it exists or creates a container without starting
 	RunContainer(context.Context, ContainerRequest) (Container, error)           // create a container and start it
 	Health(context.Context) error
-	Config() TestContainersConfig
+	Config() *properties.TestcontainersConfig
 }
 
 // Container allows getting info about and controlling a single container instance
@@ -90,31 +91,32 @@ 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          // alternative reaper image
-	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.
+	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
+	// Deprecated: The reaper is globally controlled by the .testcontainers.properties file or the TESTCONTAINERS_RYUK_DISABLED environment variable
+	SkipReaper      bool
+	ReaperImage     string // alternative reaper image
+	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)
 }

docker.go

@@ -30,10 +30,10 @@ import (
 	"github.com/docker/docker/pkg/jsonmessage"
 	"github.com/docker/go-connections/nat"
 	"github.com/google/uuid"
-	"github.com/magiconair/properties"
 	"github.com/moby/term"
 	specs "github.com/opencontainers/image-spec/specs-go/v1"
 
+	"github.com/testcontainers/testcontainers-go/internal/properties"
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
@@ -649,19 +649,11 @@ type DockerProvider struct {
 	client    *client.Client
 	host      string
 	hostCache string
-	config    TestContainersConfig
+	config    *properties.TestcontainersConfig
 }
 
 var _ ContainerProvider = (*DockerProvider)(nil)
 
-// or through Decode
-type TestContainersConfig struct {
-	Host           string `properties:"docker.host,default="`
-	TLSVerify      int    `properties:"docker.tls.verify,default=0"`
-	CertPath       string `properties:"docker.cert.path,default="`
-	RyukPrivileged bool   `properties:"ryuk.container.privileged,default=false"`
-}
-
 type (
 	// DockerProviderOptions defines options applicable to DockerProvider
 	DockerProviderOptions struct {
@@ -705,8 +697,8 @@ func WithDefaultBridgeNetwork(bridgeNetworkName string) DockerProviderOption {
 	})
 }
 
-func NewDockerClient() (cli *client.Client, host string, tcConfig TestContainersConfig, err error) {
-	tcConfig = configureTC()
+func newDockerClient() (cli *client.Client, host string, err error) {
+	tcConfig := properties.Get()
 
 	host = tcConfig.Host
 
@@ -731,12 +723,12 @@ func NewDockerClient() (cli *client.Client, host string, tcConfig TestContainers
 	cli, err = client.NewClientWithOpts(opts...)
 
 	if err != nil {
-		return nil, "", TestContainersConfig{}, err
+		return nil, "", err
 	}
 
 	cli.NegotiateAPIVersion(context.Background())
 
-	return cli, host, tcConfig, nil
+	return cli, host, nil
 }
 
 // NewDockerProvider creates a Docker provider with the EnvClient
@@ -751,7 +743,7 @@ func NewDockerProvider(provOpts ...DockerProviderOption) (*DockerProvider, error
 		provOpts[idx].ApplyDockerTo(o)
 	}
 
-	c, host, tcConfig, err := NewDockerClient()
+	c, host, err := newDockerClient()
 	if err != nil {
 		return nil, err
 	}
@@ -770,7 +762,7 @@ func NewDockerProvider(provOpts ...DockerProviderOption) (*DockerProvider, error
 		DockerProviderOptions: o,
 		host:                  host,
 		client:                c,
-		config:                tcConfig,
+		config:                properties.Get(),
 	}
 
 	// log docker server info only once
@@ -797,40 +789,6 @@ func (p *DockerProvider) logDockerServerInfo() {
 		info.OperatingSystem, info.MemTotal/1024/1024)
 }
 
-// configureTC reads from testcontainers properties file, if it exists
-// it is possible that certain values get overridden when set as environment variables
-func configureTC() TestContainersConfig {
-	config := TestContainersConfig{}
-
-	applyEnvironmentConfiguration := func(config TestContainersConfig) TestContainersConfig {
-		ryukPrivilegedEnv := os.Getenv("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED")
-		if ryukPrivilegedEnv != "" {
-			config.RyukPrivileged = ryukPrivilegedEnv == "true"
-		}
-
-		return config
-	}
-
-	home, err := os.UserHomeDir()
-	if err != nil {
-		return applyEnvironmentConfiguration(config)
-	}
-
-	tcProp := filepath.Join(home, ".testcontainers.properties")
-	// init from a file
-	properties, err := properties.LoadFile(tcProp, properties.UTF8)
-	if err != nil {
-		return applyEnvironmentConfiguration(config)
-	}
-
-	if err := properties.Decode(&config); err != nil {
-		fmt.Printf("invalid testcontainers properties file, returning an empty Testcontainers configuration: %v\n", err)
-		return applyEnvironmentConfiguration(config)
-	}
-
-	return applyEnvironmentConfiguration(config)
-}
-
 // BuildImage will build and image from context and Dockerfile, then return the tag
 func (p *DockerProvider) BuildImage(ctx context.Context, img ImageBuildInfo) (string, error) {
 	repo := uuid.New()
@@ -920,15 +878,14 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
 	sessionID := uuid.New()
 
 	var termSignal chan bool
-	if !req.SkipReaper {
+	// the reaper does not need to start a reaper for itself
+	if !properties.Get().RyukDisabled && !strings.EqualFold(req.Image, reaperImage(req.ReaperImage)) {
 		r, err := NewReaper(context.WithValue(ctx, dockerHostContextKey, p.host), sessionID.String(), p, req.ReaperImage)
 		if err != nil {
 			return nil, fmt.Errorf("%w: creating reaper failed", err)
 		}
-		termSignal, err = r.Connect()
-		if err != nil {
-			return nil, fmt.Errorf("%w: connecting to reaper failed", err)
-		}
+		termSignal = r.termSignal
+
 		for k, v := range r.Labels() {
 			if _, ok := req.Labels[k]; !ok {
 				req.Labels[k] = v
@@ -1134,15 +1091,12 @@ func (p *DockerProvider) ReuseOrCreateContainer(ctx context.Context, req Contain
 
 	sessionID := uuid.New()
 	var termSignal chan bool
-	if !req.SkipReaper {
+	if !properties.Get().RyukDisabled {
 		r, err := NewReaper(ctx, sessionID.String(), p, req.ReaperImage)
 		if err != nil {
 			return nil, fmt.Errorf("%w: creating reaper failed", err)
 		}
-		termSignal, err = r.Connect()
-		if err != nil {
-			return nil, fmt.Errorf("%w: connecting to reaper failed", err)
-		}
+		termSignal = r.termSignal
 	}
 	dc := &DockerContainer{
 		ID:                c.ID,
@@ -1209,9 +1163,9 @@ func (p *DockerProvider) RunContainer(ctx context.Context, req ContainerRequest)
 	return c, nil
 }
 
-// Config provides the TestContainersConfig read from $HOME/.testcontainers.properties or
+// Config provides the TestcontainersConfig read from $HOME/.testcontainers.properties or
 // the environment variables
-func (p *DockerProvider) Config() TestContainersConfig {
+func (p *DockerProvider) Config() *properties.TestcontainersConfig {
 	return p.config
 }
 
@@ -1288,15 +1242,12 @@ func (p *DockerProvider) CreateNetwork(ctx context.Context, req NetworkRequest)
 	sessionID := uuid.New()
 
 	var termSignal chan bool
-	if !req.SkipReaper {
+	if !properties.Get().RyukDisabled {
 		r, err := NewReaper(context.WithValue(ctx, dockerHostContextKey, p.host), sessionID.String(), p, req.ReaperImage)
 		if err != nil {
 			return nil, fmt.Errorf("%w: creating network reaper failed", err)
 		}
-		termSignal, err = r.Connect()
-		if err != nil {
-			return nil, fmt.Errorf("%w: connecting to network reaper failed", err)
-		}
+		termSignal = r.termSignal
 		for k, v := range r.Labels() {
 			if _, ok := req.Labels[k]; !ok {
 				req.Labels[k] = v