16 tools have no handler test; ssh-api test mocks are copied and have drifted

Offen
#164 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
55/100
Issue-Typ
Refactoring
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
node.js, typescript
Bereich
testing

Rechercherichtung

Start by reading mcp-server/src/utils/ssh-api.ts around the exported helpers and the checkSSHAvailable reference, then compare it with the hand-written mocks in handlers.test.ts, integration.test.ts and confirm-gates.test.ts. Create one shared mock factory that uses importOriginal() and overrides only execSSH, then migrate one test file at a time and run cd mcp-server && npm install && npm test. Done means every listed tool has at least one handler test, checkSSHAvailable and its mock are gone, and the tests pass against the real helper shapes.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

help wanted severity: low testing

Summary

Sixteen tools have only schema and registration coverage, and each test file hand-writes its own ssh-api mock, which no longer matches the real module.

Where

  • mcp-server/src/tools/__tests__/handlers.test.ts:3-13, :59-61, :227-241
  • mcp-server/src/tools/__tests__/integration.test.ts:3-28
  • mcp-server/src/tools/__tests__/confirm-gates.test.ts:6-17
  • mcp-server/src/utils/ssh-api.ts:406-412 (checkSSHAvailable, unused)

Details

No handler or command test for: adguardQueryLog, aptUpgradable, certList, composePull, containerScan, diskUsage, fail2banStatus, journalLogs, kernelInfo, networkInfo, npmCerts, ntfySend, openPorts, serviceLogs, speedtestResults, ufwStatus. piStatus's node: "all" path is untested.

Mock drift: handlers.test.ts's getNodeConfig returns no port; its nodeSetting ignores per-node env; errorResponse is re-implemented as error.message; TIMEOUTS values are copied; integration still mocks the unused checkSSHAvailable. The fan-out test installs a mockImplementation and resets it only on its last line, so one failed assertion cascades into later tests (vi.clearAllMocks keeps implementations).

Impact

Changes to URLs, token flow, default ports and empty-output messages in these tools would not be caught, and tool tests pass against behavior the real helpers do not have.

Suggested fix

  • Add a shared mock helper that spreads importOriginal() and overrides only execSSH; switch confirm-gates, handlers and integration to it one at a time.
  • Use vi.resetAllMocks() (or mockReset in afterEach).
  • Delete checkSSHAvailable and its mock.
  • Handler tests: ntfySend (URL, optional headers, empty-output message, exit 7); certList and npmCerts (login then Bearer GET, non-JSON login); composePull (discovery, HOMELAB_COMPOSE_FILES, TIMEOUTS.long); piStatus node: "all"; adguardQueryLog (URL-encoded search, default limit=25); serviceLogs and journalLogs (since conversion, empty output).
  • One per-node env test: HOMELAB_NODES={"nas":{"host":"nas.local","env":{"HOMELAB_ADGUARD_PORT":"3001"}}} uses port 3001 for node: "nas".

Acceptance criteria

  • Every tool has at least one handler test
  • Test files share one mock factory based on the real module

Related: #101

Getting started

  • Relevant files: mcp-server/src/tools/__tests__/handlers.test.ts, mcp-server/src/tools/__tests__/integration.test.ts, mcp-server/src/tools/__tests__/confirm-gates.test.ts, mcp-server/src/utils/ssh-api.ts
  • How to run tests: cd mcp-server && npm install && npm test (and npm run typecheck); structure tests: pip install -r requirements-test.txt && pytest tests/ -v
  • Conventions: see CLAUDE.md and CONTRIBUTING.md

Filed by repo-audit/full-audit at 636fefb. Severity: low. Effort: M. audit-key: testing|mcp-server/src/tools|handler-coverage

Vorherrschende Sprache
TypeScript
Sterne
0
Forks
4
Ø Merge
10 Std. 16 Min.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/Home-Lab-Developer-Tools

Alle Issues in TMHSDigital/Home-Lab-Developer-Tools

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.