diff --git a/cmd/compose/compose_test.go b/cmd/compose/compose_test.go index 708929ff8cd..c2492dfa201 100644 --- a/cmd/compose/compose_test.go +++ b/cmd/compose/compose_test.go @@ -31,10 +31,9 @@ func TestFilterServices(t *testing.T) { Links: []string{"bar"}, }, "bar": { - Name: "bar", - DependsOn: map[string]types.ServiceDependency{ + Name: "bar", WorkloadSpec: types.WorkloadSpec{DependsOn: map[string]types.ServiceDependency{ "zot": {}, - }, + }}, }, "zot": { Name: "zot", diff --git a/cmd/compose/config.go b/cmd/compose/config.go index 9e832931085..80efe3cbd45 100644 --- a/cmd/compose/config.go +++ b/cmd/compose/config.go @@ -260,7 +260,7 @@ func imagesOnly(project *types.Project) *types.Project { digests := types.Services{} for name, config := range project.Services { service := types.ServiceConfig{ - Image: config.Image, + ContainerSpec: types.ContainerSpec{Image: config.Image}, } for _, vol := range config.Volumes { if vol.Type == types.VolumeTypeImage { @@ -384,7 +384,7 @@ func resolveImageDigests(ctx context.Context, dockerCli command.Cli, model map[s } for _, hook := range preStartHooks(service) { image, _ := hook["image"].(string) - config.PreStart = append(config.PreStart, types.ServiceHook{Image: image}) + config.PreStart = append(config.PreStart, types.PreStartHook{ContainerSpec: types.ContainerSpec{Image: image}}) } for _, volume := range imageVolumes(service) { source, _ := volume["source"].(string) diff --git a/cmd/compose/config_test.go b/cmd/compose/config_test.go index a9a08f2cd77..a3202a97f6e 100644 --- a/cmd/compose/config_test.go +++ b/cmd/compose/config_test.go @@ -139,14 +139,17 @@ func TestImagesOnly(t *testing.T) { Name: "test", Services: types.Services{ "test": types.ServiceConfig{ - Name: "test", - Image: "docker.io/library/nginx@" + testDigest, - Command: types.ShellCommand{"echo", "hello"}, + Name: "test", + // hooks can't be overridden element-wise on merge, so the lock must not carry them - PreStart: []types.ServiceHook{{Image: "docker.io/library/hookimage@" + testDigest}}, - Volumes: []types.ServiceVolumeConfig{ - {Type: types.VolumeTypeImage, Source: "docker.io/library/someimage@" + testDigest, Target: "/data"}, - {Type: types.VolumeTypeBind, Source: "/host", Target: "/bind"}, + PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Image: "docker.io/library/hookimage@" + testDigest}}}, ContainerSpec: types.ContainerSpec{ + Image: "docker.io/library/nginx@" + testDigest, + Command: types.ShellCommand{"echo", "hello"}, + + Volumes: []types.ServiceVolumeConfig{ + {Type: types.VolumeTypeImage, Source: "docker.io/library/someimage@" + testDigest, Target: "/data"}, + {Type: types.VolumeTypeBind, Source: "/host", Target: "/bind"}, + }, }, }, }, @@ -158,9 +161,11 @@ func TestImagesOnly(t *testing.T) { assert.DeepEqual(t, locked, &types.Project{ Services: types.Services{ "test": types.ServiceConfig{ - Image: "docker.io/library/nginx@" + testDigest, - Volumes: []types.ServiceVolumeConfig{ - {Type: types.VolumeTypeImage, Source: "docker.io/library/someimage@" + testDigest, Target: "/data"}, + ContainerSpec: types.ContainerSpec{ + Image: "docker.io/library/nginx@" + testDigest, + Volumes: []types.ServiceVolumeConfig{ + {Type: types.VolumeTypeImage, Source: "docker.io/library/someimage@" + testDigest, Target: "/data"}, + }, }, }, }, @@ -177,8 +182,8 @@ func TestWarnHooksNotLockable(t *testing.T) { warnHooksNotLockable(&types.Project{ Services: types.Services{ - "with-hook-image": types.ServiceConfig{PreStart: []types.ServiceHook{{Image: "alpine:latest"}}}, - "inline-hook": types.ServiceConfig{PreStart: []types.ServiceHook{{Command: types.ShellCommand{"echo"}}}}, + "with-hook-image": types.ServiceConfig{PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Image: "alpine:latest"}}}}, + "inline-hook": types.ServiceConfig{PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Command: types.ShellCommand{"echo"}}}}}, "without-hook": types.ServiceConfig{}, }, }) diff --git a/cmd/compose/options_test.go b/cmd/compose/options_test.go index 13a33d7994c..f6744054c99 100644 --- a/cmd/compose/options_test.go +++ b/cmd/compose/options_test.go @@ -38,17 +38,18 @@ func TestApplyPlatforms_InferFromRuntime(t *testing.T) { return &types.Project{ Services: types.Services{ "test": { - Name: "test", - Image: "foo", - Build: &types.BuildConfig{ + Name: "test", ContainerSpec: types.ContainerSpec{ + Image: "foo", + + Platform: "alice/32", + }, WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{ Context: ".", Platforms: []string{ "linux/amd64", "linux/arm64", "alice/32", }, - }, - Platform: "alice/32", + }}, }, }, } @@ -75,15 +76,13 @@ func TestApplyPlatforms_DockerDefaultPlatform(t *testing.T) { }, Services: types.Services{ "test": { - Name: "test", - Image: "foo", - Build: &types.BuildConfig{ + Name: "test", ContainerSpec: types.ContainerSpec{Image: "foo"}, WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{ Context: ".", Platforms: []string{ "linux/amd64", "linux/arm64", }, - }, + }}, }, }, } @@ -110,15 +109,13 @@ func TestApplyPlatforms_UnsupportedPlatform(t *testing.T) { }, Services: types.Services{ "test": { - Name: "test", - Image: "foo", - Build: &types.BuildConfig{ + Name: "test", ContainerSpec: types.ContainerSpec{Image: "foo"}, WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{ Context: ".", Platforms: []string{ "linux/amd64", "linux/arm64", }, - }, + }}, }, }, } diff --git a/cmd/compose/pullOptions_test.go b/cmd/compose/pullOptions_test.go index 05dd868edf7..f13537923ec 100644 --- a/cmd/compose/pullOptions_test.go +++ b/cmd/compose/pullOptions_test.go @@ -27,22 +27,19 @@ func TestApplyPullOptions(t *testing.T) { project := &types.Project{ Services: types.Services{ "must-build": { - Name: "must-build", + Name: "must-build", WorkloadSpec: // No image, local build only - Build: &types.BuildConfig{ + types.WorkloadSpec{Build: &types.BuildConfig{ Context: ".", - }, + }}, }, "has-build": { - Name: "has-build", - Image: "registry.example.com/myservice", - Build: &types.BuildConfig{ + Name: "has-build", ContainerSpec: types.ContainerSpec{Image: "registry.example.com/myservice"}, WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{ Context: ".", - }, + }}, }, "must-pull": { - Name: "must-pull", - Image: "registry.example.com/another-service", + Name: "must-pull", ContainerSpec: types.ContainerSpec{Image: "registry.example.com/another-service"}, }, }, } diff --git a/cmd/compose/run.go b/cmd/compose/run.go index 7d5f522b435..f486dd26f03 100644 --- a/cmd/compose/run.go +++ b/cmd/compose/run.go @@ -71,6 +71,11 @@ type runOptions struct { } func (options runOptions) apply(project *types.Project) (*types.Project, error) { + project, err := materializeManualJob(project, options.Service) + if err != nil { + return nil, err + } + if options.noDeps { var err error project, err = project.WithSelectedServices([]string{options.Service}, types.IgnoreDependencies) @@ -83,7 +88,6 @@ func (options runOptions) apply(project *types.Project) (*types.Project, error) if err != nil { return nil, err } - target.Tty = !options.noTty target.StdinOpen = options.interactive @@ -272,6 +276,11 @@ func normalizeRunFlags(f *pflag.FlagSet, name string) pflag.NormalizedName { // their containers. func runProject(ctx context.Context, dockerCli command.Cli, backend api.Compose, p *ProjectOptions, service string) (*types.Project, error) { project, _, err := p.ToProject(ctx, dockerCli, backend, []string{service}, composecli.WithoutEnvironmentResolution) + if err != nil && strings.Contains(err.Error(), "no such service") { + // the run target may be a job, which the service selector cannot + // resolve: reload unselected and let materializeManualJob decide + project, _, err = p.ToProject(ctx, dockerCli, backend, nil, composecli.WithoutEnvironmentResolution) + } if err != nil { return nil, err } @@ -366,3 +375,29 @@ func runRun(ctx context.Context, backend api.Compose, project *types.Project, op } return err } + +// materializeManualJob lets run target a manual-trigger job exactly like a +// service. A job is a ContainerSpec+WorkloadSpec — the same layers a service +// is made of — so it materializes as a service for the one-off machinery: +// its profile is activated and the project narrowed to its dependencies by +// WithSelectedJob, then the job joins Services under its own name. +func materializeManualJob(project *types.Project, name string) (*types.Project, error) { + job, ok := project.AllJobs()[name] + if !ok { + return project, nil + } + if job.Triggers == nil || !job.Triggers.Manual { + return nil, fmt.Errorf("job %q has no manual trigger, it cannot be run", name) + } + project, err := project.WithSelectedJob(name) + if err != nil { + return nil, err + } + project.Services[name] = types.ServiceConfig{ + Name: name, + Profiles: job.Profiles, + ContainerSpec: job.ContainerSpec, + WorkloadSpec: job.WorkloadSpec, + } + return project, nil +} diff --git a/cmd/compose/run_test.go b/cmd/compose/run_test.go new file mode 100644 index 00000000000..e3117d7e563 --- /dev/null +++ b/cmd/compose/run_test.go @@ -0,0 +1,72 @@ +/* + 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 compose + +import ( + "testing" + + "github.com/compose-spec/compose-go/v2/types" + "gotest.tools/v3/assert" +) + +func TestMaterializeManualJob(t *testing.T) { + base := func() *types.Project { + return &types.Project{ + Services: types.Services{ + "db": {Name: "db", ContainerSpec: types.ContainerSpec{Image: "postgres"}}, + }, + Jobs: types.Jobs{ + "migrate": { + Name: "migrate", + Triggers: &types.TriggerConfig{Manual: true}, + ContainerSpec: types.ContainerSpec{Image: "migrator", Command: types.ShellCommand{"migrate"}}, + WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{"db": {Condition: types.ServiceConditionStarted, Required: true}}}, + }, + "backup": { + Name: "backup", + Triggers: &types.TriggerConfig{Schedule: []types.ScheduleConfig{{Cron: "0 3 * * *"}}}, + }, + }, + } + } + + t.Run("a service name passes through", func(t *testing.T) { + p := base() + got, err := materializeManualJob(p, "db") + assert.NilError(t, err) + assert.Equal(t, got, p) + }) + + t.Run("a manual job materializes as a service with its spec and deps", func(t *testing.T) { + got, err := materializeManualJob(base(), "migrate") + assert.NilError(t, err) + svc, err := got.GetService("migrate") + assert.NilError(t, err) + assert.Equal(t, svc.Image, "migrator") + assert.DeepEqual(t, []string(svc.Command), []string{"migrate"}) + _, hasDep := svc.DependsOn["db"] + assert.Check(t, hasDep) + // the dependency is kept in the narrowed project + _, err = got.GetService("db") + assert.NilError(t, err) + }) + + t.Run("a schedule-only job is rejected", func(t *testing.T) { + _, err := materializeManualJob(base(), "backup") + assert.Error(t, err, `job "backup" has no manual trigger, it cannot be run`) + }) +} diff --git a/cmd/compose/up.go b/cmd/compose/up.go index e69e455e27c..f9ce17402ad 100644 --- a/cmd/compose/up.go +++ b/cmd/compose/up.go @@ -21,6 +21,7 @@ import ( "errors" "fmt" "os" + "sort" "strings" "time" @@ -241,6 +242,11 @@ func runUp( return err } + if err := rejectScheduledJobs(project); err != nil { + return err + } + warnIgnoredJobs(project) + err := createOptions.Apply(project) if err != nil { return err @@ -349,3 +355,35 @@ func runUp( }, }) } + +// warnIgnoredJobs names the declared jobs up will not act on: manual jobs +// wait for an explicit `compose run ` trigger. +func warnIgnoredJobs(project *types.Project) { + jobs := project.AllJobs() + if len(jobs) == 0 { + return + } + names := make([]string, 0, len(jobs)) + for name := range jobs { + names = append(names, name) + } + sort.Strings(names) + logrus.Warnf("jobs are not started by up; trigger them with `docker compose run`: %s", strings.Join(names, ", ")) +} + +// rejectScheduledJobs refuses to bring a project up when it declares active +// scheduled jobs: silently not scheduling them would break the user's +// expectations, unlike manual jobs which simply wait for an explicit trigger. +func rejectScheduledJobs(project *types.Project) error { + names := make([]string, 0, len(project.Jobs)) + for name, job := range project.Jobs { + if job.Triggers != nil && len(job.Triggers.Schedule) > 0 { + names = append(names, name) + } + } + if len(names) == 0 { + return nil + } + sort.Strings(names) + return fmt.Errorf("scheduled jobs are not supported in this version: %s", strings.Join(names, ", ")) +} diff --git a/cmd/compose/up_test.go b/cmd/compose/up_test.go index e6e7fd2224f..94656792c53 100644 --- a/cmd/compose/up_test.go +++ b/cmd/compose/up_test.go @@ -155,8 +155,7 @@ services: WorkingDir: dir, Services: types.Services{ "web": { - Name: "web", - Image: "nginx", + Name: "web", ContainerSpec: types.ContainerSpec{Image: "nginx"}, }, }, } @@ -179,3 +178,18 @@ services: assert.Assert(t, strings.Contains(output, "LXKNS_PORT"), output) assert.Assert(t, !strings.Contains(fmt.Sprint(err), "invalid ip address"), fmt.Sprint(err)) } + +func TestRejectScheduledJobs(t *testing.T) { + manual := types.JobConfig{Triggers: &types.TriggerConfig{Manual: true}} + scheduled := types.JobConfig{Triggers: &types.TriggerConfig{ + Schedule: []types.ScheduleConfig{{Cron: "0 3 * * *"}}, + }} + + assert.NilError(t, rejectScheduledJobs(&types.Project{})) + assert.NilError(t, rejectScheduledJobs(&types.Project{Jobs: types.Jobs{"migrate": manual}})) + // profile-disabled scheduled jobs don't block up + assert.NilError(t, rejectScheduledJobs(&types.Project{DisabledJobs: types.Jobs{"backup": scheduled}})) + + err := rejectScheduledJobs(&types.Project{Jobs: types.Jobs{"backup": scheduled, "sync": scheduled, "migrate": manual}}) + assert.Error(t, err, "scheduled jobs are not supported in this version: backup, sync") +} diff --git a/go.mod b/go.mod index bd1f292cd7f..399bcf015e2 100644 --- a/go.mod +++ b/go.mod @@ -219,3 +219,5 @@ exclude ( github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 ) + +replace github.com/compose-spec/compose-go/v2 => github.com/ndeloof/compose-go/v2 v2.0.1-0.20260819150359-59f9907c1949 diff --git a/go.sum b/go.sum index 97d942f32c0..caca841bff5 100644 --- a/go.sum +++ b/go.sum @@ -110,8 +110,6 @@ github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= github.com/codahale/rfc6979 v0.0.0-20141003034818-6a90f24967eb h1:EDmT6Q9Zs+SbUoc7Ik9EfrFqcylYqgPZ9ANSbTAntnE= github.com/codahale/rfc6979 v0.0.0-20141003034818-6a90f24967eb/go.mod h1:ZjrT6AXHbDs86ZSdt/osfBi5qfexBrKUdONk989Wnk4= -github.com/compose-spec/compose-go/v2 v2.14.0 h1:uaJeo5B3+OVlu+Rx2qLBcAdXPEUUzm5nQrRiGJafRAQ= -github.com/compose-spec/compose-go/v2 v2.14.0/go.mod h1:ZU6zlcweCZKyiB7BVfCizQT9XmkEIMFE+PRZydVcsZg= github.com/containerd/cgroups/v3 v3.1.3 h1:eUNflyMddm18+yrDmZPn3jI7C5hJ9ahABE5q6dyLYXQ= github.com/containerd/cgroups/v3 v3.1.3/go.mod h1:PKZ2AcWmSBsY/tJUVhtS/rluX0b1uq1GmPO1ElCmbOw= github.com/containerd/console v1.0.5 h1:R0ymNeydRqH2DmakFNdmjR2k0t7UPuiOV/N/27/qqsc= @@ -445,6 +443,8 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/natefinch/atomic v1.0.1 h1:ZPYKxkqQOx3KZ+RsbnP/YsgvxWQPGxjC0oBt2AhwV0A= github.com/natefinch/atomic v1.0.1/go.mod h1:N/D/ELrljoqDyT3rZrsUmtsuzvHkeB/wWjHV22AZRbM= +github.com/ndeloof/compose-go/v2 v2.0.1-0.20260819150359-59f9907c1949 h1:4v++96bXaWqscXzJS20N1zT3YBf1Xf+aOj0iPE4bRh0= +github.com/ndeloof/compose-go/v2 v2.0.1-0.20260819150359-59f9907c1949/go.mod h1:ZU6zlcweCZKyiB7BVfCizQT9XmkEIMFE+PRZydVcsZg= github.com/oklog/ulid/v2 v2.1.1 h1:suPZ4ARWLOJLegGFiZZ1dFAkqzhMjL3J1TzI+5wHz8s= github.com/oklog/ulid/v2 v2.1.1/go.mod h1:rcEKHmBBKfef9DhnvX7y1HZBYxjXb0cP5ExxNsTT1QQ= github.com/open-policy-agent/opa v1.14.1 h1:MhurLB9mSbXmojYFCmGbiC1Uagu1+aFAV4XVotDA86M= diff --git a/internal/locker/pidfile_windows.go b/internal/locker/pidfile_windows.go index 2dac9ff031b..f953f9dcee6 100644 --- a/internal/locker/pidfile_windows.go +++ b/internal/locker/pidfile_windows.go @@ -21,8 +21,9 @@ package locker import ( "os" - "github.com/docker/compose/v5/internal/pidfile" "github.com/mitchellh/go-ps" + + "github.com/docker/compose/v5/internal/pidfile" ) func (f *Pidfile) Lock() error { diff --git a/internal/tracing/attributes_test.go b/internal/tracing/attributes_test.go index 8416f69728b..acbbe2f552a 100644 --- a/internal/tracing/attributes_test.go +++ b/internal/tracing/attributes_test.go @@ -28,27 +28,27 @@ func TestProjectHash(t *testing.T) { Name: "fake-proj", WorkingDir: "/tmp", Services: map[string]types.ServiceConfig{ - "foo": {Image: "fake-image"}, + "foo": {ContainerSpec: types.ContainerSpec{Image: "fake-image"}}, }, DisabledServices: map[string]types.ServiceConfig{ - "bar": {Image: "diff-image"}, + "bar": {ContainerSpec: types.ContainerSpec{Image: "diff-image"}}, }, } projB := &types.Project{ Name: "fake-proj", WorkingDir: "/tmp", Services: map[string]types.ServiceConfig{ - "foo": {Image: "fake-image"}, - "bar": {Image: "diff-image"}, + "foo": {ContainerSpec: types.ContainerSpec{Image: "fake-image"}}, + "bar": {ContainerSpec: types.ContainerSpec{Image: "diff-image"}}, }, } projC := &types.Project{ Name: "fake-proj", WorkingDir: "/tmp", Services: map[string]types.ServiceConfig{ - "foo": {Image: "fake-image"}, - "bar": {Image: "diff-image"}, - "baz": {Image: "yet-another-image"}, + "foo": {ContainerSpec: types.ContainerSpec{Image: "fake-image"}}, + "bar": {ContainerSpec: types.ContainerSpec{Image: "diff-image"}}, + "baz": {ContainerSpec: types.ContainerSpec{Image: "yet-another-image"}}, }, } diff --git a/pkg/api/api_test.go b/pkg/api/api_test.go index 4fb5890f763..a373f805e40 100644 --- a/pkg/api/api_test.go +++ b/pkg/api/api_test.go @@ -46,58 +46,57 @@ func TestGetDependentImages(t *testing.T) { }{ { name: "no hooks", - service: types.ServiceConfig{Image: "alpine:3.20"}, + service: types.ServiceConfig{ContainerSpec: types.ContainerSpec{Image: "alpine:3.20"}}, expected: nil, }, { name: "pre_start hook with explicit image", service: types.ServiceConfig{ - Image: "alpine:3.20", - PreStart: []types.ServiceHook{ - {Image: "alpine:3.19", Command: types.ShellCommand{"echo", "init"}}, - }, + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine:3.19", Command: types.ShellCommand{"echo", "init"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine:3.20"}, }, expected: []string{"alpine:3.19"}, }, { name: "pre_start hook without image is ignored", service: types.ServiceConfig{ - Image: "alpine:3.20", - PreStart: []types.ServiceHook{ - {Image: "busybox", Command: types.ShellCommand{"echo", "a"}}, - {Command: types.ShellCommand{"echo", "b"}}, - }, + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "busybox", Command: types.ShellCommand{"echo", "a"}}}, + {ContainerSpec: types.ContainerSpec{Command: types.ShellCommand{"echo", "b"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine:3.20"}, }, expected: []string{"busybox"}, }, { name: "pre_start hook reusing the service image is ignored", service: types.ServiceConfig{ - Image: "alpine:3.20", - PreStart: []types.ServiceHook{ - {Image: "alpine:3.20", Command: types.ShellCommand{"echo", "same"}}, - {Image: "alpine:3.19", Command: types.ShellCommand{"echo", "other"}}, - }, + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine:3.20", Command: types.ShellCommand{"echo", "same"}}}, + {ContainerSpec: types.ContainerSpec{Image: "alpine:3.19", Command: types.ShellCommand{"echo", "other"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine:3.20"}, }, expected: []string{"alpine:3.19"}, }, { name: "pre_start hook reusing the default (build) image name is ignored", service: types.ServiceConfig{ - Name: "web", - Build: &types.BuildConfig{Context: "."}, - PreStart: []types.ServiceHook{ - {Image: "demo-web", Command: types.ShellCommand{"echo", "same"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "demo-web", Command: types.ShellCommand{"echo", "same"}}}, + }, WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{Context: "."}}, }, expected: nil, }, { + // exec hooks carry no image at all since the container spec + // layering: nothing to collect, by construction name: "post_start and pre_stop hooks are not collected", service: types.ServiceConfig{ - Image: "alpine:3.20", - PostStart: []types.ServiceHook{{Image: "ignored:post", Command: types.ShellCommand{"echo"}}}, - PreStop: []types.ServiceHook{{Image: "ignored:stop", Command: types.ShellCommand{"echo"}}}, + PostStart: []types.ServiceHook{{Command: types.ShellCommand{"echo"}}}, + PreStop: []types.ServiceHook{{Command: types.ShellCommand{"echo"}}}, + ContainerSpec: types.ContainerSpec{Image: "alpine:3.20"}, }, expected: nil, }, diff --git a/pkg/bridge/convert_test.go b/pkg/bridge/convert_test.go index 6f90bd0415e..62009227399 100644 --- a/pkg/bridge/convert_test.go +++ b/pkg/bridge/convert_test.go @@ -40,9 +40,10 @@ func TestLoadAdditionalResources_BuildOnlySkipsPull(t *testing.T) { Name: "test", Services: types.Services{ "api": { - Name: "api", - Build: &types.BuildConfig{Context: "."}, - Expose: []string{"8080"}, + Name: "api", WorkloadSpec: types.WorkloadSpec{ + Build: &types.BuildConfig{Context: "."}, + Expose: []string{"8080"}, + }, }, }, } diff --git a/pkg/compose/build_test.go b/pkg/compose/build_test.go index a7fbf2e2c33..1dbba84de6b 100644 --- a/pkg/compose/build_test.go +++ b/pkg/compose/build_test.go @@ -84,26 +84,22 @@ func Test_dockerFilePath(t *testing.T) { func Test_addBuildDependencies(t *testing.T) { project := &types.Project{Services: types.Services{ "test": types.ServiceConfig{ - Build: &types.BuildConfig{ + WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{ AdditionalContexts: map[string]string{ "foo": "service:foo", "bar": "service:bar", }, - }, + }}, }, "foo": types.ServiceConfig{ - Build: &types.BuildConfig{ + WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{ AdditionalContexts: map[string]string{ "zot": "service:zot", }, - }, - }, - "bar": types.ServiceConfig{ - Build: &types.BuildConfig{}, - }, - "zot": types.ServiceConfig{ - Build: &types.BuildConfig{}, + }}, }, + "bar": types.ServiceConfig{WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{}}}, + "zot": types.ServiceConfig{WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{}}}, }} services := addBuildDependencies([]string{"test"}, project) @@ -122,11 +118,11 @@ func TestGetLocalImagesDigests_PreStartHook(t *testing.T) { Name: "demo", Services: types.Services{ "web": types.ServiceConfig{ - Name: "web", - Image: "alpine:3.20", - PreStart: []types.ServiceHook{ - {Image: "alpine:3.19", Command: types.ShellCommand{"echo", "init"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine:3.19", Command: types.ShellCommand{"echo", "init"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine:3.20"}, }, }, } @@ -155,9 +151,10 @@ func TestResolveImageVolumes(t *testing.T) { t.Run("source is an image name", func(t *testing.T) { service := types.ServiceConfig{ - Name: "web", - CustomLabels: types.Labels{}, - Volumes: []types.ServiceVolumeConfig{imageVolume("content:1", "/data")}, + Name: "web", ContainerSpec: types.ContainerSpec{ + CustomLabels: types.Labels{}, + Volumes: []types.ServiceVolumeConfig{imageVolume("content:1", "/data")}, + }, } resolveImageVolumes(&service, images, "p") assert.Equal(t, service.Volumes[0].Source, "content:1") @@ -166,9 +163,10 @@ func TestResolveImageVolumes(t *testing.T) { t.Run("source is another service resolves to its image name", func(t *testing.T) { service := types.ServiceConfig{ - Name: "web", - CustomLabels: types.Labels{}, - Volumes: []types.ServiceVolumeConfig{imageVolume("source", "/data")}, + Name: "web", ContainerSpec: types.ContainerSpec{ + CustomLabels: types.Labels{}, + Volumes: []types.ServiceVolumeConfig{imageVolume("source", "/data")}, + }, } resolveImageVolumes(&service, images, "p") // the mount Source must stay a daemon-resolvable name, never a digest @@ -178,9 +176,10 @@ func TestResolveImageVolumes(t *testing.T) { t.Run("unresolvable source is left untouched and unlabelled", func(t *testing.T) { service := types.ServiceConfig{ - Name: "web", - CustomLabels: types.Labels{}, - Volumes: []types.ServiceVolumeConfig{imageVolume("ghost:1", "/data")}, + Name: "web", ContainerSpec: types.ContainerSpec{ + CustomLabels: types.Labels{}, + Volumes: []types.ServiceVolumeConfig{imageVolume("ghost:1", "/data")}, + }, } resolveImageVolumes(&service, images, "p") assert.Equal(t, service.Volumes[0].Source, "ghost:1") @@ -190,11 +189,12 @@ func TestResolveImageVolumes(t *testing.T) { t.Run("several volumes produce a deterministic sorted label", func(t *testing.T) { service := types.ServiceConfig{ - Name: "web", - CustomLabels: types.Labels{}, - Volumes: []types.ServiceVolumeConfig{ - imageVolume("assets:2", "/b"), - imageVolume("content:1", "/a"), + Name: "web", ContainerSpec: types.ContainerSpec{ + CustomLabels: types.Labels{}, + Volumes: []types.ServiceVolumeConfig{ + imageVolume("assets:2", "/b"), + imageVolume("content:1", "/a"), + }, }, } resolveImageVolumes(&service, images, "p") @@ -203,9 +203,10 @@ func TestResolveImageVolumes(t *testing.T) { t.Run("no image volumes writes no label", func(t *testing.T) { service := types.ServiceConfig{ - Name: "web", - CustomLabels: types.Labels{}, - Volumes: []types.ServiceVolumeConfig{{Type: types.VolumeTypeVolume, Source: "vol", Target: "/data"}}, + Name: "web", ContainerSpec: types.ContainerSpec{ + CustomLabels: types.Labels{}, + Volumes: []types.ServiceVolumeConfig{{Type: types.VolumeTypeVolume, Source: "vol", Target: "/data"}}, + }, } resolveImageVolumes(&service, images, "p") _, labelled := service.CustomLabels[api.ImageVolumeDigestLabel] diff --git a/pkg/compose/compose.go b/pkg/compose/compose.go index d72bc2735b6..0801db5420c 100644 --- a/pkg/compose/compose.go +++ b/pkg/compose/compose.go @@ -373,9 +373,11 @@ func (s *composeService) projectFromName(containers Containers, projectName stri service, ok := set[serviceLabel] if !ok { service = types.ServiceConfig{ - Name: serviceLabel, - Image: ctr.Image, - Labels: ctr.Labels, + Name: serviceLabel, + ContainerSpec: types.ContainerSpec{ + Image: ctr.Image, + Labels: ctr.Labels, + }, } } service.Scale = increment(service.Scale) diff --git a/pkg/compose/convergence_test.go b/pkg/compose/convergence_test.go index a8db780b483..26d1d75f0ec 100644 --- a/pkg/compose/convergence_test.go +++ b/pkg/compose/convergence_test.go @@ -247,13 +247,12 @@ func TestWaitDependencies(t *testing.T) { replicas := 0 project := types.Project{Name: strings.ToLower(testProject), Services: types.Services{ "app": { - Name: "app", - DependsOn: types.DependsOnConfig{ + Name: "app", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "disabled": { Condition: ServiceConditionRunningOrHealthy, Required: true, }, - }, + }}, }, "disabled": { Name: "disabled", @@ -485,15 +484,14 @@ func TestCreateMobyContainer(t *testing.T) { apiClient.EXPECT().ClientVersion().Return("1.44").AnyTimes() service := types.ServiceConfig{ - Name: "test", - Networks: map[string]*types.ServiceNetworkConfig{ + Name: "test", ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{ "a": { Priority: 10, }, "b": { Priority: 100, }, - }, + }}, } project := types.Project{ Name: "bork", @@ -584,11 +582,10 @@ func TestCreateMobyContainerLegacyAPI(t *testing.T) { apiClient.EXPECT().ClientVersion().Return("1.43").AnyTimes() service := types.ServiceConfig{ - Name: "test", - Networks: map[string]*types.ServiceNetworkConfig{ + Name: "test", ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{ "a": {Priority: 10}, "b": {Priority: 100}, - }, + }}, } project := types.Project{ Name: "bork", @@ -673,11 +670,10 @@ func TestCreateMobyContainerLegacyAPI_NetworkConnectFailure(t *testing.T) { apiClient.EXPECT().ClientVersion().Return("1.43").AnyTimes() service := types.ServiceConfig{ - Name: "test", - Networks: map[string]*types.ServiceNetworkConfig{ + Name: "test", ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{ "a": {Priority: 10}, "b": {Priority: 100}, - }, + }}, } project := types.Project{ Name: "bork", diff --git a/pkg/compose/create_test.go b/pkg/compose/create_test.go index e08e4227dae..0600cf4edca 100644 --- a/pkg/compose/create_test.go +++ b/pkg/compose/create_test.go @@ -86,7 +86,7 @@ func TestBuildVolumeMount(t *testing.T) { } func TestServiceImageName(t *testing.T) { - assert.Equal(t, api.GetImageNameOrDefault(composetypes.ServiceConfig{Image: "myImage"}, "myProject"), "myImage") + assert.Equal(t, api.GetImageNameOrDefault(composetypes.ServiceConfig{ContainerSpec: composetypes.ContainerSpec{Image: "myImage"}}, "myProject"), "myImage") assert.Equal(t, api.GetImageNameOrDefault(composetypes.ServiceConfig{Name: "aService"}, "myProject"), "myProject-aService") } @@ -108,8 +108,7 @@ func TestBuildContainerMountOptions(t *testing.T) { Name: "myProject", Services: composetypes.Services{ "myService": { - Name: "myService", - Volumes: []composetypes.ServiceVolumeConfig{ + Name: "myService", ContainerSpec: composetypes.ContainerSpec{Volumes: []composetypes.ServiceVolumeConfig{ { Type: composetypes.VolumeTypeVolume, Target: "/var/myvolume1", @@ -131,7 +130,7 @@ func TestBuildContainerMountOptions(t *testing.T) { Source: "\\\\.\\pipe\\docker_engine_windows", Target: "\\\\.\\pipe\\docker_engine", }, - }, + }}, }, }, Volumes: composetypes.Volumes(map[string]composetypes.VolumeConfig{ @@ -194,15 +193,14 @@ func TestBuildContainerMountOptions(t *testing.T) { func TestDefaultNetworkSettings(t *testing.T) { t.Run("returns the network with the highest priority as primary when service has multiple networks", func(t *testing.T) { service := composetypes.ServiceConfig{ - Name: "myService", - Networks: map[string]*composetypes.ServiceNetworkConfig{ + Name: "myService", ContainerSpec: composetypes.ContainerSpec{Networks: map[string]*composetypes.ServiceNetworkConfig{ "myNetwork1": { Priority: 10, }, "myNetwork2": { Priority: 1000, }, - }, + }}, } project := composetypes.Project{ Name: "myProject", @@ -275,11 +273,10 @@ func TestDefaultNetworkSettings(t *testing.T) { t.Run("returns only primary network in EndpointsConfig for API < 1.44", func(t *testing.T) { service := composetypes.ServiceConfig{ - Name: "myService", - Networks: map[string]*composetypes.ServiceNetworkConfig{ + Name: "myService", ContainerSpec: composetypes.ContainerSpec{Networks: map[string]*composetypes.ServiceNetworkConfig{ "myNetwork1": {Priority: 10}, "myNetwork2": {Priority: 1000}, - }, + }}, } project := composetypes.Project{ Name: "myProject", @@ -299,8 +296,7 @@ func TestDefaultNetworkSettings(t *testing.T) { t.Run("returns defined network mode if explicitly set", func(t *testing.T) { service := composetypes.ServiceConfig{ - Name: "myService", - NetworkMode: "host", + Name: "myService", ContainerSpec: composetypes.ContainerSpec{NetworkMode: "host"}, } project := composetypes.Project{ Name: "myProject", @@ -324,8 +320,7 @@ func TestCreateEndpointSettings(t *testing.T) { Name: "projName", }, composetypes.ServiceConfig{ Name: "serviceName", - ContainerName: "containerName", - Networks: map[string]*composetypes.ServiceNetworkConfig{ + ContainerName: "containerName", ContainerSpec: composetypes.ContainerSpec{Networks: map[string]*composetypes.ServiceNetworkConfig{ "netName": { Priority: 100, Aliases: []string{"alias1", "alias2"}, @@ -338,7 +333,7 @@ func TestCreateEndpointSettings(t *testing.T) { "driverOpt2": "optval2", }, }, - }, + }}, }, 0, "netName", []string{"link1", "link2"}, true) assert.NilError(t, err) macAddr, _ := net.ParseMAC("02:00:00:00:00:01") diff --git a/pkg/compose/dependencies_test.go b/pkg/compose/dependencies_test.go index 947a9bd4a3d..9069f1c7f7e 100644 --- a/pkg/compose/dependencies_test.go +++ b/pkg/compose/dependencies_test.go @@ -34,16 +34,14 @@ func createTestProject() *types.Project { return &types.Project{ Services: types.Services{ "test1": { - Name: "test1", - DependsOn: map[string]types.ServiceDependency{ + Name: "test1", WorkloadSpec: types.WorkloadSpec{DependsOn: map[string]types.ServiceDependency{ "test2": {}, - }, + }}, }, "test2": { - Name: "test2", - DependsOn: map[string]types.ServiceDependency{ + Name: "test2", WorkloadSpec: types.WorkloadSpec{DependsOn: map[string]types.ServiceDependency{ "test3": {}, - }, + }}, }, "test3": { Name: "test3", @@ -54,8 +52,7 @@ func createTestProject() *types.Project { func TestTraversalWithMultipleParents(t *testing.T) { dependent := types.ServiceConfig{ - Name: "dependent", - DependsOn: make(types.DependsOnConfig), + Name: "dependent", WorkloadSpec: types.WorkloadSpec{DependsOn: make(types.DependsOnConfig)}, } project := types.Project{ @@ -124,8 +121,7 @@ func TestBuildGraph(t *testing.T) { desc: "builds graph with single service", services: types.Services{ "test": { - Name: "test", - DependsOn: types.DependsOnConfig{}, + Name: "test", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{}}, }, }, expectedVertices: map[string]*Vertex{ @@ -142,12 +138,10 @@ func TestBuildGraph(t *testing.T) { desc: "builds graph with two separate services", services: types.Services{ "test": { - Name: "test", - DependsOn: types.DependsOnConfig{}, + Name: "test", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{}}, }, "another": { - Name: "another", - DependsOn: types.DependsOnConfig{}, + Name: "another", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{}}, }, }, expectedVertices: map[string]*Vertex{ @@ -171,14 +165,12 @@ func TestBuildGraph(t *testing.T) { desc: "builds graph with a service and a dependency", services: types.Services{ "test": { - Name: "test", - DependsOn: types.DependsOnConfig{ + Name: "test", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "another": types.ServiceDependency{}, - }, + }}, }, "another": { - Name: "another", - DependsOn: types.DependsOnConfig{}, + Name: "another", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{}}, }, }, expectedVertices: map[string]*Vertex{ @@ -206,20 +198,17 @@ func TestBuildGraph(t *testing.T) { desc: "builds graph with multiple dependency levels", services: types.Services{ "test": { - Name: "test", - DependsOn: types.DependsOnConfig{ + Name: "test", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "another": types.ServiceDependency{}, - }, + }}, }, "another": { - Name: "another", - DependsOn: types.DependsOnConfig{ + Name: "another", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "another_dep": types.ServiceDependency{}, - }, + }}, }, "another_dep": { - Name: "another_dep", - DependsOn: types.DependsOnConfig{}, + Name: "another_dep", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{}}, }, }, expectedVertices: map[string]*Vertex{ @@ -283,15 +272,14 @@ func TestBuildGraphDependsOn(t *testing.T) { desc: "service depends on init container which is already removed", services: types.Services{ "test": { - Name: "test", - DependsOn: types.DependsOnConfig{ + Name: "test", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "test-removed-init-container": types.ServiceDependency{ Condition: "service_completed_successfully", Restart: false, Extensions: types.Extensions(nil), Required: false, }, - }, + }}, }, }, expectedVertices: map[string]*Vertex{ diff --git a/pkg/compose/down_test.go b/pkg/compose/down_test.go index eea13b9d231..fa14f0aff75 100644 --- a/pkg/compose/down_test.go +++ b/pkg/compose/down_test.go @@ -287,11 +287,11 @@ func TestDownRemoveImages(t *testing.T) { Name: strings.ToLower(testProject), Services: types.Services{ "local-anonymous": {Name: "local-anonymous"}, - "local-named": {Name: "local-named", Image: "local-named-image"}, - "remote": {Name: "remote", Image: "remote-image"}, - "remote-tagged": {Name: "remote-tagged", Image: "registry.example.com/remote-image-tagged:v1.0"}, + "local-named": {Name: "local-named", ContainerSpec: types.ContainerSpec{Image: "local-named-image"}}, + "remote": {Name: "remote", ContainerSpec: types.ContainerSpec{Image: "remote-image"}}, + "remote-tagged": {Name: "remote-tagged", ContainerSpec: types.ContainerSpec{Image: "registry.example.com/remote-image-tagged:v1.0"}}, "no-images-anonymous": {Name: "no-images-anonymous"}, - "no-images-named": {Name: "no-images-named", Image: "missing-named-image"}, + "no-images-named": {Name: "no-images-named", ContainerSpec: types.ContainerSpec{Image: "missing-named-image"}}, }, }, } diff --git a/pkg/compose/generate.go b/pkg/compose/generate.go index fed2461a5c1..4ee63352e7b 100644 --- a/pkg/compose/generate.go +++ b/pkg/compose/generate.go @@ -85,9 +85,11 @@ func (s *composeService) createProjectFromContainers(containers []container.Summ service, ok := services[serviceLabel] if !ok { service = types.ServiceConfig{ - Name: serviceLabel, - Image: ctr.Image, - Labels: ctr.Labels, + Name: serviceLabel, + ContainerSpec: types.ContainerSpec{ + Image: ctr.Image, + Labels: ctr.Labels, + }, } } service.Scale = increment(service.Scale) diff --git a/pkg/compose/hash_test.go b/pkg/compose/hash_test.go index 73b7f387735..b25ea9b887e 100644 --- a/pkg/compose/hash_test.go +++ b/pkg/compose/hash_test.go @@ -37,7 +37,6 @@ func serviceConfig(replicas int) types.ServiceConfig { Deploy: &types.DeployConfig{ Replicas: &replicas, }, - Name: "foo", - Image: "bar", + Name: "foo", ContainerSpec: types.ContainerSpec{Image: "bar"}, } } diff --git a/pkg/compose/hook_spec.go b/pkg/compose/hook_spec.go new file mode 100644 index 00000000000..8cc698693ac --- /dev/null +++ b/pkg/compose/hook_spec.go @@ -0,0 +1,88 @@ +/* + 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 compose + +import ( + "fmt" + + "github.com/compose-spec/compose-go/v2/loader" + "github.com/compose-spec/compose-go/v2/override" + "github.com/compose-spec/compose-go/v2/types" + yaml "go.yaml.in/yaml/v4" +) + +// mergedPreStartSpec merges the hook's container specification over the +// service's, following the compose file merge rules: command and entrypoint +// replace, environment merges per key with the hook winning, extra_hosts and +// dns accumulate entries, ulimits merge, ... Every ContainerSpec attribute +// inherits this way, current and future, without attribute-specific code. +// +// Volumes are deliberately dropped from the inherited side: mounts inherit +// at runtime through volumes_from, the only mechanism that shares the +// service's anonymous and image volumes; the merged spec carries the hook's +// own volume declarations only, which take precedence per target. +func mergedPreStartSpec(service types.ServiceConfig, hook types.PreStartHook) (types.ContainerSpec, error) { + base, err := containerSpecDict(service.ContainerSpec) + if err != nil { + return types.ContainerSpec{}, err + } + delete(base, "volumes") + over, err := containerSpecDict(hook.ContainerSpec) + if err != nil { + return types.ContainerSpec{}, err + } + + merged, err := override.Merge( + map[string]any{"services": map[string]any{"hook": base}}, + map[string]any{"services": map[string]any{"hook": over}}, + ) + if err != nil { + return types.ContainerSpec{}, fmt.Errorf("merging pre_start hook specification: %w", err) + } + dict, ok := merged["services"].(map[string]any)["hook"].(map[string]any) + if !ok { + return types.ContainerSpec{}, fmt.Errorf("internal: unexpected merged hook specification shape") + } + + var spec types.ContainerSpec + if err := loader.Transform(dict, &spec); err != nil { + return types.ContainerSpec{}, fmt.Errorf("decoding merged pre_start hook specification: %w", err) + } + return spec, nil +} + +// containerSpecDict serializes a ContainerSpec to the canonical yaml tree the +// compose merge rules operate on — the same serialization compose config +// uses. +func containerSpecDict(spec types.ContainerSpec) (map[string]any, error) { + p := &types.Project{Services: types.Services{"hook": {ContainerSpec: spec}}} + raw, err := p.MarshalYAML() + if err != nil { + return nil, err + } + var dict map[string]any + if err := yaml.Unmarshal(raw, &dict); err != nil { + return nil, err + } + svc, ok := dict["services"].(map[string]any)["hook"].(map[string]any) + if !ok { + // a zero spec marshals to a null service entry + return map[string]any{}, nil + } + delete(svc, "name") + return svc, nil +} diff --git a/pkg/compose/hook_spec_test.go b/pkg/compose/hook_spec_test.go new file mode 100644 index 00000000000..2a116a96200 --- /dev/null +++ b/pkg/compose/hook_spec_test.go @@ -0,0 +1,86 @@ +/* + 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 compose + +import ( + "testing" + + "github.com/compose-spec/compose-go/v2/types" + "gotest.tools/v3/assert" + is "gotest.tools/v3/assert/cmp" +) + +func strPtr(s string) *string { return &s } + +func TestMergedPreStartSpec(t *testing.T) { + service := types.ServiceConfig{ + Name: "db", + ContainerSpec: types.ContainerSpec{ + Image: "postgres:16", + User: "999", + WorkingDir: "/srv", + Command: types.ShellCommand{"postgres"}, + Environment: types.MappingWithEquals{"PGDATA": strPtr("/data"), "SHARED": strPtr("service")}, + ExtraHosts: types.HostsList{"inherited": {"192.0.2.10"}, "shared": {"192.0.2.11"}}, + DNS: types.StringList{"1.1.1.1"}, + CapAdd: []string{"NET_ADMIN"}, + Volumes: []types.ServiceVolumeConfig{{Type: types.VolumeTypeVolume, Source: "data", Target: "/data", ReadOnly: true}}, + }, + } + hook := types.PreStartHook{ContainerSpec: types.ContainerSpec{ + Command: types.ShellCommand{"init.sh"}, + Environment: types.MappingWithEquals{"SHARED": strPtr("hook"), "ONLY": strPtr("hook")}, + ExtraHosts: types.HostsList{"declared": {"192.0.2.20"}, "shared": {"192.0.2.99"}}, + DNS: types.StringList{"8.8.8.8"}, + Volumes: []types.ServiceVolumeConfig{{Type: types.VolumeTypeVolume, Source: "data", Target: "/data"}}, + }} + + spec, err := mergedPreStartSpec(service, hook) + assert.NilError(t, err) + + // scalars inherit when undeclared + assert.Check(t, is.Equal(spec.Image, "postgres:16")) + assert.Check(t, is.Equal(spec.User, "999")) + assert.Check(t, is.Equal(spec.WorkingDir, "/srv")) + // command replaces + assert.Check(t, is.DeepEqual([]string(spec.Command), []string{"init.sh"})) + // collections merge per the compose file rules: environment per key + // (hook wins), extra_hosts accumulate entries per hostname + assert.Check(t, is.Equal(*spec.Environment["PGDATA"], "/data")) + assert.Check(t, is.Equal(*spec.Environment["SHARED"], "hook")) + assert.Check(t, is.Equal(*spec.Environment["ONLY"], "hook")) + assert.Check(t, is.DeepEqual(spec.ExtraHosts["inherited"], []string{"192.0.2.10"})) + assert.Check(t, is.DeepEqual(spec.ExtraHosts["declared"], []string{"192.0.2.20"})) + assert.Check(t, is.DeepEqual(spec.ExtraHosts["shared"], []string{"192.0.2.11", "192.0.2.99"})) + assert.Check(t, is.DeepEqual([]string(spec.DNS), []string{"1.1.1.1", "8.8.8.8"})) + // previously-unwired attributes inherit too, with zero dedicated code + assert.Check(t, is.DeepEqual(spec.CapAdd, []string{"NET_ADMIN"})) + // volumes are NOT inherited at the model level: runtime volumes_from does + assert.Assert(t, is.Len(spec.Volumes, 1)) + assert.Check(t, !spec.Volumes[0].ReadOnly, "hook keeps its own rw declaration") +} + +func TestMergedPreStartSpecEmptyHook(t *testing.T) { + service := types.ServiceConfig{ContainerSpec: types.ContainerSpec{ + Image: "alpine", Sysctls: types.Mapping{"net.core.somaxconn": "1024"}, + }} + spec, err := mergedPreStartSpec(service, types.PreStartHook{}) + assert.NilError(t, err) + assert.Check(t, is.Equal(spec.Image, "alpine")) + assert.Check(t, is.Equal(spec.Sysctls["net.core.somaxconn"], "1024")) + assert.Check(t, is.Len(spec.Volumes, 0)) +} diff --git a/pkg/compose/hook_test.go b/pkg/compose/hook_test.go index 5a4ad1d8ea0..9093f9a5cbd 100644 --- a/pkg/compose/hook_test.go +++ b/pkg/compose/hook_test.go @@ -87,8 +87,7 @@ func TestRunHook_ConsoleSize(t *testing.T) { mockCli.EXPECT().Out().Return(streams.NewOut(tty)).AnyTimes() service := types.ServiceConfig{ - Name: "test", - Tty: tc.tty, + Name: "test", WorkloadSpec: types.WorkloadSpec{Tty: tc.tty}, } hook := types.ServiceHook{Command: []string{"echo", "hello"}} ctr := container.Summary{ID: "container123"} @@ -450,7 +449,7 @@ func TestRunHook_CopyError(t *testing.T) { mockCli.EXPECT().Out().Return(streams.NewOut(os.Stdout)).AnyTimes() ctr := container.Summary{ID: "ctr-1"} - service := types.ServiceConfig{Name: "svc", Tty: false} + service := types.ServiceConfig{Name: "svc", WorkloadSpec: types.WorkloadSpec{Tty: false}} hook := types.ServiceHook{Command: types.ShellCommand{"true"}} mockAPI.EXPECT(). @@ -572,7 +571,7 @@ func TestRunHook_ExecInspectError(t *testing.T) { mockCli.EXPECT().Out().Return(streams.NewOut(os.Stdout)).AnyTimes() ctr := container.Summary{ID: "ctr-1"} - service := types.ServiceConfig{Name: "svc", Tty: false} + service := types.ServiceConfig{Name: "svc", WorkloadSpec: types.WorkloadSpec{Tty: false}} hook := types.ServiceHook{Command: types.ShellCommand{"true"}} mockAPI.EXPECT(). diff --git a/pkg/compose/images_test.go b/pkg/compose/images_test.go index 9775fd14d5c..a1b53ad477d 100644 --- a/pkg/compose/images_test.go +++ b/pkg/compose/images_test.go @@ -389,10 +389,11 @@ func TestPlatformPinnedDigest(t *testing.T) { Name: "p", Services: types.Services{ "app": { - Name: "app", - Image: "foo:1", - Platform: "linux/s390x", - CustomLabels: types.Labels{}, + Name: "app", ContainerSpec: types.ContainerSpec{ + Image: "foo:1", + Platform: "linux/s390x", + CustomLabels: types.Labels{}, + }, }, }, } @@ -455,7 +456,7 @@ func TestPlatformPinnedDigest(t *testing.T) { // whichever service triggered it, so services sharing the image with another // pinned platform must re-resolve theirs. func TestServiceImageDigest(t *testing.T) { - pinnedService := types.ServiceConfig{Name: "app", Platform: "linux/s390x"} + pinnedService := types.ServiceConfig{Name: "app", ContainerSpec: types.ContainerSpec{Platform: "linux/s390x"}} t.Run("unpinned service uses the shared digest, no inspect", func(t *testing.T) { mockCtrl := gomock.NewController(t) diff --git a/pkg/compose/pre_start.go b/pkg/compose/pre_start.go index 4d70c54bbd8..77cdec2ca72 100644 --- a/pkg/compose/pre_start.go +++ b/pkg/compose/pre_start.go @@ -88,7 +88,7 @@ func (s *composeService) runPreStart(ctx context.Context, project *types.Project func (s *composeService) runPreStartHook( ctx context.Context, project *types.Project, service types.ServiceConfig, - ctr container.Summary, index int, hook types.ServiceHook, listener api.ContainerEventListener, + ctr container.Summary, index int, hook types.PreStartHook, listener api.ContainerEventListener, ) error { created, err := s.createPreStartContainer(ctx, project, service, ctr, hook) if err != nil { @@ -164,49 +164,59 @@ func (s *composeService) runPreStartHook( func (s *composeService) createPreStartContainer( ctx context.Context, project *types.Project, service types.ServiceConfig, - ctr container.Summary, hook types.ServiceHook, + ctr container.Summary, hook types.PreStartHook, ) (client.ContainerCreateResult, error) { - image := hook.Image - if image == "" { - image = api.GetImageNameOrDefault(service, project.Name) + // A pre_start hook is a full container specification (compose-spec#656) + // inheriting from the service per the compose file merge rules; the + // merged spec runs through the standard create path, so every attribute + // — resources, capabilities, dns, sysctls, ... — materializes exactly as + // it would for a service container. + spec, err := mergedPreStartSpec(service, hook) + if err != nil { + return client.ContainerCreateResult{}, err } - - cfg := &container.Config{ - Image: image, - Cmd: hook.Command, - User: hook.User, - WorkingDir: hook.WorkingDir, - Env: append(ToMobyEnv(service.Environment), ToMobyEnv(hook.Environment)...), - // Tag the ephemeral hook container with the project/service it belongs - // to so it can be found by `compose down` and label-scoped tooling. - // HookLabel also distinguishes hook containers from the real service - // container (which shares ProjectLabel and ServiceLabel). - Labels: map[string]string{ + if spec.Image == "" { + spec.Image = api.GetImageNameOrDefault(service, project.Name) + } + hookService := types.ServiceConfig{ + Name: service.Name, + ContainerSpec: spec, + } + cfgs, err := s.getCreateConfigs(ctx, project, hookService, 0, nil, createOptions{ + // AutoRemove is intentionally false: a failed hook container is + // retained so the operator can inspect its logs. runPreStartHook + // removes it explicitly on success, and the orphan sweep catches + // leftovers on the next run. + AutoRemove: false, + UseNetworkAliases: true, + // Tag the ephemeral hook container with the project/service it + // belongs to so `compose down` and label-scoped tooling can find it. + // HookLabel distinguishes hook containers from the real service + // container; no container-number: tooling telling replicas apart must + // not count hook containers. + Labels: types.Labels{ api.ProjectLabel: project.Name, api.ServiceLabel: service.Name, api.VersionLabel: api.ComposeVersion, api.HookLabel: preStartHookType, }, - } - hostCfg := &container.HostConfig{ - // AutoRemove is intentionally false: a failed hook container is retained - // so the operator can inspect its logs. On success runPreStartHook - // removes the container explicitly (see the success path below). - AutoRemove: false, - Privileged: hook.Privileged, - VolumesFrom: []string{ctr.ID}, - } - - apiVersion, err := s.RuntimeAPIVersion(ctx) + }) if err != nil { return client.ContainerCreateResult{}, err } + // Mounts inherit from the live service container: volumes_from carries + // its anonymous and image volumes too. The hook's own mounts, already in + // the host config from the merged spec, take precedence on shared + // targets. + cfgs.Host.VolumesFrom = append(cfgs.Host.VolumesFrom, ctr.ID) + cfg := cfgs.Container + hostCfg := cfgs.Host + networkingConfig := cfgs.Network - networkMode, networkingConfig, err := defaultNetworkSettings(project, service, 0, nil, true, apiVersion) + apiVersion, err := s.RuntimeAPIVersion(ctx) if err != nil { return client.ContainerCreateResult{}, err } - hostCfg.NetworkMode = networkMode created, err := s.apiClient().ContainerCreate(ctx, client.ContainerCreateOptions{ Config: cfg, @@ -218,7 +228,7 @@ func (s *composeService) createPreStartContainer( } if versions.LessThan(apiVersion, apiVersion144) { - if err := s.connectPreStartExtraNetworks(ctx, project, service, created.ID, networkMode); err != nil { + if err := s.connectPreStartExtraNetworks(ctx, project, service, created.ID, hostCfg.NetworkMode); err != nil { // AutoRemove is false; remove the container explicitly since it was // never started. Log failures so the orphan is at least visible. if _, removeErr := s.apiClient().ContainerRemove(ctx, created.ID, client.ContainerRemoveOptions{Force: true, RemoveVolumes: true}); removeErr != nil { diff --git a/pkg/compose/pre_start_test.go b/pkg/compose/pre_start_test.go index 97e6cbc625f..a71e7762f8e 100644 --- a/pkg/compose/pre_start_test.go +++ b/pkg/compose/pre_start_test.go @@ -25,6 +25,7 @@ import ( "testing" "github.com/compose-spec/compose-go/v2/types" + "github.com/docker/cli/cli/config/configfile" "github.com/moby/moby/api/types/container" "github.com/moby/moby/client" "go.uber.org/goleak" @@ -50,9 +51,11 @@ func newPreStartTestServiceWithVersion(t *testing.T, apiVersion string) (*compos apiClient := mocks.NewMockAPIClient(mockCtrl) cli := mocks.NewMockCli(mockCtrl) cli.EXPECT().Client().Return(apiClient).AnyTimes() + cli.EXPECT().ConfigFile().Return(&configfile.ConfigFile{}).AnyTimes() apiClient.EXPECT().Ping(gomock.Any(), client.PingOptions{NegotiateAPIVersion: true}). Return(client.PingResult{APIVersion: apiVersion}, nil).AnyTimes() apiClient.EXPECT().ClientVersion().Return(apiVersion).AnyTimes() + apiClient.EXPECT().DaemonHost().Return("unix:///var/run/docker.sock").AnyTimes() tested, err := NewComposeService(cli) assert.NilError(t, err) return tested.(*composeService), apiClient @@ -91,12 +94,12 @@ func TestPreStart_SuccessTwoHooksInOrder(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"echo", "first"}}, - {Image: "alpine", Command: types.ShellCommand{"echo", "second"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"echo", "first"}}}, + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"echo", "second"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -134,12 +137,12 @@ func TestPreStart_FirstHookFailsStopsExecution(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"false"}}, - {Image: "alpine", Command: types.ShellCommand{"echo", "never"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"false"}}}, + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"echo", "never"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -164,11 +167,11 @@ func TestPreStart_PerReplicaRejected(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}, PerReplica: true}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {PerReplica: true, ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -184,8 +187,8 @@ func TestPreStart_ImageFallsBackToBuiltImage(t *testing.T) { // Service with no explicit image (build-only); hook image also empty. service := types.ServiceConfig{ Name: "web", - PreStart: []types.ServiceHook{ - {Command: types.ShellCommand{"echo", "hi"}}, + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Command: types.ShellCommand{"echo", "hi"}}}, }, } ctr := container.Summary{ID: "service-ctr-id"} @@ -215,11 +218,11 @@ func TestPreStart_ExplicitHookImageUsed(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "service-image:latest", - PreStart: []types.ServiceHook{ - {Image: "custom-hook-image:1.2.3", Command: types.ShellCommand{"echo"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "custom-hook-image:1.2.3", Command: types.ShellCommand{"echo"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "service-image:latest"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -248,11 +251,11 @@ func TestPreStart_VolumesFromServiceContainer(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -290,12 +293,12 @@ func TestPreStart_ContainerCreateFailurePropagates(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "missing:latest", Command: types.ShellCommand{"true"}}, - {Image: "alpine", Command: types.ShellCommand{"never"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "missing:latest", Command: types.ShellCommand{"true"}}}, + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"never"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -312,11 +315,11 @@ func TestPreStart_ContainerStartFailurePropagates(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -350,11 +353,11 @@ func TestPreStart_WaitResultPreferredOverNilError(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -434,11 +437,11 @@ func TestPreStart_DetachedModeAttachesLogs(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -466,11 +469,11 @@ func TestPreStart_FailureIncludesTail(t *testing.T) { project := &types.Project{Name: "demo"} service := types.ServiceConfig{ - Name: "db", - Image: "postgres", - PreStart: []types.ServiceHook{ - {Image: "postgres", Command: types.ShellCommand{"migrate"}}, - }, + Name: "db", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "postgres", Command: types.ShellCommand{"migrate"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "postgres"}, } ctr := container.Summary{ID: "service-ctr-id"} @@ -510,11 +513,11 @@ func TestPreStart_SuccessRemovesContainer(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -549,11 +552,11 @@ func TestPreStart_FailureRetainsContainer(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"migrate"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"migrate"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -588,11 +591,11 @@ func TestPreStart_CancellationRemovesContainer(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"long-running-op"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"long-running-op"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -634,11 +637,11 @@ func TestPreStart_RemovesOrphanBeforeRun(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"migrate"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"migrate"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -671,11 +674,11 @@ func TestPreStart_SuccessRemoveFailureIsNonFatal(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -763,11 +766,11 @@ func TestPreStart_StreamLogsError_NilListener(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -795,11 +798,11 @@ func TestPreStart_StreamLogsError_WithListener(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -838,13 +841,15 @@ func TestPreStart_OldAPIVersion(t *testing.T) { }, } service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - Networks: map[string]*types.ServiceNetworkConfig{ - "default": nil, - }, - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{ + Image: "alpine", + Networks: map[string]*types.ServiceNetworkConfig{ + "default": nil, + }, }, } ctr := container.Summary{ID: "svc-ctr"} @@ -878,11 +883,12 @@ func TestPreStart_ConnectExtraNetworksSuccess(t *testing.T) { }, } service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - Networks: map[string]*types.ServiceNetworkConfig{ - "default": nil, - "extra": nil, + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "alpine", + Networks: map[string]*types.ServiceNetworkConfig{ + "default": nil, + "extra": nil, + }, }, } @@ -907,11 +913,12 @@ func TestPreStart_ConnectExtraNetworksFails(t *testing.T) { }, } service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - Networks: map[string]*types.ServiceNetworkConfig{ - "default": nil, - "extra": nil, + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "alpine", + Networks: map[string]*types.ServiceNetworkConfig{ + "default": nil, + "extra": nil, + }, }, } @@ -931,11 +938,11 @@ func TestPreStart_ContainerStartFailureAndRemoveFails(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -965,11 +972,11 @@ func TestPreStart_OrphanScanFails(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -998,11 +1005,11 @@ func TestPreStart_OrphanRemovalFails(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, - }, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -1042,14 +1049,16 @@ func TestPreStart_OldAPINetworkConnectFails(t *testing.T) { }, } service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - Networks: map[string]*types.ServiceNetworkConfig{ - "default": nil, - "extra": nil, - }, - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{ + Image: "alpine", + Networks: map[string]*types.ServiceNetworkConfig{ + "default": nil, + "extra": nil, + }, }, } ctr := container.Summary{ID: "svc-ctr"} @@ -1082,14 +1091,16 @@ func TestPreStart_OldAPINetworkConnectAndRemoveFails(t *testing.T) { }, } service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - Networks: map[string]*types.ServiceNetworkConfig{ - "default": nil, - "extra": nil, - }, - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, + Name: "web", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, + }, ContainerSpec: types.ContainerSpec{ + Image: "alpine", + Networks: map[string]*types.ServiceNetworkConfig{ + "default": nil, + "extra": nil, + }, }, } ctr := container.Summary{ID: "svc-ctr"} @@ -1119,17 +1130,20 @@ func TestPreStart_RuntimeAPIVersionError(t *testing.T) { apiClient := mocks.NewMockAPIClient(mockCtrl) cli := mocks.NewMockCli(mockCtrl) cli.EXPECT().Client().Return(apiClient).AnyTimes() + // the merged-spec create path reads the CLI config and daemon host + cli.EXPECT().ConfigFile().Return(&configfile.ConfigFile{}).AnyTimes() + apiClient.EXPECT().DaemonHost().Return("unix:///var/run/docker.sock").AnyTimes() tested, err := NewComposeService(cli) assert.NilError(t, err) s := tested.(*composeService) project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{ - {Image: "alpine", Command: types.ShellCommand{"true"}}, + Name: "web", + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "alpine", Command: types.ShellCommand{"true"}}}, }, + ContainerSpec: types.ContainerSpec{Image: "alpine"}, } ctr := container.Summary{ID: "svc-ctr"} @@ -1153,11 +1167,11 @@ func TestPreStart_FailureStdoutOnlyTail(t *testing.T) { project := &types.Project{Name: "proj"} service := types.ServiceConfig{ - Name: "db", - Image: "postgres", - PreStart: []types.ServiceHook{ - {Image: "postgres", Command: types.ShellCommand{"migrate"}}, - }, + Name: "db", + + PreStart: []types.PreStartHook{ + {ContainerSpec: types.ContainerSpec{Image: "postgres", Command: types.ShellCommand{"migrate"}}}, + }, ContainerSpec: types.ContainerSpec{Image: "postgres"}, } ctr := container.Summary{ID: "svc-ctr"} diff --git a/pkg/compose/publish.go b/pkg/compose/publish.go index c1590089a51..21a30026a7e 100644 --- a/pkg/compose/publish.go +++ b/pkg/compose/publish.go @@ -322,7 +322,7 @@ func (s *composeService) generateImageDigestsOverride(ctx context.Context, proje } for name, service := range project.Services { override.Services[name] = types.ServiceConfig{ - Image: service.Image, + ContainerSpec: types.ContainerSpec{Image: service.Image}, } } return override.MarshalYAML() diff --git a/pkg/compose/publish_test.go b/pkg/compose/publish_test.go index c78808ac25d..4a8519c15bd 100644 --- a/pkg/compose/publish_test.go +++ b/pkg/compose/publish_test.go @@ -121,10 +121,11 @@ func Test_preChecks_sensitive_data_detected_decline(t *testing.T) { project := &types.Project{ Services: types.Services{ "web": { - Name: "web", - Image: "nginx", - EnvFiles: []types.EnvFile{ - {Path: envPath, Required: true}, + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "nginx", + EnvFiles: []types.EnvFile{ + {Path: envPath, Required: true}, + }, }, }, }, @@ -214,10 +215,11 @@ func Test_checkForSensitiveData_optional_env_file_missing(t *testing.T) { project := &types.Project{ Services: types.Services{ "web": { - Name: "web", - Image: "nginx", - EnvFiles: []types.EnvFile{ - {Path: filepath.Join(dir, "missing.env"), Required: false}, + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "nginx", + EnvFiles: []types.EnvFile{ + {Path: filepath.Join(dir, "missing.env"), Required: false}, + }, }, }, }, @@ -237,10 +239,11 @@ func Test_checkForSensitiveData_optional_env_file_present(t *testing.T) { project := &types.Project{ Services: types.Services{ "web": { - Name: "web", - Image: "nginx", - EnvFiles: []types.EnvFile{ - {Path: envPath, Required: false}, + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "nginx", + EnvFiles: []types.EnvFile{ + {Path: envPath, Required: false}, + }, }, }, }, @@ -257,10 +260,11 @@ func Test_checkForSensitiveData_required_env_file_missing(t *testing.T) { project := &types.Project{ Services: types.Services{ "web": { - Name: "web", - Image: "nginx", - EnvFiles: []types.EnvFile{ - {Path: filepath.Join(dir, "missing.env"), Required: true}, + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "nginx", + EnvFiles: []types.EnvFile{ + {Path: filepath.Join(dir, "missing.env"), Required: true}, + }, }, }, }, @@ -703,13 +707,14 @@ func Test_publish_decline_returns_ErrCanceled(t *testing.T) { project := &types.Project{ Services: types.Services{ "web": { - Name: "web", - Image: "nginx", - Volumes: []types.ServiceVolumeConfig{ - { - Type: types.VolumeTypeBind, - Source: "/host/path", - Target: "/container/path", + Name: "web", ContainerSpec: types.ContainerSpec{ + Image: "nginx", + Volumes: []types.ServiceVolumeConfig{ + { + Type: types.VolumeTypeBind, + Source: "/host/path", + Target: "/container/path", + }, }, }, }, @@ -747,11 +752,14 @@ func Test_generateImageDigestsOverride_resolvesDependentImages(t *testing.T) { Name: "test", Services: types.Services{ "app": types.ServiceConfig{ - Name: "app", - Image: "nginx:latest", - PreStart: []types.ServiceHook{{Image: "hookimage:latest"}}, - Volumes: []types.ServiceVolumeConfig{ - {Type: types.VolumeTypeImage, Source: "someimage:latest", Target: "/data"}, + Name: "app", + + PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Image: "hookimage:latest"}}}, ContainerSpec: types.ContainerSpec{ + Image: "nginx:latest", + + Volumes: []types.ServiceVolumeConfig{ + {Type: types.VolumeTypeImage, Source: "someimage:latest", Target: "/data"}, + }, }, }, }, diff --git a/pkg/compose/pull.go b/pkg/compose/pull.go index 08522930394..f6eb40155a9 100644 --- a/pkg/compose/pull.go +++ b/pkg/compose/pull.go @@ -182,7 +182,7 @@ func (p *imagePuller) pullHookImages(ctx context.Context) error { hookPolicy = types.PullPolicyMissing } for _, img := range api.GetDependentImages(service, p.project.Name) { - pullRequired, skipReason, err := shouldPullImage(types.ServiceConfig{Name: name, Image: img, PullPolicy: hookPolicy}, p.images) + pullRequired, skipReason, err := shouldPullImage(types.ServiceConfig{Name: name, ContainerSpec: types.ContainerSpec{Image: img, PullPolicy: hookPolicy}}, p.images) if err != nil { return err } @@ -196,7 +196,7 @@ func (p *imagePuller) pullHookImages(ctx context.Context) error { continue } p.scheduled[img] = name - hookService := types.ServiceConfig{Name: name, Image: img} + hookService := types.ServiceConfig{Name: name, ContainerSpec: types.ContainerSpec{Image: img}} p.eg.Go(func() error { err := p.pullServiceImage(ctx, hookService, p.opts.Quiet, p.project.Environment["DOCKER_DEFAULT_PLATFORM"]) if err != nil && !p.opts.IgnoreFailures { @@ -429,8 +429,8 @@ func (s *composeService) pullRequiredImages(ctx context.Context, project *types. // Hack: create a fake ServiceConfig so we pull missing volume image n := fmt.Sprintf("%s:volume %d", name, i) needPull[n] = types.ServiceConfig{ - Name: n, - Image: vol.Source, + Name: n, + ContainerSpec: types.ContainerSpec{Image: vol.Source}, } scheduled[vol.Source] = true } @@ -525,7 +525,7 @@ func addPreStartHookPulls(project *types.Project, images map[string]api.ImageSum hookPolicy = types.PullPolicyMissing } for i, img := range api.GetDependentImages(service, project.Name) { - pull, err := mustPull(types.ServiceConfig{Name: name, Image: img, PullPolicy: hookPolicy}, images) + pull, err := mustPull(types.ServiceConfig{Name: name, ContainerSpec: types.ContainerSpec{Image: img, PullPolicy: hookPolicy}}, images) if err != nil { return err } @@ -536,8 +536,8 @@ func addPreStartHookPulls(project *types.Project, images map[string]api.ImageSum // Hack: create a fake ServiceConfig so we pull missing pre_start hook image n := fmt.Sprintf("%s:pre_start %d", name, i) needPull[n] = types.ServiceConfig{ - Name: n, - Image: img, + Name: n, + ContainerSpec: types.ContainerSpec{Image: img}, } } } diff --git a/pkg/compose/pull_test.go b/pkg/compose/pull_test.go index 606ea175b5b..b0f62251326 100644 --- a/pkg/compose/pull_test.go +++ b/pkg/compose/pull_test.go @@ -64,10 +64,12 @@ func scheduledHookImages(t *testing.T, project *types.Project, present map[strin func serviceWithHook(name, img, policy string) types.ServiceConfig { return types.ServiceConfig{ - Name: name, - Image: img, - PullPolicy: policy, - PreStart: []types.ServiceHook{{Image: "init:latest"}}, + Name: name, + + PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Image: "init:latest"}}}, ContainerSpec: types.ContainerSpec{ + Image: img, + PullPolicy: policy, + }, } } @@ -166,8 +168,8 @@ func TestPullRequiredImagesUsesContentDigest(t *testing.T) { project := &types.Project{ Name: "demo", Services: types.Services{ - "web": {Name: "web", Image: ref}, - "pinned": {Name: "pinned", Image: ref, Platform: "linux/amd64"}, + "web": {Name: "web", ContainerSpec: types.ContainerSpec{Image: ref}}, + "pinned": {Name: "pinned", ContainerSpec: types.ContainerSpec{Image: ref, Platform: "linux/amd64"}}, }, } images := map[string]api.ImageSummary{} @@ -197,7 +199,7 @@ func TestShouldPullImage(t *testing.T) { "old:1": {LastTagTime: time.Now().Add(-48 * time.Hour)}, } svc := func(image, policy string) types.ServiceConfig { - return types.ServiceConfig{Name: "web", Image: image, PullPolicy: policy} + return types.ServiceConfig{Name: "web", ContainerSpec: types.ContainerSpec{Image: image, PullPolicy: policy}} } t.Run("no explicit policy always refreshes", func(t *testing.T) { @@ -286,9 +288,9 @@ func TestShouldPullImageProvider(t *testing.T) { images := map[string]api.ImageSummary{} pull, _, err := shouldPullImage(types.ServiceConfig{ - Name: "db", - Image: "db:1", - Provider: &types.ServiceProviderConfig{Type: "acme"}, + Name: "db", + + Provider: &types.ServiceProviderConfig{Type: "acme"}, ContainerSpec: types.ContainerSpec{Image: "db:1"}, }, images) assert.NilError(t, err) assert.Assert(t, pull, "provider service with a declared image must be pulled") diff --git a/pkg/compose/reconcile_test.go b/pkg/compose/reconcile_test.go index 8f58122669e..c266b613a2e 100644 --- a/pkg/compose/reconcile_test.go +++ b/pkg/compose/reconcile_test.go @@ -155,7 +155,7 @@ func networkAttachedContainer(t *testing.T, svc types.ServiceConfig, id string) // network is removed then recreated, and the same containers are reconnected — // not recreated. func TestReconcileNetworks_Diverged(t *testing.T) { - web := types.ServiceConfig{Name: "web", Scale: intPtr(1), Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}} + web := types.ServiceConfig{Name: "web", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}}} project := &types.Project{ Name: "myproject", Networks: types.Networks{"frontend": {Name: "myproject_frontend", Driver: "overlay"}}, @@ -188,7 +188,7 @@ func TestReconcileNetworks_Diverged(t *testing.T) { // recreated (by reconcileContainers), with the reconnect ordered before the old // container's removal so they don't race. func TestReconcileNetworks_DivergedAlsoRecreatesChangedContainer(t *testing.T) { - web := types.ServiceConfig{Name: "web", Scale: intPtr(1), Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}} + web := types.ServiceConfig{Name: "web", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}}} project := &types.Project{ Name: "myproject", Networks: types.Networks{"frontend": {Name: "myproject_frontend", Driver: "overlay"}}, @@ -231,14 +231,12 @@ func TestReconcileNetworks_DivergedMultipleServices(t *testing.T) { }, Services: types.Services{ "web": { - Name: "web", - Scale: intPtr(1), - Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}, + Name: "web", + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}}, }, "api": { - Name: "api", - Scale: intPtr(1), - Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}, + Name: "api", + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}}, }, }, } @@ -280,7 +278,7 @@ func TestReconcileNetworks_DivergedMultipleServices(t *testing.T) { // migration), so a network still in use by non-Compose containers cannot block a // rename. func TestReconcileNetworks_Renamed(t *testing.T) { - web := types.ServiceConfig{Name: "web", Scale: intPtr(1), Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}} + web := types.ServiceConfig{Name: "web", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Networks: map[string]*types.ServiceNetworkConfig{"frontend": {}}}} project := &types.Project{ Name: "myproject", Networks: types.Networks{"frontend": {Name: "myproject_frontend_v2", Driver: "overlay"}}, @@ -430,9 +428,8 @@ func divergedVolumeProject(t *testing.T, count, scale int) (*types.Project, *Obs for s := 0; s < count; s++ { name := fmt.Sprintf("db%d", s) svc := types.ServiceConfig{ - Name: name, - Scale: intPtr(scale), - Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}, + Name: name, + Scale: intPtr(scale), ContainerSpec: types.ContainerSpec{Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}}, } project.Services[name] = svc hash := mustServiceHash(t, svc) @@ -568,11 +565,10 @@ func TestReconcileVolumes_DivergedConfirmedSharedContainer(t *testing.T) { vol2 := types.VolumeConfig{Name: "myproject_data2", Driver: "local"} svc := types.ServiceConfig{ Name: "db", - Scale: intPtr(1), - Volumes: []types.ServiceVolumeConfig{ + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Volumes: []types.ServiceVolumeConfig{ {Source: "data1", Type: "volume"}, {Source: "data2", Type: "volume"}, - }, + }}, } project := &types.Project{ Name: "myproject", @@ -619,8 +615,8 @@ func TestReconcileVolumes_DivergedConfirmedSharedContainer(t *testing.T) { func TestReconcileVolumes_DivergedPartialConfirm(t *testing.T) { vol1 := types.VolumeConfig{Name: "myproject_data1", Driver: "local"} vol2 := types.VolumeConfig{Name: "myproject_data2", Driver: "local"} - svc1 := types.ServiceConfig{Name: "db1", Scale: intPtr(1), Volumes: []types.ServiceVolumeConfig{{Source: "data1", Type: "volume"}}} - svc2 := types.ServiceConfig{Name: "db2", Scale: intPtr(1), Volumes: []types.ServiceVolumeConfig{{Source: "data2", Type: "volume"}}} + svc1 := types.ServiceConfig{Name: "db1", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Volumes: []types.ServiceVolumeConfig{{Source: "data1", Type: "volume"}}}} + svc2 := types.ServiceConfig{Name: "db2", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Volumes: []types.ServiceVolumeConfig{{Source: "data2", Type: "volume"}}}} project := &types.Project{ Name: "myproject", Volumes: types.Volumes{"data1": vol1, "data2": vol2}, @@ -679,17 +675,22 @@ func TestReconcileVolumes_DivergedPartialConfirm(t *testing.T) { func TestReconcileVolumes_DivergedCascadesToDependent(t *testing.T) { vol := types.VolumeConfig{Name: "myproject_data", Driver: "local"} owner := types.ServiceConfig{ - Name: "owner", - Image: "alpine", - Scale: intPtr(1), - Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}, + Name: "owner", + + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{ + Image: "alpine", + + Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}, + }, } dependent := types.ServiceConfig{ - Name: "dependent", - Image: "alpine", - Scale: intPtr(1), - VolumesFrom: []string{"owner"}, - DependsOn: types.DependsOnConfig{"owner": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}}, + Name: "dependent", + + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{ + Image: "alpine", + + VolumesFrom: []string{"owner"}, + }, WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{"owner": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}}}, } project := &types.Project{ Name: "myproject", @@ -747,19 +748,24 @@ func TestReconcileVolumes_DivergedCascadesToDependent(t *testing.T) { func TestReconcileVolumes_DivergedVolumesFromRemovedBeforeVolume(t *testing.T) { vol := types.VolumeConfig{Name: "myproject_data", Driver: "local"} owner := types.ServiceConfig{ - Name: "owner", - Image: "alpine", - Scale: intPtr(1), - Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}, + Name: "owner", + + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{ + Image: "alpine", + + Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}, + }, } // consumer inherits owner's mounts (including data) but never declares the // volume itself. consumer := types.ServiceConfig{ - Name: "consumer", - Image: "alpine", - Scale: intPtr(1), - VolumesFrom: []string{"owner"}, - DependsOn: types.DependsOnConfig{"owner": {Condition: types.ServiceConditionStarted, Required: true}}, + Name: "consumer", + + Scale: intPtr(1), ContainerSpec: types.ContainerSpec{ + Image: "alpine", + + VolumesFrom: []string{"owner"}, + }, WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{"owner": {Condition: types.ServiceConditionStarted, Required: true}}}, } project := &types.Project{ Name: "myproject", @@ -830,7 +836,7 @@ func TestReconcileVolumes_UnmanagedMatchReused(t *testing.T) { Name: "myproject", Volumes: types.Volumes{"data": {Name: "myproject_data", Driver: "local"}}, Services: types.Services{ - "db": {Name: "db", Scale: intPtr(1), Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}}, + "db": {Name: "db", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}}}, }, } dbHash := mustServiceHash(t, project.Services["db"]) @@ -893,7 +899,7 @@ func TestReconcileVolumes_RenamedMigratesContainers(t *testing.T) { Name: "myproject", Volumes: types.Volumes{"data": {Name: "myproject_data_v2", Driver: "local"}}, Services: types.Services{ - "db": {Name: "db", Scale: intPtr(1), Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}}, + "db": {Name: "db", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Volumes: []types.ServiceVolumeConfig{{Source: "data", Type: "volume"}}}}, }, } dbHash := mustServiceHash(t, project.Services["db"]) @@ -1257,10 +1263,9 @@ func TestReconcileContainers_DependsOnChain(t *testing.T) { "db": {Name: "db", Scale: intPtr(1)}, "web": { Name: "web", - Scale: intPtr(1), - DependsOn: types.DependsOnConfig{ + Scale: intPtr(1), WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "db": {Condition: types.ServiceConditionStarted}, - }, + }}, }, }, } @@ -1295,10 +1300,9 @@ func TestReconcileContainers_DependsOnScaleDown(t *testing.T) { "db": svc, "web": { Name: "web", - Scale: intPtr(1), - DependsOn: types.DependsOnConfig{ + Scale: intPtr(1), WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "db": {Condition: types.ServiceConditionStarted}, - }, + }}, }, }, } @@ -1427,8 +1431,8 @@ func TestReconcileContainers_ServiceReference_NoRecreate(t *testing.T) { } for _, tc := range cases { t.Run(tc.name, func(t *testing.T) { - parent := types.ServiceConfig{Name: "parent", Image: "alpine", Scale: intPtr(1)} - dependent := types.ServiceConfig{Name: "dependent", Image: "alpine", Scale: intPtr(1)} + parent := types.ServiceConfig{Name: "parent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Image: "alpine"}} + dependent := types.ServiceConfig{Name: "dependent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Image: "alpine"}} tc.mutate(&dependent) project := &types.Project{ Name: "myproject", @@ -1449,10 +1453,11 @@ func TestReconcileContainers_ServiceReference_NoRecreate(t *testing.T) { // produces for namespace-sharing services, so planStopDependents fires too — // the test also asserts the resulting Stop is not duplicated. func TestReconcileContainers_NamespaceParentRecreated_CascadesToDependent(t *testing.T) { - parent := types.ServiceConfig{Name: "parent", Image: "alpine", Scale: intPtr(1)} + parent := types.ServiceConfig{Name: "parent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Image: "alpine"}} dependent := types.ServiceConfig{ - Name: "dependent", Image: "alpine", Scale: intPtr(1), NetworkMode: "service:parent", - DependsOn: types.DependsOnConfig{"parent": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}}, + Name: "dependent", Scale: intPtr(1), + ContainerSpec: types.ContainerSpec{Image: "alpine", NetworkMode: "service:parent"}, + WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{"parent": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}}}, } project := &types.Project{ Name: "myproject", @@ -1478,17 +1483,20 @@ func TestReconcileContainers_NamespaceParentRecreated_CascadesToDependent(t *tes // non-matching parent: a dependent sharing namespace with two parents must // cascade-recreate when either parent is scheduled for recreation. func TestReconcileContainers_MultipleParents_EitherTriggersCascade(t *testing.T) { - netParent := types.ServiceConfig{Name: "netparent", Image: "alpine", Scale: intPtr(1)} - volParent := types.ServiceConfig{Name: "volparent", Image: "alpine", Scale: intPtr(1)} + netParent := types.ServiceConfig{Name: "netparent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Image: "alpine"}} + volParent := types.ServiceConfig{Name: "volparent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Image: "alpine"}} dependent := types.ServiceConfig{ - Name: "dependent", Image: "alpine", Scale: intPtr(1), - NetworkMode: "service:netparent", - VolumesFrom: []string{"volparent"}, - // Mirrors what compose-go's normalizer injects for namespace-sharing - // references, so the dependency graph orders parents before dependent. - DependsOn: types.DependsOnConfig{ - "netparent": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}, - "volparent": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}, + Name: "dependent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{ + Image: "alpine", + NetworkMode: "service:netparent", + VolumesFrom: []string{"volparent"}, + }, WorkloadSpec: types.WorkloadSpec{ + // Mirrors what compose-go's normalizer injects for namespace-sharing + // references, so the dependency graph orders parents before dependent. + DependsOn: types.DependsOnConfig{ + "netparent": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}, + "volparent": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}, + }, }, } project := &types.Project{ @@ -1547,10 +1555,11 @@ func TestReconcileContainers_MultipleParents_EitherTriggersCascade(t *testing.T) // TestReconcileContainers_RegularDependsOn_NoCascade ensures the cascade fires // only for namespace/volume-sharing dependencies, not for plain depends_on. func TestReconcileContainers_RegularDependsOn_NoCascade(t *testing.T) { - parent := types.ServiceConfig{Name: "parent", Image: "alpine", Scale: intPtr(1)} + parent := types.ServiceConfig{Name: "parent", Scale: intPtr(1), ContainerSpec: types.ContainerSpec{Image: "alpine"}} dependent := types.ServiceConfig{ - Name: "dependent", Image: "alpine", Scale: intPtr(1), - DependsOn: types.DependsOnConfig{"parent": {Condition: types.ServiceConditionStarted, Restart: true}}, + Name: "dependent", Scale: intPtr(1), + ContainerSpec: types.ContainerSpec{Image: "alpine"}, + WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{"parent": {Condition: types.ServiceConditionStarted, Restart: true}}}, } project := &types.Project{ Name: "myproject", diff --git a/pkg/compose/restart_test.go b/pkg/compose/restart_test.go index d35dba7ca9c..5cf6696179e 100644 --- a/pkg/compose/restart_test.go +++ b/pkg/compose/restart_test.go @@ -51,16 +51,14 @@ func TestPrepareRestartProject(t *testing.T) { Name: "prj", Services: types.Services{ "proxy": { - Name: "proxy", - DependsOn: types.DependsOnConfig{ + Name: "proxy", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "web": {Condition: types.ServiceConditionStarted, Restart: true, Required: true}, - }, + }}, }, "web": { - Name: "web", - DependsOn: types.DependsOnConfig{ + Name: "web", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "db": {Condition: types.ServiceConditionStarted, Restart: false, Required: true}, - }, + }}, }, "db": {Name: "db"}, }, diff --git a/pkg/compose/start_test.go b/pkg/compose/start_test.go index 859aa274cc4..e75c6d30ee3 100644 --- a/pkg/compose/start_test.go +++ b/pkg/compose/start_test.go @@ -26,6 +26,7 @@ import ( "testing" "github.com/compose-spec/compose-go/v2/types" + "github.com/docker/cli/cli/config/configfile" "github.com/moby/moby/api/types/container" "github.com/moby/moby/client" "go.uber.org/mock/gomock" @@ -89,6 +90,10 @@ func newStartTestService(t *testing.T) (*composeService, *mocks.MockAPIClient, * apiClient.EXPECT().Ping(gomock.Any(), client.PingOptions{NegotiateAPIVersion: true}). Return(client.PingResult{APIVersion: "1.44"}, nil).AnyTimes() apiClient.EXPECT().ClientVersion().Return("1.44").AnyTimes() + // the generic pre_start inheritance goes through getCreateConfigs, which + // reads the CLI configuration and the daemon host + cli.EXPECT().ConfigFile().Return(&configfile.ConfigFile{}).AnyTimes() + apiClient.EXPECT().DaemonHost().Return("unix:///var/run/docker.sock").AnyTimes() rec := &recordingEventProcessor{} svc, err := NewComposeService(cli, WithEventProcessor(rec)) @@ -164,7 +169,7 @@ func TestStartService_StartsOnlyStoppedReplicas(t *testing.T) { project := &types.Project{Name: "prj"} service := types.ServiceConfig{ Name: "web", - PreStart: []types.ServiceHook{{Command: types.ShellCommand{"init"}}}, + PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Command: types.ShellCommand{"init"}}}}, } running := serviceContainer("web", 1, container.StateRunning) stopped := serviceContainer("web", 2, container.StateExited) @@ -194,11 +199,14 @@ func TestStartService_PreStartOnLowestReplica(t *testing.T) { project := &types.Project{Name: "prj"} service := types.ServiceConfig{ - Name: "web", - Image: "alpine", - PreStart: []types.ServiceHook{{Command: types.ShellCommand{"init"}}}, + Name: "web", + + PreStart: []types.PreStartHook{{ContainerSpec: types.ContainerSpec{Command: types.ShellCommand{"init"}}}}, ContainerSpec: + + // Listed out of order on purpose: replica 2 first. + types.ContainerSpec{Image: "alpine"}, } - // Listed out of order on purpose: replica 2 first. + replica2 := serviceContainer("web", 2, container.StateExited) replica1 := serviceContainer("web", 1, container.StateExited) containers := Containers{replica2, replica1} @@ -253,9 +261,9 @@ func TestStartServiceContainer_Order(t *testing.T) { }, } service := types.ServiceConfig{ - Name: "web", - Secrets: []types.ServiceSecretConfig{{Source: "token"}}, - PostStart: []types.ServiceHook{{Command: types.ShellCommand{"notify"}}}, + Name: "web", + + PostStart: []types.ServiceHook{{Command: types.ShellCommand{"notify"}}}, ContainerSpec: types.ContainerSpec{Secrets: []types.ServiceSecretConfig{{Source: "token"}}}, } ctr := serviceContainer("web", 1, container.StateExited) @@ -327,10 +335,9 @@ func TestStartServiceContainer_FailedPostStart(t *testing.T) { func TestGetDependencyCondition(t *testing.T) { oneShot := types.ServiceConfig{Name: "migrate"} web := types.ServiceConfig{ - Name: "web", - DependsOn: types.DependsOnConfig{ + Name: "web", WorkloadSpec: types.WorkloadSpec{DependsOn: types.DependsOnConfig{ "migrate": {Condition: types.ServiceConditionCompletedSuccessfully}, - }, + }}, } project := &types.Project{ Name: "prj", diff --git a/pkg/compose/viz_test.go b/pkg/compose/viz_test.go index 2ecbb5ab06f..85c58e2b2a3 100644 --- a/pkg/compose/viz_test.go +++ b/pkg/compose/viz_test.go @@ -35,9 +35,13 @@ func TestViz(t *testing.T) { WorkingDir: "/home", Services: types.Services{ "service1": { - Name: "service1", - Image: "image-for-service1", - Ports: []types.ServicePortConfig{ + Name: "service1", ContainerSpec: types.ContainerSpec{ + Image: "image-for-service1", + + Networks: map[string]*types.ServiceNetworkConfig{ + "internal": nil, + }, + }, WorkloadSpec: types.WorkloadSpec{Ports: []types.ServicePortConfig{ { Published: "80", Target: 80, @@ -48,51 +52,47 @@ func TestViz(t *testing.T) { Target: 533, Protocol: "udp", }, - }, - Networks: map[string]*types.ServiceNetworkConfig{ - "internal": nil, - }, + }}, }, "service2": { - Name: "service2", - Image: "image-for-service2", - Ports: []types.ServicePortConfig{}, + Name: "service2", ContainerSpec: types.ContainerSpec{Image: "image-for-service2"}, WorkloadSpec: types.WorkloadSpec{Ports: []types.ServicePortConfig{}}, }, "service3": { - Name: "service3", - Image: "some-image", - DependsOn: map[string]types.ServiceDependency{ + Name: "service3", ContainerSpec: types.ContainerSpec{Image: "some-image"}, WorkloadSpec: types.WorkloadSpec{DependsOn: map[string]types.ServiceDependency{ "service2": {}, "service1": {}, - }, + }}, }, "service4": { - Name: "service4", - Image: "another-image", - DependsOn: map[string]types.ServiceDependency{ - "service3": {}, - }, - Ports: []types.ServicePortConfig{ - { - Published: "8080", - Target: 80, + Name: "service4", ContainerSpec: types.ContainerSpec{ + Image: "another-image", + + Networks: map[string]*types.ServiceNetworkConfig{ + "external": nil, + }, + }, WorkloadSpec: types.WorkloadSpec{ + DependsOn: map[string]types.ServiceDependency{ + "service3": {}, + }, + Ports: []types.ServicePortConfig{ + { + Published: "8080", + Target: 80, + }, }, - }, - Networks: map[string]*types.ServiceNetworkConfig{ - "external": nil, }, }, "With host IP": { - Name: "With host IP", - Image: "user/image-name", - DependsOn: map[string]types.ServiceDependency{ - "service1": {}, - }, - Ports: []types.ServicePortConfig{ - { - Published: "8888", - Target: 8080, - HostIP: "127.0.0.1", + Name: "With host IP", ContainerSpec: types.ContainerSpec{Image: "user/image-name"}, WorkloadSpec: types.WorkloadSpec{ + DependsOn: map[string]types.ServiceDependency{ + "service1": {}, + }, + Ports: []types.ServicePortConfig{ + { + Published: "8888", + Target: 8080, + HostIP: "127.0.0.1", + }, }, }, }, diff --git a/pkg/compose/watch_test.go b/pkg/compose/watch_test.go index 04f8bf5a438..cf94a4dfae5 100644 --- a/pkg/compose/watch_test.go +++ b/pkg/compose/watch_test.go @@ -228,8 +228,7 @@ func TestInitialSyncFilesRegularFile(t *testing.T) { syncer := &fakeSyncer{synced: make(chan []*sync.PathMapping, 1)} err := (&composeService{}).initialSync(t.Context(), types.ServiceConfig{ - Name: "svc", - Build: &types.BuildConfig{Context: hostDir}, + Name: "svc", WorkloadSpec: types.WorkloadSpec{Build: &types.BuildConfig{Context: hostDir}}, }, types.Trigger{ Path: hostFile, Target: "/app/test.txt", diff --git a/pkg/e2e/compose_test.go b/pkg/e2e/compose_test.go index f0ff1da0707..444a0994074 100644 --- a/pkg/e2e/compose_test.go +++ b/pkg/e2e/compose_test.go @@ -201,11 +201,11 @@ func TestConfig(t *testing.T) { OutputContains(fmt.Sprintf(`name: %s services: nginx: + networks: + default: null build: context: %s dockerfile: Dockerfile - networks: - default: null networks: default: name: %s_default diff --git a/pkg/e2e/hooks_test.go b/pkg/e2e/hooks_test.go index 8d44de83801..550f0a6af04 100644 --- a/pkg/e2e/hooks_test.go +++ b/pkg/e2e/hooks_test.go @@ -207,3 +207,38 @@ func TestPreStartHookRunsOnceForScaledService(t *testing.T) { probeVolume(s, "wc", "-l", "/mnt/log"), OutputContains("1 /mnt/log")) } + +// A pre_start hook is a full container specification inheriting in the +// spirit of the yaml merge rules: collections complete the inherited value, +// the hook's declarations winning on conflicts (docker/compose#13939). +func TestPreStartHookExtraHosts(t *testing.T) { + NewScenario(t, "pre_start hooks must inherit the service's extra_hosts, completed by their own declarations"). + Step("up succeeds: both hooks asserted their /etc/hosts content", + ComposeCmd("up", "-d", "--wait").Within(60*time.Second), + ServiceState("app", "running")) +} + +// The init-container use case of docker/compose#13934: the hook redeclares a +// service volume read-write to prepare content the service mounts read-only. +func TestPreStartHookVolumes(t *testing.T) { + NewScenario(t, "a pre_start hook must write through its own read-write volume declaration while the service stays read-only"). + Step("up succeeds: the hook wrote through its rw mount", + ComposeCmd("up", "-d", "--wait").Within(60*time.Second)). + Step("the service reads what the hook prepared", + ComposeCmd("exec", "app", "cat", "/data/init.txt"), + OutputContains("initialized")). + Step("the service's own mount is still read-only", + ComposeCmd("exec", "app", "touch", "/data/blocked").MayFail(), + OutputContains("Read-only file system")) +} + +// Volumes merge by target: the hook keeps every service mount it did not +// redeclare (docker/compose#13934). +func TestPreStartHookVolumesMerge(t *testing.T) { + NewScenario(t, "a pre_start hook declaring a volume must still see the service's other mounts"). + Step("up succeeds: the hook read the inherited mount and wrote through its own", + ComposeCmd("up", "-d", "--wait").Within(60*time.Second)). + Step("the hook combined the inherited mount's content with its own write", + ComposeCmd("exec", "app", "cat", "/data/init.txt"), + OutputContains("saw-config")) +} diff --git a/pkg/e2e/jobs_test.go b/pkg/e2e/jobs_test.go new file mode 100644 index 00000000000..27ac94fe600 --- /dev/null +++ b/pkg/e2e/jobs_test.go @@ -0,0 +1,45 @@ +/* + 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 ( + "testing" +) + +// Scheduled jobs cannot run in this version: silently not scheduling them +// would break the user's expectations, so up must refuse the whole project. +func TestUpRejectsScheduledJobs(t *testing.T) { + NewScenario(t, "up must reject a project declaring active scheduled jobs, before creating anything"). + Step("up fails naming the scheduled job", + ComposeCmd("up", "-d").MayFail(), + StderrContains("scheduled jobs are not supported in this version: backup"), + ServiceNotCreated("web")) +} + +// A manual-trigger job runs through `compose run` exactly like a service +// would: its declared dependencies start first, its output and exit flow +// back. A schedule-only job stays out of reach. +func TestRunManualJob(t *testing.T) { + NewScenario(t, "run must execute a manual job like a service, starting its depends_on services first"). + Step("run executes the job after starting its dependency", + ComposeCmd("run", "--rm", "migrate"), + OutputContains("migration done"), + ServiceState("db", "running")). + Step("a schedule-only job cannot be run", + ComposeCmd("run", "--rm", "backup").MayFail(), + StderrContains(`job "backup" has no manual trigger`)) +} diff --git a/pkg/e2e/testdata/TestPreStartHookExtraHosts/compose.yaml b/pkg/e2e/testdata/TestPreStartHookExtraHosts/compose.yaml new file mode 100644 index 00000000000..ef78d6cdb12 --- /dev/null +++ b/pkg/e2e/testdata/TestPreStartHookExtraHosts/compose.yaml @@ -0,0 +1,21 @@ +services: + app: + image: alpine + init: true + command: sleep infinity + extra_hosts: + - "inherited-host:192.0.2.10" + - "shared-host:192.0.2.11" + pre_start: + # no extra_hosts declared: the service's entries are inherited + - command: sh -c 'grep inherited-host /etc/hosts' + # declared extra_hosts complete the inherited ones; entries for the + # same hostname accumulate, exactly like the compose file merge rules + - command: > + sh -c 'grep declared-host /etc/hosts && + grep inherited-host /etc/hosts && + grep "192.0.2.99.*shared-host" /etc/hosts && + grep "192.0.2.11.*shared-host" /etc/hosts' + extra_hosts: + - "declared-host:192.0.2.20" + - "shared-host:192.0.2.99" diff --git a/pkg/e2e/testdata/TestPreStartHookVolumes/compose.yaml b/pkg/e2e/testdata/TestPreStartHookVolumes/compose.yaml new file mode 100644 index 00000000000..26b0fd0370f --- /dev/null +++ b/pkg/e2e/testdata/TestPreStartHookVolumes/compose.yaml @@ -0,0 +1,15 @@ +services: + app: + image: alpine + init: true + command: sleep infinity + volumes: + - data:/data:ro + pre_start: + # the hook redeclares the volume read-write to prepare content the + # service will only ever read + - command: sh -c 'echo initialized > /data/init.txt' + volumes: + - data:/data:rw +volumes: + data: {} diff --git a/pkg/e2e/testdata/TestPreStartHookVolumesMerge/compose.yaml b/pkg/e2e/testdata/TestPreStartHookVolumesMerge/compose.yaml new file mode 100644 index 00000000000..2a48265b99c --- /dev/null +++ b/pkg/e2e/testdata/TestPreStartHookVolumesMerge/compose.yaml @@ -0,0 +1,17 @@ +services: + app: + image: alpine + init: true + command: sleep infinity + volumes: + - data:/data:ro + - config:/config:ro + pre_start: + # declares only /data read-write: /config must still be visible, + # inherited through volumes_from + - command: sh -c 'test -d /config && echo "saw-config" > /data/init.txt' + volumes: + - data:/data:rw +volumes: + data: {} + config: {} diff --git a/pkg/e2e/testdata/TestRunManualJob/compose.yaml b/pkg/e2e/testdata/TestRunManualJob/compose.yaml new file mode 100644 index 00000000000..675477855e4 --- /dev/null +++ b/pkg/e2e/testdata/TestRunManualJob/compose.yaml @@ -0,0 +1,20 @@ +services: + db: + image: alpine + init: true + command: sleep infinity +jobs: + migrate: + image: alpine + command: sh -c 'echo "migration done"' + triggers: + manual: true + depends_on: + db: + condition: service_started + backup: + image: alpine + command: echo backup + triggers: + schedule: + - cron: "0 3 * * *" diff --git a/pkg/e2e/testdata/TestUpRejectsScheduledJobs/compose.yaml b/pkg/e2e/testdata/TestUpRejectsScheduledJobs/compose.yaml new file mode 100644 index 00000000000..5efd658bb6d --- /dev/null +++ b/pkg/e2e/testdata/TestUpRejectsScheduledJobs/compose.yaml @@ -0,0 +1,12 @@ +services: + web: + image: alpine + init: true + command: sleep infinity +jobs: + backup: + image: alpine + command: echo backup + triggers: + schedule: + - cron: "0 3 * * *"