mirror of
https://github.com/docker/compose.git
synced 2026-11-20 06:59:53 +00:00
Compose silently ignored several spec-valid attributes it doesn't honor outside Swarm mode: deploy.update_config, credential_spec, ports[].mode: host, and others had no visible effect on a plain `docker compose up`. Detection is wired into compose-go's loader as a fail-closed allowlist: every attribute path the schema declares, minus the handful this runtime deliberately doesn't implement, plus a few value-conditional checks for attributes only unsupported for one specific value. A newly-specified attribute gets flagged automatically, with no corresponding code change needed here. Depends on an unreleased compose-go change; go.mod carries a temporary replace to a fork branch until it's released. Signed-off-by: Guillaume Lours <glours@users.noreply.github.com>
124 lines
4.3 KiB
Go
124 lines
4.3 KiB
Go
/*
|
|
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 (
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/compose-spec/compose-go/v2/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/docker/compose/v5/pkg/api"
|
|
"github.com/docker/compose/v5/pkg/compose"
|
|
)
|
|
|
|
// validArgsFn defines a completion func to be returned to fetch completion options
|
|
type validArgsFn func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
|
|
|
|
func noCompletion() validArgsFn {
|
|
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
return []string{}, cobra.ShellCompDirectiveNoSpace
|
|
}
|
|
}
|
|
|
|
func completeServiceNames(dockerCli command.Cli, p *ProjectOptions) validArgsFn {
|
|
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
p.Offline = true
|
|
backend, err := compose.NewComposeService(dockerCli)
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
|
|
// only service names are needed, so skip environment resolution: a missing
|
|
// env_file must not prevent completion
|
|
project, _, err := p.ToProject(cmd.Context(), dockerCli, backend, nil, skipUnsupportedAttributesWarning, cli.WithoutEnvironmentResolution)
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
var values []string
|
|
serviceNames := append(project.ServiceNames(), project.DisabledServiceNames()...)
|
|
for _, s := range serviceNames {
|
|
if toComplete == "" || strings.HasPrefix(s, toComplete) {
|
|
values = append(values, s)
|
|
}
|
|
}
|
|
return values, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
}
|
|
|
|
func completeProjectNames(dockerCli command.Cli, backendOptions *BackendOptions) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
backend, err := compose.NewComposeService(dockerCli, backendOptions.Options...)
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveError
|
|
}
|
|
|
|
list, err := backend.List(cmd.Context(), api.ListOptions{
|
|
All: true,
|
|
})
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveError
|
|
}
|
|
var values []string
|
|
for _, stack := range list {
|
|
if strings.HasPrefix(stack.Name, toComplete) {
|
|
values = append(values, stack.Name)
|
|
}
|
|
}
|
|
return values, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
}
|
|
|
|
func completeProfileNames(dockerCli command.Cli, p *ProjectOptions) validArgsFn {
|
|
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
p.Offline = true
|
|
backend, err := compose.NewComposeService(dockerCli)
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
|
|
// only profile names are needed, so skip environment resolution: a missing
|
|
// env_file must not prevent completion
|
|
project, _, err := p.ToProject(cmd.Context(), dockerCli, backend, nil, skipUnsupportedAttributesWarning, cli.WithoutEnvironmentResolution)
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
|
|
allProfileNames := project.AllServices().GetProfiles()
|
|
sort.Strings(allProfileNames)
|
|
|
|
var values []string
|
|
for _, profileName := range allProfileNames {
|
|
if strings.HasPrefix(profileName, toComplete) {
|
|
values = append(values, profileName)
|
|
}
|
|
}
|
|
return values, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
}
|
|
|
|
func completeScaleArgs(dockerCli command.Cli, p *ProjectOptions) cobra.CompletionFunc {
|
|
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
completions, directive := completeServiceNames(dockerCli, p)(cmd, args, toComplete)
|
|
for i, completion := range completions {
|
|
completions[i] = completion + "="
|
|
}
|
|
return completions, directive
|
|
}
|
|
}
|