mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-09-02 13:48:00 +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>
105 lines
3.1 KiB
Go
105 lines
3.1 KiB
Go
package containers
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"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/containers/podman/v2/pkg/signal"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
killDescription = "The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal."
|
|
killCommand = &cobra.Command{
|
|
Use: "kill [options] CONTAINER [CONTAINER...]",
|
|
Short: "Kill one or more running containers with a specific signal",
|
|
Long: killDescription,
|
|
RunE: kill,
|
|
Args: func(cmd *cobra.Command, args []string) error {
|
|
return validate.CheckAllLatestAndCIDFile(cmd, args, false, false)
|
|
},
|
|
ValidArgsFunction: common.AutocompleteContainersRunning,
|
|
Example: `podman kill mywebserver
|
|
podman kill 860a4b23
|
|
podman kill --signal TERM ctrID`,
|
|
}
|
|
|
|
containerKillCommand = &cobra.Command{
|
|
Args: func(cmd *cobra.Command, args []string) error {
|
|
return validate.CheckAllLatestAndCIDFile(cmd, args, false, false)
|
|
},
|
|
Use: killCommand.Use,
|
|
Short: killCommand.Short,
|
|
Long: killCommand.Long,
|
|
RunE: killCommand.RunE,
|
|
ValidArgsFunction: killCommand.ValidArgsFunction,
|
|
Example: `podman container kill mywebserver
|
|
podman container kill 860a4b23
|
|
podman container kill --signal TERM ctrID`,
|
|
}
|
|
)
|
|
|
|
var (
|
|
killOptions = entities.KillOptions{}
|
|
)
|
|
|
|
func killFlags(cmd *cobra.Command) {
|
|
flags := cmd.Flags()
|
|
|
|
flags.BoolVarP(&killOptions.All, "all", "a", false, "Signal all running containers")
|
|
|
|
signalFlagName := "signal"
|
|
flags.StringVarP(&killOptions.Signal, signalFlagName, "s", "KILL", "Signal to send to the container")
|
|
_ = cmd.RegisterFlagCompletionFunc(signalFlagName, common.AutocompleteStopSignal)
|
|
}
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: killCommand,
|
|
})
|
|
killFlags(killCommand)
|
|
validate.AddLatestFlag(killCommand, &killOptions.Latest)
|
|
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: containerKillCommand,
|
|
Parent: containerCmd,
|
|
})
|
|
killFlags(containerKillCommand)
|
|
validate.AddLatestFlag(containerKillCommand, &killOptions.Latest)
|
|
}
|
|
|
|
func kill(_ *cobra.Command, args []string) error {
|
|
var (
|
|
err error
|
|
errs utils.OutputErrors
|
|
)
|
|
// Check if the signalString provided by the user is valid
|
|
// Invalid signals will return err
|
|
sig, err := signal.ParseSignalNameOrNumber(killOptions.Signal)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if sig < 1 || sig > 64 {
|
|
return errors.New("valid signals are 1 through 64")
|
|
}
|
|
responses, err := registry.ContainerEngine().ContainerKill(context.Background(), args, killOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, r := range responses {
|
|
if r.Err == nil {
|
|
fmt.Println(r.Id)
|
|
} else {
|
|
errs = append(errs, r.Err)
|
|
}
|
|
}
|
|
return errs.PrintErrors()
|
|
}
|