fae2303db3
* feat(plugins): per-plugin settings pages driven by manifest config_schema Settings > Plugins rows now open /settings/plugins/:id — a detail page showing the manifest plus a settings form generated from the plugin author's config_schema. Secret fields (secret: true / format: password) are masked on the operator API and kept on masked re-submits; a running plugin restarts on save and reads its config (cleartext secrets included) through the new Host GetConfig gRPC RPC. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): write plugin config file owner-only (0600) Operator config can now carry cleartext secret values (config_schema fields marked secret), so <id>.config.yml must not be world-readable — match the 0600 mode the record file already uses. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * feat(plugins): vault-backed plugin secrets — Get/Set/DeleteSecret RPCs and encrypted config secrets Plugins get vault-backed secret primitives on the Host API (GetSecret/SetSecret/DeleteSecret, capability-gated, namespaced to plugin:<id>㊙️<key> so a plugin can only touch its own entries; purged on uninstall). Secret config_schema fields now live in kandev's AES-256-GCM vault too — <id>.config.yml persists only a vault reference, and the Host GetConfig RPC resolves it back to cleartext for the plugin. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * chore(plugins): serve PR screenshots from the media/pr-1761-screenshots ref instead of the repo The PR body now points at raw URLs pinned to an unmerged media ref, so the binaries never land in main (PRs are squash-merged; only the branch tip tree merges). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): address review feedback on settings validation and save flow - integer form fields reject non-integral input instead of parseInt-truncating - enum selections keep their schema-declared types (numeric enums round-trip) - backend enum validation normalizes int-vs-float64 before comparison - maskSecrets masks any non-zero secret value regardless of runtime type - save flow splits PATCH from refetch: a refetch failure no longer reports a successful save as an error, and typed secrets are masked on screen - optional enum fields gain a 'Not set' option so they can be cleared - resolveConfigSecrets copies before mutating; restart-failure SetStatus errors are logged; SDK test fake returns a non-nil empty config map - add missing tests: usePluginConfigForm hook, getPluginConfig client, integer/enum regression cases Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): harden secret config invariants from review - reject non-string values on declared secret fields at validation time, closing the path where a numeric/boolean secret bypassed the vault and persisted cleartext in the config file - delete removed secret fields' vault entries only AFTER the config commit succeeds, so a failed SetConfig never leaves the still-current config referencing a deleted vault entry - uninstall fails closed: the plugin's vault namespace is purged before any destructive step, and a cleanup failure aborts the uninstall (retryable) instead of letting a reinstall inherit stale secrets Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): failure-atomic config secrets, quiesced uninstall purge, ctx propagation - UpdateConfig is now failure-atomic for secret overwrites: storeConfigSecrets snapshots each vault entry before writing and returns a rollback that restores prior values (or deletes newly-created ones). A vault.Set failure mid-loop or a failed SetConfig commit rolls back, so a request reported as failed never changes the value a still-current config ref resolves to. - Uninstall stops the plugin process BEFORE purging its vault namespace, so the plugin can no longer race the cleanup with a SetSecret between ListIDs and the deletes; the purge stays fail-closed and retryable. - Thread the request context through Uninstall -> deletePluginSecrets instead of context.Background(), per the pass-context-through-chains convention. - Consolidate the 'secret not found:' prefix check into isSecretNotFound (host.go + service rollback share one definition). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): detach rollback context, fail closed without a vault, reconcile uninstall status - vault rollback closures now run on context.WithoutCancel(ctx): a request cancelled mid-save (browser closed) can no longer abort the rollback and leave the vault holding new values while the unchanged config still points at them (Greptile P1). - storeConfigSecrets fails closed (errSecretVaultRequired) when a plugin declares secret config fields but no vault is wired, instead of silently persisting the secret in cleartext. - vaultRestoreFunc distinguishes not-found from a genuine Reveal error: a backend read failure aborts the update before writing rather than risk a rollback that deletes a real secret; rollback now returns errors, joined into UpdateConfig's failure so an inconsistent vault is surfaced, not just logged. - Uninstall reconciles lifecycle status when a secret-purge failure aborts after the process was stopped: a previously-running plugin transitions to error and notifies observers instead of being reported active with no process running. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): detach removed-secret cleanup ctx and clear stale save dirty flag - cleanupRemovedConfigSecrets now runs on context.WithoutCancel(ctx), matching the rollback path, so a client disconnect right after the config commit can no longer cancel the delete and orphan now-unreferenced vault entries. - tests: assert GetConfig succeeds before treating an empty map as proof that nothing persisted (a swallowed read error would be a false pass). - web: on a post-save refetch failure, rebase initialValues onto the masked snapshot so the saved form no longer reads as dirty. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): fail tests on discarded GetConfig errors, drop setState-in-updater - config_test: capture and fatal on GetConfig errors at the four remaining positive-assertion sites (a nil from a failed read would panic on the next map access instead of giving a clear failure), matching the earlier fix. - web hook: compute the masked post-save snapshot from the current values and apply it to setValues + setInitialValues directly, instead of calling setInitialValues inside a setValues functional updater (a React anti-pattern that runs twice under StrictMode). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(plugins): skip validation of a secret field's own vault ref - validateConfigSchema takes the plugin id and skips a secret field whose value is that field's config vault ref (an internal storage marker, already validated when first set). Without this, a field declaring both secret: true and enum: [...] 400s on every save that keeps the mask, because the enum check saw the vault ref instead of a user value. Freshly entered secret values are still validated; a foreign plugin's ref is not skipped. Covered by unit + service-level regression tests. - surface mid-loop vault rollback failures in storeConfigSecrets via a warning instead of discarding them (double-fault observability). - web: integer inputs get step=1 so browsers flag non-integral input in place (serializeConfigValues remains the backstop). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * test(plugins): split config secret tests into config_secrets_test.go config_test.go had grown past the 800-line backend file-length limit (revive), failing CI lint. Move the vault-backed config and plugin-scoped secret tests (plus their fake-vault/store helpers) into a sibling file; no test logic changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Kandev Agent <agent@kandev.dev> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
196 lines
6.3 KiB
Go
196 lines
6.3 KiB
Go
// Command plugin-fixture tests. Exercises fixturePlugin's Plugin methods
|
|
// (OnEvent, InvokeTool, HandleWebhook) via direct calls — no go-plugin
|
|
// spawn needed, since fixturePlugin has no dependency on the gRPC
|
|
// transport itself (pluginsdk.Serve owns that wiring and is covered by
|
|
// pkg/pluginsdk's own tests).
|
|
package main
|
|
|
|
import (
|
|
"bufio"
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/kandev/kandev/pkg/pluginsdk"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
var errBoom = errors.New("boom")
|
|
|
|
// readJSONLines reads path and decodes each non-empty line as T.
|
|
func readJSONLines[T any](t *testing.T, path string) []T {
|
|
t.Helper()
|
|
data, err := os.ReadFile(path)
|
|
require.NoError(t, err)
|
|
|
|
var out []T
|
|
scanner := bufio.NewScanner(bytes.NewReader(data))
|
|
for scanner.Scan() {
|
|
line := scanner.Bytes()
|
|
if len(bytes.TrimSpace(line)) == 0 {
|
|
continue
|
|
}
|
|
var v T
|
|
require.NoError(t, json.Unmarshal(line, &v))
|
|
out = append(out, v)
|
|
}
|
|
require.NoError(t, scanner.Err())
|
|
return out
|
|
}
|
|
|
|
func TestOnEvent_AppendsJSONLineToDataDir(t *testing.T) {
|
|
dir := t.TempDir()
|
|
p := &fixturePlugin{dataDir: dir}
|
|
|
|
err := p.OnEvent(context.Background(), &pluginsdk.Event{
|
|
EventID: "evt_1",
|
|
EventType: "task.created",
|
|
Payload: map[string]any{"task_id": "t1"},
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
recs := readJSONLines[deliveryRecord](t, filepath.Join(dir, "deliveries.jsonl"))
|
|
require.Len(t, recs, 1)
|
|
require.Equal(t, "task.created", recs[0].EventType)
|
|
require.Equal(t, "evt_1", recs[0].EventID)
|
|
}
|
|
|
|
func TestOnEvent_AppendsMultipleDeliveriesInOrder(t *testing.T) {
|
|
dir := t.TempDir()
|
|
p := &fixturePlugin{dataDir: dir}
|
|
|
|
require.NoError(t, p.OnEvent(context.Background(), &pluginsdk.Event{EventID: "e1", EventType: "task.created"}))
|
|
require.NoError(t, p.OnEvent(context.Background(), &pluginsdk.Event{EventID: "e2", EventType: "task.updated"}))
|
|
|
|
recs := readJSONLines[deliveryRecord](t, filepath.Join(dir, "deliveries.jsonl"))
|
|
require.Len(t, recs, 2)
|
|
require.Equal(t, "e1", recs[0].EventID)
|
|
require.Equal(t, "e2", recs[1].EventID)
|
|
}
|
|
|
|
func TestOnEvent_CreatesDataDirIfMissing(t *testing.T) {
|
|
dir := filepath.Join(t.TempDir(), "nested", "data")
|
|
p := &fixturePlugin{dataDir: dir}
|
|
|
|
err := p.OnEvent(context.Background(), &pluginsdk.Event{EventID: "e1", EventType: "task.created"})
|
|
require.NoError(t, err)
|
|
|
|
_, err = os.Stat(filepath.Join(dir, "deliveries.jsonl"))
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func TestOnEvent_FirstEventCallsHostSetState(t *testing.T) {
|
|
dir := t.TempDir()
|
|
p := &fixturePlugin{dataDir: dir}
|
|
host := &fakeHost{}
|
|
p.SetHost(host)
|
|
|
|
require.NoError(t, p.OnEvent(context.Background(), &pluginsdk.Event{EventID: "e1", EventType: "task.created"}))
|
|
require.NoError(t, p.OnEvent(context.Background(), &pluginsdk.Event{EventID: "e2", EventType: "task.updated"}))
|
|
|
|
require.Len(t, host.setStateCalls, 1, "SetState should only be exercised on the first event")
|
|
call := host.setStateCalls[0]
|
|
require.Equal(t, "instance", call.scope)
|
|
require.Equal(t, "", call.scopeID)
|
|
require.Equal(t, "last_event", call.key)
|
|
require.Equal(t, "e1", call.value["event_id"])
|
|
}
|
|
|
|
func TestOnEvent_IgnoresHostSetStateError(t *testing.T) {
|
|
dir := t.TempDir()
|
|
p := &fixturePlugin{dataDir: dir}
|
|
host := &fakeHost{setStateErr: errBoom}
|
|
p.SetHost(host)
|
|
|
|
err := p.OnEvent(context.Background(), &pluginsdk.Event{EventID: "e1", EventType: "task.created"})
|
|
require.NoError(t, err, "Host.SetState failures must be best-effort and not fail OnEvent")
|
|
}
|
|
|
|
func TestInvokeTool_EchoReturnsInput(t *testing.T) {
|
|
p := &fixturePlugin{dataDir: t.TempDir()}
|
|
|
|
input := map[string]any{"channel": "#dev", "text": "hi"}
|
|
resp, err := p.InvokeTool(context.Background(), &pluginsdk.ToolRequest{
|
|
ToolName: "echo",
|
|
Input: input,
|
|
})
|
|
require.NoError(t, err)
|
|
require.Equal(t, input, resp.Output)
|
|
}
|
|
|
|
func TestHandleWebhook_AppendsJSONLineAndRespondsOK(t *testing.T) {
|
|
dir := t.TempDir()
|
|
p := &fixturePlugin{dataDir: dir}
|
|
|
|
resp, err := p.HandleWebhook(context.Background(), &pluginsdk.WebhookRequest{
|
|
WebhookKey: "test-hook",
|
|
Method: "POST",
|
|
Body: []byte(`{"ping":true}`),
|
|
})
|
|
require.NoError(t, err)
|
|
require.Equal(t, int32(200), resp.Status)
|
|
require.Equal(t, "ok", string(resp.Body))
|
|
|
|
recs := readJSONLines[webhookRecord](t, filepath.Join(dir, "webhooks.jsonl"))
|
|
require.Len(t, recs, 1)
|
|
require.Equal(t, "test-hook", recs[0].WebhookKey)
|
|
}
|
|
|
|
func TestResolveDataDir_UsesEnvWhenSet(t *testing.T) {
|
|
t.Setenv("KANDEV_PLUGIN_DATA_DIR", "/tmp/kandev-plugin-e2e-data")
|
|
require.Equal(t, "/tmp/kandev-plugin-e2e-data", resolveDataDir())
|
|
}
|
|
|
|
func TestResolveDataDir_FallsBackToCwdWhenUnset(t *testing.T) {
|
|
t.Setenv("KANDEV_PLUGIN_DATA_DIR", "")
|
|
wd, err := os.Getwd()
|
|
require.NoError(t, err)
|
|
require.Equal(t, wd, resolveDataDir())
|
|
}
|
|
|
|
// setStateCall records one fakeHost.SetState invocation.
|
|
type setStateCall struct {
|
|
scope, scopeID, key string
|
|
value map[string]any
|
|
}
|
|
|
|
// fakeHost is a minimal pluginsdk.Host test double that only records
|
|
// SetState calls; the fixture plugin never exercises the other methods. It
|
|
// embeds UnimplementedHostData to satisfy the Host data API (ADR 0043)
|
|
// sub-accessors without wiring them.
|
|
type fakeHost struct {
|
|
pluginsdk.UnimplementedHostData
|
|
|
|
setStateCalls []setStateCall
|
|
setStateErr error
|
|
}
|
|
|
|
func (h *fakeHost) GetState(context.Context, string, string, string) (map[string]any, bool, error) {
|
|
return nil, false, nil
|
|
}
|
|
|
|
func (h *fakeHost) SetState(_ context.Context, scope, scopeID, key string, value map[string]any) error {
|
|
h.setStateCalls = append(h.setStateCalls, setStateCall{scope: scope, scopeID: scopeID, key: key, value: value})
|
|
return h.setStateErr
|
|
}
|
|
|
|
func (h *fakeHost) DeleteState(context.Context, string, string, string) error { return nil }
|
|
|
|
func (h *fakeHost) ListState(context.Context, string, string) ([]pluginsdk.StateEntry, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (h *fakeHost) GetConfig(context.Context) (map[string]any, error) { return nil, nil }
|
|
func (h *fakeHost) GetSecret(context.Context, string) (string, bool, error) { return "", false, nil }
|
|
func (h *fakeHost) SetSecret(context.Context, string, string) error { return nil }
|
|
func (h *fakeHost) DeleteSecret(context.Context, string) error { return nil }
|
|
func (h *fakeHost) RevealSecret(context.Context, string) (string, error) { return "", nil }
|
|
|
|
func (h *fakeHost) EmitEvent(context.Context, string, map[string]any) error { return nil }
|
|
|
|
var _ pluginsdk.Host = (*fakeHost)(nil)
|