Generator skryptu Bash

Generator skryptu Bash

Dobry skrypt Bash zaczyna się od shebanga i trybu strict, ma logowanie, obsługę błędów i bezpieczne parsowanie argumentów. Ten generator składa gotowy szkielet z tymi elementami, a w funkcji main wstawia jedno z czterech zadań: pętlę przykładową, kopię zapasową katalogu do archiwum tar.gz z rotacją, usuwanie plików starszych niż N dni albo pusty szablon pod własną logikę.

Elementy skryptu

Szablony „Wdrożenie”, „Kopia zapasowa” i „Czyszczenie plików” ustawiają jednym kliknięciem nazwę pliku, opis, zadanie, katalog i liczbę dni. Ścieżki i retencja trafiają do zmiennych readonly na górze skryptu, a każdą z nich nadpiszesz przy uruchomieniu, np. RETENTION_DAYS=30 ./backup.sh.

Przykład

Początek i koniec szkieletu z domyślnymi ustawieniami (szablon „Wdrożenie”). Pierwsza linia to shebang wskazujący /usr/bin/env bash, dalej:

# Skrypt wdrożeniowy
set -Eeuo pipefail
IFS=$'\n\t'
readonly LOG_FILE="${LOG_FILE:-/var/log/deploy.log}"
…
main() {
log INFO "Start: $0 (środowisko: ${ENVIRONMENT:-default})"
# TODO: zaimplementuj logikę
…
}
main "$@"

Uruchomienie

Po zapisaniu nadaj prawa wykonywania: chmod +x skrypt.sh, sprawdź składnię bez uruchamiania: bash -n skrypt.sh, a następnie uruchom ./skrypt.sh --help. Generator pokazuje te polecenia z nazwą twojego pliku, a przy kopii i czyszczeniu dodaje przykładowy wpis crona na 3:00.

Jak składa się wygenerowany skrypt

Generator nie wykonuje żadnego polecenia i nie analizuje twojej logiki. To składacz tekstu: wybrane bloki trafiają do wyniku w ustalonej kolejności — shebang z komentarzem, tryb strict i IFS, konfiguracja w zmiennych, funkcja log, trap ERR, katalog tymczasowy, obsługa argumentów, funkcja main i na końcu jej wywołanie. Nad kodem widzisz liczbę linii, rozmiar w bajtach, liczbę funkcji i ocenę ochrony przed błędami: „pełna” wymaga jednocześnie trybu strict i trap ERR.

Kolejność bloków nie jest przypadkowa. Funkcja log musi być zdefiniowana, zanim cokolwiek może zawieść, bo korzysta z niej procedura on_error wywoływana przez trap ERR. Wywołanie main "$@" musi znaleźć się na samym końcu, bo powłoka czyta plik od góry do dołu i w chwili wywołania wszystkie funkcje muszą już istnieć. Argumenty są czytane wcześniej, poza main: pętla while z case zdejmuje je poleceniem shift i zapisuje w zmiennych ENVIRONMENT, DRY_RUN i VERBOSE, z których korzysta dalsza część skryptu.

Tryb strict działa globalnie, od miejsca włączenia do końca pliku. set -e przerywa pracę po pierwszym poleceniu z niezerowym kodem, set -u zgłasza błąd przy odwołaniu do niezdefiniowanej zmiennej, a set -o pipefail sprawia, że potok kończy się błędem, gdy zawiedzie którekolwiek polecenie, a nie tylko ostatnie (zwracany jest kod ostatniego polecenia, które zawiodło). Gdy zaznaczysz trap ERR, generator dopisuje też -E, bez którego pułapka nie zadziałałaby wewnątrz funkcji, czyli w całym main.

Przykład krok po kroku

