feat: support reading Docker host from the current Docker context

config.go

@@ -4,6 +4,7 @@ import (
 	"github.com/testcontainers/testcontainers-go/internal/config"
 )
 
+// Deprecated: use [testcontainers.Config] instead
 // TestcontainersConfig represents the configuration for Testcontainers
 type TestcontainersConfig struct {
 	Host           string `properties:"docker.host,default="`                    // Deprecated: use Config.Host instead
@@ -14,10 +15,15 @@ type TestcontainersConfig struct {
 	Config         config.Config
 }
 
+// Deprecated: use [testcontainers.NewConfig] instead
 // ReadConfig reads from testcontainers properties file, storing the result in a singleton instance
 // of the TestcontainersConfig struct
 func ReadConfig() TestcontainersConfig {
-	cfg := config.Read()
+	cfg, err := NewConfig()
+	if err != nil {
+		return TestcontainersConfig{}
+	}
+
 	return TestcontainersConfig{
 		Host:           cfg.Host,
 		TLSVerify:      cfg.TLSVerify,
@@ -27,3 +33,11 @@ func ReadConfig() TestcontainersConfig {
 		Config:         cfg,
 	}
 }
+
+// Config is a type alias for the internal config.Config type
+type Config = config.Config
+
+// NewConfig reads the properties file and returns a new Config instance
+func NewConfig() (Config, error) {
+	return config.Read()
+}

docker.go

@@ -43,9 +43,9 @@ import (
 var _ Container = (*DockerContainer)(nil)
 
 const (
-	Bridge        = "bridge" // Bridge network name (as well as driver)
-	Podman        = "podman"
-	ReaperDefault = "reaper_default" // Default network name when bridge is not available
+	Bridge        = "bridge"         // Deprecated, it will removed in the next major release. Bridge network driver and name
+	Podman        = "podman"         // Deprecated: Podman is supported through the current Docker context
+	ReaperDefault = "reaper_default" // Deprecated: it will removed in the next major release. Default network name when bridge is not available
 	packagePath   = "github.com/testcontainers/testcontainers-go"
 )
 
@@ -1026,29 +1026,6 @@ func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerReque
 	// defer the close of the Docker client connection the soonest
 	defer p.Close()
 
-	var defaultNetwork string
-	defaultNetwork, err = p.ensureDefaultNetwork(ctx)
-	if err != nil {
-		return nil, fmt.Errorf("ensure default network: %w", err)
-	}
-
-	// If default network is not bridge make sure it is attached to the request
-	// as container won't be attached to it automatically
-	// in case of Podman the bridge network is called 'podman' as 'bridge' would conflict
-	if defaultNetwork != p.defaultBridgeNetworkName {
-		isAttached := false
-		for _, net := range req.Networks {
-			if net == defaultNetwork {
-				isAttached = true
-				break
-			}
-		}
-
-		if !isAttached {
-			req.Networks = append(req.Networks, defaultNetwork)
-		}
-	}
-
 	imageName := req.Image
 
 	env := []string{}
@@ -1452,6 +1429,7 @@ func (p *DockerProvider) RunContainer(ctx context.Context, req ContainerRequest)
 	return c, nil
 }
 
+// Deprecated: use [testcontainers.NewConfig] instead
 // Config provides the TestcontainersConfig read from $HOME/.testcontainers.properties or
 // the environment variables
 func (p *DockerProvider) Config() TestcontainersConfig {
@@ -1522,10 +1500,6 @@ func (p *DockerProvider) CreateNetwork(ctx context.Context, req NetworkRequest)
 	// defer the close of the Docker client connection the soonest
 	defer p.Close()
 
-	if _, err = p.ensureDefaultNetwork(ctx); err != nil {
-		return nil, fmt.Errorf("ensure default network: %w", err)
-	}
-
 	if req.Labels == nil {
 		req.Labels = make(map[string]string)
 	}
@@ -1593,13 +1567,7 @@ func (p *DockerProvider) GetNetwork(ctx context.Context, req NetworkRequest) (ne
 }
 
 func (p *DockerProvider) GetGatewayIP(ctx context.Context) (string, error) {
-	// Use a default network as defined in the DockerProvider
-	defaultNetwork, err := p.ensureDefaultNetwork(ctx)
-	if err != nil {
-		return "", fmt.Errorf("ensure default network: %w", err)
-	}
-
-	nw, err := p.GetNetwork(ctx, NetworkRequest{Name: defaultNetwork})
+	nw, err := p.GetNetwork(ctx, NetworkRequest{Name: Bridge})
 	if err != nil {
 		return "", err
 	}
@@ -1618,58 +1586,6 @@ func (p *DockerProvider) GetGatewayIP(ctx context.Context) (string, error) {
 	return ip, nil
 }
 
-// ensureDefaultNetwork ensures that defaultNetwork is set and creates
-// it if it does not exist, returning its value.
-// It is safe to call this method concurrently.
-func (p *DockerProvider) ensureDefaultNetwork(ctx context.Context) (string, error) {
-	p.mtx.Lock()
-	defer p.mtx.Unlock()
-
-	if p.defaultNetwork != "" {
-		// Already set.
-		return p.defaultNetwork, nil
-	}
-
-	networkResources, err := p.client.NetworkList(ctx, network.ListOptions{})
-	if err != nil {
-		return "", fmt.Errorf("network list: %w", err)
-	}
-
-	// TODO: remove once we have docker context support via #2810
-	// Prefer the default bridge network if it exists.
-	// This makes the results stable as network list order is not guaranteed.
-	for _, net := range networkResources {
-		switch net.Name {
-		case p.defaultBridgeNetworkName:
-			p.defaultNetwork = p.defaultBridgeNetworkName
-			return p.defaultNetwork, nil
-		case ReaperDefault:
-			p.defaultNetwork = ReaperDefault
-		}
-	}
-
-	if p.defaultNetwork != "" {
-		return p.defaultNetwork, nil
-	}
-
-	// Create a bridge network for the container communications.
-	_, err = p.client.NetworkCreate(ctx, ReaperDefault, network.CreateOptions{
-		Driver:     Bridge,
-		Attachable: true,
-		Labels:     GenericLabels(),
-	})
-	// If the network already exists, we can ignore the error as that can
-	// happen if we are running multiple tests in parallel and we only
-	// need to ensure that the network exists.
-	if err != nil && !errdefs.IsConflict(err) {
-		return "", fmt.Errorf("network create: %w", err)
-	}
-
-	p.defaultNetwork = ReaperDefault
-
-	return p.defaultNetwork, nil
-}
-
 // ContainerFromType builds a Docker container struct from the response of the Docker API
 func (p *DockerProvider) ContainerFromType(ctx context.Context, response types.Container) (ctr *DockerContainer, err error) {
 	exposedPorts := make([]string, len(response.Ports))

docker_auth.go

@@ -172,7 +172,7 @@ func configKey(cfg *dockercfg.Config) (string, error) {
 // getDockerAuthConfigs returns a map with the auth configs from the docker config file
 // using the registry as the key
 func getDockerAuthConfigs() (map[string]registry.AuthConfig, error) {
-	cfg, err := getDockerConfig()
+	cfg, err := core.DockerConfig()
 	if err != nil {
 		if errors.Is(err, os.ErrNotExist) {
 			return map[string]registry.AuthConfig{}, nil
@@ -258,25 +258,3 @@ func getDockerAuthConfigs() (map[string]registry.AuthConfig, error) {
 
 	return cfgs, nil
 }
-
-// getDockerConfig returns the docker config file. It will internally check, in this particular order:
-// 1. the DOCKER_AUTH_CONFIG environment variable, unmarshalling it into a dockercfg.Config
-// 2. the DOCKER_CONFIG environment variable, as the path to the config file
-// 3. else it will load the default config file, which is ~/.docker/config.json
-func getDockerConfig() (*dockercfg.Config, error) {
-	if env := os.Getenv("DOCKER_AUTH_CONFIG"); env != "" {
-		var cfg dockercfg.Config
-		if err := json.Unmarshal([]byte(env), &cfg); err != nil {
-			return nil, fmt.Errorf("unmarshal DOCKER_AUTH_CONFIG: %w", err)
-		}
-
-		return &cfg, nil
-	}
-
-	cfg, err := dockercfg.LoadDefaultConfig()
-	if err != nil {
-		return nil, fmt.Errorf("load default config: %w", err)
-	}
-
-	return &cfg, nil
-}

docker_auth_test.go

@@ -26,76 +26,6 @@ const (
 	exampleRegistry = "https://example.com"
 )
 
-func Test_getDockerConfig(t *testing.T) {
-	expectedConfig := &dockercfg.Config{
-		AuthConfigs: map[string]dockercfg.AuthConfig{
-			core.IndexDockerIO: {},
-			exampleRegistry:    {},
-			privateRegistry:    {},
-		},
-		CredentialsStore: "desktop",
-	}
-	t.Run("HOME/valid", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata")
-
-		cfg, err := getDockerConfig()
-		require.NoError(t, err)
-		require.Equal(t, expectedConfig, cfg)
-	})
-
-	t.Run("HOME/not-found", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "not-found")
-
-		cfg, err := getDockerConfig()
-		require.ErrorIs(t, err, os.ErrNotExist)
-		require.Nil(t, cfg)
-	})
-
-	t.Run("HOME/invalid-config", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "invalid-config")
-
-		cfg, err := getDockerConfig()
-		require.ErrorContains(t, err, "json: cannot unmarshal array")
-		require.Nil(t, cfg)
-	})
-
-	t.Run("DOCKER_AUTH_CONFIG/valid", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "not-found")
-		t.Setenv("DOCKER_AUTH_CONFIG", dockerConfig)
-
-		cfg, err := getDockerConfig()
-		require.NoError(t, err)
-		require.Equal(t, expectedConfig, cfg)
-	})
-
-	t.Run("DOCKER_AUTH_CONFIG/invalid-config", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "not-found")
-		t.Setenv("DOCKER_AUTH_CONFIG", `{"auths": []}`)
-
-		cfg, err := getDockerConfig()
-		require.ErrorContains(t, err, "json: cannot unmarshal array")
-		require.Nil(t, cfg)
-	})
-
-	t.Run("DOCKER_CONFIG/valid", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "not-found")
-		t.Setenv("DOCKER_CONFIG", filepath.Join("testdata", ".docker"))
-
-		cfg, err := getDockerConfig()
-		require.NoError(t, err)
-		require.Equal(t, expectedConfig, cfg)
-	})
-
-	t.Run("DOCKER_CONFIG/invalid-config", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "not-found")
-		t.Setenv("DOCKER_CONFIG", filepath.Join("testdata", "invalid-config", ".docker"))
-
-		cfg, err := getDockerConfig()
-		require.ErrorContains(t, err, "json: cannot unmarshal array")
-		require.Nil(t, cfg)
-	})
-}
-
 func TestDockerImageAuth(t *testing.T) {
 	t.Run("retrieve auth with DOCKER_AUTH_CONFIG env var", func(t *testing.T) {
 		username, password := "gopher", "secret"
@@ -297,7 +227,6 @@ func prepareLocalRegistryWithAuth(t *testing.T) string {
 	// }
 
 	genContainerReq := GenericContainerRequest{
-		ProviderType:     providerType,
 		ContainerRequest: req,
 		Started:          true,
 	}
@@ -322,7 +251,6 @@ func prepareLocalRegistryWithAuth(t *testing.T) string {
 
 func prepareRedisImage(ctx context.Context, req ContainerRequest) (Container, error) {
 	genContainerReq := GenericContainerRequest{
-		ProviderType:     providerType,
 		ContainerRequest: req,
 		Started:          true,
 	}
@@ -474,15 +402,6 @@ func Test_getDockerAuthConfigs(t *testing.T) {
 
 		requireValidAuthConfig(t)
 	})
-
-	t.Run("DOCKER_CONFIG/invalid-config", func(t *testing.T) {
-		testDockerConfigHome(t, "testdata", "not-found")
-		t.Setenv("DOCKER_CONFIG", filepath.Join("testdata", "invalid-config", ".docker"))
-
-		cfg, err := getDockerConfig()
-		require.ErrorContains(t, err, "json: cannot unmarshal array")
-		require.Nil(t, cfg)
-	})
 }
 
 // requireValidAuthConfig checks that the given authConfigs map contains the expected keys.