Пример библиотеки для скриптов на языке bash - shell-framework

Это гостевой пост автора Beggy. Оригинальный пост доступен по этой ссылке.

О чем все это?
Библиотека shell-framework - это набор функций, которые вы можете вызвать из своего скрипта. Она была задумана для облегчения создания скриптов на языке bash и полностью написана на этом языке. В основном библиотека писалась для упрощения работы с опциями командной строки, генерации краткой справки(help-а) скрипта и работы с конфигурационными файлами. В этой статье я постараюсь показать как именно можно упростить написание рутинного кода, связанного с этими задачами, используя shell-framework.



Установка
Процесс установки shell-framework предельно прост. Откройте страничку download проекта и скачайте последнюю версию архива с библиотекой, например, shell-framework_0.22.tar.bz2. Предположим, вы положили ее в текущий каталог, который специально создали для экспериментов. Теперь нужно распаковать библиотеку - например так:

$ tar xjf ./framework_0.21.tar.bz2

после чего должен появиться подкаталог shell-framework. Скачанный архив вам больше не нужен и его можно удалить.

Пример использования библиотеки для написания скриптов
Давайте напишем простейший helloWorld скрипт в том самом экспериментальном каталоге и на его примере разберем основные возможности библиотеки:

#!/bin/bash
shF_PATH_TO_LIB="./shell-framework/lib"
source "${shF_PATH_TO_LIB}/base"

setDescription "Hello world is example script."

#addOption <name> [defaultValue] [shortForm] [longForm] [type] [shortDescription] [longDescription] [priority] [notForConfig]
#    type can be shF_SIMPLE_OPTION or shF_OPTION_WITH_VALUE
addOption "name" "World" "-n" "--name" "${shF_OPTION_WITH_VALUE}" "you can define your name as ${shF_COMMON_PARAMETER_NAME}." "" "110"
if ! initConfig "$@"  ; then
    exit 1
fi

echo "Hello, ${name}!"

Вы можете скопировать скрипт прямо отсюда в файл. Я назвал у себя этот файл helloWorld.sh и дальше буду ссылаться на него именно под этим именем. Не забудьте сделать его исполняемым - например так:

$ chmod +x ./helloWorld.sh

Рассмотрим отдельные части более подробно:

#!/bin/bash
shF_PATH_TO_LIB="./shell-framework/lib"
source "${shF_PATH_TO_LIB}/base"

Библиотека shell-framework - это набор bash скриптов, каждый из который, в свою очередь, определяет набор функций. Таким образом, чтобы начать использовать их в скрипте нужно просто подключить нужный файл с помощью инструкции source или ".".Однако, библиотека состоит из нескольких файлов и они тоже должны, в свою очередь, подключить необходимые функции (например функциям работы с опциями командной строки нужны функции работы с ассоциативными массивами). Для этого определяется переменная shF_PATH_TO_LIB, в которой прописывается, где лежат файлы shell-framework/lib, и именно она используется внутри библиотеки, чтобы собрать весь необходимый нам инструментарий. Ее определение является обязательным и оно должно предшествовать source.

setDescription "Hello world is example script."

setDescription - первая функция shell-framework, которую мы использовали. Она устанавливает краткое описание нашего скрипта. Позже эта строка будет использована при генерации справки (help-а).

#addOption <name> [defaultValue] [shortForm] [longForm] [type] [shortDescription] [longDescription] [priority] [notForConfig]]
#   type can be shF_SIMPLE_OPTION or shF_OPTION_WITH_VALUE
addOption "name" "World" "-n" "--name" "${shF_OPTION_WITH_VALUE}" "you can define your name as ${shF_COMMON_PARAMETER_NAME}." "" "110"

Первые две строки - это комментарии, чтобы не забыть в каком порядке идут параметры, что они значат и какие значения можно использовать. Последняя строка - непосредственно вызов addOption, которая добавляет новый параметр (option) со следующими атрибутами:

• переменная name, которая будет хранить его значение
• значение по умолчанию: World
• краткая форма -n
• длинная --name
• после него ожидается значение (${shF_OPTION_WITH_VALUE}),
• описание: "you can define your name as ${shF_COMMON_PARAMETER_NAME}."
• При распечатке в help-е список параметров будет отсортирован в соответствии с весом заданным при инициализации - 110.

if ! initConfig "$@"  ; then
    exit 1
fi

initConfig "$@" пытается "распарсить" строку параметров в соответствии с конфигурацией, заданной выше. Если произойдет ошибка, скрипт прервет свое выполнение. При выполнении initConfig, среди прочего будет создана переменная name со значением по умолчанию (World), потом опции командной строки будут перебраны и если найдется комбинация -n <value> или --name=<value>, то name получит новое значение (<value>).

