mirror of
https://github.com/binaricat/Netcatty.git
synced 2026-11-16 12:01:13 +00:00
* feat(vault): let Skills + CLI operate notes with the same approval as MCP Expose vault note list, read, write, and markdown import on the tool CLI so agents can save generated documents only after the user approves. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(vault): keep explicit empty note fields in the CLI A supplied empty string was treated as an omitted flag, so note clears and empty markdown imports never reached the note service. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(vault): allow an explicit empty note body on CLI create notes create --content "" was rejected as a missing flag, so it did not match vault_notes_create. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(vault): stop echoing imported note bodies and recognize leading CLI flags A batch import resent every document over IPC, and a leading --json hid the notes command from artifact inference. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(vault): make note CLI import safe and fail writes cleanly --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: bincxz <16399091+binaricat@users.noreply.github.com>
284 lines
9.7 KiB
JavaScript
284 lines
9.7 KiB
JavaScript
"use strict";
|
|
|
|
const test = require("node:test");
|
|
const assert = require("node:assert/strict");
|
|
const { Readable } = require("node:stream");
|
|
|
|
const { parseArgs, readNoteInputFromStdin, readNoteFromAttachment, validateNoteImportSize, bindHostChatSession, requireChatSession } = require("./netcatty-tool-cli.cjs");
|
|
const { buildCatalogCliParams } = require("../capabilities/adapters/cliAdapter.cjs");
|
|
const { TOOL_CLI_CHAT_SESSION_ENV_VAR } = require("./cliChatSession.cjs");
|
|
|
|
function fakeCreateError(code, message) {
|
|
const err = new Error(message);
|
|
err.code = code;
|
|
return err;
|
|
}
|
|
|
|
test("parseArgs consumes attachment filename flag", () => {
|
|
const { positionals, opts } = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"attachment",
|
|
"read",
|
|
"--filename",
|
|
"hosts.csv",
|
|
"--json",
|
|
]);
|
|
|
|
assert.deepEqual(positionals, ["attachment", "read"]);
|
|
assert.equal(opts.filename, "hosts.csv");
|
|
assert.equal(opts.chatSessionId, null);
|
|
assert.equal(opts.json, true);
|
|
});
|
|
|
|
test("parseArgs rejects the removed --chat-session flag", () => {
|
|
assert.throws(
|
|
() => parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"env",
|
|
"--chat-session",
|
|
"other-chat",
|
|
"--json",
|
|
]),
|
|
(err) => {
|
|
assert.equal(err.code, "INVALID_ARGUMENT");
|
|
assert.match(err.message, /not a CLI flag/);
|
|
return true;
|
|
},
|
|
);
|
|
});
|
|
|
|
test("parseArgs consumes snippet multi-line run mode flag", () => {
|
|
const { positionals, opts } = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"snippets",
|
|
"update",
|
|
"--snippet-id",
|
|
"snippet-1",
|
|
"--multi-line-run-mode",
|
|
"lineDelay",
|
|
"--json",
|
|
]);
|
|
|
|
assert.deepEqual(positionals, ["snippets", "update"]);
|
|
assert.equal(opts.snippetId, "snippet-1");
|
|
assert.equal(opts.multiLineRunMode, "lineDelay");
|
|
assert.equal(opts.json, true);
|
|
});
|
|
|
|
test("parseArgs consumes dynamic script group targets", () => {
|
|
const { positionals, opts } = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"scripts",
|
|
"targets",
|
|
"set",
|
|
"--script-id",
|
|
"script-1",
|
|
"--target-groups",
|
|
'["Production","Staging/Web"]',
|
|
"--json",
|
|
]);
|
|
|
|
assert.deepEqual(positionals, ["scripts", "targets", "set"]);
|
|
assert.equal(opts.scriptId, "script-1");
|
|
assert.equal(opts.targetGroups, '["Production","Staging/Web"]');
|
|
assert.equal(opts.json, true);
|
|
});
|
|
|
|
test("parseArgs consumes vault note import flags", () => {
|
|
const { positionals, opts } = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"notes",
|
|
"import",
|
|
"--file-name",
|
|
"runbook.md",
|
|
"--title",
|
|
"Runbook",
|
|
"--content",
|
|
"# Steps",
|
|
"--group",
|
|
"ops",
|
|
"--json",
|
|
]);
|
|
|
|
assert.deepEqual(positionals, ["notes", "import"]);
|
|
assert.equal(opts.fileName, "runbook.md");
|
|
assert.equal(opts.title, "Runbook");
|
|
assert.equal(opts.content, "# Steps");
|
|
assert.equal(opts.group, "ops");
|
|
assert.equal(opts.json, true);
|
|
});
|
|
|
|
test("notes import reads literal markdown from stdin without shell expansion or argument limits", async () => {
|
|
const parsed = parseArgs(["node", "netcatty-tool-cli", "notes", "import", "--content-stdin", "--json"]);
|
|
const markdown = '# Runbook\n\n$(printf SHOULD_NOT_EXECUTE)\n`command`\n';
|
|
await readNoteInputFromStdin(parsed.positionals, parsed.opts, Readable.from([markdown]));
|
|
const params = buildCatalogCliParams("vault.note.import", parsed.opts, fakeCreateError);
|
|
assert.equal(params.content, markdown);
|
|
});
|
|
|
|
test("notes import reads a batch JSON document from stdin", async () => {
|
|
const parsed = parseArgs(["node", "netcatty-tool-cli", "notes", "import", "--documents-stdin"]);
|
|
const documents = '[{"fileName":"one.md","content":"# One\\n$(whoami)"}]';
|
|
await readNoteInputFromStdin(parsed.positionals, parsed.opts, Readable.from([documents]));
|
|
assert.equal(buildCatalogCliParams("vault.note.import", parsed.opts, fakeCreateError).documents, documents);
|
|
});
|
|
|
|
test("note stdin rejects conflicting flags and oversized content before connecting", async () => {
|
|
const conflicting = parseArgs(["node", "netcatty-tool-cli", "notes", "create", "--title", "A", "--content", "x", "--content-stdin"]);
|
|
await assert.rejects(
|
|
readNoteInputFromStdin(conflicting.positionals, conflicting.opts, Readable.from(["body"])),
|
|
/Do not combine stdin note input/,
|
|
);
|
|
const oversized = parseArgs(["node", "netcatty-tool-cli", "notes", "import", "--content-stdin"]);
|
|
await assert.rejects(
|
|
readNoteInputFromStdin(oversized.positionals, oversized.opts, Readable.from([Buffer.alloc(4 * 1024 * 1024 + 1)])),
|
|
/exceeds the 4 MiB CLI limit/,
|
|
);
|
|
});
|
|
|
|
test("notes import reads a registered attachment by index without a shell content argument", async () => {
|
|
const parsed = parseArgs(["node", "netcatty-tool-cli", "notes", "import", "--attachment-index", "0"]);
|
|
parsed.opts.chatSessionId = "chat-a";
|
|
const calls = [];
|
|
const client = { call: async (method, params) => {
|
|
calls.push({ method, params });
|
|
if (method === "netcatty/listAttachments") return {
|
|
ok: true,
|
|
attachments: [{ filename: "runbook.md", filePath: "/registered/runbook.md", sizeBytes: 25 }],
|
|
};
|
|
return { ok: true, filename: "runbook.md", text: "# Runbook\n$(whoami)" };
|
|
} };
|
|
await readNoteFromAttachment(client, parsed.opts);
|
|
assert.deepEqual(calls.map((call) => call.method), ["netcatty/listAttachments", "netcatty/readAttachment"]);
|
|
assert.equal(calls[1].params.chatSessionId, "chat-a");
|
|
assert.equal(calls[1].params.filePath, "/registered/runbook.md");
|
|
assert.equal(calls[1].params.maxBytes, 1024 * 1024);
|
|
const params = buildCatalogCliParams("vault.note.import", parsed.opts, fakeCreateError);
|
|
assert.equal(params.fileName, "runbook.md");
|
|
assert.equal(params.content, "# Runbook\n$(whoami)");
|
|
});
|
|
|
|
test("notes import rejects oversized attachment content even without listed size", async () => {
|
|
const parsed = parseArgs(["node", "netcatty-tool-cli", "notes", "import", "--attachment-index", "0"]);
|
|
parsed.opts.chatSessionId = "chat-a";
|
|
const client = { call: async (method) => method === "netcatty/listAttachments"
|
|
? { ok: true, attachments: [{ filename: "runbook.md" }] }
|
|
: { ok: true, filename: "runbook.md", text: "x".repeat(1024 * 1024 + 1) } };
|
|
await assert.rejects(readNoteFromAttachment(client, parsed.opts), /1 MiB attachment limit/);
|
|
});
|
|
|
|
test("notes import checks per-document character limits before requesting approval", () => {
|
|
assert.doesNotThrow(() => validateNoteImportSize({ content: "x".repeat(512000) }));
|
|
assert.throws(() => validateNoteImportSize({ content: "x".repeat(512001) }), /512,000 character/);
|
|
assert.throws(() => validateNoteImportSize({ documents: JSON.stringify([
|
|
{ fileName: "runbook.md", content: "x".repeat(512001) },
|
|
]) }), /512,000 character/);
|
|
});
|
|
|
|
test("notes import refuses an attachment that is not Markdown", async () => {
|
|
const parsed = parseArgs(["node", "netcatty-tool-cli", "notes", "import", "--attachment-index", "0"]);
|
|
parsed.opts.chatSessionId = "chat-a";
|
|
const client = { call: async () => ({ ok: true, attachments: [{ filename: "hosts.csv", sizeBytes: 12 }] }) };
|
|
await assert.rejects(readNoteFromAttachment(client, parsed.opts), /registered Markdown file/);
|
|
});
|
|
|
|
test("notes create CLI keeps an explicit empty content and still requires the flag", () => {
|
|
const created = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"notes",
|
|
"create",
|
|
"--title",
|
|
"Empty",
|
|
"--content",
|
|
"",
|
|
"--json",
|
|
]);
|
|
assert.equal(created.opts.title, "Empty");
|
|
assert.equal(created.opts.content, "");
|
|
const params = buildCatalogCliParams("vault.note.create", created.opts, fakeCreateError);
|
|
assert.equal(params.title, "Empty");
|
|
assert.equal(params.content, "");
|
|
|
|
const omitted = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"notes",
|
|
"create",
|
|
"--title",
|
|
"Empty",
|
|
"--json",
|
|
]);
|
|
assert.equal(omitted.opts.content, null);
|
|
assert.throws(
|
|
() => buildCatalogCliParams("vault.note.create", omitted.opts, fakeCreateError),
|
|
/Missing required --content for vault\.note\.create/,
|
|
);
|
|
});
|
|
|
|
test("notes CLI keeps explicit empty content and group through parse and catalog params", () => {
|
|
const cleared = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"notes",
|
|
"update",
|
|
"--note-id",
|
|
"n1",
|
|
"--content",
|
|
"",
|
|
"--group",
|
|
"",
|
|
"--json",
|
|
]);
|
|
assert.equal(cleared.opts.content, "");
|
|
assert.equal(cleared.opts.group, "");
|
|
const updateParams = buildCatalogCliParams("vault.note.update", cleared.opts, fakeCreateError);
|
|
assert.equal(updateParams.noteId, "n1");
|
|
assert.equal(updateParams.content, "");
|
|
assert.equal(updateParams.group, "");
|
|
assert.equal("title" in updateParams, false);
|
|
|
|
const imported = parseArgs([
|
|
"node",
|
|
"netcatty-tool-cli",
|
|
"notes",
|
|
"import",
|
|
"--file-name",
|
|
"empty.md",
|
|
"--content",
|
|
"",
|
|
"--json",
|
|
]);
|
|
assert.equal(imported.opts.content, "");
|
|
const importParams = buildCatalogCliParams("vault.note.import", imported.opts, fakeCreateError);
|
|
assert.equal(importParams.fileName, "empty.md");
|
|
assert.equal(importParams.content, "");
|
|
});
|
|
|
|
test("requireChatSession accepts a resolved id", () => {
|
|
assert.equal(requireChatSession({ chatSessionId: "chat-1" }, "env"), "chat-1");
|
|
});
|
|
|
|
test("requireChatSession explains the host env var when missing", () => {
|
|
assert.throws(
|
|
() => requireChatSession({ chatSessionId: null }, "env"),
|
|
(err) => {
|
|
assert.equal(err.code, "INVALID_ARGUMENT");
|
|
assert.match(err.message, /NETCATTY_CLI_CHAT_SESSION_ID/);
|
|
assert.doesNotMatch(err.message, /Pass --chat-session/);
|
|
return true;
|
|
},
|
|
);
|
|
});
|
|
|
|
test("bindHostChatSession copies only the host env id onto opts", () => {
|
|
const opts = { chatSessionId: null };
|
|
bindHostChatSession(opts, { [TOOL_CLI_CHAT_SESSION_ENV_VAR]: "ai_123" });
|
|
assert.equal(opts.chatSessionId, "ai_123");
|
|
});
|