1. Klikasz szablon „Kopia zapasowa”. Generator ustawia plik backup.sh, katalog źródłowy /var/www/html i retencję 7 dni. Przy domyślnych opcjach wynik ma ponad sto linii, a w main zamiast komentarza TODO stoją gotowe polecenia mkdir, tar i find.
2. Pobierasz plik i nadajesz mu prawo wykonywania poleceniem chmod +x backup.sh. Bez tego kroku powłoka odmówi uruchomienia pliku przez ./ i pozostanie wywołanie bash backup.sh.
3. Uruchamiasz ./backup.sh --help. Parser trafia w gałąź -h, wypisuje sposób użycia i kończy pracę kodem 0 — żadna operacja na danych nie zostaje wykonana.
4. Uruchamiasz ./backup.sh --dry-run. Skrypt sprawdza, czy w systemie są tar, gzip i find, a potem funkcja run zamiast wykonać mkdir, tar i find wypisuje je jako wpisy [dry-run]. Nic nie powstaje i nic nie znika.
5. Uruchamiasz ./backup.sh -e prod. Powstaje archiwum w rodzaju /var/backups/backup/html-20261021-030000.tar.gz, a find usuwa archiwa tego katalogu starsze niż RETENTION_DAYS dni. Nieznana opcja kończy skrypt kodem 1 i wypisuje pomoc, środowisko spoza dev, staging i prod też daje kod 1.
6. Jeśli któreś polecenie zawiedzie, na przykład tar nie może odczytać części plików, set -e przerywa skrypt, a trap ERR zapisuje wpis ERROR z kodem wyjścia i numerem linii. Skrypt kończy pracę tym samym kodem, więc cron albo CI widzą niepowodzenie.

Co robi każdy element szkieletu

Praktyczne wskazówki

• Uruchom skrypt z opcją --help, zanim go rozbudujesz. Sprawdzisz, czy parser argumentów działa.
• Całą logikę trzymaj w main. Poza nią zostaw definicje funkcji i ustawienia globalne, a nowe polecenia, które zmieniają dane, poprzedzaj słowem run — wtedy --dry-run obejmie także je.
• Sprawdź, gdzie trafia log. Domyślny LOG_FILE to /var/log/<nazwa>.log; zwykły użytkownik zwykle nie ma tam prawa zapisu, a szkielet celowo wycisza ten błąd, więc komunikaty pojawią się tylko na stderr. Uruchom skrypt przez sudo albo podaj np. LOG_FILE="$HOME/backup.log".
• Testuj na kopii danych. Tryb strict potrafi zatrzymać skrypt w połowie serii operacji, więc pierwsze uruchomienie po --dry-run zrób na katalogu roboczym.
• Nie mieszaj kodu z konfiguracją. Szkielet zbiera ścieżki i retencję w zmiennych na górze pliku; własne progi i nazwy dopisuj w tym samym miejscu, a nie w środku funkcji.

Ograniczenia generatora

• Nie zna twojej logiki. Poza kopią zapasową i czyszczeniem narzędzie dostarcza wyłącznie szkielet, a resztę dopisujesz w miejscu oznaczonym jako TODO.
• Nie sprawdza składni po twojej edycji. Generator zwraca tekst i go nie uruchamia; błąd wyłapiesz poleceniem bash -n albo dopiero przy starcie skryptu.
• Ma stały zestaw opcji. Parser obsługuje -e, -n, -v i -h, a środowisko przyjmuje tylko dev, staging i prod. Inne przełączniki dopisujesz w pętli case i w funkcji usage.
• Pilnuje ścieżek. Katalog musi być ścieżką bezwzględną bez spacji i „..”, retencja liczbą od 1 do 3650 dni, a wymaganych poleceń może być najwyżej 15. Czyszczenia nie ustawisz na / ani na katalogi systemowe, takie jak /etc, /var czy /home — trzeba wskazać podkatalog.
• Celuje w bash na Linuksie. W sh lub zsh skrypt może zachowywać się inaczej, a blokada flock wymaga pakietu util-linux.