mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-09-04 14:47:51 +00:00
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>
115 lines
3.3 KiB
Go
115 lines
3.3 KiB
Go
package containers
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
"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/libpod/define"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
waitDescription = `Block until one or more containers stop and then print their exit codes.
|
|
`
|
|
waitCommand = &cobra.Command{
|
|
Use: "wait [options] CONTAINER [CONTAINER...]",
|
|
Short: "Block on one or more containers",
|
|
Long: waitDescription,
|
|
RunE: wait,
|
|
ValidArgsFunction: common.AutocompleteContainers,
|
|
Example: `podman wait --interval 5s ctrID
|
|
podman wait ctrID1 ctrID2`,
|
|
}
|
|
|
|
containerWaitCommand = &cobra.Command{
|
|
Use: waitCommand.Use,
|
|
Short: waitCommand.Short,
|
|
Long: waitCommand.Long,
|
|
RunE: waitCommand.RunE,
|
|
ValidArgsFunction: waitCommand.ValidArgsFunction,
|
|
Example: `podman container wait --interval 5s ctrID
|
|
podman container wait ctrID1 ctrID2`,
|
|
}
|
|
)
|
|
|
|
var (
|
|
waitOptions = entities.WaitOptions{}
|
|
waitCondition string
|
|
waitInterval string
|
|
)
|
|
|
|
func waitFlags(cmd *cobra.Command) {
|
|
flags := cmd.Flags()
|
|
|
|
intervalFlagName := "interval"
|
|
flags.StringVarP(&waitInterval, intervalFlagName, "i", "250ns", "Time Interval to wait before polling for completion")
|
|
_ = cmd.RegisterFlagCompletionFunc(intervalFlagName, completion.AutocompleteNone)
|
|
|
|
conditionFlagName := "condition"
|
|
flags.StringVar(&waitCondition, conditionFlagName, "stopped", "Condition to wait on")
|
|
_ = cmd.RegisterFlagCompletionFunc(conditionFlagName, common.AutocompleteWaitCondition)
|
|
|
|
}
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: waitCommand,
|
|
})
|
|
waitFlags(waitCommand)
|
|
validate.AddLatestFlag(waitCommand, &waitOptions.Latest)
|
|
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: containerWaitCommand,
|
|
Parent: containerCmd,
|
|
})
|
|
waitFlags(containerWaitCommand)
|
|
validate.AddLatestFlag(containerWaitCommand, &waitOptions.Latest)
|
|
}
|
|
|
|
func wait(cmd *cobra.Command, args []string) error {
|
|
var (
|
|
err error
|
|
errs utils.OutputErrors
|
|
)
|
|
if waitOptions.Interval, err = time.ParseDuration(waitInterval); err != nil {
|
|
var err1 error
|
|
if waitOptions.Interval, err1 = time.ParseDuration(waitInterval + "ms"); err1 != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if !waitOptions.Latest && len(args) == 0 {
|
|
return errors.Errorf("%q requires a name, id, or the \"--latest\" flag", cmd.CommandPath())
|
|
}
|
|
if waitOptions.Latest && len(args) > 0 {
|
|
return errors.New("--latest and containers cannot be used together")
|
|
}
|
|
|
|
waitOptions.Condition, err = define.StringToContainerStatus(waitCondition)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
responses, err := registry.ContainerEngine().ContainerWait(context.Background(), args, waitOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, r := range responses {
|
|
if r.Error == nil {
|
|
fmt.Println(r.ExitCode)
|
|
} else {
|
|
errs = append(errs, r.Error)
|
|
}
|
|
}
|
|
return errs.PrintErrors()
|
|
}
|