78f3994112
Roadmap items 3-9 (download) and 3-10 (recursive upload).
SDK addition (additive, non-breaking):
- OpenKnowledgeFile(ctx, id) (filename, body io.ReadCloser, err) —
the new primitive that returns the body as a stream plus the
server-suggested Content-Disposition filename. The existing path-
form DownloadKnowledgeFile is now a thin wrapper (also gained
partial-file-on-error cleanup, a pre-existing bug exposed by the
reshape).
doc download <id>:
Borrows shape from `gh release download` (positional id, output flag,
`-` sentinel for stdout). Flag names match gh canon verified against
the gh manual: `-O, --output <file>` for destination; `--clobber` for
overwrite control.
- Default: writes to cwd under the server-suggested filename. If the
server didn't send one, errors with input.missing_flag.
- --output FILE / -O FILE: writes to FILE. Refuses overwrite without
--clobber.
- --output -: stream to stdout (binary-safe).
- Partial writes on error are cleaned up.
doc upload --recursive <dir> --glob '*.pdf':
NOTE on upstream parity: `gh release upload` does NOT support
--recursive (verified — it takes individual file args only). `aws s3
cp --recursive` does, but uses `--include`/`--exclude` glob pattern
pairs rather than a single `--glob`. weknora's single positive `--glob`
is a deliberate simplification, not a direct mirror of either tool.
- Walks the tree, filters by base-name glob, uploads each match
sequentially. Per-file line output: OK / FAIL with the underlying
error. Exit 0 only on full success; on partial failure returns the
first failure's typed code so callers can branch. Rejects --name
with --recursive.
- --dry-run lists matches without uploading.
- --json emits {kb_id, uploaded[], failed[]} envelope at completion.
Bugs caught in the post-commit reviewer round:
- SECURITY: server-supplied filename was used in os.Rename without
sanitization. A malicious / buggy server returning
"../../etc/shadow" could escape cwd. Now filepath.Base'd; "." / "/"
/ "" rejected. Regression test added.
- Wasted-bytes path eliminated via the SDK reshape: the CLI now
inspects filename and applies refuseIfExists BEFORE streaming.
Two-phase temp+rename gone.
- refuseIfExists(path, clobber) helper extracted.
- --json honored in --recursive (uploadOutcome was JSON-tagged but
the envelope was never emitted).
7 + 7 unit tests for download (+ path-traversal regression) and
recursive upload (+ JSON envelope regression).
Roadmap: 3-9, 3-10.
137 lines
4.6 KiB
Go
137 lines
4.6 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))
|
|
}
|
|
|
|
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))
|
|
}
|