feat(libstack): remove the docker-compose binary BE-10801 (#111)

Co-authored-by: andres-portainer <andres-portainer@users.noreply.github.com>
Co-authored-by: oscarzhou <oscar.zhou@portainer.io>

pkg/libstack/compose/status.go

@@ -0,0 +1,213 @@
+package compose
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/portainer/portainer/pkg/libstack"
+
+	"github.com/compose-spec/compose-go/v2/types"
+	"github.com/docker/compose/v2/pkg/api"
+	"github.com/rs/zerolog/log"
+)
+
+type publisher struct {
+	URL           string
+	TargetPort    int
+	PublishedPort int
+	Protocol      string
+}
+
+type service struct {
+	ID         string
+	Name       string
+	Image      string
+	Command    string
+	Project    string
+	Service    string
+	Created    int64
+	State      string
+	Status     string
+	Health     string
+	ExitCode   int
+	Publishers []publisher
+}
+
+// docker container state can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
+func getServiceStatus(service service) (libstack.Status, string) {
+	log.Debug().
+		Str("service", service.Name).
+		Str("state", service.State).
+		Int("exitCode", service.ExitCode).
+		Msg("getServiceStatus")
+
+	switch service.State {
+	case "created", "restarting", "paused":
+		return libstack.StatusStarting, ""
+	case "running":
+		return libstack.StatusRunning, ""
+	case "removing":
+		return libstack.StatusRemoving, ""
+	case "exited":
+		if service.ExitCode != 0 {
+			return libstack.StatusError, fmt.Sprintf("service %s exited with code %d", service.Name, service.ExitCode)
+		}
+		return libstack.StatusCompleted, ""
+	case "dead":
+		if service.ExitCode != 0 {
+			return libstack.StatusError, fmt.Sprintf("service %s exited with code %d", service.Name, service.ExitCode)
+		}
+
+		return libstack.StatusRemoved, ""
+	default:
+		return libstack.StatusUnknown, ""
+	}
+}
+
+func aggregateStatuses(services []service) (libstack.Status, string) {
+	servicesCount := len(services)
+
+	if servicesCount == 0 {
+		log.Debug().
+			Msg("no services found")
+
+		return libstack.StatusRemoved, ""
+	}
+
+	statusCounts := make(map[libstack.Status]int)
+	errorMessage := ""
+	for _, service := range services {
+		status, serviceError := getServiceStatus(service)
+		if serviceError != "" {
+			errorMessage = serviceError
+		}
+		statusCounts[status]++
+	}
+
+	log.Debug().
+		Interface("statusCounts", statusCounts).
+		Str("errorMessage", errorMessage).
+		Msg("check_status")
+
+	switch {
+	case errorMessage != "":
+		return libstack.StatusError, errorMessage
+	case statusCounts[libstack.StatusStarting] > 0:
+		return libstack.StatusStarting, ""
+	case statusCounts[libstack.StatusRemoving] > 0:
+		return libstack.StatusRemoving, ""
+	case statusCounts[libstack.StatusCompleted] == servicesCount:
+		return libstack.StatusCompleted, ""
+	case statusCounts[libstack.StatusRunning]+statusCounts[libstack.StatusCompleted] == servicesCount:
+		return libstack.StatusRunning, ""
+	case statusCounts[libstack.StatusStopped] == servicesCount:
+		return libstack.StatusStopped, ""
+	case statusCounts[libstack.StatusRemoved] == servicesCount:
+		return libstack.StatusRemoved, ""
+	default:
+		return libstack.StatusUnknown, ""
+	}
+
+}
+
+func (c *ComposeDeployer) WaitForStatus(ctx context.Context, name string, status libstack.Status, _ string) <-chan libstack.WaitResult {
+	waitResultCh := make(chan libstack.WaitResult)
+	waitResult := libstack.WaitResult{Status: status}
+
+	go func() {
+		for {
+			select {
+			case <-ctx.Done():
+				waitResult.ErrorMsg = "failed to wait for status: " + ctx.Err().Error()
+				waitResultCh <- waitResult
+			default:
+			}
+
+			time.Sleep(1 * time.Second)
+
+			var containerSummaries []api.ContainerSummary
+
+			if err := withComposeService(ctx, nil, libstack.Options{ProjectName: name}, func(composeService api.Service, project *types.Project) error {
+				var err error
+				containerSummaries, err = composeService.Ps(ctx, name, api.PsOptions{All: true})
+
+				return err
+			}); err != nil {
+				log.Debug().
+					Str("project_name", name).
+					Err(err).
+					Msg("error from docker compose ps")
+
+				continue
+			}
+
+			services := serviceListFromContainerSummary(containerSummaries)
+
+			if len(services) == 0 && status == libstack.StatusRemoved {
+				waitResultCh <- waitResult
+				return
+			}
+
+			aggregateStatus, errorMessage := aggregateStatuses(services)
+			if aggregateStatus == status {
+				waitResultCh <- waitResult
+				return
+			}
+
+			if status == libstack.StatusRunning && aggregateStatus == libstack.StatusCompleted {
+				waitResult.Status = libstack.StatusCompleted
+				waitResultCh <- waitResult
+				return
+			}
+
+			if errorMessage != "" {
+				waitResult.ErrorMsg = errorMessage
+				waitResultCh <- waitResult
+				return
+			}
+
+			log.Debug().
+				Str("project_name", name).
+				Str("required_status", string(status)).
+				Str("status", string(aggregateStatus)).
+				Msg("waiting for status")
+		}
+	}()
+
+	return waitResultCh
+}
+
+func serviceListFromContainerSummary(containerSummaries []api.ContainerSummary) []service {
+	var services []service
+
+	for _, cs := range containerSummaries {
+		var publishers []publisher
+
+		for _, p := range cs.Publishers {
+			publishers = append(publishers, publisher{
+				URL:           p.URL,
+				TargetPort:    p.TargetPort,
+				PublishedPort: p.PublishedPort,
+				Protocol:      p.Protocol,
+			})
+		}
+
+		services = append(services, service{
+			ID:         cs.ID,
+			Name:       cs.Name,
+			Image:      cs.Image,
+			Command:    cs.Command,
+			Project:    cs.Project,
+			Service:    cs.Service,
+			Created:    cs.Created,
+			State:      cs.State,
+			Status:     cs.Status,
+			Health:     cs.Health,
+			ExitCode:   cs.ExitCode,
+			Publishers: publishers,
+		})
+	}
+
+	return services
+}