feat!: introduce client interface, refactor packages

Author: silenium-dev

examples/podman/main.go

@@ -13,7 +13,7 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
-	isPodman, err := cli.IsPodman(context.Background())
+	isPodman, err := cli.SystemIsPodman(context.Background())
 	if err != nil {
 		panic(err)
 	}
@@ -43,7 +43,7 @@ func main() {
 	}
 	defer cli.NetworkRemove(context.Background(), netResp.ID)
 
-	hostIP, err := cli.HostIPFromContainers(context.Background(), &netResp.ID)
+	hostIP, err := cli.SystemHostIPFromContainers(context.Background(), &netResp.ID)
 	if err != nil {
 		panic(err)
 	}

examples/pull/main.go

@@ -15,11 +15,11 @@ import (
 
 func main() {
 	logger := zap.Must(zap.NewDevelopment()).Sugar()
-	authProvider, err := auth.NewDefaultProvider()
+	authProvider, err := auth.NewDefaultAuthProvider()
 	if err != nil {
 		panic(err)
 	}
-	override := auth.NewOverridingProvider(
+	override := auth.NewOverridingAuthProvider(
 		authProvider, map[string]registry.AuthConfig{},
 		auth.WithSugaredLogger(logger.With(zap.String("component", "auth-provider"))),
 	).WithOverride("quay.io", registry.AuthConfig{})
@@ -51,7 +51,7 @@ func main() {
 			logger.Infof("%02d [%s]: %s", idx, l.Id(), l.Status())
 		}
 	}
-	digest, err := cli.ImagePull(context.Background(), ref, image.PullOptions{})
+	digest, err := cli.ImagePullSimple(context.Background(), ref, image.PullOptions{})
 	if err != nil {
 		panic(err)
 	}

pkg/api/client.go

@@ -0,0 +1,59 @@
+package api
+
+import (
+	"context"
+	"io"
+	"net"
+	"net/http"
+
+	"github.com/distribution/reference"
+	"github.com/docker/docker/api/types/build"
+	"github.com/docker/docker/api/types/image"
+	"github.com/docker/docker/client"
+	v1 "github.com/google/go-containerregistry/pkg/v1"
+	"github.com/opencontainers/go-digest"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/provider"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/pull/events"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/pull/state"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/stream"
+	"go.uber.org/zap"
+)
+
+type ClientBase interface {
+	AuthProvider() provider.AuthProvider
+	Logger() *zap.SugaredLogger
+	Close() error
+	RequestAuthenticate(req *http.Request, ref reference.Named) error
+}
+
+type ImageClient interface {
+	ImageBuild(
+		ctx context.Context, buildContext io.Reader, opts build.ImageBuildOptions,
+	) (build.ImageBuildResponse, error)
+	ImagePullWithEvents(ctx context.Context, ref reference.Named, options image.PullOptions) (
+		v1.Hash, *v1.Manifest, chan events.PullEvent, error,
+	)
+	ImagePullWithState(ctx context.Context, ref reference.Named, options image.PullOptions) (
+		v1.Hash, *v1.Manifest, chan state.Pull, error,
+	)
+	ImagePullSimple(ctx context.Context, ref reference.Named, options image.PullOptions) (digest.Digest, error)
+	ImageGetManifest(ctx context.Context, ref reference.Named, platform *v1.Platform) (v1.Hash, *v1.Manifest, error)
+}
+
+type ContainerClient interface {
+	StreamLogs(ctx context.Context, id string, follow bool) (*stream.MultiplexedStream, error)
+}
+
+type SystemClient interface {
+	SystemHostIPFromContainers(ctx context.Context, netId *string) (net.IP, error)
+	SystemIsPodman(ctx context.Context) (bool, error)
+	SystemDefaultPlatform(ctx context.Context) (*v1.Platform, error)
+}
+
+type ClientWrapper interface {
+	client.APIClient
+	ClientBase
+	ImageClient
+	ContainerClient
+	SystemClient
+}

pkg/client/base.go

@@ -0,0 +1,18 @@
+package client
+
+import (
+	"github.com/silenium-dev/docker-wrapper/pkg/client/provider"
+	"go.uber.org/zap"
+)
+
+func (c *Client) Close() error {
+	return c.Client.Close()
+}
+
+func (c *Client) AuthProvider() provider.AuthProvider {
+	return c.authProvider
+}
+
+func (c *Client) Logger() *zap.SugaredLogger {
+	return c.logger
+}

pkg/client/build.go

@@ -2,12 +2,15 @@ package client
 
 import (
 	"context"
-	"github.com/docker/docker/api/types"
 	"io"
 	"maps"
+
+	"github.com/docker/docker/api/types/build"
 )
 
-func (c *Client) ImageBuild(ctx context.Context, buildContext io.Reader, opts types.ImageBuildOptions) (types.ImageBuildResponse, error) {
+func (c *Client) ImageBuild(
+	ctx context.Context, buildContext io.Reader, opts build.ImageBuildOptions,
+) (build.ImageBuildResponse, error) {
 	authConfigs := c.authProvider.AuthConfigs()
 	maps.Copy(authConfigs, opts.AuthConfigs)
 	opts.AuthConfigs = authConfigs

pkg/client/client.go

@@ -2,28 +2,23 @@ package client
 
 import (
 	"net"
-	"net/http"
-	"slices"
 	"sync"
 
 	"github.com/docker/docker/client"
-	"github.com/silenium-dev/docker-wrapper/pkg/client/auth"
-	"github.com/silenium-dev/docker-wrapper/pkg/client/image"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/provider"
 	"go.uber.org/zap"
 )
 
 type Client struct {
 	*client.Client
 	dockerOpts             []client.Opt
-	authProvider           auth.Provider
-	imageProvider          image.Provider
+	authProvider           provider.AuthProvider
+	imageProvider          provider.ImageProvider
 	logger                 *zap.SugaredLogger
 	hostFromContainerAddr  net.IP
 	hostFromContainerMutex sync.RWMutex
 }
 
-type Opt func(*Client) error
-
 func NewWithOpts(opts ...Opt) (*Client, error) {
 	c := &Client{}
 	for _, opt := range opts {
@@ -37,7 +32,7 @@ func NewWithOpts(opts ...Opt) (*Client, error) {
 		c.logger = zap.Must(zap.NewDevelopment()).Sugar()
 	}
 	if c.imageProvider == nil {
-		c.imageProvider = image.DefaultProvider()
+		c.imageProvider = provider.DefaultImageProvider()
 	}
 
 	cli, err := client.NewClientWithOpts(c.dockerOpts...)
@@ -47,67 +42,3 @@ func NewWithOpts(opts ...Opt) (*Client, error) {
 	c.Client = cli
 	return c, nil
 }
-
-func (c *Client) Close() error {
-	return c.Client.Close()
-}
-
-func (c *Client) AuthProvider() auth.Provider {
-	return c.authProvider
-}
-
-func (c *Client) Logger() *zap.SugaredLogger {
-	return c.logger
-}
-
-func WithVersionNegotiation(c *Client) error {
-	c.dockerOpts = append(c.dockerOpts, client.WithAPIVersionNegotiation())
-	return nil
-}
-
-func WithAuthProvider(authProvider auth.Provider) Opt {
-	return func(c *Client) error {
-		c.authProvider = authProvider
-		return nil
-	}
-}
-
-func WithSugaredLogger(logger *zap.SugaredLogger) Opt {
-	return func(c *Client) error {
-		c.logger = logger
-		return nil
-	}
-}
-
-func WithLogger(logger *zap.Logger) Opt {
-	return func(c *Client) error {
-		c.logger = logger.Sugar()
-		return nil
-	}
-}
-
-func WithImageProvider(imageProvider image.Provider) Opt {
-	return func(c *Client) error {
-		c.imageProvider = imageProvider
-		return nil
-	}
-}
-
-func WithDockerOpts(opts ...client.Opt) Opt {
-	return func(c *Client) error {
-		c.dockerOpts = slices.Concat(c.dockerOpts, opts)
-		return nil
-	}
-}
-
-func WithHTTPClient(httpClient *http.Client) Opt {
-	return func(c *Client) error {
-		c.dockerOpts = append(c.dockerOpts, client.WithHTTPClient(httpClient))
-		return nil
-	}
-}
-
-func FromEnv(c *Client) error {
-	c.dockerOpts = append(c.dockerOpts, client.FromEnv)
-	return nil
-}

pkg/client/client_opts.go

@@ -0,0 +1,64 @@
+package client
+
+import (
+	"net/http"
+	"slices"
+
+	"github.com/docker/docker/client"
+	"github.com/silenium-dev/docker-wrapper/pkg/client/provider"
+	"go.uber.org/zap"
+)
+
+type Opt func(*Client) error
+
+func WithVersionNegotiation(c *Client) error {
+	c.dockerOpts = append(c.dockerOpts, client.WithAPIVersionNegotiation())
+	return nil
+}
+
+func WithAuthProvider(authProvider provider.AuthProvider) Opt {
+	return func(c *Client) error {
+		c.authProvider = authProvider
+		return nil
+	}
+}
+
+func WithSugaredLogger(logger *zap.SugaredLogger) Opt {
+	return func(c *Client) error {
+		c.logger = logger
+		return nil
+	}
+}
+
+func WithLogger(logger *zap.Logger) Opt {
+	return func(c *Client) error {
+		c.logger = logger.Sugar()
+		return nil
+	}
+}
+
+func WithImageProvider(imageProvider provider.ImageProvider) Opt {
+	return func(c *Client) error {
+		c.imageProvider = imageProvider
+		return nil
+	}
+}
+
+func WithDockerOpts(opts ...client.Opt) Opt {
+	return func(c *Client) error {
+		c.dockerOpts = slices.Concat(c.dockerOpts, opts)
+		return nil
+	}
+}
+
+func WithHTTPClient(httpClient *http.Client) Opt {
+	return func(c *Client) error {
+		c.dockerOpts = append(c.dockerOpts, client.WithHTTPClient(httpClient))
+		return nil
+	}
+}
+
+func FromEnv(c *Client) error {
+	c.dockerOpts = append(c.dockerOpts, client.FromEnv)
+	return nil
+}

pkg/client/logs.go pkg/client/container_logs.gopkg/client/logs.go renamed to pkg/client/container_logs.go

@@ -0,0 +1,48 @@
+package client
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/distribution/reference"
+	"github.com/google/go-containerregistry/pkg/name"
+	v1 "github.com/google/go-containerregistry/pkg/v1"
+	"github.com/google/go-containerregistry/pkg/v1/remote"
+)
+
+func (c *Client) ImageGetManifest(ctx context.Context, ref reference.Named, platform *v1.Platform) (
+	v1.Hash, *v1.Manifest, error,
+) {
+	var err error
+	if platform == nil {
+		platform, err = c.SystemDefaultPlatform(ctx)
+		if err != nil {
+			return v1.Hash{}, nil, err
+		}
+	}
+	opts := []remote.Option{
+		remote.WithAuthFromKeychain(c.authProvider),
+		remote.WithContext(ctx),
+		remote.WithPlatform(*platform),
+	}
+
+	nameRef, err := name.ParseReference(ref.String())
+	if err != nil {
+		return v1.Hash{}, nil, err
+	}
+
+	img, err := remote.Image(nameRef, opts...)
+	if err != nil {
+		return v1.Hash{}, nil, fmt.Errorf("failed to get image manifest: %w", err)
+	}
+	manifest, err := img.Manifest()
+	if err != nil {
+		return v1.Hash{}, nil, err
+	}
+	id, err := img.ConfigName()
+	if err != nil {
+		return v1.Hash{}, nil, err
+	}
+
+	return id, manifest, nil
+}