mirror of
https://github.com/containers/podman.git
synced 2025-08-02 01:09:21 +08:00

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>
74 lines
2.3 KiB
Go
74 lines
2.3 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/containers/podman/v2/cmd/podman/common"
|
|
"github.com/containers/podman/v2/cmd/podman/containers"
|
|
"github.com/containers/podman/v2/cmd/podman/images"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/cmd/podman/validate"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// Inspect is one of the outlier commands in that it operates on images/containers/...
|
|
|
|
var (
|
|
// Command: podman _diff_ Object_ID
|
|
diffDescription = `Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer.`
|
|
diffCmd = &cobra.Command{
|
|
Use: "diff [options] {CONTAINER|IMAGE}",
|
|
Args: validate.IDOrLatestArgs,
|
|
Short: "Display the changes to the object's file system",
|
|
Long: diffDescription,
|
|
RunE: diff,
|
|
ValidArgsFunction: common.AutocompleteContainersAndImages,
|
|
Example: `podman diff imageID
|
|
podman diff ctrID
|
|
podman diff --format json redis:alpine`,
|
|
}
|
|
|
|
diffOpts = entities.DiffOptions{}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: diffCmd,
|
|
})
|
|
flags := diffCmd.Flags()
|
|
flags.BoolVar(&diffOpts.Archive, "archive", true, "Save the diff as a tar archive")
|
|
_ = flags.MarkHidden("archive")
|
|
|
|
formatFlagName := "format"
|
|
flags.StringVar(&diffOpts.Format, formatFlagName, "", "Change the output format")
|
|
_ = diffCmd.RegisterFlagCompletionFunc(formatFlagName, common.AutocompleteJSONFormat)
|
|
|
|
validate.AddLatestFlag(diffCmd, &diffOpts.Latest)
|
|
}
|
|
|
|
func diff(cmd *cobra.Command, args []string) error {
|
|
// Latest implies looking for a container
|
|
if diffOpts.Latest {
|
|
return containers.Diff(cmd, args, diffOpts)
|
|
}
|
|
|
|
options := entities.ContainerExistsOptions{
|
|
External: true,
|
|
}
|
|
if found, err := registry.ContainerEngine().ContainerExists(registry.GetContext(), args[0], options); err != nil {
|
|
return err
|
|
} else if found.Value {
|
|
return containers.Diff(cmd, args, diffOpts)
|
|
}
|
|
|
|
if found, err := registry.ImageEngine().Exists(registry.GetContext(), args[0]); err != nil {
|
|
return err
|
|
} else if found.Value {
|
|
return images.Diff(cmd, args, diffOpts)
|
|
}
|
|
|
|
return fmt.Errorf("%s not found on system", args[0])
|
|
}
|