mirror of
https://github.com/docker/compose.git
synced 2026-11-17 05:36:08 +00:00
Inline small functions that were extracted from their single call site without a real boundary to justify it — no reuse, no dedicated test, no responsibility of their own — so each caller now tells its whole story top-down: - getExecTarget, attachContainer, logContainer: one-line trampolines to getSpecifiedContainer / doAttachContainer / doLogContainer, which other call sites already use directly - removeImage: single-statement wrapper, unlike its removeVolume sibling which has actual logic - checkSelectedServices: named like a validation, actually a filter; the subtle rule (an unknown service is only an error with an explicit compose file) now reads where options.Services is rewritten - prepareLabels: mutated the map it received while looking pure at the call site; the label writes are now visible in getCreateConfigs - setDefaultTarget: mutation-by-pointer of the loop copy, now visible in the loop of injectFileReferences - buildVolumeOptions/buildTmpfsOptions/buildImageOptions: nil-guard + field copies; the buildMountOptions switch now shows side by side what each mount type propagates (buildBindOption keeps real logic and keeps buildMountOptions under the gocyclo limit) - displayDryRunBuildEvent: was longer than its only caller - hasMore: read like a predicate, was a one-line spinner restart - escapeDollarSign: wrapped a single bytes.ReplaceAll - extractEnvCLIDefined: replaced by the canonical compose-go helper types.NewMappingWithEquals().ToMapping(), as run.go already does - isPullPolicyValid: rebuilt the valid-values slice on every call; now a package-level list checked at the call site - viewFromStackList: projection now sits next to the render closure that consumes exactly its three fields No behavior change; single gocyclo threshold untouched. Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
140 lines
3.6 KiB
Go
140 lines
3.6 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 (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"regexp"
|
|
"strings"
|
|
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/opts"
|
|
"github.com/moby/moby/client"
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/docker/compose/v5/cmd/formatter"
|
|
"github.com/docker/compose/v5/pkg/api"
|
|
"github.com/docker/compose/v5/pkg/compose"
|
|
)
|
|
|
|
type lsOptions struct {
|
|
Format string
|
|
Quiet bool
|
|
All bool
|
|
Filter opts.FilterOpt
|
|
}
|
|
|
|
func listCommand(dockerCli command.Cli, backendOptions *BackendOptions) *cobra.Command {
|
|
lsOpts := lsOptions{Filter: opts.NewFilterOpt()}
|
|
lsCmd := &cobra.Command{
|
|
Use: "ls [OPTIONS]",
|
|
Short: "List running compose projects",
|
|
RunE: Adapt(func(ctx context.Context, args []string) error {
|
|
return runList(ctx, dockerCli, backendOptions, lsOpts)
|
|
}),
|
|
Args: cobra.NoArgs,
|
|
ValidArgsFunction: noCompletion(),
|
|
}
|
|
lsCmd.Flags().StringVar(&lsOpts.Format, "format", "table", "Format the output. Values: [table | json]")
|
|
lsCmd.Flags().BoolVarP(&lsOpts.Quiet, "quiet", "q", false, "Only display project names")
|
|
lsCmd.Flags().Var(&lsOpts.Filter, "filter", "Filter output based on conditions provided")
|
|
lsCmd.Flags().BoolVarP(&lsOpts.All, "all", "a", false, "Show all stopped Compose projects")
|
|
|
|
return lsCmd
|
|
}
|
|
|
|
var acceptedListFilters = map[string]bool{
|
|
"name": true,
|
|
}
|
|
|
|
// match returns true if any of the values at key match the source string
|
|
func match(filters client.Filters, field, source string) bool {
|
|
if f, ok := filters[field]; ok && f[source] {
|
|
return true
|
|
}
|
|
|
|
fieldValues := filters[field]
|
|
for name2match := range fieldValues {
|
|
isMatch, err := regexp.MatchString(name2match, source)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
if isMatch {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func runList(ctx context.Context, dockerCli command.Cli, backendOptions *BackendOptions, lsOpts lsOptions) error {
|
|
filters := lsOpts.Filter.Value()
|
|
|
|
for filter := range filters {
|
|
if _, ok := acceptedListFilters[filter]; !ok {
|
|
return errors.New("invalid filter '" + filter + "'")
|
|
}
|
|
}
|
|
|
|
backend, err := compose.NewComposeService(dockerCli, backendOptions.Options...)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
stackList, err := backend.List(ctx, api.ListOptions{All: lsOpts.All})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if len(filters) > 0 {
|
|
var filtered []api.Stack
|
|
for _, s := range stackList {
|
|
if match(filters, "name", s.Name) {
|
|
filtered = append(filtered, s)
|
|
}
|
|
}
|
|
stackList = filtered
|
|
}
|
|
|
|
if lsOpts.Quiet {
|
|
for _, s := range stackList {
|
|
_, _ = fmt.Fprintln(dockerCli.Out(), s.Name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
view := make([]stackView, len(stackList))
|
|
for i, s := range stackList {
|
|
view[i] = stackView{
|
|
Name: s.Name,
|
|
Status: strings.TrimSpace(s.Status + " " + s.Reason),
|
|
ConfigFiles: s.ConfigFiles,
|
|
}
|
|
}
|
|
return formatter.Print(view, lsOpts.Format, dockerCli.Out(), func(w io.Writer) {
|
|
for _, stack := range view {
|
|
_, _ = fmt.Fprintf(w, "%s\t%s\t%s\n", stack.Name, stack.Status, stack.ConfigFiles)
|
|
}
|
|
}, "NAME", "STATUS", "CONFIG FILES")
|
|
}
|
|
|
|
type stackView struct {
|
|
Name string
|
|
Status string
|
|
ConfigFiles string
|
|
}
|