feat: setup docker_host discovery strategies properly

.github/workflows/ci-rootless-docker.yml

@@ -0,0 +1,72 @@
+name: Rootless Docker pipeline
+
+on:
+  push:
+    paths-ignore:
+    - 'mkdocs.yml'
+    - 'docs/**'
+    - 'README.md'
+  pull_request:
+    paths-ignore:
+    - 'mkdocs.yml'
+    - 'docs/**'
+    - 'README.md'
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.head_ref || github.sha }}"
+  cancel-in-progress: true
+
+jobs:
+  test-rootless-docker:
+    strategy:
+      matrix:
+        go-version: [1.19.x, 1.x]
+        platform: [ubuntu-latest]
+    runs-on: ${{ matrix.platform }}
+    env:
+      TESTCONTAINERS_RYUK_DISABLED: "false"
+    steps:
+
+      - name: Setup rootless Docker
+        uses: ScribeMD/[email protected]
+
+      - name: Remove Docket root socket
+        run: sudo rm -rf /var/run/docker.sock
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        run: go mod verify
+
+      - name: modTidy
+        run: make tools-tidy
+
+      - name: ensure compilation
+        env:
+          GOOS: linux
+        run: go build
+
+      - name: gotestsum
+        # only run tests on linux, there are a number of things that won't allow the tests to run on anything else
+        # many (maybe, all?) images used can only be build on Linux, they don't have Windows in their manifest, and
+        # we can't put Windows Server in "Linux Mode" in Github actions
+        # another, host mode is only available on Linux, and we have tests around that, do we skip them?
+        if: ${{ matrix.platform == 'ubuntu-latest' }}
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-*.xml"
+        if: always()

config.go

@@ -1,101 +1,38 @@
 package testcontainers
 
 import (
-	"fmt"
-	"os"
-	"path/filepath"
-	"strconv"
-	"sync"
+	"context"
 
-	"github.com/magiconair/properties"
+	"github.com/testcontainers/testcontainers-go/internal/config"
 )
 
-var tcConfig TestcontainersConfig
-var tcConfigOnce *sync.Once = new(sync.Once)
-
 // TestcontainersConfig represents the configuration for Testcontainers
-// testcontainersConfig {
 type TestcontainersConfig struct {
-	Host           string `properties:"docker.host,default="`
-	TLSVerify      int    `properties:"docker.tls.verify,default=0"`
-	CertPath       string `properties:"docker.cert.path,default="`
-	RyukDisabled   bool   `properties:"ryuk.disabled,default=false"`
-	RyukPrivileged bool   `properties:"ryuk.container.privileged,default=false"`
+	Host           string `properties:"docker.host,default="`                    // Deprecated: use Config.Host instead
+	TLSVerify      int    `properties:"docker.tls.verify,default=0"`             // Deprecated: use Config.TLSVerify instead
+	CertPath       string `properties:"docker.cert.path,default="`               // Deprecated: use Config.CertPath instead
+	RyukDisabled   bool   `properties:"ryuk.disabled,default=false"`             // Deprecated: use Config.RyukDisabled instead
+	RyukPrivileged bool   `properties:"ryuk.container.privileged,default=false"` // Deprecated: use Config.RyukPrivileged instead
+	Config         config.Config
 }
 
-// }
-
 // ReadConfig reads from testcontainers properties file, storing the result in a singleton instance
 // of the TestcontainersConfig struct
+// Deprecated use ReadConfigWithContext instead
 func ReadConfig() TestcontainersConfig {
-	tcConfigOnce.Do(func() {
-		tcConfig = readConfig()
-
-		if tcConfig.RyukDisabled {
-			ryukDisabledMessage := `
-**********************************************************************************************
-Ryuk has been disabled for the current execution. This can cause unexpected behavior in your environment.
-More on this: https://golang.testcontainers.org/features/garbage_collector/
-**********************************************************************************************`
-			Logger.Printf(ryukDisabledMessage)
-			Logger.Printf("\n%+v", tcConfig)
-		}
-	})
-
-	return tcConfig
-}
-
-// readConfig reads from testcontainers properties file, if it exists
-// it is possible that certain values get overridden when set as environment variables
-func readConfig() TestcontainersConfig {
-	config := TestcontainersConfig{}
-
-	applyEnvironmentConfiguration := func(config TestcontainersConfig) TestcontainersConfig {
-		if dockerHostEnv := os.Getenv("DOCKER_HOST"); dockerHostEnv != "" {
-			config.Host = dockerHostEnv
-		}
-		if config.Host == "" {
-			config.Host = "unix:///var/run/docker.sock"
-		}
-
-		ryukDisabledEnv := os.Getenv("TESTCONTAINERS_RYUK_DISABLED")
-		if parseBool(ryukDisabledEnv) {
-			config.RyukDisabled = ryukDisabledEnv == "true"
-		}
-
-		ryukPrivilegedEnv := os.Getenv("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED")
-		if parseBool(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)
-	}
-
-	fmt.Printf("Testcontainers properties file has been found: %s\n", tcProp)
-
-	return applyEnvironmentConfiguration(config)
+	return ReadConfigWithContext(context.Background())
 }
 
-func parseBool(input string) bool {
-	if _, err := strconv.ParseBool(input); err == nil {
-		return true
+// ReadConfigWithContext reads from testcontainers properties file, storing the result in a singleton instance
+// of the TestcontainersConfig struct
+func ReadConfigWithContext(ctx context.Context) TestcontainersConfig {
+	cfg := config.Read(ctx)
+	return TestcontainersConfig{
+		Host:           cfg.Host,
+		TLSVerify:      cfg.TLSVerify,
+		CertPath:       cfg.CertPath,
+		RyukDisabled:   cfg.RyukDisabled,
+		RyukPrivileged: cfg.RyukPrivileged,
+		Config:         cfg,
 	}
-	return false
 }