larksuite--cli/shortcuts/common/runner_flag_completion_test.go

// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT

package common

import (
	"context"
	"testing"

	"github.com/larksuite/cli/internal/cmdutil"
	"github.com/spf13/cobra"
)

// TestShortcutMount_FlagCompletionsRegistered exercises the two
// cmdutil.RegisterFlagCompletion call sites in registerShortcutFlagsWithContext:
// the per-flag enum completion (runner.go:879) and the auto-injected --format
// completion (runner.go:895).
func TestShortcutMount_FlagCompletionsRegistered(t *testing.T) {
	t.Cleanup(func() { cmdutil.SetFlagCompletionsEnabled(false) })
	cmdutil.SetFlagCompletionsEnabled(true)

	f, _, _, _ := cmdutil.TestFactory(t, nil)
	parent := &cobra.Command{Use: "root"}
	shortcut := Shortcut{
		Service:     "docs",
		Command:     "+fetch",
		Description: "fetch doc",
		HasFormat:   true,
		Flags: []Flag{
			{Name: "sort-by", Desc: "sort", Enum: []string{"asc", "desc"}},
		},
		Execute: func(context.Context, *RuntimeContext) error { return nil },
	}
	shortcut.Mount(parent, f)

	cmd, _, err := parent.Find([]string{"+fetch"})
	if err != nil {
		t.Fatalf("Find() error = %v", err)
	}

	// Enum flag completion.
	fn, ok := cmd.GetFlagCompletionFunc("sort-by")
	if !ok {
		t.Fatal("expected completion func for --sort-by")
	}
	got, _ := fn(cmd, nil, "")
	if len(got) != 2 || got[0] != "asc" || got[1] != "desc" {
		t.Fatalf("sort-by completion = %v, want [asc desc]", got)
	}

	// HasFormat-injected --format completion.
	fn, ok = cmd.GetFlagCompletionFunc("format")
	if !ok {
		t.Fatal("expected completion func for --format")
	}
	got, _ = fn(cmd, nil, "")
	want := []string{"json", "pretty", "table", "ndjson", "csv"}
	if len(got) != len(want) {
		t.Fatalf("format completion = %v, want %v", got, want)
	}
	for i, v := range want {
		if got[i] != v {
			t.Fatalf("format completion[%d] = %q, want %q", i, got[i], v)
		}
	}
}

// TestShortcutMount_FlagCompletionsDisabled verifies the switch actually
// prevents the two registrations from landing in cobra's global map.
func TestShortcutMount_FlagCompletionsDisabled(t *testing.T) {
	t.Cleanup(func() { cmdutil.SetFlagCompletionsEnabled(false) })
	cmdutil.SetFlagCompletionsEnabled(false)

	f, _, _, _ := cmdutil.TestFactory(t, nil)
	parent := &cobra.Command{Use: "root"}
	shortcut := Shortcut{
		Service:     "docs",
		Command:     "+fetch",
		Description: "fetch doc",
		HasFormat:   true,
		Flags: []Flag{
			{Name: "sort-by", Desc: "sort", Enum: []string{"asc", "desc"}},
		},
		Execute: func(context.Context, *RuntimeContext) error { return nil },
	}
	shortcut.Mount(parent, f)

	cmd, _, err := parent.Find([]string{"+fetch"})
	if err != nil {
		t.Fatalf("Find() error = %v", err)
	}
	if _, ok := cmd.GetFlagCompletionFunc("sort-by"); ok {
		t.Fatal("did not expect completion func for --sort-by when disabled")
	}
	if _, ok := cmd.GetFlagCompletionFunc("format"); ok {
		t.Fatal("did not expect completion func for --format when disabled")
	}
}

// TestShortcutMount_ReservedIntrospectionFlagCollision verifies the reserved
// --print-schema / --flag-name flags are registered defensively: a shortcut
// that already declares same-named flags must not trigger pflag's duplicate-
// registration panic (the Lookup guard in registerShortcutFlagsWithContext).
func TestShortcutMount_ReservedIntrospectionFlagCollision(t *testing.T) {
	f, _, _, _ := cmdutil.TestFactory(t, nil)
	parent := &cobra.Command{Use: "root"}
	shortcut := Shortcut{
		Service:     "docs",
		Command:     "+introspect",
		Description: "x",
		// The shortcut's own flags collide with the names the runner auto-
		// injects when PrintFlagSchema is set. Without the guard, pflag panics.
		Flags: []Flag{
			{Name: "print-schema", Desc: "user-defined collision"},
			{Name: "flag-name", Desc: "user-defined collision"},
		},
		PrintFlagSchema: func(string) ([]byte, error) { return nil, nil },
		Execute:         func(context.Context, *RuntimeContext) error { return nil },
	}

	defer func() {
		if r := recover(); r != nil {
			t.Fatalf("Mount panicked on a reserved-flag name collision (Lookup guard missing?): %v", r)
		}
	}()
	shortcut.Mount(parent, f)

	cmd, _, err := parent.Find([]string{"+introspect"})
	if err != nil {
		t.Fatalf("Find() error = %v", err)
	}
	if cmd.Flags().Lookup("print-schema") == nil {
		t.Error("print-schema flag should still exist after the guarded registration")
	}
	if cmd.Flags().Lookup("flag-name") == nil {
		t.Error("flag-name flag should still exist after the guarded registration")
	}
}

func TestShortcutMount_JsonFlag_AcceptedWhenHasFormat(t *testing.T) {
	f, _, _, _ := cmdutil.TestFactory(t, nil)
	parent := &cobra.Command{Use: "root"}
	shortcut := Shortcut{
		Service:     "test",
		Command:     "+read",
		Description: "test read",
		HasFormat:   true,
		Execute:     func(context.Context, *RuntimeContext) error { return nil },
	}
	shortcut.Mount(parent, f)

	cmd, _, err := parent.Find([]string{"+read"})
	if err != nil {
		t.Fatalf("Find() error = %v", err)
	}
	if flag := cmd.Flags().Lookup("json"); flag == nil {
		t.Fatal("expected --json flag to be registered on HasFormat shortcut")
	}
}

func TestShortcutMount_JsonFlag_SkippedWhenConflict(t *testing.T) {
	f, _, _, _ := cmdutil.TestFactory(t, nil)
	parent := &cobra.Command{Use: "root"}
	shortcut := Shortcut{
		Service:     "test",
		Command:     "+update",
		Description: "test update",
		HasFormat:   true,
		Flags: []Flag{
			{Name: "json", Desc: "body JSON object", Required: true},
		},
		Execute: func(context.Context, *RuntimeContext) error { return nil },
	}
	shortcut.Mount(parent, f)

	cmd, _, err := parent.Find([]string{"+update"})
	if err != nil {
		t.Fatalf("Find() error = %v", err)
	}
	// --json flag exists (from custom Flags), but should be the string type, not bool.
	flag := cmd.Flags().Lookup("json")
	if flag == nil {
		t.Fatal("expected --json flag from custom Flags")
	}
	if flag.DefValue != "" {
		t.Errorf("expected empty default (string flag), got %q", flag.DefValue)
	}
}

func TestShortcutMount_JsonFlag_RegisteredWithoutHasFormat(t *testing.T) {
	f, _, _, _ := cmdutil.TestFactory(t, nil)
	parent := &cobra.Command{Use: "root"}
	shortcut := Shortcut{
		Service:     "test",
		Command:     "+write",
		Description: "test write",
		HasFormat:   false,
		Execute:     func(context.Context, *RuntimeContext) error { return nil },
	}
	shortcut.Mount(parent, f)

	cmd, _, err := parent.Find([]string{"+write"})
	if err != nil {
		t.Fatalf("Find() error = %v", err)
	}
	// --format is now registered for all shortcuts (regardless of HasFormat),
	// so --json should also be present.
	if flag := cmd.Flags().Lookup("json"); flag == nil {
		t.Fatal("expected --json flag to be registered even when HasFormat is false")
	}
}