Используйте shellcheck
shellcheck — потрясающий инструмент. Если вы пишете скрипты на bash, но до сих пор не используете его — начните делать это прямо сейчас.
Он прекрасно устанавливается в любой оси, интегрируется с вашими любимыми IDE, его можно заставить проверять ваши скрипты в CI/CD.
Каждый скрипт должен проходить проверку шеллчеком. Точка.
Примите свой стайлгайд
Обсудите и примите в вашей команде свой стиль написания кода. Не надо думать, что bash — это не python, или golang, а какая-то несерьёзная фигня, поэтому и писать на нём можно как угодно.
Да и не драться же, в конце концов, из-за использования табуляций или размера отступов? :)
Начать можно с ознакомления с чужими стайлгайдами, например, за основу можно взять гугловский:
Никто не обязывает всецело следовать ему, но чужие стайлгайды — это прекрасный источник вдохновения.
Красивые отступы в HEREDOC
HEREDOC — это клёвая штука. Обязательно изучите все её возможности. В этом поможет Advanced Bash-Scripting Guide
Однако, с HEREDOC есть одна боль, которую я пока не знаю как решить: они ломают отступы. В процитированном документе есть работающее решение, где все красиво:
#!/bin/bash
ugly_func() {
cat << ENDOFMESSAGE
This is line 1 of the message.
This is line 2 of the message.
This is line 3 of the message.
This is line 4 of the message.
This is the last line of the message.
ENDOFMESSAGE
}
pretty_func() {
# The - option to a here document <<-
#+ suppresses leading tabs in the body of the document,
#+ but *not* spaces.
cat <<-ENDOFMESSAGE
This is line 1 of the message.
This is line 2 of the message.
This is line 3 of the message.
This is line 4 of the message.
This is the last line of the message.
ENDOFMESSAGE
}
Однако, оно «сжёвывает» только символы табуляций и не сработает, если вы практикуете отступы пробелами.
Очень жаль, ведь отступы табуляциями — зашквар и прошлый век.
Используйте ${...}
Вы еще не используете мощный механизм раскрытия параметров? Значит ещё не читали стрипы от замечательной Джулии Эванс
Мой любимый жизненный пример — получение аргументов запуска программы из окружения с использованием значений по умолчанию, например:
#!/bin/bash
PACKER_BIN=/usr/bin/packer
MANIFESTS_DIR=${MANIFESTS_DIR:-/mnt/ssd/packer/manifests}
TARGET_DIR=${TARGET_DIR:-/mnt/ssd/ostemplates/data}
...
В баше есть регулярки
Да, в баше есть регулярки и ничто не мешает вам использовать их, например, для валидации данных:
[[ $distro =~ ^(centos|debian|ubuntu)-[0-9.]+$ ]] \
|| error "Incorrect distro \"$distro\": validation failed"
Чтение входных данных
Давайте рассмотрим классический пример:
$ cat example.txt
word1
word2 word3
word4
$ for line in $(cat example.txt); do echo $line; done
word1
word2
word3
word4
Об этой коварной особенности нам нужно помнить. Как это обойти?
Ну, например, встречается такой распространённый совет:
$ cat example.txt | while read -r line; do echo $line; done
word1
word2 word3
word4
Вроде бы задачу выполняет, но есть нюанс. Вся эта конструкция с пайпом на while read порождает сабшелл. Про сабшеллы с их вытекающими плюсами и минусами я расскажу дальше.
Как быть? Если вас устраивает сабшелл — используйте вариант выше, он красивый. А нет — можно использовать переменную IFS:
$ IFS=
$ for line in $(cat example.txt); do echo $line; done
word1
word2 word3
word4
Главное — не забудьте потом её вернуть к исходному состоянию:
$ unset IFS
$ for line in $(cat example.txt); do echo $line; done
word1
word2
word3
word4
Помните про сабшеллы
Сабшелл — это всё, что запускается в отдельном унаследованном процессе bash. Иногда — это необходимость, иногда — это полезный трюк. Например, мы можем временно перемещаться в рамках какой-то подзадачи в другую директорию. Такой паттерн я часто использую при сборке чего-либо:
(
cd "$MANIFESTS_DIR" \
&& rm -rfv "$artifacts_dir" \
&& $PACKER_BIN \
build \
-var-file "$distro_var_file" \
manifest.json \
> >(tee -a stdout.log) \
2> >(tee -a stderr.log >&2)
) || error "BUILD FAILED"
Сабшелл работает в дочернем процессе, поэтому не меняет ничего в родительском. Этот побочный эффект в примере выше является полезным. В сабшелле мы перемещаемся в другую директорию, что-то там собираем, но когда возвращаемся из сабшелла, то остаёмся в исходной директории.
Но в других кейсах сабшеллы могут запутать вас.
Как вы думаете что выведет данный скрипт?
#!/bin/bash
declare -a numbers
seq 1 5 | while read -r num;
do
numbers["${num}"]=1
done
echo "${!numbers[@]}"
Правильно — ничего. Ассоциативный массив будет заполняться в сабшелле, а команда echo будет выполняться в родительском процессе. Учитывайте это при работе с сабшеллами.
А как можно обойти проблему? Например, так:
#!/bin/bash
declare -a numbers
while read -r num;
do
numbers["${num}"]=1
done < <(seq 1 5)
echo "${!numbers[@]}"
Мощная инструкция set
До этого года я не подозревал о том удобстве, которое предоставляет инструкция set, хотя иногда встречал её в «серьёзных скриптах».
Просто изучите варианты её использования и будете приятно удивлены. А для начала попробуйте в начало любого вашего скрипта добавить инструкцию set -x и посмотреть что получится в итоге.
Отладка скриптов если и не стала удовольствием, но уж точно перестала быть адом.
Bite Size Bash
В обязательном порядке рекомендую к прочтению Bite Size Bash Джулии Эванс. Не забывайте про региональную скидку. Например, россиянам этот журнальчик обойдётся на 70% дешевле.
