Function TestCompletionFuncCompatibility

completions_test.go:2896–2978

(t *testing.T)

}

func TestCompletionFuncCompatibility(t *testing.T) {
	t.Run("validate signature", func(t *testing.T) {
		t.Run("format with []string", func(t *testing.T) {
			var userComp func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)

			// check against new signature
			var _ CompletionFunc = userComp //nolint:staticcheck // LHS type is needed for this use case

			// check Command accepts
			cmd := Command{
				ValidArgsFunction: userComp,
			}

			_ = cmd.RegisterFlagCompletionFunc("foo", userComp)
		})

		t.Run("format with []Completion", func(t *testing.T) {
			var userComp func(cmd *Command, args []string, toComplete string) ([]Completion, ShellCompDirective)

			// check against new signature
			var _ CompletionFunc = userComp //nolint:staticcheck // LHS type is needed for this use case
			// check Command accepts
			cmd := Command{
				ValidArgsFunction: userComp,
			}

			_ = cmd.RegisterFlagCompletionFunc("foo", userComp)
		})

		t.Run("format with CompletionFunc", func(t *testing.T) {
			var userComp CompletionFunc

			// check helper against old signature
			var _ func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) = userComp     //nolint:staticcheck // LHS type is needed for this use case
			var _ func(cmd *Command, args []string, toComplete string) ([]Completion, ShellCompDirective) = userComp //nolint:staticcheck // LHS type is needed for this use case

			// check Command accepts
			cmd := Command{
				ValidArgsFunction: userComp,
			}

			_ = cmd.RegisterFlagCompletionFunc("foo", userComp)
		})
	})

	t.Run("user defined completion helper", func(t *testing.T) {
		t.Run("type helper", func(t *testing.T) {
			// This is a type that may have been defined by the user of the library
			// This replicates the issue https://github.com/docker/cli/issues/5827
			// https://github.com/docker/cli/blob/b6e7eba4470ecdca460e4b63270fba8179674ad6/cli/command/completion/functions.go#L18
			type UserCompletionTypeHelper func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)

			var userComp UserCompletionTypeHelper

			// Here we are validating the existing type validates the CompletionFunc type
			var _ CompletionFunc = userComp

			cmd := Command{