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

Abierto
#164 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
node.js, typescript
Área
testing

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
0
Forks
4
Merge medio
10 h 16 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TMHSDigital/Home-Lab-Developer-Tools

Todos los issues de TMHSDigital/Home-Lab-Developer-Tools

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.