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>
59 lines
2.1 KiB
Go
59 lines
2.1 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/containers/common/pkg/auth"
|
|
"github.com/containers/common/pkg/completion"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/containers/podman/v2/pkg/errorhandling"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
autoUpdateOptions = entities.AutoUpdateOptions{}
|
|
autoUpdateDescription = `Auto update containers according to their auto-update policy.
|
|
|
|
Auto-update policies are specified with the "io.containers.autoupdate" label.
|
|
Containers are expected to run in systemd units created with "podman-generate-systemd --new",
|
|
or similar units that create new containers in order to run the updated images.
|
|
Please refer to the podman-auto-update(1) man page for details.`
|
|
autoUpdateCommand = &cobra.Command{
|
|
Use: "auto-update [options]",
|
|
Short: "Auto update containers according to their auto-update policy",
|
|
Long: autoUpdateDescription,
|
|
RunE: autoUpdate,
|
|
ValidArgsFunction: completion.AutocompleteNone,
|
|
Example: `podman auto-update
|
|
podman auto-update --authfile ~/authfile.json`,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode},
|
|
Command: autoUpdateCommand,
|
|
})
|
|
|
|
flags := autoUpdateCommand.Flags()
|
|
|
|
authfileFlagName := "authfile"
|
|
flags.StringVar(&autoUpdateOptions.Authfile, authfileFlagName, auth.GetDefaultAuthFile(), "Path to the authentication file. Use REGISTRY_AUTH_FILE environment variable to override")
|
|
_ = autoUpdateCommand.RegisterFlagCompletionFunc(authfileFlagName, completion.AutocompleteDefault)
|
|
}
|
|
|
|
func autoUpdate(cmd *cobra.Command, args []string) error {
|
|
if len(args) > 0 {
|
|
// Backwards compat. System tests expect this error string.
|
|
return errors.Errorf("`%s` takes no arguments", cmd.CommandPath())
|
|
}
|
|
report, failures := registry.ContainerEngine().AutoUpdate(registry.GetContext(), autoUpdateOptions)
|
|
if report != nil {
|
|
for _, unit := range report.Units {
|
|
fmt.Println(unit)
|
|
}
|
|
}
|
|
return errorhandling.JoinErrors(failures)
|
|
}
|