Live-Pi e2e suite never runs and would time out at Vitest's 5s default

Offen
#151 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
68/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
docker, github-actions, typescript
Bereich
ci-cd, testing

Rechercherichtung

Start with .github/workflows/e2e.yml:13 to see the PI_CONFIGURED gate, then read mcp-server/src/tools/__tests__/e2e.test.ts around lines 14, 45 and 58-60 for the missing timeout and the diskUsage path. Run cd mcp-server && npm install && npm test and npm run typecheck to confirm the current e2e behavior. Done means the real-Pi suite has explicit timeouts and a PR-triggered e2e job exercises ssh2 against an openssh-server service container without Pi hardware.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

help wanted severity: medium testing

Summary

The e2e workflow is gated on a repository variable that is not set, so every scheduled run is skipped and no real SSH path is exercised in CI. If enabled, tests would hit Vitest's 5 s default timeout.

Where

  • .github/workflows/e2e.yml:13
  • mcp-server/src/tools/__tests__/e2e.test.ts:14, :45, :58-60

Details

The last five scheduled runs (2026-10-18 to 2026-11-15) were all skipped. There is no vitest config or per-test timeout, while execSSH allows a 10 s connect plus a 30 s exec, and the e2e diskUsage case walks / with du, which on an SD card very likely takes longer than 5 s.

Impact

The only tests against real remote output give no signal, so parser regressions in piStatus, kernelInfo, networkInfo and similar tools are not caught. Turning the suite on would first produce timeout failures unrelated to tool behavior.

Suggested fix

  • Add { timeout: 60_000 } to the e2e describe and use a small path (for example /var/log) for diskUsage.
  • Add a CI e2e job that needs no Pi: an openssh-server service container on ubuntu-latest, HOMELAB_PI_* pointed at it, and the read-only tools that need no Pi hardware (sshTest, kernelInfo, networkInfo, diskUsage on /tmp, healthCheck). This exercises ssh2, key loading and exit-code/stderr mapping.
  • On workflow_dispatch, fail or post a notice when PI_CONFIGURED is unset instead of reporting skipped.

Acceptance criteria

  • An e2e job runs on every PR against a containerized SSH server
  • Real-Pi suite has explicit timeouts

Getting started

  • Relevant files: .github/workflows/e2e.yml, mcp-server/src/tools/__tests__/e2e.test.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: medium. Effort: M. audit-key: testing|mcp-server/src/tools/__tests__/e2e.test.ts|e2e

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.