tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-05-03 06:00:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

only check if a dependency is required when something unexpected happens

Browse Source 
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
This commit is contained in:
Guillaume Lours 2023-07-18 18:24:55 +02:00
parent bb94ea034e
commit 2d16a05afa
No known key found for this signature in database
2 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
pkg/compose/convergence.go
View File

@ -286,9 +286,18 @@ func containerEvents(containers Containers, eventFunc func(string) progress.Even
return events return events
} }
func containerSkippedEvents(containers Containers, eventFunc func(string, string) progress.Event, reason string) []progress.Event {
events := []progress.Event{}
for _, container := range containers {
events = append(events, eventFunc(getContainerProgressName(container), reason))
}
return events
}
// 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"
//nolint:gocyclo
func (s *composeService) waitDependencies(ctx context.Context, project *types.Project, dependencies types.DependsOnConfig, containers Containers) 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)
@ -312,6 +321,11 @@ func (s *composeService) waitDependencies(ctx context.Context, project *types.Pr
case ServiceConditionRunningOrHealthy: case ServiceConditionRunningOrHealthy:
healthy, err := s.isServiceHealthy(ctx, waitingFor, true) healthy, err := s.isServiceHealthy(ctx, waitingFor, true)
if err != nil { if err != nil {
if !config.Required {
w.Events(containerSkippedEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %q is not running or is unhealthy", dep)))
logrus.Warnf("optional dependency %q is not running or is unhealthy: %s", dep, err.Error())
return nil
}
return err return err
} }
if healthy { if healthy {
@ -321,6 +335,11 @@ func (s *composeService) waitDependencies(ctx context.Context, project *types.Pr
case types.ServiceConditionHealthy: case types.ServiceConditionHealthy:
healthy, err := s.isServiceHealthy(ctx, waitingFor, false) healthy, err := s.isServiceHealthy(ctx, waitingFor, false)
if err != nil { if err != nil {
if !config.Required {
w.Events(containerSkippedEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %q failed to start", dep)))
logrus.Warnf("optional dependency %q failed to start: %s", dep, err.Error())
return nil
}
w.Events(containerEvents(waitingFor, progress.ErrorEvent)) w.Events(containerEvents(waitingFor, progress.ErrorEvent))
return errors.Wrap(err, "dependency failed to start") return errors.Wrap(err, "dependency failed to start")
} }
@ -334,6 +353,12 @@ func (s *composeService) waitDependencies(ctx context.Context, project *types.Pr
return err return err
} }
if exited { if exited {
logMessageSuffix := fmt.Sprintf("%q didn't complete successfully: exit %d", dep, code)
if !config.Required {
w.Events(containerSkippedEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %s", logMessageSuffix)))
logrus.Warnf("optional dependency %s", logMessageSuffix)
return nil
}
w.Events(containerEvents(waitingFor, 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)
@ -362,9 +387,6 @@ func shouldWaitForDependency(serviceName string, dependencyConfig types.ServiceD
return false, nil return false, nil
} }
} }
if !dependencyConfig.Required {
return false, nil
}
return false, err return false, err
} else if service.Scale == 0 { } else if service.Scale == 0 {
// don't wait for the dependency which configured to have 0 containers running // don't wait for the dependency which configured to have 0 containers running

4
pkg/e2e/up_test.go
View File

@ -162,7 +162,7 @@ func TestUpWithDependencyNotRequired(t *testing.T) {
}) })
res := c.RunDockerComposeCmd(t, "-f", "./fixtures/dependencies/deps-not-required.yaml", "--project-name", projectName, res := c.RunDockerComposeCmd(t, "-f", "./fixtures/dependencies/deps-not-required.yaml", "--project-name", projectName,
"up", "-d") "--profile", "not-required", "up", "-d")
assert.Assert(t, strings.Contains(res.Combined(), "foo"), res.Combined()) assert.Assert(t, strings.Contains(res.Combined(), "foo"), res.Combined())
assert.Assert(t, !strings.Contains(res.Combined(), "bar"), res.Combined()) assert.Assert(t, strings.Contains(res.Combined(), " optional dependency \"bar\" failed to start"), res.Combined())
} }