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

Aberta
#164 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
55/100
Tipo de issue
Refatoração
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
node.js, typescript
Domínio
testing

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
0
Forks
4
Merge médio
10h 16min
PRs com merge (30d)
2

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/Home-Lab-Developer-Tools

Todas as issues de TMHSDigital/Home-Lab-Developer-Tools

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.