mirror of
https://github.com/docker/compose.git
synced 2025-07-21 20:54:32 +02:00
Merge pull request #10209 from ndeloof/wait_containers
use containers we expect to start for wait condition
This commit is contained in:
commit
9a4e74c70c
@ -28,7 +28,6 @@ import (
|
|||||||
"github.com/containerd/containerd/platforms"
|
"github.com/containerd/containerd/platforms"
|
||||||
moby "github.com/docker/docker/api/types"
|
moby "github.com/docker/docker/api/types"
|
||||||
containerType "github.com/docker/docker/api/types/container"
|
containerType "github.com/docker/docker/api/types/container"
|
||||||
"github.com/docker/docker/api/types/filters"
|
|
||||||
"github.com/docker/docker/api/types/network"
|
"github.com/docker/docker/api/types/network"
|
||||||
specs "github.com/opencontainers/image-spec/specs-go/v1"
|
specs "github.com/opencontainers/image-spec/specs-go/v1"
|
||||||
"github.com/pkg/errors"
|
"github.com/pkg/errors"
|
||||||
@ -281,7 +280,7 @@ func containerEvents(containers Containers, eventFunc func(string) progress.Even
|
|||||||
// ServiceConditionRunningOrHealthy is a service condition on status running or healthy
|
// ServiceConditionRunningOrHealthy is a service condition on status running or healthy
|
||||||
const ServiceConditionRunningOrHealthy = "running_or_healthy"
|
const ServiceConditionRunningOrHealthy = "running_or_healthy"
|
||||||
|
|
||||||
func (s *composeService) waitDependencies(ctx context.Context, project *types.Project, dependencies types.DependsOnConfig) error {
|
func (s *composeService) waitDependencies(ctx context.Context, project *types.Project, dependencies types.DependsOnConfig, containers Containers) error {
|
||||||
eg, _ := errgroup.WithContext(ctx)
|
eg, _ := errgroup.WithContext(ctx)
|
||||||
w := progress.ContextWriter(ctx)
|
w := progress.ContextWriter(ctx)
|
||||||
for dep, config := range dependencies {
|
for dep, config := range dependencies {
|
||||||
@ -291,11 +290,8 @@ func (s *composeService) waitDependencies(ctx context.Context, project *types.Pr
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
containers, err := s.getContainers(ctx, project.Name, oneOffExclude, false, dep)
|
waitingFor := containers.filter(isService(dep))
|
||||||
if err != nil {
|
w.Events(containerEvents(waitingFor, progress.Waiting))
|
||||||
return err
|
|
||||||
}
|
|
||||||
w.Events(containerEvents(containers, progress.Waiting))
|
|
||||||
|
|
||||||
dep, config := dep, config
|
dep, config := dep, config
|
||||||
eg.Go(func() error {
|
eg.Go(func() error {
|
||||||
@ -305,31 +301,31 @@ func (s *composeService) waitDependencies(ctx context.Context, project *types.Pr
|
|||||||
<-ticker.C
|
<-ticker.C
|
||||||
switch config.Condition {
|
switch config.Condition {
|
||||||
case ServiceConditionRunningOrHealthy:
|
case ServiceConditionRunningOrHealthy:
|
||||||
healthy, err := s.isServiceHealthy(ctx, project, dep, true)
|
healthy, err := s.isServiceHealthy(ctx, waitingFor, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if healthy {
|
if healthy {
|
||||||
w.Events(containerEvents(containers, progress.Healthy))
|
w.Events(containerEvents(waitingFor, progress.Healthy))
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
case types.ServiceConditionHealthy:
|
case types.ServiceConditionHealthy:
|
||||||
healthy, err := s.isServiceHealthy(ctx, project, dep, false)
|
healthy, err := s.isServiceHealthy(ctx, waitingFor, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
w.Events(containerEvents(containers, progress.ErrorEvent))
|
w.Events(containerEvents(waitingFor, progress.ErrorEvent))
|
||||||
return errors.Wrap(err, "dependency failed to start")
|
return errors.Wrap(err, "dependency failed to start")
|
||||||
}
|
}
|
||||||
if healthy {
|
if healthy {
|
||||||
w.Events(containerEvents(containers, progress.Healthy))
|
w.Events(containerEvents(waitingFor, progress.Healthy))
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
case types.ServiceConditionCompletedSuccessfully:
|
case types.ServiceConditionCompletedSuccessfully:
|
||||||
exited, code, err := s.isServiceCompleted(ctx, project, dep)
|
exited, code, err := s.isServiceCompleted(ctx, waitingFor)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if exited {
|
if exited {
|
||||||
w.Events(containerEvents(containers, progress.Exited))
|
w.Events(containerEvents(waitingFor, progress.Exited))
|
||||||
if code != 0 {
|
if code != 0 {
|
||||||
return fmt.Errorf("service %q didn't complete successfully: exit %d", dep, code)
|
return fmt.Errorf("service %q didn't complete successfully: exit %d", dep, code)
|
||||||
}
|
}
|
||||||
@ -650,51 +646,41 @@ func (s *composeService) connectContainerToNetwork(ctx context.Context, id strin
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *composeService) isServiceHealthy(ctx context.Context, project *types.Project, service string, fallbackRunning bool) (bool, error) {
|
func (s *composeService) isServiceHealthy(ctx context.Context, containers Containers, fallbackRunning bool) (bool, error) {
|
||||||
containers, err := s.getContainers(ctx, project.Name, oneOffExclude, true, service)
|
|
||||||
if err != nil {
|
|
||||||
return false, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(containers) == 0 {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
for _, c := range containers {
|
for _, c := range containers {
|
||||||
container, err := s.apiClient().ContainerInspect(ctx, c.ID)
|
container, err := s.apiClient().ContainerInspect(ctx, c.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
return false, err
|
||||||
}
|
}
|
||||||
|
name := container.Name[1:]
|
||||||
|
|
||||||
|
if container.State.Status == "exited" {
|
||||||
|
return false, fmt.Errorf("container %s exited (%d)", name, container.State.ExitCode)
|
||||||
|
}
|
||||||
|
|
||||||
if container.Config.Healthcheck == nil && fallbackRunning {
|
if container.Config.Healthcheck == nil && fallbackRunning {
|
||||||
// Container does not define a health check, but we can fall back to "running" state
|
// Container does not define a health check, but we can fall back to "running" state
|
||||||
return container.State != nil && container.State.Status == "running", nil
|
return container.State != nil && container.State.Status == "running", nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if container.State.Status == "exited" {
|
|
||||||
return false, fmt.Errorf("container for service %q exited (%d)", service, container.State.ExitCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
if container.State == nil || container.State.Health == nil {
|
if container.State == nil || container.State.Health == nil {
|
||||||
return false, fmt.Errorf("container for service %q has no healthcheck configured", service)
|
return false, fmt.Errorf("container %s has no healthcheck configured", name)
|
||||||
}
|
}
|
||||||
switch container.State.Health.Status {
|
switch container.State.Health.Status {
|
||||||
case moby.Healthy:
|
case moby.Healthy:
|
||||||
// Continue by checking the next container.
|
// Continue by checking the next container.
|
||||||
case moby.Unhealthy:
|
case moby.Unhealthy:
|
||||||
return false, fmt.Errorf("container for service %q is unhealthy", service)
|
return false, fmt.Errorf("container %s is unhealthy", name)
|
||||||
case moby.Starting:
|
case moby.Starting:
|
||||||
return false, nil
|
return false, nil
|
||||||
default:
|
default:
|
||||||
return false, fmt.Errorf("container for service %q had unexpected health status %q", service, container.State.Health.Status)
|
return false, fmt.Errorf("container %s had unexpected health status %q", name, container.State.Health.Status)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *composeService) isServiceCompleted(ctx context.Context, project *types.Project, dep string) (bool, int, error) {
|
func (s *composeService) isServiceCompleted(ctx context.Context, containers Containers) (bool, int, error) {
|
||||||
containers, err := s.getContainers(ctx, project.Name, oneOffExclude, true, dep)
|
|
||||||
if err != nil {
|
|
||||||
return false, 0, err
|
|
||||||
}
|
|
||||||
for _, c := range containers {
|
for _, c := range containers {
|
||||||
container, err := s.apiClient().ContainerInspect(ctx, c.ID)
|
container, err := s.apiClient().ContainerInspect(ctx, c.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -707,23 +693,12 @@ func (s *composeService) isServiceCompleted(ctx context.Context, project *types.
|
|||||||
return false, 0, nil
|
return false, 0, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *composeService) startService(ctx context.Context, project *types.Project, service types.ServiceConfig) error {
|
func (s *composeService) startService(ctx context.Context, project *types.Project, service types.ServiceConfig, containers Containers) error {
|
||||||
if service.Deploy != nil && service.Deploy.Replicas != nil && *service.Deploy.Replicas == 0 {
|
if service.Deploy != nil && service.Deploy.Replicas != nil && *service.Deploy.Replicas == 0 {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
err := s.waitDependencies(ctx, project, service.DependsOn)
|
err := s.waitDependencies(ctx, project, service.DependsOn, containers)
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
containers, err := s.apiClient().ContainerList(ctx, moby.ContainerListOptions{
|
|
||||||
Filters: filters.NewArgs(
|
|
||||||
projectFilter(project.Name),
|
|
||||||
serviceFilter(service.Name),
|
|
||||||
oneOffFilter(false),
|
|
||||||
),
|
|
||||||
All: true,
|
|
||||||
})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -736,7 +711,7 @@ func (s *composeService) startService(ctx context.Context, project *types.Projec
|
|||||||
}
|
}
|
||||||
|
|
||||||
w := progress.ContextWriter(ctx)
|
w := progress.ContextWriter(ctx)
|
||||||
for _, container := range containers {
|
for _, container := range containers.filter(isService(service.Name)) {
|
||||||
if container.State == ContainerRunning {
|
if container.State == ContainerRunning {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
@ -229,7 +229,7 @@ func TestWaitDependencies(t *testing.T) {
|
|||||||
"db": {Condition: ServiceConditionRunningOrHealthy},
|
"db": {Condition: ServiceConditionRunningOrHealthy},
|
||||||
"redis": {Condition: ServiceConditionRunningOrHealthy},
|
"redis": {Condition: ServiceConditionRunningOrHealthy},
|
||||||
}
|
}
|
||||||
assert.NilError(t, tested.waitDependencies(context.Background(), &project, dependencies))
|
assert.NilError(t, tested.waitDependencies(context.Background(), &project, dependencies, nil))
|
||||||
})
|
})
|
||||||
t.Run("should skip dependencies with condition service_started", func(t *testing.T) {
|
t.Run("should skip dependencies with condition service_started", func(t *testing.T) {
|
||||||
dbService := types.ServiceConfig{Name: "db", Scale: 1}
|
dbService := types.ServiceConfig{Name: "db", Scale: 1}
|
||||||
@ -239,6 +239,6 @@ func TestWaitDependencies(t *testing.T) {
|
|||||||
"db": {Condition: types.ServiceConditionStarted},
|
"db": {Condition: types.ServiceConditionStarted},
|
||||||
"redis": {Condition: types.ServiceConditionStarted},
|
"redis": {Condition: types.ServiceConditionStarted},
|
||||||
}
|
}
|
||||||
assert.NilError(t, tested.waitDependencies(context.Background(), &project, dependencies))
|
assert.NilError(t, tested.waitDependencies(context.Background(), &project, dependencies, nil))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -76,11 +76,6 @@ func (s *composeService) prepareRun(ctx context.Context, project *types.Project,
|
|||||||
if err := s.ensureImagesExists(ctx, project, opts.QuietPull); err != nil { // all dependencies already checked, but might miss service img
|
if err := s.ensureImagesExists(ctx, project, opts.QuietPull); err != nil { // all dependencies already checked, but might miss service img
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
if !opts.NoDeps {
|
|
||||||
if err := s.waitDependencies(ctx, project, service.DependsOn); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
observedState, err := s.getContainers(ctx, project.Name, oneOffInclude, true)
|
observedState, err := s.getContainers(ctx, project.Name, oneOffInclude, true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -88,6 +83,11 @@ func (s *composeService) prepareRun(ctx context.Context, project *types.Project,
|
|||||||
}
|
}
|
||||||
updateServices(&service, observedState)
|
updateServices(&service, observedState)
|
||||||
|
|
||||||
|
if !opts.NoDeps {
|
||||||
|
if err := s.waitDependencies(ctx, project, service.DependsOn, observedState); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
created, err := s.createContainer(ctx, project, service, service.ContainerName, 1,
|
created, err := s.createContainer(ctx, project, service, service.ContainerName, 1,
|
||||||
opts.AutoRemove, opts.UseNetworkAliases, opts.Interactive)
|
opts.AutoRemove, opts.UseNetworkAliases, opts.Interactive)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -21,14 +21,15 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/compose-spec/compose-go/types"
|
|
||||||
"github.com/docker/compose/v2/pkg/utils"
|
|
||||||
moby "github.com/docker/docker/api/types"
|
|
||||||
"github.com/pkg/errors"
|
|
||||||
"golang.org/x/sync/errgroup"
|
|
||||||
|
|
||||||
"github.com/docker/compose/v2/pkg/api"
|
"github.com/docker/compose/v2/pkg/api"
|
||||||
"github.com/docker/compose/v2/pkg/progress"
|
"github.com/docker/compose/v2/pkg/progress"
|
||||||
|
"github.com/docker/compose/v2/pkg/utils"
|
||||||
|
|
||||||
|
"github.com/compose-spec/compose-go/types"
|
||||||
|
moby "github.com/docker/docker/api/types"
|
||||||
|
"github.com/docker/docker/api/types/filters"
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
"golang.org/x/sync/errgroup"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (s *composeService) Start(ctx context.Context, projectName string, options api.StartOptions) error {
|
func (s *composeService) Start(ctx context.Context, projectName string, options api.StartOptions) error {
|
||||||
@ -75,13 +76,25 @@ func (s *composeService) start(ctx context.Context, projectName string, options
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
err := InDependencyOrder(ctx, project, func(c context.Context, name string) error {
|
var containers Containers
|
||||||
|
containers, err := s.apiClient().ContainerList(ctx, moby.ContainerListOptions{
|
||||||
|
Filters: filters.NewArgs(
|
||||||
|
projectFilter(project.Name),
|
||||||
|
oneOffFilter(false),
|
||||||
|
),
|
||||||
|
All: true,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = InDependencyOrder(ctx, project, func(c context.Context, name string) error {
|
||||||
service, err := project.GetService(name)
|
service, err := project.GetService(name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return s.startService(ctx, project, service)
|
return s.startService(ctx, project, service, containers)
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@ -94,7 +107,7 @@ func (s *composeService) start(ctx context.Context, projectName string, options
|
|||||||
Condition: getDependencyCondition(s, project),
|
Condition: getDependencyCondition(s, project),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
err = s.waitDependencies(ctx, project, depends)
|
err = s.waitDependencies(ctx, project, depends, containers)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
@ -38,7 +38,7 @@ func TestUpServiceUnhealthy(t *testing.T) {
|
|||||||
const projectName = "e2e-start-fail"
|
const projectName = "e2e-start-fail"
|
||||||
|
|
||||||
res := c.RunDockerComposeCmdNoCheck(t, "-f", "fixtures/start-fail/compose.yaml", "--project-name", projectName, "up", "-d")
|
res := c.RunDockerComposeCmdNoCheck(t, "-f", "fixtures/start-fail/compose.yaml", "--project-name", projectName, "up", "-d")
|
||||||
res.Assert(t, icmd.Expected{ExitCode: 1, Err: `container for service "fail" is unhealthy`})
|
res.Assert(t, icmd.Expected{ExitCode: 1, Err: `container e2e-start-fail-fail-1 is unhealthy`})
|
||||||
|
|
||||||
c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
|
c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
|
||||||
}
|
}
|
||||||
@ -135,6 +135,6 @@ func TestUpWithDependencyExit(t *testing.T) {
|
|||||||
c.RunDockerComposeCmd(t, "--project-name", "dependencies", "down")
|
c.RunDockerComposeCmd(t, "--project-name", "dependencies", "down")
|
||||||
})
|
})
|
||||||
|
|
||||||
res.Assert(t, icmd.Expected{ExitCode: 1, Err: "dependency failed to start: container for service \"db\" exited (1)"})
|
res.Assert(t, icmd.Expected{ExitCode: 1, Err: "dependency failed to start: container dependencies-db-1 exited (1)"})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user