8bcbf5a154
Empirical mainstream-CLI surveys (gh / kubectl / aws / gcloud / stripe /
flyctl / terraform / vercel / netlify / lark) drove five alignment
fixes — each replaces a weknora-only design choice that mainstream CLIs
do not share. No backwards-compat shims; the CLI has no v0.1 users yet.
1. Single --kb flag (was --kb-id + --kb mutually exclusive)
Survey: 0/7 mainstream CLIs use two parallel flags for "by id" vs
"by name". Single flag (gh -R, gcloud --project) or positional
(kubectl, stripe, terraform). Closest analog — gcloud --project —
collapses identifier types onto one flag.
Now: every command exposes one --kb flag; client-side prefix
detection (cmdutil.IsKBID looks for "kb_") routes id-form values
through directly and name-form values through ListKnowledgeBases.
Mirrors gcloud --project's id-or-name auto-detection.
Touched: search, chat, doc list / upload / delete, link.
Factory.ResolveKB chain trimmed from 5 levels to 4.
2. link supersedes init
Survey: only vercel and netlify ship both `init` AND `link` as
siblings, and they keep them semantically distinct. weknora's pair
wrote the same .weknora/project.yaml file with the same meaning,
differentiated only by interactivity — that's a flag concern, not
a command concern.
Now: cmd/init/ deleted. cmd/link absorbs the interactive flow:
- link --kb <id-or-name> → non-interactive write
- link on a TTY → interactive prompt (lists KBs)
- link non-TTY without --kb → CodeKBIDRequired
Always overwrites silently (matches vercel link / netlify link /
kubectl apply rather than git init's refuse-if-exists).
Dead code purged: --force flag, CodeProjectAlreadyLinked error code.
3. whoami dropped
Survey: 7/7 mainstream CLIs ship exactly one identity command —
never both a status and a whoami. gh / gcloud / stripe pick status
(config + live API); aws / kubectl / flyctl pick whoami (live API).
weknora's auth status was already a superset of whoami (host +
context + user + email + tenant_id + tenant_name vs user_id +
tenant_id), so dropping whoami preserves all functionality and
aligns with the gh / gcloud / stripe form.
4. kb get alias dropped
`view` was already primary (gh repo view / gh pr view convention);
`get` was kept as a cobra alias for v0.0/v0.1 callers. With no
v0.0/v0.1 users to break, the alias is just noise on the command
surface. Acceptance contract envelope cases renamed kb_get.* →
kb_view.*; goldens renamed in lockstep.
5. api refactored to gh shape (-X/--method, default GET, auto-POST)
gh CLI's signature is `gh api <endpoint> [--method M]` — single
positional path, method as a flag, default GET, auto-promoted to
POST when a body is supplied. weknora's previous `api <method>
<path>` inverted this and forced the method to be passed even for
GET — a needless deviation from our declared north star.
Now: `api <path> [-X METHOD] [--data ...]`. Exit-10 protocol
on the DELETE escape-hatch is preserved; -X DELETE still hits
ConfirmDestructive when -y absent.
Plus: AGENTS.md gains an explicit note that `doctor` is a deliberate
divergence from gh / lark — borrowed from `flutter doctor` / `brew
doctor` because RAG deployments routinely break on misconfigured
embeddings / storage / credentials and a 4-status structured envelope
is the cleanest surface for it.
Tests: 24 cli packages green (was 26 in PR-14; init + whoami packages
removed). Acceptance contract envelope cases for whoami removed,
kb_get → kb_view renamed, search args / mock path updated for the
kb_<id> form. e2e harness flag args updated. Factory.ResolveKB tests
rewritten for the single-flag shape. api_test driver updated for the
positional-path / -X-method shape.
149 lines
4.0 KiB
Go
149 lines
4.0 KiB
Go
package linkcmd
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"path/filepath"
|
|
"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/projectlink"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
func chdir(t *testing.T, dir string) {
|
|
t.Helper()
|
|
prev, err := os.Getwd()
|
|
require.NoError(t, err)
|
|
require.NoError(t, os.Chdir(dir))
|
|
t.Cleanup(func() { _ = os.Chdir(prev) })
|
|
}
|
|
|
|
func fakeKBServer(t *testing.T, kbs []sdk.KnowledgeBase) *httptest.Server {
|
|
t.Helper()
|
|
mux := http.NewServeMux()
|
|
mux.HandleFunc("/api/v1/knowledge-bases", func(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
_ = json.NewEncoder(w).Encode(sdk.KnowledgeBaseListResponse{Success: true, Data: kbs})
|
|
})
|
|
srv := httptest.NewServer(mux)
|
|
t.Cleanup(srv.Close)
|
|
return srv
|
|
}
|
|
|
|
func newFactory(currentCtx string, client *sdk.Client) *cmdutil.Factory {
|
|
cfg := &config.Config{
|
|
CurrentContext: currentCtx,
|
|
Contexts: map[string]config.Context{
|
|
currentCtx: {Host: "https://example"},
|
|
},
|
|
}
|
|
return &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return cfg, nil },
|
|
Client: func() (*sdk.Client, error) {
|
|
if client == nil {
|
|
return nil, errors.New("client not configured")
|
|
}
|
|
return client, nil
|
|
},
|
|
}
|
|
}
|
|
|
|
func TestLink_ByID(t *testing.T) {
|
|
dir := t.TempDir()
|
|
chdir(t, dir)
|
|
out, _ := iostreams.SetForTest(t)
|
|
|
|
f := newFactory("default", nil)
|
|
opts := &Options{KB: "kb_xxx"}
|
|
require.NoError(t, runLink(context.Background(), opts, f))
|
|
|
|
linkPath := filepath.Join(dir, ".weknora", "project.yaml")
|
|
p, err := projectlink.Load(linkPath)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "kb_xxx", p.KBID)
|
|
assert.Equal(t, "default", p.Context)
|
|
assert.Contains(t, out.String(), "✓")
|
|
}
|
|
|
|
func TestLink_ByName(t *testing.T) {
|
|
dir := t.TempDir()
|
|
chdir(t, dir)
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
srv := fakeKBServer(t, []sdk.KnowledgeBase{
|
|
{ID: "kb_a", Name: "foo"},
|
|
{ID: "kb_b", Name: "bar"},
|
|
})
|
|
cli := sdk.NewClient(srv.URL)
|
|
f := newFactory("default", cli)
|
|
opts := &Options{KB: "foo"}
|
|
require.NoError(t, runLink(context.Background(), opts, f))
|
|
|
|
p, err := projectlink.Load(filepath.Join(dir, ".weknora", "project.yaml"))
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "kb_a", p.KBID)
|
|
}
|
|
|
|
func TestLink_KBNotFound(t *testing.T) {
|
|
dir := t.TempDir()
|
|
chdir(t, dir)
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
srv := fakeKBServer(t, []sdk.KnowledgeBase{{ID: "kb_a", Name: "foo"}})
|
|
cli := sdk.NewClient(srv.URL)
|
|
f := newFactory("default", cli)
|
|
opts := &Options{KB: "missing"}
|
|
err := runLink(context.Background(), opts, f)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeKBNotFound, typed.Code)
|
|
}
|
|
|
|
func TestLink_OverwritesExisting(t *testing.T) {
|
|
dir := t.TempDir()
|
|
chdir(t, dir)
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
// Pre-existing link.
|
|
linkPath := filepath.Join(dir, ".weknora", "project.yaml")
|
|
require.NoError(t, projectlink.Save(linkPath, &projectlink.Project{
|
|
Context: "default", KBID: "kb_old",
|
|
}))
|
|
|
|
f := newFactory("default", nil)
|
|
opts := &Options{KB: "kb_new"}
|
|
require.NoError(t, runLink(context.Background(), opts, f))
|
|
|
|
p, err := projectlink.Load(linkPath)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "kb_new", p.KBID, "link should overwrite silently")
|
|
}
|
|
|
|
// TestLink_NonInteractive_NoKB exercises the non-TTY-without-flag error path.
|
|
// SetForTest gives us a non-TTY iostreams, so omitting --kb must error rather
|
|
// than hang on a prompt.
|
|
func TestLink_NonInteractive_NoKB(t *testing.T) {
|
|
dir := t.TempDir()
|
|
chdir(t, dir)
|
|
_, _ = iostreams.SetForTest(t)
|
|
|
|
f := newFactory("default", nil)
|
|
opts := &Options{} // no KB
|
|
err := runLink(context.Background(), opts, f)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeKBIDRequired, typed.Code)
|
|
}
|