mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-26 18:27:53 +00:00
2870a0b0a6
There exists a unit test to ensure that shell completion functions are defined. However there was no check about the quality of the provided shell completions. Lets change that. The idea is to create a general test that makes sure we are suggesting containers,pods,images... for the correct commands. This works by reading the command use line and checking for each arg if we provide the correct suggestions for this arg. It includes the following tests: - flag suggestions if [options] is set - container, pod, image, network, volume, registry completion - path completion for the appropriate arg KEYWORDS (`PATH`,`CONTEXT`,etc.) - no completion if there are no args - completion for more than one arg if it ends with `...]` The test does not cover completion values for flags and not every arg KEYWORD is supported. This is still a huge improvement and covers most use cases. This test spotted several inconsistencies between the completion and the command use line. All of them have been adjusted to make the test pass. The biggest advantage is that the completions always match the latest command changes. So if someone changes the arguments for a command this ensures that the completions must be adjusted. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
98 lines
4.3 KiB
Go
98 lines
4.3 KiB
Go
package containers
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
|
|
"github.com/containers/common/pkg/auth"
|
|
"github.com/containers/common/pkg/completion"
|
|
"github.com/containers/image/v5/types"
|
|
"github.com/containers/podman/v2/cmd/podman/common"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/sirupsen/logrus"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// runlabelOptionsWrapper allows for combining API-only with CLI-only options
|
|
// and to convert between them.
|
|
type runlabelOptionsWrapper struct {
|
|
entities.ContainerRunlabelOptions
|
|
TLSVerifyCLI bool
|
|
}
|
|
|
|
var (
|
|
runlabelOptions = runlabelOptionsWrapper{}
|
|
runlabelDescription = "Executes a command as described by a container image label."
|
|
runlabelCommand = &cobra.Command{
|
|
Use: "runlabel [options] LABEL IMAGE [ARG...]",
|
|
Short: "Execute the command described by an image label",
|
|
Long: runlabelDescription,
|
|
RunE: runlabel,
|
|
Args: cobra.MinimumNArgs(2),
|
|
ValidArgsFunction: common.AutocompleteRunlabelCommand,
|
|
Example: `podman container runlabel run imageID
|
|
podman container runlabel install imageID arg1 arg2
|
|
podman container runlabel --display run myImage`,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode},
|
|
Command: runlabelCommand,
|
|
Parent: containerCmd,
|
|
})
|
|
|
|
flags := runlabelCommand.Flags()
|
|
|
|
authfileflagName := "authfile"
|
|
flags.StringVar(&runlabelOptions.Authfile, authfileflagName, auth.GetDefaultAuthFile(), "Path of the authentication file. Use REGISTRY_AUTH_FILE environment variable to override")
|
|
_ = runlabelCommand.RegisterFlagCompletionFunc(authfileflagName, completion.AutocompleteDefault)
|
|
|
|
certDirFlagName := "cert-dir"
|
|
flags.StringVar(&runlabelOptions.CertDir, certDirFlagName, "", "`Pathname` of a directory containing TLS certificates and keys")
|
|
_ = runlabelCommand.RegisterFlagCompletionFunc(certDirFlagName, completion.AutocompleteDefault)
|
|
|
|
credsFlagName := "creds"
|
|
flags.StringVar(&runlabelOptions.Credentials, credsFlagName, "", "`Credentials` (USERNAME:PASSWORD) to use for authenticating to a registry")
|
|
_ = runlabelCommand.RegisterFlagCompletionFunc(credsFlagName, completion.AutocompleteNone)
|
|
|
|
flags.BoolVar(&runlabelOptions.Display, "display", false, "Preview the command that the label would run")
|
|
|
|
nameFlagName := "name"
|
|
flags.StringVarP(&runlabelOptions.Name, nameFlagName, "n", "", "Assign a name to the container")
|
|
_ = runlabelCommand.RegisterFlagCompletionFunc(nameFlagName, completion.AutocompleteNone)
|
|
|
|
flags.StringVar(&runlabelOptions.Optional1, "opt1", "", "Optional parameter to pass for install")
|
|
flags.StringVar(&runlabelOptions.Optional2, "opt2", "", "Optional parameter to pass for install")
|
|
flags.StringVar(&runlabelOptions.Optional3, "opt3", "", "Optional parameter to pass for install")
|
|
flags.BoolVarP(&runlabelOptions.Pull, "pull", "p", true, "Pull the image if it does not exist locally prior to executing the label contents")
|
|
flags.BoolVarP(&runlabelOptions.Quiet, "quiet", "q", false, "Suppress output information when installing images")
|
|
flags.BoolVar(&runlabelOptions.Replace, "replace", false, "Replace existing container with a new one from the image")
|
|
flags.StringVar(&runlabelOptions.SignaturePolicy, "signature-policy", "", "`Pathname` of signature policy file (not usually used)")
|
|
flags.BoolVar(&runlabelOptions.TLSVerifyCLI, "tls-verify", true, "Require HTTPS and verify certificates when contacting registries")
|
|
|
|
// Hide the optional flags.
|
|
_ = flags.MarkHidden("opt1")
|
|
_ = flags.MarkHidden("opt2")
|
|
_ = flags.MarkHidden("opt3")
|
|
_ = flags.MarkHidden("pull")
|
|
_ = flags.MarkHidden("signature-policy")
|
|
|
|
if err := flags.MarkDeprecated("pull", "podman will pull if not found in local storage"); err != nil {
|
|
logrus.Error("unable to mark pull flag deprecated")
|
|
}
|
|
}
|
|
|
|
func runlabel(cmd *cobra.Command, args []string) error {
|
|
if cmd.Flags().Changed("tls-verify") {
|
|
runlabelOptions.SkipTLSVerify = types.NewOptionalBool(!runlabelOptions.TLSVerifyCLI)
|
|
}
|
|
if runlabelOptions.Authfile != "" {
|
|
if _, err := os.Stat(runlabelOptions.Authfile); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return registry.ContainerEngine().ContainerRunlabel(context.Background(), args[0], args[1], args[2:], runlabelOptions.ContainerRunlabelOptions)
|
|
}
|