2ce348d020
D1 — --format default flipped to json regardless of TTY: - v0.6: smart default (text on TTY, json on pipe). - v0.7: always json; TTY only affects indent (compact in pipe). Enum values unchanged (text | json | ndjson). - Typed FormatMode enum replaces untyped string consts. - --format / --jq promoted to persistent root flags so unknown- subcommand paths still reach the typed-envelope guard (per-command registration in v0.6 would have rejected --format on unknown commands as cobra-prose exit 2). - WEKNORA_FORMAT env var added; precedence --format > env > default. Invalid env values silently ignored. D2 — chat / session ask default to NDJSON event-stream: - New cli/internal/output/ndjson_stream.go: InitEvent struct + EmitInit / EmitSDKEvent / WriteNDJSONLine helpers. EmitInit doc encodes the must-be-first-line invariant agents key on. - chat / session ask: --format json AND --format ndjson both emit one JSON event per line (no envelope wrapping). CLI injects exactly one `init` event at stream head carrying session_id + optional kb_id / agent_id / profile. Subsequent events pass through verbatim from the SDK (passthrough discipline per spec §5.1). - --format text keeps the SSE-style live renderer. context → profile full cascade: - Command group: cli/cmd/context/ → cli/cmd/profile/ (git mv; package contextcmd → profilecmd). - Global flag --context → --profile. Factory.ContextOverride → ProfileOverride. WEKNORA_PROFILE env var honored (--profile flag > env > config.CurrentContext). When --profile or WEKNORA_PROFILE references a missing profile, the error is input.invalid_argument with hint "weknora profile list" — not the destructive local.config_corrupt path (which would have told users to delete their config file). - Binding file .weknora/project.yaml field context: → profile: (no backwards-compat alias; re-run weknora link). - profile use JSON fields current_context / previous_context → current_profile / previous_profile. - weknora link JSON field context → profile. - CodeLocalContextNotFound → CodeLocalProfileNotFound (typed code rename). - Envelope top-level profile field populated via globalProfile (set by root PersistentPreRunE from Factory.ActiveProfile). chat / session ask NDJSON init event carries the same profile. - Rationale: "context" collided with LLM context window / RAG context / Go context.Context; mainstream multi-credential CLIs (AWS / Stripe / OpenAI / Anthropic / lark) all use "profile". H2/C1' help calibration: - AgentHelp gains Warnings []string; single SetAgentHelp helper routes on WEKNORA_AGENT_HELP=1 (emits JSON blob including warnings) vs human help (appends "AI agents:" block from same source). Warnings surface as both a structured JSON field and visible help-text addendum without drift. - 9 destructive commands carry warnings: kb / doc / agent / session / chunk delete; profile remove; kb / agent edit; auth logout. - weknora doc wait dedups ids at entry; SIGINT mid-wait returns silently (root signal handler maps to exit 130) instead of being miscategorised as operation.timeout / operation.failed. A4 — docs: - cli/AGENTS.md gains four agent-facing sections: Wire contract for AI agents (stdout / stderr / NDJSON / _notice evolution / SDK contract boundary); Deliberate deviations + mainstream alignments; Pre-1.0 breaking policy; Exit-10 anti-patterns. ERROR_REFERENCE table extended. - cli/README.md adds Agent quick start under Wire contract. - cli/CHANGELOG.md v0.7 section: BREAKING entries with migration notes, Added (WEKNORA_FORMAT / WEKNORA_PROFILE / retry_command / retry_after_seconds / risk / _notice reserved infra / meta.count / meta.has_more / doc fetch / doc create / session ask / doc delete --all / NDJSON init), Changed (docs additions), Deprecated (none — pre-release one-shot breaking). Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3 / §4 / §5 / §6 / §11
296 lines
9.5 KiB
Go
296 lines
9.5 KiB
Go
package auth
|
|
|
|
import (
|
|
"encoding/json"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
)
|
|
|
|
// tokenTestFactory wires a config + in-memory secrets store the same way
|
|
// the production Factory does, so runToken exercises the real LoadSecret
|
|
// path.
|
|
func tokenTestFactory(t *testing.T, cfg *config.Config, store *secrets.MemStore) *cmdutil.Factory {
|
|
t.Helper()
|
|
f := &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return cfg, nil },
|
|
Secrets: func() (secrets.Store, error) { return store, nil },
|
|
}
|
|
return f
|
|
}
|
|
|
|
func TestAuthToken_BearerMode_PlainOutput(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://kb.example.com", TokenRef: "prod:access", RefreshRef: "prod:refresh"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("prod", "access", "jwt-token-xyz")
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText})
|
|
if err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
got := out.String()
|
|
if got != "jwt-token-xyz" {
|
|
t.Errorf("expected raw token, got %q", got)
|
|
}
|
|
if strings.HasSuffix(got, "\n") {
|
|
t.Errorf("output must NOT end with newline (clean $(...) substitution); got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_APIKeyMode_PlainOutput(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "ci",
|
|
Contexts: map[string]config.Context{
|
|
"ci": {Host: "https://kb.example.com", APIKeyRef: "ci:api_key"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("ci", "api_key", "sk_test_apikey_42")
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
if err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
if got := out.String(); got != "sk_test_apikey_42" {
|
|
t.Errorf("expected api-key value, got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_JSON(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://kb.example.com", TokenRef: "prod:access"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("prod", "access", "jwt-xyz")
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
if err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
var env struct {
|
|
OK bool `json:"ok"`
|
|
Data struct {
|
|
Token string `json:"token"`
|
|
Mode string `json:"mode"`
|
|
Profile string `json:"profile"`
|
|
} `json:"data"`
|
|
}
|
|
if err := json.Unmarshal(out.Bytes(), &env); err != nil {
|
|
t.Fatalf("parse: %v\n%s", err, out.String())
|
|
}
|
|
got := env.Data
|
|
if got.Token != "jwt-xyz" || got.Mode != "bearer" || got.Profile != "prod" {
|
|
t.Errorf("payload wrong: %+v", got)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_JSON_JQProjection(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "ci",
|
|
Contexts: map[string]config.Context{
|
|
"ci": {Host: "https://kb.example.com", APIKeyRef: "ci:api_key"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("ci", "api_key", "sk_42")
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
// jq projects from the envelope; .data | {token} extracts from the data object inside envelope.
|
|
fopts := &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON, JQ: ".data | {token}"}
|
|
if err := runToken(tokenTestFactory(t, cfg, store), fopts); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
var got map[string]any
|
|
if err := json.Unmarshal(out.Bytes(), &got); err != nil {
|
|
t.Fatalf("parse: %v", err)
|
|
}
|
|
if _, has := got["mode"]; has {
|
|
t.Errorf("mode should be filtered out: %+v", got)
|
|
}
|
|
if got["token"] != "sk_42" {
|
|
t.Errorf("token wrong: %+v", got)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_NoCurrentContext(t *testing.T) {
|
|
cfg := &config.Config{}
|
|
store := secrets.NewMemStore()
|
|
iostreams.SetForTest(t)
|
|
err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText})
|
|
if err == nil {
|
|
t.Fatal("expected error, got nil")
|
|
}
|
|
if !cmdutil.IsAuthError(err) {
|
|
t.Errorf("want auth.* code, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_ProfileOverride(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://prod.example.com", TokenRef: "prod:access"},
|
|
"staging": {Host: "https://staging.example.com", APIKeyRef: "staging:api_key"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("prod", "access", "prod-jwt")
|
|
_ = store.Set("staging", "api_key", "staging-key")
|
|
|
|
f := tokenTestFactory(t, cfg, store)
|
|
f.ProfileOverride = "staging"
|
|
|
|
out, _ := iostreams.SetForTest(t)
|
|
if err := runToken(f, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
if got := out.String(); got != "staging-key" {
|
|
t.Errorf("expected staging-key (override), got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_NoStoredCredential(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://kb.example.com", TokenRef: "prod:access"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
// no Set - keyring is empty
|
|
iostreams.SetForTest(t)
|
|
err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText})
|
|
if err == nil {
|
|
t.Fatal("expected auth.unauthenticated, got nil")
|
|
}
|
|
if !cmdutil.IsAuthError(err) {
|
|
t.Errorf("want auth.*, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_ContextWithNoCredentialRefs(t *testing.T) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "empty",
|
|
Contexts: map[string]config.Context{
|
|
"empty": {Host: "https://kb.example.com"}, // no TokenRef or APIKeyRef
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
iostreams.SetForTest(t)
|
|
err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText})
|
|
if err == nil {
|
|
t.Fatal("expected auth.unauthenticated, got nil")
|
|
}
|
|
if !cmdutil.IsAuthError(err) {
|
|
t.Errorf("want auth.*, got %v", err)
|
|
}
|
|
}
|
|
|
|
// --- stderr advisory tests --------------------------------------------------
|
|
//
|
|
// auth token prints the token to stdout unconditionally. When stdout is an
|
|
// interactive terminal, it ALSO writes a stderr advisory ("you just put the
|
|
// secret in your scrollback") + a mode-specific rotation note for api-key
|
|
// credentials. The stdout half must stay clean under all modes so $(...)
|
|
// substitution is unaffected - tests assert both axes.
|
|
|
|
func makeBearerCfg() (*config.Config, *secrets.MemStore) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://kb.example.com", TokenRef: "prod:access"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("prod", "access", "jwt-xyz")
|
|
return cfg, store
|
|
}
|
|
|
|
func makeAPIKeyCfg() (*config.Config, *secrets.MemStore) {
|
|
cfg := &config.Config{
|
|
CurrentContext: "ci",
|
|
Contexts: map[string]config.Context{
|
|
"ci": {Host: "https://kb.example.com", APIKeyRef: "ci:api_key"},
|
|
},
|
|
}
|
|
store := secrets.NewMemStore()
|
|
_ = store.Set("ci", "api_key", "sk_42")
|
|
return cfg, store
|
|
}
|
|
|
|
func TestAuthToken_NonTTY_NoStderrHint(t *testing.T) {
|
|
cfg, store := makeBearerCfg()
|
|
out, errBuf := iostreams.SetForTest(t)
|
|
if err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
if out.String() != "jwt-xyz" {
|
|
t.Errorf("stdout = %q, want %q", out.String(), "jwt-xyz")
|
|
}
|
|
if errBuf.Len() != 0 {
|
|
t.Errorf("non-TTY stderr should be empty (scripts depend on this), got %q", errBuf.String())
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_TTY_BearerMode_StderrHintNoRotationNote(t *testing.T) {
|
|
cfg, store := makeBearerCfg()
|
|
out, errBuf := iostreams.SetForTestWithTTY(t)
|
|
if err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
if out.String() != "jwt-xyz" {
|
|
t.Errorf("stdout = %q, want raw token only", out.String())
|
|
}
|
|
if !strings.Contains(errBuf.String(), "scrollback") {
|
|
t.Errorf("expected stderr scrollback hint on TTY, got %q", errBuf.String())
|
|
}
|
|
if strings.Contains(errBuf.String(), "api-key") {
|
|
t.Errorf("bearer mode should not surface the api-key rotation note: %q", errBuf.String())
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_TTY_APIKeyMode_IncludesRotationNote(t *testing.T) {
|
|
cfg, store := makeAPIKeyCfg()
|
|
out, errBuf := iostreams.SetForTestWithTTY(t)
|
|
if err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatText}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
if out.String() != "sk_42" {
|
|
t.Errorf("stdout = %q, want raw token only", out.String())
|
|
}
|
|
stderr := errBuf.String()
|
|
if !strings.Contains(stderr, "scrollback") {
|
|
t.Errorf("api-key TTY stderr should still include the scrollback hint, got %q", stderr)
|
|
}
|
|
if !strings.Contains(stderr, "long-lived") || !strings.Contains(stderr, "rotate") {
|
|
t.Errorf("api-key mode should include rotation note, got %q", stderr)
|
|
}
|
|
}
|
|
|
|
func TestAuthToken_TTY_JSONMode_NoStderrHint(t *testing.T) {
|
|
// --format json output mode targets script/agent consumers even when stdout
|
|
// happens to be a TTY (e.g. an IDE running the CLI on the user's
|
|
// behalf). Hint would pollute their parsing - suppress.
|
|
cfg, store := makeBearerCfg()
|
|
_, errBuf := iostreams.SetForTestWithTTY(t)
|
|
if err := runToken(tokenTestFactory(t, cfg, store), &cmdutil.FormatOptions{Mode: cmdutil.FormatJSON}); err != nil {
|
|
t.Fatalf("runToken: %v", err)
|
|
}
|
|
if errBuf.Len() != 0 {
|
|
t.Errorf("JSON mode should not emit stderr hint, got %q", errBuf.String())
|
|
}
|
|
}
|