chore(digital_ocean): refactor digital ocean provider and task to conform to new interfaces

core/go.mod

@@ -14,9 +14,9 @@ require (
 	github.com/go-rod/rod v0.114.6
 	github.com/golangci/golangci-lint v1.56.2
 	github.com/matoous/go-nanoid/v2 v2.1.0
+	github.com/opencontainers/image-spec v1.1.0-rc2
 	github.com/pkg/errors v0.9.1
 	github.com/pkg/sftp v1.13.6
-	github.com/puzpuzpuz/xsync/v3 v3.4.0
 	github.com/spf13/afero v1.11.0
 	github.com/stretchr/testify v1.9.0
 	go.uber.org/zap v1.26.0
@@ -199,7 +199,6 @@ require (
 	github.com/oasisprotocol/curve25519-voi v0.0.0-20230904125328-1f23a7beb09a // indirect
 	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
-	github.com/opencontainers/image-spec v1.1.0-rc2 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
 	github.com/petermattis/goid v0.0.0-20231207134359-e60b3f734c67 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect

core/go.sum

@@ -742,8 +742,6 @@ github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1
 github.com/prometheus/procfs v0.7.3/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA=
 github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc=
 github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk=
-github.com/puzpuzpuz/xsync/v3 v3.4.0 h1:DuVBAdXuGFHv8adVXjWWZ63pJq+NRXOWVXlKDBZ+mJ4=
-github.com/puzpuzpuz/xsync/v3 v3.4.0/go.mod h1:VjzYrABPabuM4KyBh1Ftq6u8nhwY5tBPKP9jpmh0nnA=
 github.com/quasilyte/go-ruleguard v0.4.0 h1:DyM6r+TKL+xbKB4Nm7Afd1IQh9kEUKQs2pboWGKtvQo=
 github.com/quasilyte/go-ruleguard v0.4.0/go.mod h1:Eu76Z/R8IXtViWUIHkE3p8gdH3/PKk1eh3YGfaEof10=
 github.com/quasilyte/gogrep v0.5.0 h1:eTKODPXbI8ffJMN+W2aE0+oL0z/nh8/5eNdiO34SOAo=

core/provider/clients/docker_client.go

@@ -0,0 +1,194 @@
+package clients
+
+import (
+	"context"
+	"fmt"
+	"go.uber.org/zap"
+	"io"
+
+	"github.com/docker/docker/api/types"
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/image"
+	"github.com/docker/docker/api/types/network"
+	"github.com/docker/docker/api/types/volume"
+	dockerclient "github.com/docker/docker/client"
+	specs "github.com/opencontainers/image-spec/specs-go/v1"
+)
+
+// DockerClient is a unified interface for interacting with Docker
+// It combines functionality needed by both the Docker and DigitalOcean providers
+type DockerClient interface {
+	// Container Operations
+	ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *specs.Platform, containerName string) (container.CreateResponse, error)
+	ContainerStart(ctx context.Context, container string, options container.StartOptions) error
+	ContainerStop(ctx context.Context, container string, options container.StopOptions) error
+	ContainerRemove(ctx context.Context, container string, options container.RemoveOptions) error
+	ContainerInspect(ctx context.Context, container string) (types.ContainerJSON, error)
+	ContainerList(ctx context.Context, options container.ListOptions) ([]types.Container, error)
+	ContainerWait(ctx context.Context, containerID string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error)
+
+	// Container Exec Operations
+	ContainerExecCreate(ctx context.Context, container string, config container.ExecOptions) (types.IDResponse, error)
+	ContainerExecAttach(ctx context.Context, execID string, config container.ExecStartOptions) (types.HijackedResponse, error)
+	ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error)
+
+	// Container File Operations
+	CopyToContainer(ctx context.Context, container, path string, content io.Reader, options container.CopyToContainerOptions) error
+	CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, container.PathStat, error)
+	ContainerLogs(ctx context.Context, container string, options container.LogsOptions) (io.ReadCloser, error)
+
+	// Image Operations
+	ImageInspectWithRaw(ctx context.Context, imageID string) (types.ImageInspect, []byte, error)
+	ImagePull(ctx context.Context, logger *zap.Logger, refStr string, options image.PullOptions) error
+
+	// Volume Operations
+	VolumeCreate(ctx context.Context, options volume.CreateOptions) (volume.Volume, error)
+	VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error)
+	VolumeList(ctx context.Context, options volume.ListOptions) (volume.ListResponse, error)
+	VolumeRemove(ctx context.Context, volumeID string, force bool) error
+
+	// Network Operations
+	NetworkCreate(ctx context.Context, name string, options network.CreateOptions) (network.CreateResponse, error)
+	NetworkInspect(ctx context.Context, networkID string, options network.InspectOptions) (network.Inspect, error)
+	NetworkRemove(ctx context.Context, networkID string) error
+
+	// System Operations
+	Ping(ctx context.Context) (types.Ping, error)
+	Close() error
+}
+
+// defaultDockerClient is the default implementation of DockerClient interface
+type defaultDockerClient struct {
+	client *dockerclient.Client
+}
+
+func NewDockerClient(host string) (DockerClient, error) {
+	// If host is empty, use default Docker socket
+	if host == "" {
+		client, err := dockerclient.NewClientWithOpts()
+		if err != nil {
+			return nil, err
+		}
+		return &defaultDockerClient{client: client}, nil
+	}
+
+	host = fmt.Sprintf("tcp://%s:2375", host)
+
+	client, err := dockerclient.NewClientWithOpts(dockerclient.WithHost(host))
+	if err != nil {
+		return nil, err
+	}
+	return &defaultDockerClient{client: client}, nil
+}
+
+func (d *defaultDockerClient) Ping(ctx context.Context) (types.Ping, error) {
+	return d.client.Ping(ctx)
+}
+
+func (d *defaultDockerClient) ImageInspectWithRaw(ctx context.Context, image string) (types.ImageInspect, []byte, error) {
+	return d.client.ImageInspectWithRaw(ctx, image)
+}
+
+func (d *defaultDockerClient) ImagePull(ctx context.Context, logger *zap.Logger, ref string, options image.PullOptions) error {
+	_, _, err := d.client.ImageInspectWithRaw(ctx, ref)
+	if err != nil {
+		logger.Info("pulling image", zap.String("image", ref))
+		resp, err := d.client.ImagePull(ctx, ref, options)
+		if err != nil {
+			return fmt.Errorf("failed to pull docker image: %w", err)
+		}
+
+		defer resp.Close()
+		// throw away the image pull stdout response
+		_, err = io.Copy(io.Discard, resp)
+		if err != nil {
+			return fmt.Errorf("failed to pull docker image: %w", err)
+		}
+		return nil
+	}
+	return nil
+}
+
+func (d *defaultDockerClient) ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *specs.Platform, containerName string) (container.CreateResponse, error) {
+	return d.client.ContainerCreate(ctx, config, hostConfig, networkingConfig, platform, containerName)
+}
+
+func (d *defaultDockerClient) ContainerList(ctx context.Context, options container.ListOptions) ([]types.Container, error) {
+	return d.client.ContainerList(ctx, options)
+}
+
+func (d *defaultDockerClient) ContainerStart(ctx context.Context, containerID string, options container.StartOptions) error {
+	return d.client.ContainerStart(ctx, containerID, options)
+}
+
+func (d *defaultDockerClient) ContainerStop(ctx context.Context, containerID string, options container.StopOptions) error {
+	return d.client.ContainerStop(ctx, containerID, options)
+}
+
+func (d *defaultDockerClient) ContainerInspect(ctx context.Context, containerID string) (types.ContainerJSON, error) {
+	return d.client.ContainerInspect(ctx, containerID)
+}
+
+func (d *defaultDockerClient) ContainerExecCreate(ctx context.Context, container string, config container.ExecOptions) (types.IDResponse, error) {
+	return d.client.ContainerExecCreate(ctx, container, config)
+}
+
+func (d *defaultDockerClient) ContainerExecAttach(ctx context.Context, execID string, config container.ExecStartOptions) (types.HijackedResponse, error) {
+	return d.client.ContainerExecAttach(ctx, execID, config)
+}
+
+func (d *defaultDockerClient) ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error) {
+	return d.client.ContainerExecInspect(ctx, execID)
+}
+
+func (d *defaultDockerClient) ContainerRemove(ctx context.Context, containerID string, options container.RemoveOptions) error {
+	return d.client.ContainerRemove(ctx, containerID, options)
+}
+
+func (d *defaultDockerClient) ContainerWait(ctx context.Context, containerID string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error) {
+	return d.client.ContainerWait(ctx, containerID, condition)
+}
+
+func (d *defaultDockerClient) ContainerLogs(ctx context.Context, container string, options container.LogsOptions) (io.ReadCloser, error) {
+	return d.client.ContainerLogs(ctx, container, options)
+}
+
+func (d *defaultDockerClient) CopyToContainer(ctx context.Context, container, path string, content io.Reader, options container.CopyToContainerOptions) error {
+	return d.client.CopyToContainer(ctx, container, path, content, options)
+}
+
+func (d *defaultDockerClient) CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, container.PathStat, error) {
+	return d.client.CopyFromContainer(ctx, container, srcPath)
+}
+
+func (d *defaultDockerClient) VolumeCreate(ctx context.Context, options volume.CreateOptions) (volume.Volume, error) {
+	return d.client.VolumeCreate(ctx, options)
+}
+
+func (d *defaultDockerClient) VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error) {
+	return d.client.VolumeInspect(ctx, volumeID)
+}
+
+func (d *defaultDockerClient) VolumeList(ctx context.Context, options volume.ListOptions) (volume.ListResponse, error) {
+	return d.client.VolumeList(ctx, options)
+}
+
+func (d *defaultDockerClient) VolumeRemove(ctx context.Context, volumeID string, force bool) error {
+	return d.client.VolumeRemove(ctx, volumeID, force)
+}
+
+func (d *defaultDockerClient) NetworkCreate(ctx context.Context, name string, options network.CreateOptions) (network.CreateResponse, error) {
+	return d.client.NetworkCreate(ctx, name, options)
+}
+
+func (d *defaultDockerClient) NetworkInspect(ctx context.Context, networkID string, options network.InspectOptions) (network.Inspect, error) {
+	return d.client.NetworkInspect(ctx, networkID, options)
+}
+
+func (d *defaultDockerClient) NetworkRemove(ctx context.Context, networkID string) error {
+	return d.client.NetworkRemove(ctx, networkID)
+}
+
+func (d *defaultDockerClient) Close() error {
+	return d.client.Close()
+}

