nullkey
cc8254f862
Two intertwined mainstream-alignment moves bundled because they share
the migration target (every command's --json path):
1. Drop --dry-run entirely. Survey of comparable API-wrapper CLIs
(gh, aws, stripe, lark): none expose --dry-run. The mainstream that
does (kubectl/git/helm/ansible) operates on declarative manifests
or local state where the preview is materially different from the
executed action. WeKnora's CLI just echoed the same parameters
that would have gone on the wire — the preview added no real
signal over `--help` + reading the call site. Removes:
- root --dry-run persistent flag + cmdutil/dryrun.go
- DryRun fields + EmitDryRun calls in 12 write commands
- format.Envelope.DryRun field
- 8 corresponding *_test.go cases
- --dry-run mention from README.md and CHANGELOG.md
- "dry_run":false from 16 golden envelopes
2. Migrate every --json output to bare data:
- New format.WriteJSON / WriteJSONFiltered helpers
(cli/internal/format/bare.go) share filterArrayItems /
filterObjectKeys / writeJQ with the (still-live for now) envelope
filter helpers.
- Read commands (kb/doc/session list+view, search chunks/docs/
sessions/kb, auth list/status, agent list/view, context list,
doctor) emit bare arrays / objects on stdout.
- Write commands (kb create/edit/delete/pin/empty, doc upload/
upload_recursive/delete, session delete, auth login/logout/
refresh/token, link/unlink, context add/use/remove, agent
invoke, chat, api, version) emit bare result objects. Risk
classification dropped — the resource + exit code already
convey the action.
Per-command shape changes:
list / search → []T (was {ok, data:{items:[…]}})
view → T (was {ok, data:T, _meta:…})
create / edit → T
delete / pin / etc. → {id, …action result…}
doctor → {summary, checks}
api → {status, headers, body}
_meta dropped on the read path:
pagination (page/page_size/total/has_more) — agents iterate with
--all-pages or accept --limit (gh CLI parity);
kb_id / context echo — caller already knows what it asked for.
Acceptance contract goldens regenerated for the new bare shape.
Error envelope on stdout (PrintErrorEnvelope) stays live for now —
the envelope-infra deletion lands in the next commit.
107 lines
3.4 KiB
Go
107 lines
3.4 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"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"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakePinSvc satisfies PinService: GetKnowledgeBase + TogglePinKnowledgeBase.
|
|
type fakePinSvc struct {
|
|
current sdk.KnowledgeBase
|
|
getErr error
|
|
toggleErr error
|
|
toggleCalled bool
|
|
}
|
|
|
|
func (f *fakePinSvc) GetKnowledgeBase(_ context.Context, id string) (*sdk.KnowledgeBase, error) {
|
|
if f.getErr != nil {
|
|
return nil, f.getErr
|
|
}
|
|
c := f.current
|
|
c.ID = id
|
|
return &c, nil
|
|
}
|
|
|
|
func (f *fakePinSvc) TogglePinKnowledgeBase(_ context.Context, id string) (*sdk.KnowledgeBase, error) {
|
|
f.toggleCalled = true
|
|
if f.toggleErr != nil {
|
|
return nil, f.toggleErr
|
|
}
|
|
c := f.current
|
|
c.ID = id
|
|
c.IsPinned = !c.IsPinned
|
|
return &c, nil
|
|
}
|
|
|
|
func TestPin_UnpinnedToPinned_CallsToggle(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{current: sdk.KnowledgeBase{IsPinned: false}}
|
|
require.NoError(t, runPin(context.Background(), &PinOptions{}, nil, svc, "kb_abc", true))
|
|
assert.True(t, svc.toggleCalled, "must call toggle when current state differs")
|
|
assert.Contains(t, out.String(), "kb_abc")
|
|
}
|
|
|
|
func TestPin_AlreadyPinned_NoOp(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{current: sdk.KnowledgeBase{IsPinned: true}}
|
|
require.NoError(t, runPin(context.Background(), &PinOptions{}, nil, svc, "kb_abc", true))
|
|
assert.False(t, svc.toggleCalled, "already pinned ⇒ must not call toggle")
|
|
assert.Contains(t, out.String(), "already pinned")
|
|
}
|
|
|
|
func TestUnpin_PinnedToUnpinned_CallsToggle(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{current: sdk.KnowledgeBase{IsPinned: true}}
|
|
require.NoError(t, runPin(context.Background(), &PinOptions{}, nil, svc, "kb_abc", false))
|
|
assert.True(t, svc.toggleCalled)
|
|
}
|
|
|
|
func TestUnpin_AlreadyUnpinned_NoOp(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{current: sdk.KnowledgeBase{IsPinned: false}}
|
|
require.NoError(t, runPin(context.Background(), &PinOptions{}, nil, svc, "kb_abc", false))
|
|
assert.False(t, svc.toggleCalled, "already unpinned ⇒ must not call toggle")
|
|
assert.Contains(t, out.String(), "already unpinned")
|
|
}
|
|
|
|
func TestPin_NotFound(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{getErr: errors.New("HTTP error 404: not found")}
|
|
err := runPin(context.Background(), &PinOptions{}, nil, svc, "kb_missing", true)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
assert.False(t, svc.toggleCalled)
|
|
}
|
|
|
|
func TestPin_ToggleError(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{
|
|
current: sdk.KnowledgeBase{IsPinned: false},
|
|
toggleErr: errors.New("HTTP error 500: internal"),
|
|
}
|
|
err := runPin(context.Background(), &PinOptions{}, nil, svc, "kb_abc", true)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
|
|
}
|
|
|
|
func TestPin_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakePinSvc{current: sdk.KnowledgeBase{IsPinned: false}}
|
|
require.NoError(t, runPin(context.Background(), &PinOptions{}, &cmdutil.JSONOptions{}, svc, "kb_abc", true))
|
|
body := out.String()
|
|
assert.Contains(t, body, `"is_pinned":true`)
|
|
assert.Contains(t, body, `"id":"kb_abc"`)
|
|
}
|