Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 11: ShellCheck, shfmt, bats

Ziel: ShellCheck gezielt schärfer stellen, alle Skripte mit shfmt einheitlich formatieren, Funktionen und Werkzeuge mit bats testen und alles in einem CI-Skript bündeln, das vor jedem Commit läuft. · Dauer: ca. 90 min · Voraussetzung: Tag 10

Briefing

  • ShellCheck kennt neben den Standardprüfungen optionale Checks, die du in .shellcheckrc einschaltest.
  • shfmt formatiert Shell-Code wie gofmt Go-Code: einheitliche Einrückung, eine Form für case, if und Pipes. Diskussionen über Stil sind damit erledigt.
  • bats (Bash Automated Testing System) führt Tests aus, die selbst in Bash geschrieben sind: run befehl, dann $status, $output und ${lines[@]} prüfen.
  • Ein CI-Skript führt alles in fester Reihenfolge aus. Lokal per Git-Hook vor jedem Commit, in der CI bei jedem Push – mit demselben Skript.
 werkzeug/ci.sh ─► shellcheck -x bin/* lib/lib.sh
               ─► shfmt -d bin lib
               ─► bats tests/   (lib.bats, notes-report.bats, …)
 git commit ─► .git/hooks/pre-commit ─► ci.sh

Drill 1: ShellCheck schärfer

source ~/sh-lab/setup/env.sh
cd ~/sh-lab/werkzeug
shellcheck --list-optional | grep -c '^name:'
shellcheck -x -o all bin/* lib/lib.sh | grep -oE 'SC[0-9]+ \([a-z]+\)' | sort | uniq -c

Erwartet (die Zahlen hängen von deinen Skripten ab):

11
      1 SC2249 (info)
     86 SC2250 (style)
      1 SC2310 (info)
     18 SC2312 (info)

Alles einzuschalten ist zu viel: SC2250 will ${var} statt $var – 86 Mal reine Geschmackssache, SC2312 meldet jede Command Substitution in einem Argument. Sinnvoll ist eine bewusste Auswahl:

cat > .shellcheckrc <<'EOF'
source-path=SCRIPTDIR
# Fehlendes *) in case ist fast immer ein vergessener Fall
enable=add-default-case
# Unterdrücktes set -e in if/&&/|| sichtbar machen
enable=check-set-e-suppressed
EOF
shellcheck -x bin/* lib/lib.sh | grep -E '^In |SC[0-9]+'

Erwartet (gekürzt):

In bin/notes-add line 11:
                                                 ^-------^ SC2310 (info): This func…
In bin/notes-last line 11:
  ^-- SC2249 (info): Consider adding a default *) case, even if it just exits wi…
  • SC2249 in notes-last: Das case deckt zwar alle Reste von 0 bis 9 ab, ein *)-Zweig macht das aber für jeden Leser sichtbar.
  • SC2310 in notes-add: $(notes_url) steht in einem Befehl, hinter dem || die folgt. In so einem Zweig schaltet Bash set -e für die Funktion ab – scheitert etwas darin, merkt es niemand. Hier ist es harmlos, aber leicht zu beheben: Die URL wird vorher ermittelt.
sed -i 's|^    9) curl -s -o /dev/null -A notes-last "\$url/admin" ;;$|&\n    *) ;;|' \
  bin/notes-last
sed -i 's|^key=.*|&\nurl=$(notes_url)|; s|"\$(notes_url)/notes")|"$url/notes")|' \
  bin/notes-add
shellcheck -x bin/* lib/lib.sh && echo sauber

Erwartet:

sauber

Gibt es einen guten Grund, eine Meldung stehen zu lassen, gehört die Ausnahme mit Begründung direkt über die Zeile: # shellcheck disable=SC2310 # Fehler ist erwartet.

Fortschritt speichern? Kostenlos registrieren

Drill 2: shfmt

cat > .editorconfig <<'EOF'
[*]
indent_style = space
indent_size = 2
switch_case_indent = true
EOF
shfmt -l bin lib
shfmt -d bin/notes-check | head -12
shfmt -w bin lib && shfmt -l bin lib | wc -l
shellcheck -x bin/* lib/lib.sh && notes-check -q && echo "läuft noch"

Erwartet:

bin/notes-add
bin/notes-aufraeumen
bin/notes-backup
bin/notes-check
bin/notes-find
bin/notes-sichern
--- bin/notes-check.orig
+++ bin/notes-check
@@ -26,7 +26,10 @@
     t) timeout="$OPTARG" ;;
     v) verbose=1 ;;
     q) quiet=1 ;;
-    h) usage; exit 0 ;;
+    h)
+      usage
+      exit 0
+      ;;
     :) die "Option -$OPTARG braucht einen Wert" 2 ;;
     *) die "unbekannte Option -$OPTARG (Hilfe: -h)" 2 ;;
0
läuft noch

shfmt liest die Einstellungen aus .editorconfig – dieselbe Datei, die auch Editoren verstehen. -l listet Dateien, die anders aussähen, -d zeigt den Unterschied, -w schreibt ihn. Ohne Dateiendung erkennt shfmt Skripte am Shebang.

Fortschritt speichern? Kostenlos registrieren

Drill 3: Erste Tests mit bats

cat > tests/lib.bats <<'EOF'
#!/usr/bin/env bats
# Tests für lib/lib.sh

setup() {
  source "$BATS_TEST_DIRNAME/../lib/lib.sh"
}

@test "need findet vorhandene Programme" {
  run need bash curl
  [ "$status" -eq 0 ]
}

@test "need bricht mit Exit-Code 3 ab" {
  run need gibtsnicht
  [ "$status" -eq 3 ]
  [[ $output == *"Programm fehlt: gibtsnicht"* ]]
}

@test "notes_url hat einen Standard" {
  unset NOTES_URL
  run notes_url
  [ "$output" = "http://127.0.0.1:8080" ]
}

@test "retry gibt nach der erlaubten Anzahl auf" {
  run retry 2 false
  [ "$status" -eq 1 ]
  [ "${#lines[@]}" -eq 1 ]
}
EOF
bats tests/lib.bats

Erwartet:

lib.bats
 ✓ need findet vorhandene Programme
 ✓ need bricht mit Exit-Code 3 ab
 ✓ notes_url hat einen Standard
 ✓ retry gibt nach der erlaubten Anzahl auf

4 tests, 0 failures
  • run führt den Befehl aus, fängt Exit-Code und Ausgabe (stdout und stderr) ab und bricht den Test nicht ab. Danach prüfst du mit [ … ] oder [[ … ]] – jede gescheiterte Prüfung lässt den Test scheitern.
  • setup läuft vor jedem Test, jeder Test in einer eigenen Shell. unset NOTES_URL wirkt nur in diesem Test.
  • ${lines[@]}: Bei zwei Versuchen gibt es genau eine Warnung.

Fortschritt speichern? Kostenlos registrieren

Drill 4: Ein Werkzeug testen

notes-report braucht ein Log mit bekanntem Inhalt – eine Fixture:

mkdir -p tests/fixtures
cat > tests/fixtures/access.log <<'EOF'
10.0.0.1 [02/Nov/2026:10:00:00 +0000] "GET /notes HTTP/1.1" 200 69 0.004 test
10.0.0.1 [02/Nov/2026:10:00:01 +0000] "GET /notes HTTP/1.1" 200 69 0.006 test
10.0.0.2 [02/Nov/2026:10:00:02 +0000] "POST /notes HTTP/1.1" 201 68 0.010 test
10.0.0.2 [02/Nov/2026:10:00:03 +0000] "GET /notes/7 HTTP/1.1" 404 19 0.001 test
10.0.0.3 [02/Nov/2026:10:00:04 +0000] "GET /healthz HTTP/1.1" 200 3 0.001 test
10.0.0.3 [02/Nov/2026:10:00:05 +0000] "GET /admin HTTP/1.1" 404 19 0.001 test
10.0.0.3 [02/Nov/2026:10:00:06 +0000] "GET /notes HTTP/1.1" 500 30 0.050 test
10.0.0.1 [02/Nov/2026:10:00:07 +0000] "GET /version HTTP/1.1" 200 6 0.002 test
EOF
cat > tests/notes-report.bats <<'EOF'
#!/usr/bin/env bats
# Tests für bin/notes-report

setup() {
  PATH="$BATS_TEST_DIRNAME/../bin:$PATH"
  fixture="$BATS_TEST_DIRNAME/fixtures/access.log"
}

@test "zählt Anfragen und Fehler" {
  run notes-report "$fixture"
  [ "$status" -eq 0 ]
  [ "${lines[0]}" = "Anfragen: 8" ]
  [ "${lines[1]}" = "Fehler:   3 (37.5 %)" ]
}

@test "findet die langsamste Anfrage" {
  run notes-report "$fixture"
  [[ ${lines[2]} == *'max 50.0 ms ("GET /notes")' ]]
}

@test "fasst IDs zu /notes/:id zusammen" {
  run notes-report "$fixture"
  [[ $output == *"/notes/:id"* ]]
  [[ $output != *"/notes/7"* ]]
}

@test "leeres Log ist ein Fehler" {
  run notes-report /dev/null
  [ "$status" -eq 1 ]
  [[ $output == *"Log ist leer"* ]]
}
EOF
bats tests/

Erwartet:

lib.bats
 ✓ need findet vorhandene Programme
 ✓ need bricht mit Exit-Code 3 ab
 ✓ notes_url hat einen Standard
 ✓ retry gibt nach der erlaubten Anzahl auf
notes-report.bats
 ✓ zählt Anfragen und Fehler
 ✓ findet die langsamste Anfrage
 ✓ fasst IDs zu /notes/:id zusammen
 ✓ leeres Log ist ein Fehler

8 tests, 0 failures

Die Tests brauchen weder notes noch Docker – nur Bash und die Fixture. So laufen sie in jeder CI in Sekunden. Was mit Netz oder Datenbank arbeitet, teilt man auf: die Logik in Funktionen, die sich ohne Netz testen lassen, und einen dünnen Rand, der nur curl aufruft.

Fortschritt speichern? Kostenlos registrieren

Drill 5: Ein CI-Skript und ein Git-Hook

cat > ci.sh <<'EOF'
#!/usr/bin/env bash
# ci.sh – prüft den Werkzeugkasten, lokal und in der CI
set -euo pipefail
cd "$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
echo "== shellcheck"
shellcheck -x bin/* lib/lib.sh ci.sh
echo "== shfmt"
shfmt -d bin lib ci.sh
echo "== bats"
bats --tap tests
echo "ci: alles grün"
EOF
chmod +x ci.sh
./ci.sh | grep -E '^==|^1\.\.|ci:'
git init -q -b main
git config user.name "Lab" && git config user.email [email protected]
cat > .git/hooks/pre-commit <<'EOF'
#!/usr/bin/env bash
# nur bei Fehlern etwas zeigen
out=$(./ci.sh 2>&1) || { echo "$out" >&2; exit 1; }
EOF
chmod +x .git/hooks/pre-commit
git add -A && git commit -qm "Werkzeugkasten mit Tests" && git log --oneline | cut -c9-

Erwartet:

== shellcheck
== shfmt
== bats
1..8
ci: alles grün
Werkzeugkasten mit Tests

In der CI liest kein Mensch mit: --tap schaltet bats auf das schlichte TAP-Format (ok 1 …, not ok 2 …), das jede CI versteht. Ohne Terminal wählt bats es ohnehin selbst; mit --tap sieht die Ausgabe lokal und in der CI gleich aus.

Jetzt der Gegenversuch – ein Fehler, den ShellCheck findet:

echo 'echo $unquoted' >> bin/hallo
git commit -qam "kaputt" 2>&1 | grep -E '^In |SC2086' | head -2
git log --oneline | wc -l
git checkout -q bin/hallo

Erwartet:

In bin/hallo line 4:
     ^-------^ SC2086 (info): Double quote to prevent globbing and word splitting.
1

Der Hook hat den Commit verhindert. In der CI läuft dasselbe Skript, zum Beispiel in GitHub Actions:

# .github/workflows/ci.yml
name: ci
on: [push, pull_request]
jobs:
  werkzeug:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v5
      - run: sudo apt-get install -y shellcheck bats
      - run: |
          U=https://github.com/mvdan/sh/releases/download/v3.14.1
          sudo curl -fsSL -o /usr/local/bin/shfmt $U/shfmt_v3.14.1_linux_amd64
          sudo chmod +x /usr/local/bin/shfmt
      - run: ./ci.sh

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

~/sh-lab/werkzeug/ci.sh | tail -1

Erwartet:

ci: alles grün
bats --count ~/sh-lab/werkzeug/tests

Erwartet:

8
shfmt -l ~/sh-lab/werkzeug/bin ~/sh-lab/werkzeug/lib | wc -l

Erwartet:

0

Challenge

Schreib tests/notes-check.bats mit zwei Tests, die ohne laufendes notes auskommen: Eine unbekannte Option endet mit Exit-Code 2, und -h gibt die Hilfe aus und endet mit 0.

Hinweis: Wie in notes-report.bats kommt bin/ per setup an den Anfang von PATH.

Lösung

cd ~/sh-lab/werkzeug
cat > tests/notes-check.bats <<'EOF'
#!/usr/bin/env bats
# Tests für bin/notes-check, ohne Netz

setup() {
  PATH="$BATS_TEST_DIRNAME/../bin:$PATH"
}

@test "unbekannte Option endet mit 2" {
  run notes-check -x
  [ "$status" -eq 2 ]
  [[ $output == *"unbekannte Option -x"* ]]
}

@test "-h zeigt die Hilfe" {
  run notes-check -h
  [ "$status" -eq 0 ]
  [[ ${lines[0]} == "Aufruf: notes-check"* ]]
}
EOF
./ci.sh | grep -E '^1\.\.|ci:'
git add -A && git commit -qm "Tests für notes-check" && git log --oneline | wc -l

Erwartet:

1..10
ci: alles grün
2

Fortschritt speichern? Kostenlos registrieren

Enterprise-Notiz

  • Gleiche Versionen überall: ShellCheck, shfmt und bats in der CI fest pinnen und lokal dieselben nutzen. Ein Container-Image mit allen dreien ist der einfachste Weg.
  • pre-commit-Framework: Für Teams ersetzt pre-commit (pre-commit.com) eigene Hooks – mit fertigen Einträgen für ShellCheck und shfmt.
  • Tests für Skripte sind kein Luxus: Ein Backup-Skript, das still nichts sichert, merkst du erst beim Restore. Jeder Bugfix bekommt einen Test, der ihn festhält.