summaryrefslogtreecommitdiff
path: root/cmd/podman/common/netflags.go
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2020-05-31 17:35:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2020-11-12 11:38:31 +0100
commitb5d1d89a377e38762a75c2042dcc50a370ba6707 (patch)
treeeebedb62f7aeeb17cd6fdbe9317a59effd02e96d /cmd/podman/common/netflags.go
parentdf4bf5c584f264bdefef5cb30d85c036260eff8f (diff)
downloadpodman-b5d1d89a377e38762a75c2042dcc50a370ba6707.tar.gz
podman-b5d1d89a377e38762a75c2042dcc50a370ba6707.tar.bz2
podman-b5d1d89a377e38762a75c2042dcc50a370ba6707.zip
Add shell completion with cobra
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>
Diffstat (limited to 'cmd/podman/common/netflags.go')
-rw-r--r--cmd/podman/common/netflags.go53
1 files changed, 40 insertions, 13 deletions
diff --git a/cmd/podman/common/netflags.go b/cmd/podman/common/netflags.go
index 935a5f7b9..cae52ccaa 100644
--- a/cmd/podman/common/netflags.go
+++ b/cmd/podman/common/netflags.go
@@ -4,58 +4,85 @@ import (
"net"
"strings"
+ "github.com/containers/common/pkg/completion"
"github.com/containers/podman/v2/cmd/podman/parse"
"github.com/containers/podman/v2/libpod/define"
"github.com/containers/podman/v2/pkg/domain/entities"
"github.com/containers/podman/v2/pkg/specgen"
"github.com/pkg/errors"
"github.com/spf13/cobra"
- "github.com/spf13/pflag"
)
-func GetNetFlags() *pflag.FlagSet {
- netFlags := pflag.FlagSet{}
+func DefineNetFlags(cmd *cobra.Command) {
+ netFlags := cmd.Flags()
+
+ addHostFlagName := "add-host"
netFlags.StringSlice(
- "add-host", []string{},
+ addHostFlagName, []string{},
"Add a custom host-to-IP mapping (host:ip) (default [])",
)
+ _ = cmd.RegisterFlagCompletionFunc(addHostFlagName, completion.AutocompleteNone)
+
+ dnsFlagName := "dns"
netFlags.StringSlice(
- "dns", containerConfig.DNSServers(),
+ dnsFlagName, containerConfig.DNSServers(),
"Set custom DNS servers",
)
+ _ = cmd.RegisterFlagCompletionFunc(dnsFlagName, completion.AutocompleteNone)
+
+ dnsOptFlagName := "dns-opt"
netFlags.StringSlice(
- "dns-opt", containerConfig.DNSOptions(),
+ dnsOptFlagName, containerConfig.DNSOptions(),
"Set custom DNS options",
)
+ _ = cmd.RegisterFlagCompletionFunc(dnsOptFlagName, completion.AutocompleteNone)
+
+ dnsSearchFlagName := "dns-search"
netFlags.StringSlice(
- "dns-search", containerConfig.DNSSearches(),
+ dnsSearchFlagName, containerConfig.DNSSearches(),
"Set custom DNS search domains",
)
+ _ = cmd.RegisterFlagCompletionFunc(dnsSearchFlagName, completion.AutocompleteNone)
+
+ ipFlagName := "ip"
netFlags.String(
- "ip", "",
+ ipFlagName, "",
"Specify a static IPv4 address for the container",
)
+ _ = cmd.RegisterFlagCompletionFunc(ipFlagName, completion.AutocompleteNone)
+
+ macAddressFlagName := "mac-address"
netFlags.String(
- "mac-address", "",
+ macAddressFlagName, "",
"Container MAC address (e.g. 92:d0:c6:0a:29:33)",
)
+ _ = cmd.RegisterFlagCompletionFunc(macAddressFlagName, completion.AutocompleteNone)
+
+ networkFlagName := "network"
netFlags.String(
- "network", containerConfig.NetNS(),
+ networkFlagName, containerConfig.NetNS(),
"Connect a container to a network",
)
+ _ = cmd.RegisterFlagCompletionFunc(networkFlagName, AutocompleteNetworks)
+
+ networkAliasFlagName := "network-alias"
netFlags.StringSlice(
- "network-alias", []string{},
+ networkAliasFlagName, []string{},
"Add network-scoped alias for the container",
)
+ _ = cmd.RegisterFlagCompletionFunc(networkAliasFlagName, completion.AutocompleteNone)
+
+ publishFlagName := "publish"
netFlags.StringSliceP(
- "publish", "p", []string{},
+ publishFlagName, "p", []string{},
"Publish a container's port, or a range of ports, to the host (default [])",
)
+ _ = cmd.RegisterFlagCompletionFunc(publishFlagName, completion.AutocompleteNone)
+
netFlags.Bool(
"no-hosts", false,
"Do not create /etc/hosts within the container, instead use the version from the image",
)
- return &netFlags
}
func NetFlagsToNetOptions(cmd *cobra.Command) (*entities.NetOptions, error) {