From a70785a303fd6e845d2ff535e6b96a3b8e944452 Mon Sep 17 00:00:00 2001
From: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
Date: Sun, 16 Feb 2025 18:38:44 +0100
Subject: [PATCH] chore: add missing non-regression test for completions
The new type CompletionFunc could lead to a regression.
This commit adds a test to ensure that the completion function is correctly
The tests are currently failing. This is expected as the fix is not yet implemented.
Signed-off-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
---
completions_test.go | 88 ++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 87 insertions(+), 1 deletion(-)
diff --git a/completions_test.go b/completions_test.go
index 62c203e1..73d370f6 100644
--- a/completions_test.go
+++ b/completions_test.go
@@ -2838,13 +2838,99 @@ func TestCompleteWithRootAndLegacyArgs(t *testing.T) {
"arg1",
"arg2",
":4",
- "Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n")
+ "Completion ended with directive: ShellCompDirectiveNoFileComp", "",
+ }, "\n")
if output != expected {
t.Errorf("expected: %q, got: %q", expected, output)
}
}
+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
+
+ // 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
+
+ // 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
+ var _ func(cmd *Command, args []string, toComplete string) ([]Completion, ShellCompDirective) = userComp
+
+ // 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{
+ ValidArgsFunction: userComp,
+ }
+
+ _ = cmd.RegisterFlagCompletionFunc("foo", userComp)
+ })
+
+ t.Run("type alias helper", func(t *testing.T) {
+ // This is a type that may have been defined by the user of the library
+ // This replicates the possible fix that was tried here https://github.com/docker/cli/pull/5828
+ // https://github.com/docker/cli/blob/ae3d4db9f658259dace9dee515718be7c1b1f517/cli/command/completion/functions.go#L18
+ type UserCompletionTypeAliasHelper = func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)
+
+ var userComp UserCompletionTypeAliasHelper
+
+ // Here we are validating the existing type validates the CompletionFunc type
+ var _ CompletionFunc = userComp
+
+ cmd := Command{
+ ValidArgsFunction: userComp,
+ }
+
+ _ = cmd.RegisterFlagCompletionFunc("foo", userComp)
+ })
+ })
+}
+
func TestFixedCompletions(t *testing.T) {
rootCmd := &Command{Use: "root", Args: NoArgs, Run: emptyRun}
choices := []string{"apple", "banana", "orange"}