feat(cli): --json field-select, --jq, auth token, doc --from-url

Output ergonomics:
- `--json` accepts a comma-separated field list (gh-parity); selects
  named keys from the per-command payload. Bare `--json` keeps the
  full shape.
- `--jq <expr>` evaluates a gojq expression over the JSON; pairs with
  `--json field-list` so projection runs before jq.
- `--version` is a global cobra flag in addition to the `version`
  subcommand; both render the same line.
- Per-command `--help` now renders the available JSON field list under
  "JSON fields available via `--json id,name,...`" (field-discovery
  parity with gh / kubectl `-o jsonpath`).

New commands:
- `auth token` — print the active context's credential to stdout for
  shell command substitution (`WEKNORA_TOKEN=$(weknora auth token)`).
  Default: raw secret, no trailing newline. `--json` emits
  `{token, mode, context}`.
- `doc upload --from-url <URL>` — ingest a remote URL via the SDK
  `CreateKnowledgeFromURL`. `--name` forwarded as `FileName` so the
  server's known-extension heuristic upgrades crawl-mode to
  file-download-mode where appropriate.

Includes the simplify post-review polish pass (field-filter unit
tests, --json/--jq compose check, agent_help copy fixes).
This commit is contained in:
nullkey
2026-05-14 23:28:14 +08:00
committed by lyingbug
parent 4fb089d4d7
commit 1b20b06f5e
81 changed files with 2351 additions and 642 deletions
+124 -9
View File
@@ -18,12 +18,15 @@ import (
// fakeUploadSvc captures call arguments and returns canned responses.
type fakeUploadSvc struct {
resp *sdk.Knowledge
err error
got struct {
resp *sdk.Knowledge
err error
urlResp *sdk.Knowledge
urlErr error
got struct {
kbID, filePath, customName, channel string
metadata map[string]string
enableMultimodel *bool
urlReq sdk.CreateKnowledgeFromURLRequest
}
}
@@ -43,6 +46,16 @@ func (f *fakeUploadSvc) CreateKnowledgeFromFile(
return f.resp, f.err
}
func (f *fakeUploadSvc) CreateKnowledgeFromURL(
_ context.Context,
kbID string,
req sdk.CreateKnowledgeFromURLRequest,
) (*sdk.Knowledge, error) {
f.got.kbID = kbID
f.got.urlReq = req
return f.urlResp, f.urlErr
}
// writeTempFile creates a regular file under t.TempDir() with sample content.
func writeTempFile(t *testing.T, name string) string {
t.Helper()
@@ -56,7 +69,7 @@ func TestUpload_Success_Human(t *testing.T) {
path := writeTempFile(t, "report.pdf")
svc := &fakeUploadSvc{resp: &sdk.Knowledge{ID: "doc_99", FileName: "report.pdf"}}
opts := &UploadOptions{}
require.NoError(t, runUpload(context.Background(), opts, svc, "kb_xxx", path))
require.NoError(t, runUpload(context.Background(), opts, nil, svc, "kb_xxx", path))
assert.Equal(t, "kb_xxx", svc.got.kbID)
assert.Equal(t, path, svc.got.filePath)
@@ -78,7 +91,7 @@ func TestUpload_Success_CustomName(t *testing.T) {
path := writeTempFile(t, "q3.pdf")
svc := &fakeUploadSvc{resp: &sdk.Knowledge{ID: "doc_88", FileName: "q3.pdf"}}
opts := &UploadOptions{Name: "Q3 Marketing Report.pdf"}
require.NoError(t, runUpload(context.Background(), opts, svc, "kb_xxx", path))
require.NoError(t, runUpload(context.Background(), opts, nil, svc, "kb_xxx", path))
assert.Equal(t, "Q3 Marketing Report.pdf", svc.got.customName)
}
@@ -86,8 +99,8 @@ func TestUpload_Success_JSON(t *testing.T) {
out, _ := iostreams.SetForTest(t)
path := writeTempFile(t, "a.md")
svc := &fakeUploadSvc{resp: &sdk.Knowledge{ID: "doc_77", FileName: "a.md"}}
opts := &UploadOptions{JSONOut: true}
require.NoError(t, runUpload(context.Background(), opts, svc, "kb_xxx", path))
opts := &UploadOptions{}
require.NoError(t, runUpload(context.Background(), opts, &cmdutil.JSONOptions{}, svc, "kb_xxx", path))
got := out.String()
assert.True(t, strings.HasPrefix(got, `{"ok":true`), "envelope should start with ok:true; got %q", got)
@@ -100,7 +113,7 @@ func TestUpload_HTTPError_500(t *testing.T) {
_, _ = iostreams.SetForTest(t)
path := writeTempFile(t, "x.txt")
svc := &fakeUploadSvc{err: errors.New("HTTP error 500: internal")}
err := runUpload(context.Background(), &UploadOptions{}, svc, "kb_xxx", path)
err := runUpload(context.Background(), &UploadOptions{}, nil, svc, "kb_xxx", path)
require.Error(t, err)
var typed *cmdutil.Error
@@ -112,7 +125,7 @@ func TestUpload_HTTPError_409Conflict(t *testing.T) {
_, _ = iostreams.SetForTest(t)
path := writeTempFile(t, "dup.pdf")
svc := &fakeUploadSvc{err: errors.New("HTTP error 409: file exists")}
err := runUpload(context.Background(), &UploadOptions{}, svc, "kb_xxx", path)
err := runUpload(context.Background(), &UploadOptions{}, nil, svc, "kb_xxx", path)
require.Error(t, err)
var typed *cmdutil.Error
@@ -155,3 +168,105 @@ func TestValidateUploadPath_SymlinkToFileAccepted(t *testing.T) {
// os.Stat (not Lstat) should follow the symlink and report regular file.
require.NoError(t, validateUploadPath(link))
}
// --from-url tests (4-N1).
func TestUploadFromURL_Success_Human(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &fakeUploadSvc{urlResp: &sdk.Knowledge{ID: "doc_url_1", FileName: "whitepaper.pdf"}}
opts := &UploadOptions{FromURL: "https://example.com/whitepaper.pdf"}
require.NoError(t, runUploadFromURL(context.Background(), opts, nil, svc, "kb_xxx"))
assert.Equal(t, "kb_xxx", svc.got.kbID)
assert.Equal(t, "https://example.com/whitepaper.pdf", svc.got.urlReq.URL)
assert.Equal(t, "api", svc.got.urlReq.Channel)
assert.Contains(t, out.String(), "Ingested")
assert.Contains(t, out.String(), "doc_url_1")
}
func TestUploadFromURL_WithName_Passes_AsFileName(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeUploadSvc{urlResp: &sdk.Knowledge{ID: "doc_url_2"}}
opts := &UploadOptions{FromURL: "https://example.com/article.html", Name: "Q3 Article"}
require.NoError(t, runUploadFromURL(context.Background(), opts, nil, svc, "kb_xxx"))
assert.Equal(t, "Q3 Article", svc.got.urlReq.FileName,
"--name must be forwarded as FileName (server uses it for file-vs-crawl mode hint)")
}
func TestUploadFromURL_JSON_Envelope(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &fakeUploadSvc{urlResp: &sdk.Knowledge{ID: "doc_url_3", FileName: "ok.pdf"}}
jopts := &cmdutil.JSONOptions{}
require.NoError(t, runUploadFromURL(context.Background(),
&UploadOptions{FromURL: "https://example.com/ok.pdf"}, jopts, svc, "kb_xxx"))
assert.Contains(t, out.String(), `"ok":true`)
assert.Contains(t, out.String(), `"id":"doc_url_3"`)
assert.Contains(t, out.String(), `"risk":{"level":"write"`)
}
func TestUploadFromURL_DryRun(t *testing.T) {
out, _ := iostreams.SetForTest(t)
svc := &fakeUploadSvc{} // must not be called
jopts := &cmdutil.JSONOptions{}
opts := &UploadOptions{FromURL: "https://example.com/x.pdf", DryRun: true}
require.NoError(t, runUploadFromURL(context.Background(), opts, jopts, svc, "kb_xxx"))
got := out.String()
assert.Contains(t, got, `"dry_run":true`)
assert.Contains(t, got, `"from_url"`)
assert.Empty(t, svc.got.urlReq.URL, "SDK call must NOT fire on --dry-run")
}
func TestUploadFromURL_DuplicateURLMaps_resource_already_exists(t *testing.T) {
_, _ = iostreams.SetForTest(t)
svc := &fakeUploadSvc{
urlResp: &sdk.Knowledge{ID: "doc_existing"},
urlErr: sdk.ErrDuplicateURL,
}
err := runUploadFromURL(context.Background(),
&UploadOptions{FromURL: "https://example.com/dup.pdf"}, nil, svc, "kb_xxx")
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeResourceAlreadyExists, typed.Code)
}
func TestValidateUploadFlags_FromURL_OK(t *testing.T) {
require.NoError(t, validateUploadFlags(&UploadOptions{FromURL: "https://example.com/x.pdf"}, nil))
}
func TestValidateUploadFlags_FromURL_WithPositional_Rejected(t *testing.T) {
err := validateUploadFlags(&UploadOptions{FromURL: "https://example.com/x.pdf"}, []string{"/tmp/x.pdf"})
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
}
func TestValidateUploadFlags_FromURL_WithRecursive_Rejected(t *testing.T) {
err := validateUploadFlags(&UploadOptions{FromURL: "https://example.com/x.pdf", Recursive: true}, nil)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
}
func TestValidateUploadFlags_FromURL_BadScheme(t *testing.T) {
err := validateUploadFlags(&UploadOptions{FromURL: "file:///etc/passwd"}, nil)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
}
func TestValidateUploadFlags_FromURL_NoHost(t *testing.T) {
err := validateUploadFlags(&UploadOptions{FromURL: "https://"}, nil)
require.Error(t, err)
}
func TestValidateUploadFlags_NoPathOrURL_Rejected(t *testing.T) {
err := validateUploadFlags(&UploadOptions{}, nil)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
}