d3c03b2f34
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.
Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
"no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
stream sets Done=true on an intermediate agent_query frame before the answer,
and AgentAccumulator treated the first Done as terminal. Terminate on the
`complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
including `doc upload --recursive` partial failures — a permanent per-file
failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
would loop on; per-item typed errors stay in the envelope.
Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
retrieval_ready, and kb create hints the fix when no embedding model is bound
— an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
(drift-guarded); output strings match the meta actually emitted; chunk list
and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
`link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
accept and ignore it, declared in schema) so a carried-over --kb doesn't
exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.
Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
(server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
model.update / kb.config.set) and batch example (failed item carries `error`);
session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
give an env-aware message instead of looping on "run auth login". `auth logout`
clears credentials but keeps the profile registered (host preserved for
re-login); deleting a profile is `profile remove`'s job (clean logout/remove
separation, matching gh / lark).
Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.
Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
166 lines
6.9 KiB
Go
166 lines
6.9 KiB
Go
package auth
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"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/prompt"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
)
|
|
|
|
// newLogoutFactory builds a Factory whose Config closure mutates the supplied
|
|
// cfg in place - runLogout writes back via config.Save which touches disk, so
|
|
// tests use t.Setenv("XDG_CONFIG_HOME", t.TempDir()) at the call site to
|
|
// isolate the on-disk file.
|
|
func newLogoutFactory(t *testing.T, cfg *config.Config, store secrets.Store) *cmdutil.Factory {
|
|
t.Helper()
|
|
return &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return cfg, nil },
|
|
Secrets: func() (secrets.Store, error) { return store, nil },
|
|
Prompter: func() prompt.Prompter { return &prompt.AgentPrompter{} },
|
|
}
|
|
}
|
|
|
|
func isolateConfig(t *testing.T) {
|
|
t.Helper()
|
|
t.Setenv("XDG_CONFIG_HOME", t.TempDir())
|
|
}
|
|
|
|
func TestLogout_CurrentProfile(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("prod", "access", "jwt-prod"))
|
|
require.NoError(t, store.Set("prod", "refresh", "rfr-prod"))
|
|
require.NoError(t, store.Set("staging", "api_key", "sk-staging"))
|
|
|
|
cfg := &config.Config{
|
|
CurrentProfile: "prod",
|
|
Profiles: map[string]config.Profile{
|
|
"prod": {Host: "https://prod", TokenRef: store.Ref("prod", "access"), RefreshRef: store.Ref("prod", "refresh")},
|
|
"staging": {Host: "https://staging", APIKeyRef: store.Ref("staging", "api_key")},
|
|
},
|
|
}
|
|
require.NoError(t, runLogout(&LogoutOptions{Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, newLogoutFactory(t, cfg, store)))
|
|
|
|
assert.Equal(t, "prod", cfg.CurrentProfile, "active profile stays selected — logout clears creds, not the profile")
|
|
require.Contains(t, cfg.Profiles, "prod", "profile stays registered after logout")
|
|
assert.Empty(t, cfg.Profiles["prod"].APIKeyRef, "credential ref cleared")
|
|
assert.Empty(t, cfg.Profiles["prod"].TokenRef, "credential ref cleared")
|
|
assert.Empty(t, cfg.Profiles["prod"].RefreshRef, "credential ref cleared")
|
|
assert.Equal(t, "https://prod", cfg.Profiles["prod"].Host, "host preserved for re-login")
|
|
assert.Contains(t, cfg.Profiles, "staging", "non-target profile untouched")
|
|
|
|
// Secrets gone for the removed profile, kept for the survivor.
|
|
if _, err := store.Get("prod", "access"); err == nil {
|
|
t.Error("prod access secret should be deleted")
|
|
}
|
|
if v, _ := store.Get("staging", "api_key"); v != "sk-staging" {
|
|
t.Errorf("staging secret unexpectedly cleared: %q", v)
|
|
}
|
|
}
|
|
|
|
// TestLogout_ActiveProfileViaOverride exercises targeting a non-default
|
|
// profile. Production resolves this via the global --profile flag (which
|
|
// rewrites cfg.CurrentProfile in Factory.Config); here we simulate that by
|
|
// setting CurrentProfile=staging directly, since runLogout's single target is
|
|
// the active profile.
|
|
func TestLogout_ActiveProfileViaOverride(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("staging", "api_key", "sk-staging"))
|
|
|
|
cfg := &config.Config{
|
|
CurrentProfile: "staging", // global --profile staging resolves to this
|
|
Profiles: map[string]config.Profile{
|
|
"prod": {Host: "https://prod", TokenRef: "tok"},
|
|
"staging": {Host: "https://staging", APIKeyRef: store.Ref("staging", "api_key")},
|
|
},
|
|
}
|
|
require.NoError(t, runLogout(&LogoutOptions{Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, newLogoutFactory(t, cfg, store)))
|
|
|
|
require.Contains(t, cfg.Profiles, "staging", "target profile stays registered (creds cleared, not removed)")
|
|
assert.Empty(t, cfg.Profiles["staging"].APIKeyRef, "target's credential ref cleared")
|
|
assert.Contains(t, cfg.Profiles, "prod", "non-target profile untouched")
|
|
}
|
|
|
|
func TestLogout_All(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
cfg := &config.Config{
|
|
CurrentProfile: "prod",
|
|
Profiles: map[string]config.Profile{
|
|
"prod": {Host: "https://prod"},
|
|
"staging": {Host: "https://staging"},
|
|
},
|
|
}
|
|
require.NoError(t, runLogout(&LogoutOptions{All: true, Yes: true}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, newLogoutFactory(t, cfg, store)))
|
|
|
|
// --all clears every profile's credentials but keeps the profiles registered.
|
|
require.NotEmpty(t, cfg.Profiles, "profiles stay registered after logout --all")
|
|
for name, p := range cfg.Profiles {
|
|
assert.Empty(t, p.APIKeyRef, "%s api-key ref cleared", name)
|
|
assert.Empty(t, p.TokenRef, "%s token ref cleared", name)
|
|
assert.Empty(t, p.RefreshRef, "%s refresh ref cleared", name)
|
|
}
|
|
assert.Equal(t, "prod", cfg.CurrentProfile, "active selection is preserved; logout clears creds, not the profile")
|
|
}
|
|
|
|
func TestLogout_NoProfiles(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
cfg := &config.Config{}
|
|
err := runLogout(&LogoutOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, newLogoutFactory(t, cfg, secrets.NewMemStore()))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthUnauthenticated, typed.Code)
|
|
}
|
|
|
|
// TestLogout_ActiveProfileMissing covers the corrupt-config case where the
|
|
// active profile name (e.g. set via --profile ghost) has no matching entry.
|
|
func TestLogout_ActiveProfileMissing(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
cfg := &config.Config{
|
|
CurrentProfile: "ghost", // points at a non-existent entry
|
|
Profiles: map[string]config.Profile{"prod": {Host: "https://prod"}},
|
|
}
|
|
err := runLogout(&LogoutOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, newLogoutFactory(t, cfg, secrets.NewMemStore()))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeLocalProfileNotFound, typed.Code)
|
|
}
|
|
|
|
func TestLogout_NoCurrentNoFlag(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
cfg := &config.Config{
|
|
Profiles: map[string]config.Profile{"prod": {Host: "https://prod"}},
|
|
}
|
|
err := runLogout(&LogoutOptions{}, &cmdutil.FormatOptions{Mode: cmdutil.FormatText}, newLogoutFactory(t, cfg, secrets.NewMemStore()))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code)
|
|
}
|
|
|
|
// TestLogout_NoNameFlag asserts the --name flag is gone (logout now targets
|
|
// the active profile / global --profile) while --all stands alone.
|
|
func TestLogout_NoNameFlag(t *testing.T) {
|
|
isolateConfig(t)
|
|
_, _ = iostreams.SetForTest(t)
|
|
cfg := &config.Config{Profiles: map[string]config.Profile{"a": {}}}
|
|
cmd := NewCmdLogout(newLogoutFactory(t, cfg, secrets.NewMemStore()))
|
|
assert.Nil(t, cmd.Flags().Lookup("name"), "--name flag must be removed")
|
|
assert.NotNil(t, cmd.Flags().Lookup("all"), "--all flag must remain")
|
|
}
|