Skip to content

Commit

Permalink
chore: always close Docker client (testcontainers#939)
Browse files Browse the repository at this point in the history 
* chore: simplify how to negotiate the API version

* chore: use filepath in compose tests

* chore: unify how to internally retrieve a Docker client

* chore: defer closing the internal Docker client

* chore: extract provider code to a separate file

* chor: always Close the Docker client

* chore: extract test paths to variables

* fix: always fallback to the client from env when the host does not respond
  • Loading branch information
@mdelapenya
mdelapenya authored Mar 14, 2023
1 parent 1c453df commit ee9ff41
Show file tree
Hide file tree
Showing 15 changed files with 283 additions and 193 deletions.
68 changes: 0 additions & 68 deletions container.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,6 @@ type DeprecatedContainer interface {
Terminate(ctx context.Context) error
}

// ContainerProvider allows the creation of containers on an arbitrary system
type ContainerProvider interface {
CreateContainer(context.Context, ContainerRequest) (Container, error) // create a container without starting it
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
}

// Container allows getting info about and controlling a single container instance
type Container interface {
GetContainerID() string // get the container id from the provider
Expand Down Expand Up @@ -132,30 +123,6 @@ type ContainerRequest struct {
EnpointSettingsModifier func(map[string]*network.EndpointSettings) // Modifier for the network settings before container creation
}

type (
// ProviderType is an enum for the possible providers
ProviderType int

// GenericProviderOptions defines options applicable to all providers
GenericProviderOptions struct {
Logger Logging
DefaultNetwork string
}

// GenericProviderOption defines a common interface to modify GenericProviderOptions
// These options can be passed to GetProvider in a variadic way to customize the returned GenericProvider instance
GenericProviderOption interface {
ApplyGenericTo(opts *GenericProviderOptions)
}

// GenericProviderOptionFunc is a shorthand to implement the GenericProviderOption interface
GenericProviderOptionFunc func(opts *GenericProviderOptions)
)

func (f GenericProviderOptionFunc) ApplyGenericTo(opts *GenericProviderOptions) {
f(opts)
}

// containerOptions functional options for a container
type containerOptions struct {
ImageName string
Expand All @@ -180,41 +147,6 @@ func WithRegistryCredentials(registryCredentials string) ContainerOption {
}
}

// possible provider types
const (
ProviderDocker ProviderType = iota // Docker is default = 0
ProviderPodman
)

// GetProvider provides the provider implementation for a certain type
func (t ProviderType) GetProvider(opts ...GenericProviderOption) (GenericProvider, error) {
opt := &GenericProviderOptions{
Logger: Logger,
}

for _, o := range opts {
o.ApplyGenericTo(opt)
}

switch t {
case ProviderDocker:
providerOptions := append(Generic2DockerOptions(opts...), WithDefaultBridgeNetwork(Bridge))
provider, err := NewDockerProvider(providerOptions...)
if err != nil {
return nil, fmt.Errorf("%w, failed to create Docker provider", err)
}
return provider, nil
case ProviderPodman:
providerOptions := append(Generic2DockerOptions(opts...), WithDefaultBridgeNetwork(Podman))
provider, err := NewDockerProvider(providerOptions...)
if err != nil {
return nil, fmt.Errorf("%w, failed to create Docker provider", err)
}
return provider, nil
}
return nil, errors.New("unknown provider")
}

// Validate ensures that the ContainerRequest does not have invalid parameters configured to it
// ex. make sure you are not specifying both an image as well as a context
func (c *ContainerRequest) Validate() error {
Expand Down
150 changes: 62 additions & 88 deletions docker.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ func (c *DockerContainer) Start(ctx context.Context) error {
if err := c.provider.client.ContainerStart(ctx, c.ID, types.ContainerStartOptions{}); err != nil {
return err
}
defer c.provider.Close()

// if a Wait Strategy has been specified, wait before returning
if c.WaitingFor != nil {
Expand Down Expand Up @@ -231,6 +232,7 @@ func (c *DockerContainer) Stop(ctx context.Context, timeout *time.Duration) erro
if err := c.provider.client.ContainerStop(ctx, c.ID, options); err != nil {
return err
}
defer c.provider.Close()

c.logger.Printf("Container is stopped id: %s image: %s", shortID, c.Image)
c.isRunning = false
Expand Down Expand Up @@ -277,6 +279,8 @@ func (c *DockerContainer) inspectRawContainer(ctx context.Context) (*types.Conta
if err != nil {
return nil, err
}
defer c.provider.Close()

c.raw = &inspect
return c.raw, nil
}
Expand All @@ -286,6 +290,7 @@ func (c *DockerContainer) inspectContainer(ctx context.Context) (*types.Containe
if err != nil {
return nil, err
}
defer c.provider.Close()

return &inspect, nil
}
Expand All @@ -305,6 +310,7 @@ func (c *DockerContainer) Logs(ctx context.Context) (io.ReadCloser, error) {
if err != nil {
return nil, err
}
defer c.provider.Close()

pr, pw := io.Pipe()
r := bufio.NewReader(rc)
Expand Down Expand Up @@ -512,6 +518,8 @@ func (c *DockerContainer) CopyFileFromContainer(ctx context.Context, filePath st
if err != nil {
return nil, err
}
defer c.provider.Close()

tarReader := tar.NewReader(r)

// if we got here we have exactly one file in the TAR-stream
Expand Down Expand Up @@ -550,7 +558,13 @@ func (c *DockerContainer) CopyDirToContainer(ctx context.Context, hostDirPath st
// create the directory under its parent
parent := filepath.Dir(containerParentPath)

return c.provider.client.CopyToContainer(ctx, c.ID, parent, buff, types.CopyToContainerOptions{})
err = c.provider.client.CopyToContainer(ctx, c.ID, parent, buff, types.CopyToContainerOptions{})
if err != nil {
return err
}
defer c.provider.Close()

return nil
}

func (c *DockerContainer) CopyFileToContainer(ctx context.Context, hostFilePath string, containerFilePath string, fileMode int64) error {
Expand All @@ -577,7 +591,13 @@ func (c *DockerContainer) CopyToContainer(ctx context.Context, fileContent []byt
return err
}

return c.provider.client.CopyToContainer(ctx, c.ID, filepath.Dir(containerFilePath), buffer, types.CopyToContainerOptions{})
err = c.provider.client.CopyToContainer(ctx, c.ID, filepath.Dir(containerFilePath), buffer, types.CopyToContainerOptions{})
if err != nil {
return err
}
defer c.provider.Close()

return nil
}

// StartLogProducer will start a concurrent process that will continuously read logs
Expand All @@ -603,6 +623,7 @@ func (c *DockerContainer) StartLogProducer(ctx context.Context) error {
// from within this goroutine
panic(err)
}
defer c.provider.Close()

for {
select {
Expand Down Expand Up @@ -685,7 +706,14 @@ func (n *DockerNetwork) Remove(ctx context.Context) error {
case n.terminationSignal <- true:
default:
}
return n.provider.client.NetworkRemove(ctx, n.ID)

err := n.provider.client.NetworkRemove(ctx, n.ID)
if err != nil {
return err
}
defer n.provider.Close()

return nil
}

// DockerProvider implements the ContainerProvider interface
Expand All @@ -702,6 +730,15 @@ func (p *DockerProvider) Client() client.APIClient {
return p.client
}

// Close closes the docker client used by the provider
func (p *DockerProvider) Close() error {
if p.client == nil {
return nil
}

return p.client.Close()
}

// SetClient sets the docker client to be used by the provider
func (p *DockerProvider) SetClient(c client.APIClient) {
p.client = c
Expand All @@ -717,55 +754,12 @@ type TestContainersConfig struct {
RyukPrivileged bool `properties:"ryuk.container.privileged,default=false"`
}

type (
// DockerProviderOptions defines options applicable to DockerProvider
DockerProviderOptions struct {
defaultBridgeNetworkName string
*GenericProviderOptions
}

// DockerProviderOption defines a common interface to modify DockerProviderOptions
// These can be passed to NewDockerProvider in a variadic way to customize the returned DockerProvider instance
DockerProviderOption interface {
ApplyDockerTo(opts *DockerProviderOptions)
}

// DockerProviderOptionFunc is a shorthand to implement the DockerProviderOption interface
DockerProviderOptionFunc func(opts *DockerProviderOptions)
)

func (f DockerProviderOptionFunc) ApplyDockerTo(opts *DockerProviderOptions) {
f(opts)
}

func Generic2DockerOptions(opts ...GenericProviderOption) []DockerProviderOption {
converted := make([]DockerProviderOption, 0, len(opts))
for _, o := range opts {
switch c := o.(type) {
case DockerProviderOption:
converted = append(converted, c)
default:
converted = append(converted, DockerProviderOptionFunc(func(opts *DockerProviderOptions) {
o.ApplyGenericTo(opts.GenericProviderOptions)
}))
}
}

return converted
}

func WithDefaultBridgeNetwork(bridgeNetworkName string) DockerProviderOption {
return DockerProviderOptionFunc(func(opts *DockerProviderOptions) {
opts.defaultBridgeNetworkName = bridgeNetworkName
})
}

func NewDockerClient() (cli *client.Client, host string, tcConfig TestContainersConfig, err error) {
tcConfig = configureTC()

host = tcConfig.Host

opts := []client.Opt{client.FromEnv}
opts := []client.Opt{client.FromEnv, client.WithAPIVersionNegotiation()}
if host != "" {
opts = append(opts, client.WithHost(host))

Expand All @@ -790,56 +784,21 @@ func NewDockerClient() (cli *client.Client, host string, tcConfig TestContainers
)

cli, err = client.NewClientWithOpts(opts...)

if err != nil {
return nil, "", TestContainersConfig{}, err
}

cli.NegotiateAPIVersion(context.Background())

return cli, host, tcConfig, nil
}

// NewDockerProvider creates a Docker provider with the EnvClient
func NewDockerProvider(provOpts ...DockerProviderOption) (*DockerProvider, error) {
o := &DockerProviderOptions{
GenericProviderOptions: &GenericProviderOptions{
Logger: Logger,
},
}

for idx := range provOpts {
provOpts[idx].ApplyDockerTo(o)
}

c, host, tcConfig, err := NewDockerClient()
if err != nil {
return nil, err
}

_, err = c.Ping(context.TODO())
_, err = cli.Ping(context.TODO())
if err != nil {
// fallback to environment
c, err = client.NewClientWithOpts(client.FromEnv)
cli, err = testcontainersdocker.NewClient(context.Background())
if err != nil {
return nil, err
return nil, "", TestContainersConfig{}, err
}
}
defer cli.Close()

c.NegotiateAPIVersion(context.Background())
p := &DockerProvider{
DockerProviderOptions: o,
host: host,
client: c,
config: tcConfig,
}

// log docker server info only once
logOnce.Do(func() {
LogDockerServerInfo(context.Background(), p.client, p.Logger)
})

return p, nil
return cli, host, tcConfig, nil
}

// configureTC reads from testcontainers properties file, if it exists
Expand Down Expand Up @@ -908,6 +867,8 @@ func (p *DockerProvider) BuildImage(ctx context.Context, img ImageBuildInfo) (st
Logger.Printf("Failed to build image: %s, will retry", err)
return err
}
defer p.Close()

return nil
}, backoff.WithContext(backoff.NewExponentialBackOff(), ctx))
if err != nil {
Expand Down Expand Up @@ -939,6 +900,9 @@ func (p *DockerProvider) BuildImage(ctx context.Context, img ImageBuildInfo) (st
func (p *DockerProvider) CreateContainer(ctx context.Context, req ContainerRequest) (Container, error) {
var err error

// defer the close of the Docker client connection the soonest
defer p.Close()

// Make sure that bridge network exists
// In case it is disabled we will create reaper_default network
if p.DefaultNetwork == "" {
Expand Down Expand Up @@ -1147,6 +1111,8 @@ func (p *DockerProvider) findContainerByName(ctx context.Context, name string) (
if err != nil {
return nil, err
}
defer p.Close()

if len(containers) > 0 {
return &containers[0], nil
}
Expand Down Expand Up @@ -1207,6 +1173,8 @@ func (p *DockerProvider) attemptToPullImage(ctx context.Context, tag string, pul
Logger.Printf("Failed to pull image: %s, will retry", err)
return err
}
defer p.Close()

return nil
}, backoff.WithContext(backoff.NewExponentialBackOff(), ctx))
if err != nil {
Expand All @@ -1223,7 +1191,9 @@ func (p *DockerProvider) attemptToPullImage(ctx context.Context, tag string, pul
// docker-client ping endpoint to see if the daemon is reachable.
func (p *DockerProvider) Health(ctx context.Context) (err error) {
_, err = p.client.Ping(ctx)
return
defer p.Close()

return err
}

// RunContainer takes a RequestContainer as input and it runs a container via the docker sdk
Expand Down Expand Up @@ -1269,6 +1239,7 @@ func daemonHost(ctx context.Context, p *DockerProvider) (string, error) {
if err != nil {
return "", err
}
defer p.Close()

switch url.Scheme {
case "http", "https", "tcp":
Expand Down Expand Up @@ -1297,6 +1268,9 @@ func daemonHost(ctx context.Context, p *DockerProvider) (string, error) {
func (p *DockerProvider) CreateNetwork(ctx context.Context, req NetworkRequest) (Network, error) {
var err error

// defer the close of the Docker client connection the soonest
defer p.Close()

// Make sure that bridge network exists
// In case it is disabled we will create reaper_default network
if p.DefaultNetwork == "" {
Expand Down
Loading

0 comments on commit ee9ff41

Please sign in to comment.