config.go

package testcontainers

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
	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
}

// 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, err := NewConfig()
	if err != nil {
		return TestcontainersConfig{}
	}

	return TestcontainersConfig{
		Host:           cfg.Host,
		TLSVerify:      cfg.TLSVerify,
		CertPath:       cfg.CertPath,
		RyukDisabled:   cfg.RyukDisabled,
		RyukPrivileged: cfg.RyukPrivileged,
		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()
}