4a5449233d
Seven bugs surfaced via two audit rounds — parallel reviewer agents
plus a real-server end-to-end demo. Each fix arrives with a
regression test.
1. doc upload --recursive --json corrupted the envelope stream.
Per-file FAIL/OK plain lines printed unconditionally to stdout,
then a Success envelope, then on partial failure a typed error
that the root handler turned into a SECOND Failure envelope —
three outputs where one was expected. Fix: gate the plain lines
behind !opts.JSONOut, and add cmdutil.Error.Silent so the JSON-
path partial-failure preserves its typed exit code without
triggering PrintErrorEnvelope's default Failure-envelope write.
2. auth refresh / AuthRetryTransport misclassified HTTP failures as
network.error. RefreshAndPersist wrapped every refresher error
with CodeNetworkError, but the SDK emits "HTTP error 401: ..."
for a rejected refresh token — which should surface as
auth.token_expired. Switched to WrapHTTP for proper status-
derived classification. Affects both `auth refresh` and the
transport's refresh closure.
3. doc download accepted ".." as a server-suggested filename. The
rejection list covered "" / "." / filepath.Separator but not
bare ".." — filepath.Base("..") is "..", which slipped through
to os.Create and produced a confusing local.file_io wrap. Added
to the rejection set.
4. search chunks / docs / kb / sessions had no lower bound on
--limit. `-L 0` / `-L -1` was forwarded to the server with
undefined behavior. Added a 1..1000 bound at the RunE boundary
across all four (matching doc list / session list page-size
bounds). Internal callers in tests can still pass Limit==0 for
the "no client-side cap" runChunks path — the bound only applies
at the user-input layer.
5. cli/AGENTS.md ADR-3 verb-canon summary listed only v0.2 verbs as
"gh-canonical" and missed v0.3 additions (edit, pin, unpin,
download — all gh-canonical) plus locally-introduced ones
(empty, refresh, add, remove, link). Rewritten as an explicit
gh-canonical / locally-introduced split.
6. kb pin returned 404. Server registers /knowledge-bases/{id}/pin
as PUT (router.go:292); SDK was using POST. gin's router silently
404s on method-mismatch (treats it as path-not-found, not 405),
so the CLI classified the response as resource.not_found and
masked the real failure mode. Switched the SDK to http.MethodPut.
The asymmetry that hid this past round 1: kb unpin on a freshly-
created KB hits the no-op branch in cmd/kb/pin.go that skips the
SDK call entirely, so unpin "worked" without ever exercising the
broken path. Only the real-server demo, where kb pin actually
fires, surfaced it.
7. kb edit clobbered current Name when only --description was
passed. EditOptions used *string to distinguish "unset" from
"set to empty", but sdk.UpdateKnowledgeBaseRequest declares both
fields as plain string (no omitempty), so the JSON body always
carried `"name": ""`. Server requires Name → 400. Fix: runEdit
does fetch-then-update — GetKnowledgeBase first, build the PUT
body with current values, then overlay user-set fields. Same
TOCTOU window as kb pin / unpin.
Audit-flagged items intentionally NOT changed:
- kb pin / unpin check-then-toggle TOCTOU: documented; the clean
fix would be a server-side setter and belongs in a separate API
change.
- AuthRetryTransport singleflight test gap for one concurrency
scenario; v0.4 polish.
- cli/README.md:50 "once v0.2 ships" and CHANGELOG.md:8
"10 top-level commands": v0.2-PR artifacts, not v0.3-introduced.
- kb edit / kb pin are v0.3-new commands, so neither bug needs a
cli/CHANGELOG.md Fixed entry — the v0.3 release ships them
working as the Added bullets advertise.
152 lines
5.2 KiB
Go
152 lines
5.2 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// fakeDownloadSvc scripts an OpenKnowledgeFile response. The fake returns
|
|
// a ReadCloser over `content` and reports `filename` as the server-
|
|
// suggested name.
|
|
type fakeDownloadSvc struct {
|
|
content string
|
|
filename string
|
|
err error
|
|
gotID string
|
|
}
|
|
|
|
func (f *fakeDownloadSvc) OpenKnowledgeFile(_ context.Context, id string) (string, io.ReadCloser, error) {
|
|
f.gotID = id
|
|
if f.err != nil {
|
|
return "", nil, f.err
|
|
}
|
|
return f.filename, io.NopCloser(strings.NewReader(f.content)), nil
|
|
}
|
|
|
|
func TestDownload_DefaultUsesServerFilename(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
tmp := t.TempDir()
|
|
prevWD, _ := os.Getwd()
|
|
require.NoError(t, os.Chdir(tmp))
|
|
defer os.Chdir(prevWD)
|
|
|
|
svc := &fakeDownloadSvc{content: "PDF-1.4 bytes", filename: "report.pdf"}
|
|
require.NoError(t, runDownload(context.Background(), &DownloadOptions{}, svc, "doc_abc"))
|
|
|
|
got, err := os.ReadFile(filepath.Join(tmp, "report.pdf"))
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "PDF-1.4 bytes", string(got))
|
|
}
|
|
|
|
func TestDownload_OutFile(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
dest := filepath.Join(t.TempDir(), "out.bin")
|
|
svc := &fakeDownloadSvc{content: "hello", filename: "ignored.txt"}
|
|
require.NoError(t, runDownload(context.Background(), &DownloadOptions{Output: dest}, svc, "doc_abc"))
|
|
|
|
got, err := os.ReadFile(dest)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "hello", string(got))
|
|
}
|
|
|
|
func TestDownload_OutDash_Stdout(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeDownloadSvc{content: "binary payload", filename: "report.pdf"}
|
|
require.NoError(t, runDownload(context.Background(), &DownloadOptions{Output: "-"}, svc, "doc_abc"))
|
|
assert.Equal(t, "binary payload", out.String())
|
|
}
|
|
|
|
func TestDownload_NoFilenameFromServer_DefaultPath_Errors(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeDownloadSvc{content: "x", filename: ""}
|
|
err := runDownload(context.Background(), &DownloadOptions{}, svc, "doc_abc")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code)
|
|
assert.Contains(t, typed.Hint, "--output")
|
|
}
|
|
|
|
func TestDownload_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeDownloadSvc{err: errors.New("HTTP error 404: not found")}
|
|
err := runDownload(context.Background(), &DownloadOptions{Output: filepath.Join(t.TempDir(), "x")}, svc, "doc_missing")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func TestDownload_RefusesOverwrite(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
dest := filepath.Join(t.TempDir(), "exists.bin")
|
|
require.NoError(t, os.WriteFile(dest, []byte("OLD"), 0o644))
|
|
|
|
svc := &fakeDownloadSvc{content: "NEW", filename: ""}
|
|
err := runDownload(context.Background(), &DownloadOptions{Output: dest}, svc, "doc_abc")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
got, _ := os.ReadFile(dest)
|
|
assert.Equal(t, "OLD", string(got), "must not overwrite without --clobber")
|
|
}
|
|
|
|
// TestDownload_RejectsServerPathTraversal proves that a malicious or buggy
|
|
// server cannot escape the cwd via Content-Disposition: only the basename
|
|
// of the suggested filename is accepted.
|
|
func TestDownload_RejectsServerPathTraversal(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
tmp := t.TempDir()
|
|
prevWD, _ := os.Getwd()
|
|
require.NoError(t, os.Chdir(tmp))
|
|
defer os.Chdir(prevWD)
|
|
|
|
// The server sends "../../etc/shadow" — we accept only "shadow" and
|
|
// write to cwd.
|
|
svc := &fakeDownloadSvc{content: "exfil", filename: "../../etc/shadow"}
|
|
require.NoError(t, runDownload(context.Background(), &DownloadOptions{}, svc, "doc_abc"))
|
|
|
|
// File must land inside cwd; parent dirs untouched.
|
|
got, err := os.ReadFile(filepath.Join(tmp, "shadow"))
|
|
require.NoError(t, err)
|
|
assert.Equal(t, "exfil", string(got))
|
|
}
|
|
|
|
// TestDownload_RejectsBareDotDot covers the literal-".." case: a server
|
|
// returning Content-Disposition: attachment; filename=".." would, before
|
|
// the rejection list was extended, pass `filepath.Base("..") == ".."`
|
|
// through to os.Create and produce a confusing local.file_io wrap.
|
|
func TestDownload_RejectsBareDotDot(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
for _, name := range []string{"..", "../"} {
|
|
_, err := resolveDownloadDest(&DownloadOptions{}, name)
|
|
require.Error(t, err, "filename=%q must be rejected", name)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
}
|
|
}
|
|
|
|
func TestDownload_ForceOverwrites(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
dest := filepath.Join(t.TempDir(), "exists.bin")
|
|
require.NoError(t, os.WriteFile(dest, []byte("OLD"), 0o644))
|
|
|
|
svc := &fakeDownloadSvc{content: "NEW", filename: ""}
|
|
require.NoError(t, runDownload(context.Background(), &DownloadOptions{Output: dest, Clobber: true}, svc, "doc_abc"))
|
|
got, _ := os.ReadFile(dest)
|
|
assert.Equal(t, "NEW", string(got))
|
|
}
|