feat!: replace direct client usage with apiclient base interface, add option to pass in custom docker client

Author: silenium-dev

examples/pull/main.go

@@ -9,19 +9,19 @@ import (
 	"github.com/docker/docker/api/types/registry"
 	client2 "github.com/docker/docker/client"
 	"github.com/silenium-dev/docker-wrapper/pkg/client"
-	"github.com/silenium-dev/docker-wrapper/pkg/client/auth"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/provider"
 	"go.uber.org/zap"
 )
 
 func main() {
 	logger := zap.Must(zap.NewDevelopment()).Sugar()
-	authProvider, err := auth.NewDefaultAuthProvider()
+	authProvider, err := provider.NewDefaultAuthProvider()
 	if err != nil {
 		panic(err)
 	}
-	override := auth.NewOverridingAuthProvider(
+	override := provider.NewOverridingAuthProvider(
 		authProvider, map[string]registry.AuthConfig{},
-		auth.WithSugaredLogger(logger.With(zap.String("component", "auth-provider"))),
+		provider.WithSugaredLogger(logger.With(zap.String("component", "auth-provider"))),
 	).WithOverride("quay.io", registry.AuthConfig{})
 	cli, err := client.NewWithOpts(
 		client.WithAuthProvider(override),

pkg/client/base.go

@@ -6,7 +6,7 @@ import (
 )
 
 func (c *Client) Close() error {
-	return c.Client.Close()
+	return c.APIClient.Close()
 }
 
 func (c *Client) AuthProvider() provider.AuthProvider {

pkg/client/build.go

@@ -15,5 +15,5 @@ func (c *Client) ImageBuild(
 	maps.Copy(authConfigs, opts.AuthConfigs)
 	opts.AuthConfigs = authConfigs
 
-	return c.Client.ImageBuild(ctx, buildContext, opts)
+	return c.APIClient.ImageBuild(ctx, buildContext, opts)
 }

pkg/client/client.go

@@ -10,7 +10,7 @@ import (
 )
 
 type Client struct {
-	*client.Client
+	client.APIClient
 	dockerOpts             []client.Opt
 	authProvider           provider.AuthProvider
 	imageProvider          provider.ImageProvider
@@ -34,11 +34,12 @@ func NewWithOpts(opts ...Opt) (*Client, error) {
 	if c.imageProvider == nil {
 		c.imageProvider = provider.DefaultImageProvider()
 	}
-
-	cli, err := client.NewClientWithOpts(c.dockerOpts...)
-	if err != nil {
-		return nil, err
+	if c.APIClient == nil {
+		cli, err := client.NewClientWithOpts(c.dockerOpts...)
+		if err != nil {
+			return nil, err
+		}
+		c.APIClient = cli
 	}
-	c.Client = cli
 	return c, nil
 }

pkg/client/client_opts.go

@@ -11,6 +11,13 @@ import (
 
 type Opt func(*Client) error
 
+func WithAPIClient(apiClient client.APIClient) Opt {
+	return func(c *Client) error {
+		c.APIClient = apiClient
+		return nil
+	}
+}
+
 func WithVersionNegotiation(c *Client) error {
 	c.dockerOpts = append(c.dockerOpts, client.WithAPIVersionNegotiation())
 	return nil

pkg/client/image_pull.go

@@ -38,7 +38,7 @@ func (c *Client) ImagePullWithEvents(ctx context.Context, ref reference.Named, o
 		return v1.Hash{}, nil, nil, err
 	}
 
-	reader, err := c.Client.ImagePull(ctx, ref.String(), options)
+	reader, err := c.APIClient.ImagePull(ctx, ref.String(), options)
 	if err != nil {
 		return v1.Hash{}, nil, nil, err
 	}

pkg/client/podman/client/client.go

@@ -5,48 +5,39 @@ import (
 	"fmt"
 
 	"github.com/blang/semver/v4"
-	"github.com/silenium-dev/docker-wrapper/pkg/client"
-	"github.com/silenium-dev/docker-wrapper/pkg/client/auth"
+	"github.com/silenium-dev/docker-wrapper/pkg/api"
 	"github.com/silenium-dev/docker-wrapper/pkg/client/podman/containers/bindings"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/provider"
 	"go.uber.org/zap"
 )
 
 type Podman struct {
-	cli          *client.Client
+	cli          api.ClientWrapper
 	conn         *bindings.Connection
 	ver          *semver.Version
 	logger       *zap.SugaredLogger
-	authProvider auth.AuthProvider
+	authProvider provider.AuthProvider
 }
 
 // FromDocker derives a podman connection from the docker remote. Fails if remote is not a podman engine
 func FromDocker(
 	ctx context.Context,
-	cli *client.Client,
-	authProvider auth.AuthProvider,
-	logger *zap.SugaredLogger,
+	cli api.ClientWrapper,
 ) (*Podman, error) {
-	if logger == nil {
-		_logger, err := zap.NewDevelopment()
-		if err != nil {
-			panic(err)
-		}
-		logger = _logger.Sugar()
-	}
-	conn, ver, err := getPodmanConnection(cli, ctx, logger)
+	conn, ver, err := getPodmanConnection(cli, ctx, cli.Logger())
 	if err != nil {
 		return nil, fmt.Errorf("failed to retrieve podman connection: %w", err)
 	}
 	return &Podman{
 		cli:          cli,
 		conn:         conn,
 		ver:          ver,
-		logger:       logger,
-		authProvider: authProvider,
+		logger:       cli.Logger(),
+		authProvider: cli.AuthProvider(),
 	}, nil
 }
 
-func (p *Podman) AuthProvider() auth.AuthProvider {
+func (p *Podman) AuthProvider() provider.AuthProvider {
 	return p.authProvider
 }
 

pkg/client/podman/client/derive.go

@@ -5,14 +5,14 @@ import (
 	"fmt"
 
 	"github.com/blang/semver/v4"
-	"github.com/silenium-dev/docker-wrapper/pkg/client"
+	"github.com/silenium-dev/docker-wrapper/pkg/api"
 	"github.com/silenium-dev/docker-wrapper/pkg/client/podman/containers/bindings"
 	"go.uber.org/zap"
 )
 
 var ErrNotPodman = fmt.Errorf("not a podman server")
 
-func getPodmanConnection(cli *client.Client, ctx context.Context, logger *zap.SugaredLogger) (
+func getPodmanConnection(cli api.ClientWrapper, ctx context.Context, logger *zap.SugaredLogger) (
 	*bindings.Connection, *semver.Version, error,
 ) {
 	if ok, err := cli.SystemIsPodman(ctx); err != nil {

pkg/client/podman/containers/bindings/connection.go

@@ -98,7 +98,9 @@ var connectionFactories = map[string]func(_url *url.URL, uri string, identity st
 // For example tcp://localhost:<port>
 // or unix:///run/podman/podman.sock
 // or ssh://<user>@<host>[:port]/run/podman/podman.sock
-func NewConnectionWithIdentity(ctx context.Context, uri string, identity string, machine bool) (context.Context, error) {
+func NewConnectionWithIdentity(ctx context.Context, uri string, identity string, machine bool) (
+	context.Context, error,
+) {
 	var err error
 	if v, found := os.LookupEnv("CONTAINER_HOST"); found && uri == "" {
 		uri = v
@@ -228,13 +230,15 @@ func sshClient(_url *url.URL, uri string, identity string, machine bool) (Connec
 			logrus.Debugf("  IdentityFile: %q", identity)
 		}
 	}
-	conn, err := ssh.Dial(&ssh.ConnectionDialOptions{
-		Host:                        uri,
-		Identity:                    identity,
-		User:                        userinfo,
-		Port:                        port,
-		InsecureIsMachineConnection: machine,
-	}, ssh.GolangMode)
+	conn, err := ssh.Dial(
+		&ssh.ConnectionDialOptions{
+			Host:                        uri,
+			Identity:                    identity,
+			User:                        userinfo,
+			Port:                        port,
+			InsecureIsMachineConnection: machine,
+		}, ssh.GolangMode,
+	)
 	if err != nil {
 		return connection, newConnectError(err)
 	}
@@ -248,7 +252,8 @@ func sshClient(_url *url.URL, uri string, identity string, machine bool) (Connec
 		var b bytes.Buffer
 		session.Stdout = &b
 		if err := session.Run(
-			"podman info --format '{{.Host.RemoteSocket.Path}}'"); err != nil {
+			"podman info --format '{{.Host.RemoteSocket.Path}}'",
+		); err != nil {
 			return connection, err
 		}
 		val := strings.TrimSuffix(b.String(), "\n")
@@ -339,8 +344,10 @@ func pingNewConnection(ctx context.Context) (*semver.Version, error) {
 			// Server's job when Client version is equal or older
 			return &versionSrv, nil
 		case 1:
-			return nil, fmt.Errorf("server API version is too old. Client %q server %q",
-				version.APIVersion[version.Libpod][version.MinimalAPI].String(), versionSrv.String())
+			return nil, fmt.Errorf(
+				"server API version is too old. Client %q server %q",
+				version.APIVersion[version.Libpod][version.MinimalAPI].String(), versionSrv.String(),
+			)
 		}
 	}
 	return nil, fmt.Errorf("ping response was %d", response.StatusCode)
@@ -366,7 +373,10 @@ func unixClient(_url *url.URL, uri string, _ string, _ bool) (Connection, error)
 
 // DoRequest assembles the http request and returns the response.
 // The caller must close the response body.
-func (c *Connection) DoRequest(ctx context.Context, httpBody io.Reader, httpMethod, endpoint string, queryParams url.Values, headers http.Header, pathValues ...string) (*APIResponse, error) {
+func (c *Connection) DoRequest(
+	ctx context.Context, httpBody io.Reader, httpMethod, endpoint string, queryParams url.Values, headers http.Header,
+	pathValues ...string,
+) (*APIResponse, error) {
 	var (
 		err      error
 		response *http.Response

pkg/client/system.go

@@ -22,7 +22,7 @@ func (c *Client) SystemIsPodman(ctx context.Context) (bool, error) {
 }
 
 func (c *Client) SystemDefaultPlatform(ctx context.Context) (*v1.Platform, error) {
-	info, err := c.Client.Info(ctx)
+	info, err := c.APIClient.Info(ctx)
 	if err != nil {
 		return nil, err
 	}