echo "Hello, ${name}!"

Используем значение переменной name и печатаем приветствие.Итак, мы задействовали 3 функции из библиотеки (setDescription, addOption, initConfig) и набросали тестовый скрипт. Давайте теперь посмотрим, что же он в результате умеет?

Использование скрипта helloWorld.sh
Попробуем запустить скрипт, который мы только что написали, и убедимся, что мы можем передать ему значение для переменной name, как опцию командной строки.

$ ./helloWorld.sh
Hello, World!
$ ./helloWorld.sh -n Nick
Hello, Nick!
$ ./helloWorld.sh --name Nick
<current time>: ERROR ./shell-framework/lib/opts.parseOpts:122 The value for option (--name) must be defined.

В последнем примере, скрипт нам сообщает, что после параметра (--name) ожидается значение. Дело в том, что shell-framework предполагает, что при использовании "длинных" option будет использована форма --<option name>=<option value>:

$ ./helloWorld.sh --name=Nick
Hello, Nick!

Однако этим возможности скрипта не ограничиваются - он умеет рассказывать пользователю о себе и как им пользоваться (help):

$ ./helloWorld.sh -h 
Hello world is example script.
Usage: ./helloWorld.sh [option(s)] [command]
Options:
        -h|--help       print this help
        --help-options  print detailed description of options using
        -l <parameter>|--shF_logLevel=<parameter>   define the current log level (<parameter>). You can use the following number - 0(shF_EVERYTHING), 1(shF_DEBUG), 2(shF_INFO), 3(shF_HIGH), 4(shF_WARN), 5(shF_ERROR). Config name is shF_currentLogLevel. Default value is "2".
        --logFile=<parameter>     define the <parameter> as log stream. You can use stdError, stdOut or file name. Config name is shF_currentLogFile. Default value is "stdError".
        -c <parameter>|--config=<parameter> define the <parameter> as property file which will be loaded.
        -p|--print-config       print the current configuration.
        -n <parameter>|--name=<parameter>   you can define your name as <parameter>. Config name is name. Default value is "World"

Как видите, скрипт оказывается содержит намного больше чем единственная option, которую мы с вами сначала определили. Причиной тому - использование библиотеки base, которая на самом деле написана, чтобы избежать рутинного перечисления стандартных, на мой взгляд options. Если в вашем случае это не так, то можно обойтись и без base, подключая по отдельности остальные файлы библиотеки.Наша с вами option name, согласно весу 110, располагается в конце этого списка. Над ней две другие option позволяют нам использовать еще одну возможность библиотеки shell-framework - конфигурационные файлы. Давайте рассмотрим их подробнее.Когда мы создаем option, то мы задаем так же и имя переменной. Порядок инициализации этой переменной будет следующим:

1. значение по умолчанию, если оно есть
2. значение из конфигурационного файла, если оно есть
3. значение командной строки, если оно есть

Так что если мы создадим файл config.txt в текущем каталоге с таким содержимым

name="Config"

то вполне можем его использовать:

$ ./helloWorld.sh
Hello, World!
$ ./helloWorld.sh --config=./config.txt
Hello, Config!
$ ./helloWorld.sh -c ./config.txt --name=Virens
Hello, Virens!

Option -p используется для генерации конфигурационного файла, что может быть удобно, если вы не хотите создавать его с нуля или просто для записи какого-нибудь удачного, но большого набора опций.

$ ./helloWorld.sh -p
#define the current log level (). You can use the following number - 0(shF_EVERYTHING), 1(shF_DEBUG), 2(shF_INFO), 3(shF_HIGH), 4(shF_WARN), 5(shF_ERROR). Default value is "2".
#shF_currentLogLevel="2"

#define the  as log stream. You can use stdError, stdOut or file name. Default value is "stdError".
#shF_currentLogFile="stdError"

#you can define your name as . Default value is "World".
#name="World"

Таким образом, конфигурационные файлы, которые умеет использовать наш скрипт - это обыкновенный текст, в котором значок # начинает комментарии, а пары имя-значение используются для определения значений конкретных переменных.

Заключение
Вы безусловно успели заметить, что я не описал options связанные с logging-ом скриптов(см. help выше). Это не единственная из неописанных возможностей библиотеки shell-framework - среди них так есть работа с ассоциативными массивами (да - они есть в bash 4, но в более ранних версиях, увы, этот тип данных отсутсвует), некоторое расширение, позволяющее вешать на trap не одну функцию, а несколько, использование unit тестирования и тд.