feat(tests): add unit tests for log sanitization and project commands

Author: mahmudunnabikajal

bin/niftycli-mcp.js

@@ -1,9 +1,6 @@
 #!/usr/bin/env node
 import { startServer } from "../src/mcp/server.js";
-
-function sanitizeForLog(text) {
-  return Array.from(String(text), (ch) => (ch.charCodeAt(0) < 0x20 ? " " : ch)).join("");
-}
+import { sanitizeForLog } from "../src/logSanitizer.js";
 
 try {
   await startServer();

package.json

@@ -36,8 +36,8 @@
     "node": ">=24"
   },
   "scripts": {
-    "test": "node --test",
-    "test:coverage": "node --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info",
+    "test": "node --experimental-test-module-mocks --test",
+    "test:coverage": "node --experimental-test-module-mocks --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write .",

src/logSanitizer.js

@@ -0,0 +1,3 @@
+export function sanitizeForLog(text) {
+  return Array.from(String(text), (ch) => (ch.charCodeAt(0) < 0x20 ? " " : ch)).join("");
+}

test/logSanitizer.test.js

@@ -0,0 +1,17 @@
+import { test, describe } from "node:test";
+import assert from "node:assert/strict";
+import { sanitizeForLog } from "../src/logSanitizer.js";
+
+describe("sanitizeForLog", () => {
+  test("leaves normal text untouched", () => {
+    assert.equal(sanitizeForLog("connection failed"), "connection failed");
+  });
+
+  test("replaces control characters with spaces", () => {
+    assert.equal(sanitizeForLog("line1\nline2\rline3\ttab"), "line1 line2 line3 tab");
+  });
+
+  test("coerces non-string input", () => {
+    assert.equal(sanitizeForLog(404), "404");
+  });
+});

test/mcp-server.test.js

@@ -0,0 +1,155 @@
+import { test, describe, before, beforeEach, after, mock } from "node:test";
+import assert from "node:assert/strict";
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+let tmpHome;
+let configModule;
+let createServer;
+let sentEmails;
+
+before(async () => {
+  tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "niftycli-mcp-test-"));
+  process.env.HOME = tmpHome;
+
+  const mailerUrl = new URL("../src/mailer.js", import.meta.url).href;
+  sentEmails = [];
+  mock.module(mailerUrl, {
+    namedExports: {
+      buildTaskEmail: ({ taskName, description, status = "To Do" }) => ({
+        subject: `${taskName} [${status}]`,
+        text: description || "",
+      }),
+      sendTaskEmail: async (smtp, toEmail, email) => {
+        sentEmails.push({ smtp, toEmail, email });
+      },
+    },
+  });
+
+  configModule = await import("../src/config.js");
+  ({ createServer } = await import("../src/mcp/server.js"));
+});
+
+after(() => {
+  fs.rmSync(tmpHome, { recursive: true, force: true });
+});
+
+function callTool(server, name, args = {}) {
+  return server._registeredTools[name].handler(args);
+}
+
+describe("mcp server", () => {
+  test("niftycli_hello greets by name", async () => {
+    const server = createServer();
+    const result = await callTool(server, "niftycli_hello", { name: "World" });
+    assert.match(result.content[0].text, /Hello, World!/);
+  });
+
+  test("niftycli_hello greets without a name", async () => {
+    const server = createServer();
+    const result = await callTool(server, "niftycli_hello");
+    assert.match(result.content[0].text, /^Hello! niftycli-mcp/);
+  });
+
+  test("niftycli_status reports not configured", async () => {
+    const server = createServer();
+    const result = await callTool(server, "niftycli_status");
+    assert.match(result.content[0].text, /not configured yet/);
+  });
+
+  describe("with a saved config", () => {
+    beforeEach(() => {
+      configModule.saveConfig({
+        projects: [{ name: "Website", email: "web@example.com" }],
+        defaultProject: "Website",
+        smtp: { host: "smtp.example.com", user: "me@example.com" },
+      });
+    });
+
+    test("niftycli_status reports configured projects", async () => {
+      const server = createServer();
+      const result = await callTool(server, "niftycli_status");
+      assert.match(result.content[0].text, /niftycli is configured/);
+      assert.match(result.content[0].text, /Website/);
+    });
+
+    test("niftycli_list_projects lists saved projects", async () => {
+      const server = createServer();
+      const result = await callTool(server, "niftycli_list_projects");
+      assert.match(result.content[0].text, /Website <web@example.com> \(default\)/);
+    });
+
+    test("niftycli_add_project adds and defaults the new project", async () => {
+      const server = createServer();
+      const result = await callTool(server, "niftycli_add_project", {
+        name: "Mobile",
+        email: "mobile@example.com",
+      });
+      assert.match(result.content[0].text, /Added project "Mobile"/);
+      const config = configModule.loadConfig();
+      assert.equal(config.defaultProject, "Mobile");
+      assert.equal(config.projects.length, 2);
+    });
+
+    test("niftycli_add_project rejects duplicate names", async () => {
+      const server = createServer();
+      await assert.rejects(
+        callTool(server, "niftycli_add_project", { name: "Website", email: "dup@example.com" }),
+        /already exists/,
+      );
+    });
+
+    test("niftycli_edit_project renames and updates email", async () => {
+      const server = createServer();
+      const result = await callTool(server, "niftycli_edit_project", {
+        currentName: "Website",
+        newName: "Website Revamp",
+        newEmail: "revamp@example.com",
+      });
+      assert.match(result.content[0].text, /Website Revamp/);
+      const config = configModule.loadConfig();
+      assert.equal(config.projects[0].name, "Website Revamp");
+      assert.equal(config.projects[0].email, "revamp@example.com");
+      assert.equal(config.defaultProject, "Website Revamp");
+    });
+
+    test("niftycli_edit_project throws for an unknown project", async () => {
+      const server = createServer();
+      await assert.rejects(
+        callTool(server, "niftycli_edit_project", { currentName: "Nope" }),
+        /No project named/,
+      );
+    });
+
+    test("niftycli_remove_project removes the project", async () => {
+      const server = createServer();
+      const result = await callTool(server, "niftycli_remove_project", { name: "Website" });
+      assert.match(result.content[0].text, /Removed project "Website"/);
+      const config = configModule.loadConfig();
+      assert.equal(config.projects.length, 0);
+    });
+
+    test("niftycli_create_task sends an email to the project", async () => {
+      const server = createServer();
+      const result = await callTool(server, "niftycli_create_task", {
+        project: "Website",
+        name: "Fix bug",
+        description: "Details here",
+        status: "In Progress",
+      });
+      assert.match(result.content[0].text, /Task "Fix bug" sent to project "Website"/);
+      assert.equal(sentEmails.length, 1);
+      assert.equal(sentEmails[0].toEmail, "web@example.com");
+      assert.equal(sentEmails[0].email.subject, "Fix bug [In Progress]");
+    });
+
+    test("niftycli_create_task throws for an unknown project", async () => {
+      const server = createServer();
+      await assert.rejects(
+        callTool(server, "niftycli_create_task", { project: "Nope", name: "Task" }),
+        /No project named/,
+      );
+    });
+  });
+});

