mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-26 18:27:53 +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>
90 lines
2.1 KiB
Go
90 lines
2.1 KiB
Go
package connection
|
|
|
|
import (
|
|
"os"
|
|
"text/tabwriter"
|
|
"text/template"
|
|
|
|
"github.com/containers/common/pkg/completion"
|
|
"github.com/containers/common/pkg/config"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/cmd/podman/system"
|
|
"github.com/containers/podman/v2/cmd/podman/validate"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
listCmd = &cobra.Command{
|
|
Use: "list",
|
|
Aliases: []string{"ls"},
|
|
Args: validate.NoArgs,
|
|
Short: "List destination for the Podman service(s)",
|
|
Long: `List destination information for the Podman service(s) in podman configuration`,
|
|
DisableFlagsInUseLine: true,
|
|
Example: `podman system connection list
|
|
podman system connection ls`,
|
|
ValidArgsFunction: completion.AutocompleteNone,
|
|
RunE: list,
|
|
TraverseChildren: false,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: listCmd,
|
|
Parent: system.ConnectionCmd,
|
|
})
|
|
}
|
|
|
|
type namedDestination struct {
|
|
Name string
|
|
config.Destination
|
|
}
|
|
|
|
func list(_ *cobra.Command, _ []string) error {
|
|
cfg, err := config.ReadCustomConfig()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if len(cfg.Engine.ServiceDestinations) == 0 {
|
|
return nil
|
|
}
|
|
|
|
hdrs := []map[string]string{{
|
|
"Identity": "Identity",
|
|
"Name": "Name",
|
|
"URI": "URI",
|
|
}}
|
|
|
|
rows := make([]namedDestination, 0)
|
|
for k, v := range cfg.Engine.ServiceDestinations {
|
|
if k == cfg.Engine.ActiveService {
|
|
k += "*"
|
|
}
|
|
|
|
r := namedDestination{
|
|
Name: k,
|
|
Destination: config.Destination{
|
|
Identity: v.Identity,
|
|
URI: v.URI,
|
|
},
|
|
}
|
|
rows = append(rows, r)
|
|
}
|
|
|
|
// TODO: Allow user to override format
|
|
format := "{{range . }}{{.Name}}\t{{.Identity}}\t{{.URI}}\n{{end}}"
|
|
tmpl, err := template.New("connection").Parse(format)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
w := tabwriter.NewWriter(os.Stdout, 8, 2, 2, ' ', 0)
|
|
defer w.Flush()
|
|
|
|
_ = tmpl.Execute(w, hdrs)
|
|
return tmpl.Execute(w, rows)
|
|
}
|