Provision
—— XP

Надёжный bash-скрипт: код возврата, set -euo pipefail и if

теория~5 минут+120 XP

Бэкап «отработал»: скрипт дошёл до конца и написал «готово». Через месяц базу понадобилось восстановить — а архив пустой. Каталог, который надо было сохранить, к тому времени переименовали, команда архивации упала с ошибкой, а bash как ни в чём не бывало выполнил следующую строку. Это самая неприятная проблема скриптов — тихий провал.

От неё защищает строгий режим — три настройки bash в начале скрипта, set -euo pipefail, которые заставляют его остановиться на первой ошибке. Эту строку можно встретить почти в каждом серьёзном скрипте: в репозиториях компаний, в шагах CI, в инструкциях на Хабре. Вместе со строгим режимом в уроке — проверка if: как убедиться, что аргумент передан и каталог существует, прежде чем что-то делать. Начнём с того, как bash вообще узнаёт об ошибке.

Код возврата

Каждая команда, завершаясь, сообщает число — код возврата. 0 значит успех, всё остальное — ошибка. На экран оно не печатается, его хранит специальная переменная $?.

ubuntu@stand:~$
ls /etc/hostname
/etc/hostname
echo $?
0

Файл есть — код 0. Теперь спросим несуществующий:

ubuntu@stand:~$
ls /нет-такого
ls: cannot access '/нет-такого': No such file or directory
echo $?
2

Код 2 — ls сообщает, что не нашла. Именно по кодам возврата cron, CI и systemd понимают, удалась ли твоя задача. Поэтому скрипт тоже обязан вернуть не 0, если что-то пошло не так: это делает команда exit 1.

Знать код мало, нужно, чтобы скрипт на него реагировал.

set -euo pipefail

Строку ставят второй, сразу после шебанга. Каждая буква закрывает свою дыру.

начало скрипта
#!/bin/bash
set -euo pipefail
  • -e — остановить скрипт на первой команде с ненулевым кодом. Исключение: команды внутри условия if и слева от && или || его не останавливают — там ненулевой код считается ответом «нет», а не аварией.
  • -u — считать ошибкой обращение к необъявленной переменной. Опечатка $DIRR вместо $DIR без -u молча станет пустой строкой, и rm -rf "$DIRR"/* превратится в rm -rf /* — удаление всего содержимого корня. Голый rm -rf / современный rm откажется выполнять (у него встроенная защита --preserve-root), а вот звёздочку после слэша эта защита не ловит.
  • -o pipefail — ошибка в середине конвейера тоже ошибка. Без неё false | true считается успехом, потому что смотрят только на последнюю команду.

Строгий режим ловит то, что ты забыл проверить. Но лучше проверить самому и написать человеку, что не так.

if: проверить перед работой

Конструкция if выполняет кусок скрипта, только если условие верно. Условие пишут в квадратных скобках, с пробелами внутри.

проверка аргумента
if [ $# -ne 1 ]; then
  echo "Использование: backup.sh КАТАЛОГ" >&2
  exit 1
fi

$# — число аргументов, -ne — «не равно» (not equal). Если аргумент не один — печатаем подсказку и выходим с кодом 1. >&2 отправляет сообщение в поток ошибок: так его увидят и в терминале, и в логе cron, но оно не смешается с полезным выводом. Закрывается if словом fi — это if наоборот.

Вторая типичная проверка — существует ли каталог:

проверка каталога
if [ ! -d "$1" ]; then
  echo "Нет каталога: $1" >&2
  exit 2
fi

-d значит «существует и это каталог», ! переворачивает условие. Разные коды (1 и 2) помогают потом понять по логу, что именно сломалось. Ещё пригодятся -f — «это обычный файл» и -n — «строка не пустая».

Пробелы у скобок — частая ошибка: [$# -ne 1] bash прочитает как команду с именем [$# и ответит command not found.

Циклы for и while, функции и разбор флагов в bash тоже есть, но джуну на первых порах они нужны редко: когда скрипт перерастает сотню строк, его обычно переписывают на Ansible или на нормальный язык. Здесь достаточно знать, что они существуют.

Словарь урока

код возврата
Число, которым команда сообщает результат: 0 — успех, остальное — ошибка. Хранится в $?. ↩ к тексту
строгий режим
set -euo pipefail: остановиться на ошибке, на неизвестной переменной и на ошибке внутри конвейера. ↩ к тексту
exit N
Завершить скрипт с кодом N.
>&2
Отправить вывод в поток ошибок, а не в обычный вывод.

Что спросят на собеседовании

  • Что значит каждая часть set -euo pipefail?
    -e — выход на первой ошибке, -u — ошибка на необъявленной переменной, -o pipefail — конвейер считается упавшим, если упала любая его команда.
  • Как cron или CI понимает, что скрипт упал?
    По коду возврата: ненулевой означает ошибку. Поэтому скрипт обязан выходить через exit с ненулевым кодом, когда что-то не так.
  • Зачем писать сообщения об ошибках в stderr?
    Чтобы они не смешивались с полезным выводом, который может уходить в файл или в другую команду, и при этом были видны.

Что дальше

В практике ты соберёшь из этих кусков скрипт резервного копирования, который отказывается работать без аргумента и с несуществующим каталогом и возвращает правильные коды.

Проверь себя+120 XPдве попытки
1
Код возврата
Команда завершилась и echo $? напечатал 0. Что это значит?
2
Строгий режим
Что делает set -e в начале скрипта?
3
Проверка if
Как в скрипте проверить, что каталог из первого аргумента существует?
ответь на все вопросы, чтобы проверить

Нашёл ошибку или непонятное место? Наведи на абзац — слева появится «+», нажми и напиши, что не так. Замечание увидит автор курса.Нашёл ошибку или непонятное место? Нажми «+» справа от заголовка раздела и напиши, что не так. Замечание увидит автор курса.