mirror of
https://github.com/docker/compose.git
synced 2026-11-19 14:40:08 +00:00
fix(config): skip pure resource provider services in config --images
A provider service declaring neither image: nor build: has no image reference to list, yet config --images printed the <project>-<service> name GetImageNameOrDefault fabricates: a reference that is never built and never pulled, while the image phase of up and pull already skips such services. Consumers feeding `compose config --images` output to a registry would try to pull an image that does not exist. Mirror the pure-resource provider guard of pkg/compose/provider_images.go. Signed-off-by: Aucoto <tdnorthgarden@gmail.com>
This commit is contained in:
parent
c43a22c6ac
commit
96a9194acd
2 changed files with 85 additions and 1 deletions
|
|
@ -693,7 +693,11 @@ func runConfigImages(ctx context.Context, dockerCli command.Cli, opts configOpti
|
|||
}
|
||||
|
||||
for _, s := range project.Services {
|
||||
_, _ = fmt.Fprintln(dockerCli.Out(), api.GetImageNameOrDefault(s, project.Name))
|
||||
// pure resource provider: no image reference to list
|
||||
pure := s.Provider != nil && s.Image == "" && s.Build == nil
|
||||
if !pure {
|
||||
_, _ = fmt.Fprintln(dockerCli.Out(), api.GetImageNameOrDefault(s, project.Name))
|
||||
}
|
||||
for _, img := range api.GetDependentImages(s, project.Name) {
|
||||
_, _ = fmt.Fprintln(dockerCli.Out(), img)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -17,11 +17,15 @@
|
|||
package compose
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/compose-spec/compose-go/v2/types"
|
||||
"github.com/docker/cli/cli/config/configfile"
|
||||
"github.com/docker/cli/cli/streams"
|
||||
"github.com/moby/moby/api/types/registry"
|
||||
"github.com/moby/moby/client"
|
||||
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
|
||||
|
|
@ -307,3 +311,79 @@ func TestLockModel(t *testing.T) {
|
|||
},
|
||||
})
|
||||
}
|
||||
|
||||
// TestRunConfigImagesPureResourceProvider pins the shape of the
|
||||
// pure-resource provider guard of the pull path
|
||||
// (pkg/compose/provider_images.go): only a provider service declaring
|
||||
// neither image: nor build: has no main image to list — the
|
||||
// GetImageNameOrDefault fallback would fabricate a "<project>-<service>"
|
||||
// reference — while its pre_start hook images must stay listed, as pull
|
||||
// still pulls them.
|
||||
func TestRunConfigImagesPureResourceProvider(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
yaml string
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "pure resource provider lists only its hook images",
|
||||
yaml: `
|
||||
name: edgecase
|
||||
services:
|
||||
db:
|
||||
provider:
|
||||
type: awesomecloud
|
||||
pre_start:
|
||||
- image: busybox:1.36.1
|
||||
`,
|
||||
want: "busybox:1.36.1\n",
|
||||
},
|
||||
{
|
||||
name: "provider with an image lists it",
|
||||
yaml: `
|
||||
name: edgecase
|
||||
services:
|
||||
db:
|
||||
provider:
|
||||
type: awesomecloud
|
||||
image: redis
|
||||
`,
|
||||
want: "redis\n",
|
||||
},
|
||||
{
|
||||
name: "provider with a build lists the built image tag",
|
||||
yaml: `
|
||||
name: edgecase
|
||||
services:
|
||||
db:
|
||||
provider:
|
||||
type: awesomecloud
|
||||
build:
|
||||
context: .
|
||||
`,
|
||||
want: "edgecase-db\n",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctrl := gomock.NewController(t)
|
||||
defer ctrl.Finish()
|
||||
|
||||
dir := t.TempDir()
|
||||
composePath := filepath.Join(dir, "compose.yaml")
|
||||
assert.NilError(t, os.WriteFile(composePath, []byte(tt.yaml), 0o600))
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
cli := mocks.NewMockCli(ctrl)
|
||||
cli.EXPECT().Out().Return(streams.NewOut(buf)).AnyTimes()
|
||||
|
||||
opts := configOptions{
|
||||
ProjectOptions: &ProjectOptions{
|
||||
ConfigPaths: []string{composePath},
|
||||
},
|
||||
}
|
||||
assert.NilError(t, runConfigImages(t.Context(), cli, opts, nil))
|
||||
assert.Equal(t, buf.String(), tt.want)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue