larksuite-cli/shortcuts/apps/apps_examples_test.go

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

package apps

import (
	"regexp"
	"strings"
	"testing"
)

func TestAppsShortcutsHaveExamples(t *testing.T) {
	realAppID := regexp.MustCompile(`app_[a-z0-9]{6,}`)
	email := regexp.MustCompile(`[A-Za-z0-9._%+\-]+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,}`)
	phone := regexp.MustCompile(`\b1[3-9]\d{9}\b`)
	for _, s := range Shortcuts() {
		if s.Hidden {
			continue
		}
		hasExample := false
		for _, tip := range s.Tips {
			if strings.HasPrefix(tip, "Example: lark-cli apps +") {
				hasExample = true
			}
			if realAppID.MatchString(tip) {
				t.Errorf("%s tip leaks real-looking app id (use <app_id>): %q", s.Command, tip)
			}
			if email.MatchString(tip) || phone.MatchString(tip) {
				t.Errorf("%s tip leaks PII: %q", s.Command, tip)
			}
		}
		if !hasExample {
			t.Errorf("%s has no \"Example: lark-cli apps +...\" tip", s.Command)
		}
	}
}

func TestHighFreqCommandsHaveMultipleExamples(t *testing.T) {
	want := map[string]int{"+chat": 2, "+access-scope-set": 2}
	for _, s := range Shortcuts() {
		min, ok := want[s.Command]
		if !ok {
			continue
		}
		n := 0
		for _, tip := range s.Tips {
			if strings.HasPrefix(tip, "Example: lark-cli apps +") {
				n++
			}
		}
		if n < min {
			t.Errorf("%s has %d Example tips, want >= %d", s.Command, n, min)
		}
	}
}

func TestAppsEnvTipsCoverConfirmations(t *testing.T) {
	envSet := requireShortcutForExamples(t, "+env-set")
	if !tipsContainAll(envSet.Tips, "--environment online", "--yes") {
		t.Fatalf("+env-set tips must include an online write example with --environment online --yes: %#v", envSet.Tips)
	}

	envDelete := requireShortcutForExamples(t, "+env-delete")
	if !tipsContainAll(envDelete.Tips, "--yes") {
		t.Fatalf("+env-delete tips must include --yes: %#v", envDelete.Tips)
	}
}

func TestAppsObservabilityTipsMentionOnlineOnly(t *testing.T) {
	for _, cmd := range []string{
		"+log-list",
		"+log-get",
		"+trace-list",
		"+trace-get",
		"+metric-list",
		"+analytics-list",
	} {
		shortcut := requireShortcutForExamples(t, cmd)
		if !tipsContainAll(shortcut.Tips, "online-only", "--environment online") {
			t.Fatalf("%s tips should mention online-only env: %#v", cmd, shortcut.Tips)
		}
	}
}

func requireShortcutForExamples(t *testing.T, command string) shortcutForExamples {
	t.Helper()
	for _, sc := range Shortcuts() {
		if sc.Command == command {
			return shortcutForExamples{Tips: sc.Tips}
		}
	}
	t.Fatalf("missing shortcut %s", command)
	return shortcutForExamples{}
}

type shortcutForExamples struct {
	Tips []string
}

func tipsContainAll(tips []string, needles ...string) bool {
	for _, tip := range tips {
		ok := true
		for _, needle := range needles {
			if !strings.Contains(tip, needle) {
				ok = false
				break
			}
		}
		if ok {
			return true
		}
	}
	return false
}