Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use appropriate dependency condition for one-shot containers when running compose up --wait #9572

Merged
merged 2 commits into from
Jun 26, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion pkg/compose/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func (s *composeService) start(ctx context.Context, projectName string, options
depends := types.DependsOnConfig{}
for _, s := range project.Services {
depends[s.Name] = types.ServiceDependency{
Condition: ServiceConditionRunningOrHealthy,
Condition: getDependencyCondition(s, project),
}
}
err = s.waitDependencies(ctx, project, depends)
Expand All @@ -92,6 +92,20 @@ func (s *composeService) start(ctx context.Context, projectName string, options
return eg.Wait()
}

// getDependencyCondition checks if service is depended on by other services
// with service_completed_successfully condition, and applies that condition
// instead, or --wait will never finish waiting for one-shot containers
func getDependencyCondition(service types.ServiceConfig, project *types.Project) string {
for _, services := range project.Services {
for dependencyService, dependencyConfig := range services.DependsOn {
if dependencyService == service.Name && dependencyConfig.Condition == types.ServiceConditionCompletedSuccessfully {
return types.ServiceConditionCompletedSuccessfully
}
}
}
return ServiceConditionRunningOrHealthy
}

type containerWatchFn func(container moby.Container) error

// watchContainers uses engine events to capture container start/die and notify ContainerEventListener
Expand Down
47 changes: 47 additions & 0 deletions pkg/e2e/compose_up_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*
Copyright 2020 Docker Compose CLI authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package e2e

import (
"strings"
"testing"
"time"

"gotest.tools/v3/assert"
)

func TestUpWait(t *testing.T) {
c := NewParallelCLI(t)
const projectName = "e2e-deps-wait"

timeout := time.After(30 * time.Second)
done := make(chan bool)
go func() {
res := c.RunDockerComposeCmd(t, "-f", "fixtures/dependencies/deps-completed-successfully.yaml", "--project-name", projectName, "up", "--wait", "-d")
assert.Assert(t, strings.Contains(res.Combined(), "e2e-deps-wait-oneshot-1"), res.Combined())
done <- true
}()

select {
case <-timeout:
t.Fatal("test did not finish in time")
case <-done:
break
}

c.RunDockerComposeCmd(t, "--project-name", projectName, "down")
}
11 changes: 11 additions & 0 deletions pkg/e2e/fixtures/dependencies/deps-completed-successfully.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: '3'
laurazard marked this conversation as resolved.
Show resolved Hide resolved
services:
oneshot:
image: ubuntu
command: echo 'hello world'
longrunning:
image: ubuntu
laurazard marked this conversation as resolved.
Show resolved Hide resolved
depends_on:
oneshot:
condition: service_completed_successfully
command: sleep infinity