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>
75 lines
2.3 KiB
Go
75 lines
2.3 KiB
Go
package pods
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
|
|
"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/pkg/domain/entities"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
kubeOptions = entities.GenerateKubeOptions{}
|
|
kubeFile = ""
|
|
kubeDescription = `Command generates Kubernetes pod and service YAML (v1 specification) from Podman containers or a pod.
|
|
|
|
Whether the input is for a container or pod, Podman will always generate the specification as a pod.`
|
|
|
|
kubeCmd = &cobra.Command{
|
|
Use: "kube [options] {CONTAINER...|POD}",
|
|
Short: "Generate Kubernetes YAML from a container or pod.",
|
|
Long: kubeDescription,
|
|
RunE: kube,
|
|
Args: cobra.MinimumNArgs(1),
|
|
ValidArgsFunction: common.AutocompleteContainersAndPods,
|
|
Example: `podman generate kube ctrID
|
|
podman generate kube podID
|
|
podman generate kube --service podID`,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: kubeCmd,
|
|
Parent: generateCmd,
|
|
})
|
|
flags := kubeCmd.Flags()
|
|
flags.BoolVarP(&kubeOptions.Service, "service", "s", false, "Generate YAML for a Kubernetes service object")
|
|
|
|
filenameFlagName := "filename"
|
|
flags.StringVarP(&kubeFile, filenameFlagName, "f", "", "Write output to the specified path")
|
|
_ = kubeCmd.RegisterFlagCompletionFunc(filenameFlagName, completion.AutocompleteDefault)
|
|
|
|
flags.SetNormalizeFunc(utils.AliasFlags)
|
|
}
|
|
|
|
func kube(cmd *cobra.Command, args []string) error {
|
|
report, err := registry.ContainerEngine().GenerateKube(registry.GetContext(), args, kubeOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
content, err := ioutil.ReadAll(report.Reader)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if cmd.Flags().Changed("filename") {
|
|
if _, err := os.Stat(kubeFile); err == nil {
|
|
return errors.Errorf("cannot write to %q; file exists", kubeFile)
|
|
}
|
|
if err := ioutil.WriteFile(kubeFile, content, 0644); err != nil {
|
|
return errors.Wrapf(err, "cannot write to %q", kubeFile)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
fmt.Println(string(content))
|
|
return nil
|
|
}
|