test/project.test.js

@@ -0,0 +1,103 @@
+import { test, describe, before, beforeEach, after, mock } from "node:test";
+import assert from "node:assert/strict";
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+let tmpHome;
+let configModule;
+let projectModule;
+let inputQueue;
+let selectQueue;
+let confirmQueue;
+
+before(async () => {
+  tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "niftycli-project-test-"));
+  process.env.HOME = tmpHome;
+
+  mock.module("@inquirer/prompts", {
+    namedExports: {
+      input: async () => inputQueue.shift(),
+      select: async () => selectQueue.shift(),
+      confirm: async () => confirmQueue.shift(),
+    },
+  });
+
+  configModule = await import("../src/config.js");
+  projectModule = await import("../src/commands/project.js");
+});
+
+beforeEach(() => {
+  inputQueue = [];
+  selectQueue = [];
+  confirmQueue = [];
+  process.exitCode = 0;
+  configModule.saveConfig({ projects: [], defaultProject: undefined });
+});
+
+after(() => {
+  fs.rmSync(tmpHome, { recursive: true, force: true });
+});
+
+describe("project commands", () => {
+  test("promptNewProject appends a project and sets it as default", async () => {
+    const config = { projects: [] };
+    inputQueue = ["Website", "web@example.com"];
+    const project = await projectModule.promptNewProject(config);
+    assert.deepEqual(project, { name: "Website", email: "web@example.com" });
+    assert.equal(config.projects.length, 1);
+    assert.equal(config.defaultProject, "Website");
+    assert.deepEqual(configModule.loadConfig().projects, [project]);
+  });
+
+  test("addProjectCommand exits with an error when unconfigured", async () => {
+    fs.rmSync(configModule.getConfigPath(), { force: true });
+    await projectModule.addProjectCommand();
+    assert.equal(process.exitCode, 1);
+  });
+
+  describe("with an existing project", () => {
+    beforeEach(() => {
+      configModule.saveConfig({
+        projects: [{ name: "Website", email: "web@example.com" }],
+        defaultProject: "Website",
+      });
+    });
+
+    test("listProjectsCommand does not throw for a populated config", async () => {
+      await assert.doesNotReject(projectModule.listProjectsCommand());
+    });
+
+    test("listProjectsCommand does not throw for an empty config", async () => {
+      configModule.saveConfig({ projects: [], defaultProject: undefined });
+      await assert.doesNotReject(projectModule.listProjectsCommand());
+    });
+
+    test("editProjectCommand renames the selected project", async () => {
+      selectQueue = ["Website"];
+      inputQueue = ["Website Revamp", "revamp@example.com"];
+      await projectModule.editProjectCommand();
+      const config = configModule.loadConfig();
+      assert.equal(config.projects[0].name, "Website Revamp");
+      assert.equal(config.projects[0].email, "revamp@example.com");
+      assert.equal(config.defaultProject, "Website Revamp");
+    });
+
+    test("removeProjectCommand removes the project when confirmed", async () => {
+      selectQueue = ["Website"];
+      confirmQueue = [true];
+      await projectModule.removeProjectCommand();
+      const config = configModule.loadConfig();
+      assert.equal(config.projects.length, 0);
+      assert.equal(config.defaultProject, undefined);
+    });
+
+    test("removeProjectCommand aborts when not confirmed", async () => {
+      selectQueue = ["Website"];
+      confirmQueue = [false];
+      await projectModule.removeProjectCommand();
+      const config = configModule.loadConfig();
+      assert.equal(config.projects.length, 1);
+    });
+  });
+});