core/provider/digitalocean/client.go

@@ -0,0 +1,128 @@
+package digitalocean
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/digitalocean/godo"
+)
+
+// DoClient defines the interface for DigitalOcean API operations used by the provider
+type DoClient interface {
+	// Droplet operations
+	CreateDroplet(ctx context.Context, req *godo.DropletCreateRequest) (*godo.Droplet, error)
+	GetDroplet(ctx context.Context, dropletID int) (*godo.Droplet, error)
+	DeleteDropletByTag(ctx context.Context, tag string) error
+	DeleteDropletByID(ctx context.Context, id int) error
+
+	// Firewall operations
+	CreateFirewall(ctx context.Context, req *godo.FirewallRequest) (*godo.Firewall, error)
+	DeleteFirewall(ctx context.Context, firewallID string) error
+
+	// SSH Key operations
+	CreateKey(ctx context.Context, req *godo.KeyCreateRequest) (*godo.Key, error)
+	DeleteKeyByFingerprint(ctx context.Context, fingerprint string) error
+	GetKeyByFingerprint(ctx context.Context, fingerprint string) (*godo.Key, error)
+
+	// Tag operations
+	CreateTag(ctx context.Context, req *godo.TagCreateRequest) (*godo.Tag, error)
+	DeleteTag(ctx context.Context, tag string) error
+}
+
+// godoClient implements the DoClient interface using the actual godo.Client
+type godoClient struct {
+	*godo.Client
+}
+
+func NewGodoClient(token string) DoClient {
+	return &godoClient{Client: godo.NewFromToken(token)}
+}
+
+func checkResponse(res *godo.Response, err error) error {
+	if err != nil {
+		return err
+	}
+
+	if res.StatusCode > 299 || res.StatusCode < 200 {
+		return fmt.Errorf("unexpected status code: %d", res.StatusCode)
+	}
+
+	return nil
+}
+
+// Droplet operations
+func (c *godoClient) CreateDroplet(ctx context.Context, req *godo.DropletCreateRequest) (*godo.Droplet, error) {
+	droplet, res, err := c.Droplets.Create(ctx, req)
+	if err := checkResponse(res, err); err != nil {
+		return nil, err
+	}
+	return droplet, nil
+}
+
+func (c *godoClient) GetDroplet(ctx context.Context, dropletID int) (*godo.Droplet, error) {
+	droplet, res, err := c.Droplets.Get(ctx, dropletID)
+	if err := checkResponse(res, err); err != nil {
+		return nil, err
+	}
+	return droplet, nil
+}
+
+func (c *godoClient) DeleteDropletByTag(ctx context.Context, tag string) error {
+	res, err := c.Droplets.DeleteByTag(ctx, tag)
+	return checkResponse(res, err)
+}
+
+func (c *godoClient) DeleteDropletByID(ctx context.Context, id int) error {
+	res, err := c.Droplets.Delete(ctx, id)
+	return checkResponse(res, err)
+}
+
+// Firewall operations
+func (c *godoClient) CreateFirewall(ctx context.Context, req *godo.FirewallRequest) (*godo.Firewall, error) {
+	firewall, res, err := c.Firewalls.Create(ctx, req)
+	if err := checkResponse(res, err); err != nil {
+		return nil, err
+	}
+	return firewall, nil
+}
+
+func (c *godoClient) DeleteFirewall(ctx context.Context, firewallID string) error {
+	res, err := c.Firewalls.Delete(ctx, firewallID)
+	return checkResponse(res, err)
+}
+
+// SSH Key operations
+func (c *godoClient) CreateKey(ctx context.Context, req *godo.KeyCreateRequest) (*godo.Key, error) {
+	key, res, err := c.Keys.Create(ctx, req)
+	if err := checkResponse(res, err); err != nil {
+		return nil, err
+	}
+	return key, nil
+}
+
+func (c *godoClient) DeleteKeyByFingerprint(ctx context.Context, fingerprint string) error {
+	res, err := c.Keys.DeleteByFingerprint(ctx, fingerprint)
+	return checkResponse(res, err)
+}
+
+func (c *godoClient) GetKeyByFingerprint(ctx context.Context, fingerprint string) (*godo.Key, error) {
+	key, res, err := c.Keys.GetByFingerprint(ctx, fingerprint)
+	if err := checkResponse(res, err); err != nil {
+		return nil, err
+	}
+	return key, nil
+}
+
+// Tag operations
+func (c *godoClient) CreateTag(ctx context.Context, req *godo.TagCreateRequest) (*godo.Tag, error) {
+	tag, res, err := c.Tags.Create(ctx, req)
+	if err := checkResponse(res, err); err != nil {
+		return nil, err
+	}
+	return tag, nil
+}
+
+func (c *godoClient) DeleteTag(ctx context.Context, tag string) error {
+	res, err := c.Tags.Delete(ctx, tag)
+	return checkResponse(res, err)
+}