mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-31 00:50:02 +08:00
da9faa9e07
Borrows the lark-cli agent-affordance model (https://github.com/larksuite/cli/blob/main/AGENTS.md + skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly: error messages, output format, and flag design follow conventions agents can rely on. cli/AGENTS.md (operational reference for LLM agents invoking weknora): Public document covering envelope schema, exit-code protocol (0/1/2/10/130), stdout/stderr separation, and behavioral rules. Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`) gain "AI agents:" paragraphs in their cobra Long descriptions so guidance shows in --help. format.Envelope schema additions: Risk per-operation classification (read / write / high-risk-write + action description), populated by write commands on both success and failure paths. Notice system advisories (CLI update available, server-CLI version skew); type defined, emit sites land in v0.3. DryRun marker for envelopes returned from --dry-run preview paths. RiskLevel constants realigned to lark's taxonomy: read / write / high-risk-write (was: read / mutating / destructive — not yet wired by any command). cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it to envelope.Risk so destructive failure paths surface uniformly. Exit-10 confirmation protocol: New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in cmdutil.ExitCode. ConfirmDestructive now returns this code (with OperationRisk attached) when stdout is non-TTY or --json was set, with -y/--yes absent. Previous behavior — silent proceed in non-TTY — was unsafe: scripts and agents could delete resources with no explicit approval. Three test cases re-pinned around the new contract. This is a wire-contract change for any caller who relied on silent proceed; v0.0/v0.1 had no destructive commands, so the blast radius is contained to v0.2 itself. --dry-run global flag: cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/ DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an envelope with dry_run=true plus a Risk classification. Read commands ignore --dry-run by design (no side effect to preview). Human-mode prints \`[dry-run] would <action>\` to stdout. Command discovery: agents introspect via the existing \`--help\` surface (consistent with gh / kubectl / aws / gcloud / terraform — none of them ship a CLI-tree self-description command). An earlier draft added a \`weknora schema\` reflection command; dropped after a mainstream survey found it has no stable analog (lark-cli's schema describes Lark API methods, not its own CLI tree). Tests: 27 cli packages pass at this commit. Added two new tests covering envelope.risk and envelope._notice serialization.
146 lines
5.2 KiB
Go
146 lines
5.2 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"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"
|
|
)
|
|
|
|
// fakeDeleteSvc captures the id passed and returns a canned error.
|
|
type fakeDeleteSvc struct {
|
|
err error
|
|
got string
|
|
calls int
|
|
}
|
|
|
|
func (f *fakeDeleteSvc) DeleteKnowledge(_ context.Context, id string) error {
|
|
f.calls++
|
|
f.got = id
|
|
return f.err
|
|
}
|
|
|
|
// scriptedConfirm satisfies prompt.Prompter and returns predetermined answers.
|
|
type scriptedConfirm struct{ confirmReturn bool }
|
|
|
|
func (s scriptedConfirm) Input(string, string) (string, error) { return "", nil }
|
|
func (s scriptedConfirm) Password(string) (string, error) { return "", nil }
|
|
func (s scriptedConfirm) Confirm(string, bool) (bool, error) { return s.confirmReturn, nil }
|
|
|
|
// errPrompter returns an error from Confirm — simulates a non-TTY agent
|
|
// prompter.
|
|
type errPrompter struct{}
|
|
|
|
func (errPrompter) Input(string, string) (string, error) { return "", nil }
|
|
func (errPrompter) Password(string) (string, error) { return "", nil }
|
|
func (errPrompter) Confirm(string, bool) (bool, error) {
|
|
return false, errors.New("no tty")
|
|
}
|
|
|
|
func TestDelete_Success_WithForce(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
opts := &DeleteOptions{Yes: true}
|
|
// Force=true short-circuits the confirm path; the prompter must not be
|
|
// consulted, so any value works.
|
|
require.NoError(t, runDelete(context.Background(), opts, svc, scriptedConfirm{confirmReturn: false}, "doc_abc"))
|
|
|
|
assert.Equal(t, "doc_abc", svc.got)
|
|
assert.Equal(t, 1, svc.calls)
|
|
assert.Contains(t, out.String(), "✓")
|
|
assert.Contains(t, out.String(), "doc_abc")
|
|
}
|
|
|
|
func TestDelete_Success_JSON(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
opts := &DeleteOptions{Yes: true, JSONOut: true}
|
|
require.NoError(t, runDelete(context.Background(), opts, svc, scriptedConfirm{confirmReturn: true}, "doc_abc"))
|
|
|
|
got := out.String()
|
|
assert.True(t, strings.HasPrefix(got, `{"ok":true`), "envelope should start with ok:true; got %q", got)
|
|
assert.Contains(t, got, `"id":"doc_abc"`)
|
|
assert.Contains(t, got, `"deleted":true`)
|
|
}
|
|
|
|
func TestDelete_NotFound_404(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{err: errors.New("HTTP error 404: not found")}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: true}, svc, scriptedConfirm{}, "doc_missing")
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeResourceNotFound, typed.Code)
|
|
}
|
|
|
|
func TestDelete_HTTPError_500(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{err: errors.New("HTTP error 500: internal")}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: true}, svc, scriptedConfirm{}, "doc_x")
|
|
require.Error(t, err)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeServerError, typed.Code)
|
|
}
|
|
|
|
func TestDelete_ConfirmYes(t *testing.T) {
|
|
out, _ := iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, svc, scriptedConfirm{confirmReturn: true}, "doc_abc")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 1, svc.calls, "user said yes ⇒ delete proceeds")
|
|
assert.Contains(t, out.String(), "✓")
|
|
}
|
|
|
|
func TestDelete_ConfirmNo(t *testing.T) {
|
|
_, errBuf := iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, svc, scriptedConfirm{confirmReturn: false}, "doc_abc")
|
|
require.Error(t, err)
|
|
assert.Equal(t, 0, svc.calls, "user said no ⇒ SDK must NOT be called")
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeUserAborted, typed.Code)
|
|
assert.Contains(t, errBuf.String(), "Aborted.")
|
|
}
|
|
|
|
// TestDelete_AgentPrompterErrors covers the path where the prompter itself
|
|
// returns an error (e.g. AgentPrompter, broken stdin). runDelete maps this to
|
|
// CodeInputMissingFlag so the user sees "pass --force" in the hint.
|
|
func TestDelete_AgentPrompterErrors(t *testing.T) {
|
|
_, _ = iostreams.SetForTestWithTTY(t)
|
|
svc := &fakeDeleteSvc{}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, svc, errPrompter{}, "doc_abc")
|
|
require.Error(t, err)
|
|
assert.Equal(t, 0, svc.calls)
|
|
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputMissingFlag, typed.Code)
|
|
}
|
|
|
|
// TestDelete_NoYes_NonTTY_RequiresConfirmation: when stdout isn't a TTY
|
|
// (typical agent pipe / CI), the lark-cli skill protocol requires explicit
|
|
// -y/--yes. The CLI exits 10 with input.confirmation_required, never
|
|
// silently proceeds. See cli/AGENTS.md "Exit codes".
|
|
func TestDelete_NoYes_NonTTY_RequiresConfirmation(t *testing.T) {
|
|
_, _ = iostreams.SetForTest(t)
|
|
svc := &fakeDeleteSvc{}
|
|
err := runDelete(context.Background(), &DeleteOptions{Yes: false}, svc, errPrompter{}, "doc_abc")
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputConfirmationRequired, typed.Code)
|
|
assert.Equal(t, 0, svc.calls, "non-TTY without -y must not call DeleteKnowledge")
|
|
assert.Equal(t, 10, cmdutil.ExitCode(err))
|
|
}
|