Tests: temporäre Verzeichnisse aller Testdateien beim Prozessende aufräumen - #235
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Aufgefallen, weil
/tmpmitten in der Arbeit zu 100 % volllief (3,9 GB) und Kommandos nicht einmal mehr ihre Ausgabe schreiben konnten. Ursache waren nicht etwa große Dateien, sondern 3.667 zurückgelassene Testverzeichnisse.Befund
70 Testdateien legen mit
fs.mkdtempSyncein temporäres Verzeichnis an — jede mit eigenem Präfix (gc-caddy-retry-,gc-cc-contract-,gc-env-,gc-del-guard-…). 59 davon entfernen es nie.Gemessen, nicht geschätzt:
Bei rund 56 Läufen summierte sich das auf 3.667 Einträge. Das Tückische ist nicht der Platz, sondern die Symptomlage: ein volles
/tmpäußert sich in Fehlern ohne jeden Bezug zu Tests.Bemerkenswert ist, dass das Problem in diesem Repo schon einmal erkannt wurde:
tests/helpers/setup.jsräumt sein eigenes Verzeichnis beim Prozessende ab und hat sogar einen Selbstheilungs-Sweep für hart abgebrochene Läufe — mit einem Kommentar, der genau diese Begründung nennt. Beides greift aber ausschließlich für das Präfixgc-test-dieser einen Datei.Nicht betroffen: der Produktivcode.
src/undscripts/rufenmkdtempSyncnirgends auf — das ist ein reines Problem der Testumgebung, kein Produktfehler.Änderung
Statt 59 Dateien einzeln nachzurüsten — und die nächste neue Datei wieder zu vergessen — wird
mkdtempSynceinmal zentral umhüllt:tests/helpers/tmp-cleanup.jsmerkt sich die angelegten Verzeichnisse und entfernt sie beim Prozessende.Vorgeladen über
--requireimtest-Skript, damit es jeden Testprozess erreicht, auch die 59 Dateien, die keinen gemeinsamen Helfer verwenden. Zusätzlich austests/helpers/setup.jsheraus geladen, damit auch ein direkter Einzeldatei-Lauf ohnenpmaufräumt; der require-Cache sorgt dafür, dass die Umhüllung nur einmal greift.Dass
--requirebis in die Kindprozesse des Test-Runners durchschlägt, habe ich empirisch geprüft, nicht angenommen.Zwei Schutzmaßnahmen im Wrapper: es wird nur entfernt, was tatsächlich unterhalb von
os.tmpdir()liegt (überrealpathaufgelöst, damit auch der macOS-Symlink/tmp→/private/tmpgreift), und ein Fehler beim Aufräumen lässt einen Testlauf niemals scheitern.Tests
Sechs neue Fälle, angehängt an die vorhandene
tests/tmp_cleanup.test.js(die bisher nur dengc-test--Sweeper abdeckte). Geprüft wird die Eigenschaft, nicht die Aufrufliste: ein Kindprozess legt ein Verzeichnis mitsamt Inhalt an, und danach ist es weg.Darunter ausdrücklich der Negativfall — ohne Vorladen überlebt das Verzeichnis. Ohne diesen Fall würde der Test auch dann grün bleiben, wenn die Umhüllung gar nichts täte.
Dazu: nicht-leere Verzeichnisse werden entfernt (ein
rmSyncohnerecursivescheiterte hier), Verzeichnisse außerhalb des Temp-Wurzelverzeichnisses bleiben unangetastet,mkdtempSyncverhält sich während des Laufs unverändert, und dastest-Skript enthält das Vorladen — ohne diesen Eintrag greift die Bereinigung im Suite-Lauf nicht, und genau der hat/tmpgefüllt.Volle Suite über
npm test: 2349 bestanden, 0 fehlgeschlagen, Temp-Bilanz ±0.Nicht enthalten
Die 59 Testdateien bleiben unverändert. Ihre
mkdtempSync-Aufrufe sind nicht falsch — es fehlte nur das Gegenstück, und das gehört an eine Stelle statt an neunundfünfzig.