mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-26 18:27: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>
105 lines
3.5 KiB
Go
105 lines
3.5 KiB
Go
package containers
|
|
|
|
import (
|
|
"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/pkg/errors"
|
|
"github.com/sirupsen/logrus"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
cleanupDescription = `
|
|
podman container cleanup
|
|
|
|
Cleans up mount points and network stacks on one or more containers from the host. The container name or ID can be used. This command is used internally when running containers, but can also be used if container cleanup has failed when a container exits.
|
|
`
|
|
cleanupCommand = &cobra.Command{
|
|
Use: "cleanup [options] CONTAINER [CONTAINER...]",
|
|
Short: "Cleanup network and mountpoints of one or more containers",
|
|
Long: cleanupDescription,
|
|
RunE: cleanup,
|
|
Args: func(cmd *cobra.Command, args []string) error {
|
|
return validate.CheckAllLatestAndCIDFile(cmd, args, false, false)
|
|
},
|
|
ValidArgsFunction: common.AutocompleteContainersExited,
|
|
Example: `podman container cleanup --latest
|
|
podman container cleanup ctrID1 ctrID2 ctrID3
|
|
podman container cleanup --all`,
|
|
}
|
|
)
|
|
|
|
var (
|
|
cleanupOptions entities.ContainerCleanupOptions
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode},
|
|
Parent: containerCmd,
|
|
Command: cleanupCommand,
|
|
})
|
|
flags := cleanupCommand.Flags()
|
|
flags.BoolVarP(&cleanupOptions.All, "all", "a", false, "Cleans up all containers")
|
|
|
|
execFlagName := "exec"
|
|
flags.StringVar(&cleanupOptions.Exec, execFlagName, "", "Clean up the given exec session instead of the container")
|
|
_ = cleanupCommand.RegisterFlagCompletionFunc(execFlagName, completion.AutocompleteNone)
|
|
|
|
flags.BoolVar(&cleanupOptions.Remove, "rm", false, "After cleanup, remove the container entirely")
|
|
flags.BoolVar(&cleanupOptions.RemoveImage, "rmi", false, "After cleanup, remove the image entirely")
|
|
validate.AddLatestFlag(cleanupCommand, &cleanupOptions.Latest)
|
|
}
|
|
|
|
func cleanup(cmd *cobra.Command, args []string) error {
|
|
var (
|
|
errs utils.OutputErrors
|
|
)
|
|
|
|
if cleanupOptions.Exec != "" {
|
|
switch {
|
|
case cleanupOptions.All:
|
|
return errors.Errorf("exec and all options conflict")
|
|
case len(args) > 1:
|
|
return errors.Errorf("cannot use exec option when more than one container is given")
|
|
case cleanupOptions.RemoveImage:
|
|
return errors.Errorf("exec and rmi options conflict")
|
|
}
|
|
}
|
|
|
|
responses, err := registry.ContainerEngine().ContainerCleanup(registry.GetContext(), args, cleanupOptions)
|
|
if err != nil {
|
|
// `podman container cleanup` is almost always run in the
|
|
// background. Our only way of relaying information to the user
|
|
// is via syslog.
|
|
// As such, we need to logrus.Errorf our errors to ensure they
|
|
// are properly printed if --syslog is set.
|
|
logrus.Errorf("Error running container cleanup: %v", err)
|
|
return err
|
|
}
|
|
for _, r := range responses {
|
|
if r.CleanErr == nil && r.RmErr == nil && r.RmiErr == nil {
|
|
fmt.Println(r.Id)
|
|
continue
|
|
}
|
|
if r.RmErr != nil {
|
|
logrus.Errorf("Error removing container: %v", r.RmErr)
|
|
errs = append(errs, r.RmErr)
|
|
}
|
|
if r.RmiErr != nil {
|
|
logrus.Errorf("Error removing image: %v", r.RmiErr)
|
|
errs = append(errs, r.RmiErr)
|
|
}
|
|
if r.CleanErr != nil {
|
|
logrus.Errorf("Error cleaning up container: %v", r.CleanErr)
|
|
errs = append(errs, r.CleanErr)
|
|
}
|
|
}
|
|
return errs.PrintErrors()
|
|
}
|