feat: allow overriding the session ID

Author: jcmfernandes

internal/config/config.go

@@ -52,6 +52,13 @@ type Config struct {
 	// Environment variable: TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX
 	HubImageNamePrefix string `properties:"hub.image.name.prefix,default="`
 
+	// SessionID is the ID of the testing session.
+	// Setting this value will preclude runs from creating more than one reaper. Therefore,
+	// changes to ryuk settings past its creation will be ignored.
+	//
+	// Environment variable: TESTCONTAINERS_SESSION_ID
+	SessionID string `properties:"session.id,default="`
+
 	// RyukDisabled is a flag to enable or disable the Garbage Collector.
 	// Setting this to true will prevent testcontainers from automatically cleaning up
 	// resources, which is particularly important in tests which timeout as they
@@ -121,6 +128,11 @@ func read() Config {
 			config.HubImageNamePrefix = hubImageNamePrefix
 		}
 
+		sessionID := os.Getenv("TESTCONTAINERS_SESSION_ID")
+		if sessionID != "" {
+			config.SessionID = sessionID
+		}
+
 		ryukPrivilegedEnv := os.Getenv("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED")
 		if parseBool(ryukPrivilegedEnv) {
 			config.RyukPrivileged = ryukPrivilegedEnv == "true"

internal/config/config_test.go

@@ -21,6 +21,7 @@ const (
 func resetTestEnv(t *testing.T) {
 	t.Helper()
 	t.Setenv("TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX", "")
+	t.Setenv("TESTCONTAINERS_SESSION_ID", "")
 	t.Setenv("TESTCONTAINERS_RYUK_DISABLED", "")
 	t.Setenv("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED", "")
 	t.Setenv("RYUK_VERBOSE", "")
@@ -76,6 +77,7 @@ func TestReadTCConfig(t *testing.T) {
 		t.Setenv("USERPROFILE", "") // Windows support
 		t.Setenv("TESTCONTAINERS_RYUK_DISABLED", "true")
 		t.Setenv("TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX", defaultHubPrefix)
+		t.Setenv("TESTCONTAINERS_SESSION_ID", "foo")
 		t.Setenv("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED", "true")
 		t.Setenv("RYUK_RECONNECTION_TIMEOUT", "13s")
 		t.Setenv("RYUK_CONNECTION_TIMEOUT", "12s")
@@ -84,6 +86,7 @@ func TestReadTCConfig(t *testing.T) {
 
 		expected := Config{
 			HubImageNamePrefix:      defaultHubPrefix,
+			SessionID:               "foo",
 			RyukDisabled:            true,
 			RyukPrivileged:          true,
 			Host:                    "", // docker socket is empty at the properties file
@@ -124,6 +127,7 @@ func TestReadTCConfig(t *testing.T) {
 		t.Setenv("USERPROFILE", tmpDir) // Windows support
 		t.Setenv("TESTCONTAINERS_RYUK_DISABLED", "true")
 		t.Setenv("TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX", defaultHubPrefix)
+		t.Setenv("TESTCONTAINERS_SESSION_ID", "foo")
 		t.Setenv("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED", "true")
 		t.Setenv("RYUK_VERBOSE", "true")
 		t.Setenv("RYUK_RECONNECTION_TIMEOUT", "13s")
@@ -132,6 +136,7 @@ func TestReadTCConfig(t *testing.T) {
 		config := read()
 		expected := Config{
 			HubImageNamePrefix:      defaultHubPrefix,
+			SessionID:               "foo",
 			RyukDisabled:            true,
 			RyukPrivileged:          true,
 			RyukVerbose:             true,

internal/core/bootstrap.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/shirou/gopsutil/v4/process"
+	"github.com/testcontainers/testcontainers-go/internal/config"
 )
 
 // sessionID returns a unique session ID for the current test session. Because each Go package
@@ -45,6 +46,11 @@ var processID string
 const sessionIDPlaceholder = "testcontainers-go:%d:%d"
 
 func init() {
+	cfg := config.Read()
+	if cfg.SessionID != "" {
+		sessionID = cfg.SessionID
+	}
+
 	processID = uuid.New().String()
 
 	parentPid := os.Getppid()
@@ -57,7 +63,9 @@ func init() {
 
 	processes, err := process.Processes()
 	if err != nil {
-		sessionID = uuid.New().String()
+		if sessionID == "" {
+			sessionID = uuid.New().String()
+		}
 		projectPath = fallbackCwd
 		return
 	}
@@ -75,22 +83,26 @@ func init() {
 
 		t, err := p.CreateTime()
 		if err != nil {
-			sessionID = uuid.New().String()
+			if sessionID == "" {
+				sessionID = uuid.New().String()
+			}
 			return
 		}
 
 		createTime = t
 		break
 	}
 
-	hasher := sha256.New()
-	_, err = fmt.Fprintf(hasher, sessionIDPlaceholder, parentPid, createTime)
-	if err != nil {
-		sessionID = uuid.New().String()
-		return
-	}
+	if sessionID == "" {
+		hasher := sha256.New()
+		_, err = fmt.Fprintf(hasher, sessionIDPlaceholder, parentPid, createTime)
+		if err != nil {
+			sessionID = uuid.New().String()
+			return
+		}
 
-	sessionID = hex.EncodeToString(hasher.Sum(nil))
+		sessionID = hex.EncodeToString(hasher.Sum(nil))
+	}
 }
 
 func ProcessID() string {