Zum Inhalt springen
diggn.de
← alle Beiträge CI & Deployment · · 3 Minuten

Der Riegel, der neben der Tür hing

Vor dem Veröffentlichen prüft die Pipeline, ob Impressum und Datenschutz noch Platzhalter sind. Die Prüfung war richtig, hatte zwölf grüne Tests und lief nie.

Impressum und Datenschutz auf dieser Seite sind absichtlich unfertig: eckige Klammern statt Text, weil das ein Generator oder eine Kanzlei schreiben muss und nicht ich. „Vor dem Livegang“ ist allerdings genau der Satz, der bis zum Livegang überlebt, also gibt es dafür keine Notiz, sondern einen Riegel. Der pages-Job prüft das, bevor er veröffentlicht.

Was in der Pipeline stand

.gitlab-ci.ymlYAML
script:
  # Refuses to publish while the Impressum and Datenschutz pages are placeholders.
  # "We'll fix it before launch" is exactly what survives to launch, so this is a
  # gate rather than a note. See issue #3.
  - node tools/check-legal.mjs
  - echo "Publishing the build produced in the build stage."

Der Kommentar verspricht, was der Job tun soll. Die Zeile darunter tut es nicht. Sie führt die Datei aus, und das ist etwas anderes, als die Prüfung auszuführen: tools/check-legal.mjs ist ein Modul. Es exportiert Funktionen und Konstanten und ruft selbst nichts auf. Dass die erste Zeile #!/usr/bin/env node lautet, macht die Verwechslung leichter, nicht schwerer.

Shell
$ node tools/check-legal.mjs
$ echo $?
0

Keine Ausgabe, Exit 0, Pipeline grün. Veröffentlicht wurde trotzdem nie etwas, denn der Job steht auf when: manual und ist nie angeklickt worden. Der Riegel war offen, die Tür blieb zu. Der Einstiegspunkt heißt tools/cli-check-legal.mjs und hängt an npm run check:legal. Ruft man den, sieht es anders aus: Exit 1 und vier Dateien mit zusammen 38 Platzhaltern.

Die zwölf grünen Tests

Das Beunruhigende ist nicht der Tippfehler. Es ist, was gleichzeitig alles stimmte.

Die Prüfung hat zwölf Tests, alle grün. Zwei davon rufen statt der inneren Funktion direkt runLegalCli auf: Der eine prüft, dass sie mit Exit ungleich null abbricht und die unfertige Datei beim Namen nennt, der andere den umgekehrten Fall, dass sie schweigt, sobald nichts mehr offen ist. Ein dritter heißt

✔ the real repository still has placeholders, so the deploy is blocked today

und ist trotzdem falsch, jedenfalls in seiner zweiten Hälfte. Die Platzhalter waren da, das stimmte. Blockiert war nichts.

Ein Test kann beweisen, dass ein Riegel funktioniert, und nichts darüber sagen, ob er vor der Tür sitzt.

Was ich daraus mitnehme

Die getestete Einheit war in Ordnung. Falsch war die eine Zeile, die sie aufruft, und die hat weder ein Test noch ein Typ noch ein Linter geprüft. Zwischen check-legal.mjs und cli-check-legal.mjs liegen vier Zeichen, und beide Dateien existieren, also meckert auch niemand.

Was geholfen hätte, ist billiger als jeder weitere Test der Funktion: das Kommando einmal genau so ausführen, wie der Job es ausführt, in einem Zustand, in dem es scheitern muss. Ein Riegel, den man nie gegen eine verschlossene Tür gedrückt hat, ist eine Vermutung, genau wie ein Backup, das nie zurückgespielt wurde.

Der Job ruft jetzt npm run check:legal. Beim Korrigieren habe ich genau das getan, was vorher gefehlt hat: dasselbe Kommando im Repo laufen lassen, in dem die Platzhalter noch stehen. Exit 1, vier Dateien, 38 Platzhalter. Jetzt weiß ich, dass der Riegel hält, weil ich einmal dagegen gedrückt habe.

#ci#gitlab#tests

Ähnliche Beiträge