mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-26 10:17:53 +00:00
b5d1d89a37
Allow automatic generation for shell completion scripts with the internal cobra functions (requires v1.0.0+). This should replace the handwritten completion scripts and even adds support for fish. With this approach it is less likley that completions and code are out of sync. We can now create the scripts with - podman completion bash - podman completion zsh - podman completion fish To test the completion run: source <(podman completion bash) The same works for podman-remote and podman --remote and it will complete your remote containers/images with the correct endpoints values from --url/--connection. The completion logic is written in go and provided by the cobra library. The completion functions lives in `cmd/podman/completion/completion.go`. The unit test at cmd/podman/shell_completion_test.go checks if each command and flag has an autocompletion function set. This prevents that commands and flags have no shell completion set. This commit does not replace the current autocompletion scripts. Closes #6440 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
101 lines
2.9 KiB
Go
101 lines
2.9 KiB
Go
package pods
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/containers/common/pkg/completion"
|
|
"github.com/containers/podman/v2/cmd/podman/common"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/cmd/podman/utils"
|
|
"github.com/containers/podman/v2/cmd/podman/validate"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// allows for splitting API and CLI-only options
|
|
type podStopOptionsWrapper struct {
|
|
entities.PodStopOptions
|
|
|
|
PodIDFiles []string
|
|
TimeoutCLI uint
|
|
}
|
|
|
|
var (
|
|
stopOptions = podStopOptionsWrapper{
|
|
PodStopOptions: entities.PodStopOptions{Timeout: -1},
|
|
}
|
|
podStopDescription = `The pod name or ID can be used.
|
|
|
|
This command will stop all running containers in each of the specified pods.`
|
|
|
|
stopCommand = &cobra.Command{
|
|
Use: "stop [options] POD [POD...]",
|
|
Short: "Stop one or more pods",
|
|
Long: podStopDescription,
|
|
RunE: stop,
|
|
Args: func(cmd *cobra.Command, args []string) error {
|
|
return validate.CheckAllLatestAndPodIDFile(cmd, args, false, true)
|
|
},
|
|
ValidArgsFunction: common.AutocompletePodsRunning,
|
|
Example: `podman pod stop mywebserverpod
|
|
podman pod stop --latest
|
|
podman pod stop --time 0 490eb 3557fb`,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: stopCommand,
|
|
Parent: podCmd,
|
|
})
|
|
flags := stopCommand.Flags()
|
|
flags.BoolVarP(&stopOptions.All, "all", "a", false, "Stop all running pods")
|
|
flags.BoolVarP(&stopOptions.Ignore, "ignore", "i", false, "Ignore errors when a specified pod is missing")
|
|
|
|
timeFlagName := "time"
|
|
flags.UintVarP(&stopOptions.TimeoutCLI, timeFlagName, "t", containerConfig.Engine.StopTimeout, "Seconds to wait for pod stop before killing the container")
|
|
_ = stopCommand.RegisterFlagCompletionFunc(timeFlagName, completion.AutocompleteNone)
|
|
|
|
podIDFileFlagName := "pod-id-file"
|
|
flags.StringArrayVarP(&stopOptions.PodIDFiles, podIDFileFlagName, "", nil, "Write the pod ID to the file")
|
|
_ = stopCommand.RegisterFlagCompletionFunc(podIDFileFlagName, completion.AutocompleteDefault)
|
|
|
|
validate.AddLatestFlag(stopCommand, &stopOptions.Latest)
|
|
|
|
if registry.IsRemote() {
|
|
_ = flags.MarkHidden("ignore")
|
|
}
|
|
|
|
flags.SetNormalizeFunc(utils.AliasFlags)
|
|
}
|
|
|
|
func stop(cmd *cobra.Command, args []string) error {
|
|
var (
|
|
errs utils.OutputErrors
|
|
)
|
|
if cmd.Flag("time").Changed {
|
|
stopOptions.Timeout = int(stopOptions.TimeoutCLI)
|
|
}
|
|
|
|
ids, err := common.ReadPodIDFiles(stopOptions.PodIDFiles)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
args = append(args, ids...)
|
|
|
|
responses, err := registry.ContainerEngine().PodStop(context.Background(), args, stopOptions.PodStopOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// in the cli, first we print out all the successful attempts
|
|
for _, r := range responses {
|
|
if len(r.Errs) == 0 {
|
|
fmt.Println(r.Id)
|
|
} else {
|
|
errs = append(errs, r.Errs...)
|
|
}
|
|
}
|
|
return errs.PrintErrors()
|
|
}
|