Какой краткий способ проверить, что переменные среды установлены в сценарии оболочки Unix?

У меня есть несколько сценариев оболочки Unix, где мне нужно проверить, установлены ли определенные переменные среды, прежде чем я начну что-то делать, поэтому я делаю такие вещи:

if [ -z "$STATE" ]; then
    echo "Need to set STATE"
    exit 1
fi  

if [ -z "$DEST" ]; then
    echo "Need to set DEST"
    exit 1
fi

что много печатать. Есть ли более элегантная идиома для проверки того, что набор переменных окружения установлен?

РЕДАКТИРОВАТЬ: я должен отметить, что эти переменные не имеют значащего значения по умолчанию - скрипт должен выдавать ошибку, если какие-либо не установлены.

Расширение параметра

Очевидный ответ - использовать одну из специальных форм расширения параметров:

: ${STATE?"Need to set STATE"}
: ${DEST:?"Need to set DEST non-empty"}

Или лучше (см. Раздел «Положение двойных кавычек» ниже):

: "${STATE?Need to set STATE}"
: "${DEST:?Need to set DEST non-empty}"

Первый вариант (с использованием just ?) требует установки STATE, но STATE = "" (пустая строка) в порядке - не совсем то, что вы хотите, но альтернативная и более старая нотация.

Второй вариант (использование :?) требует, чтобы DEST был установлен и не был пустым.

Если вы не укажете сообщение, оболочка предоставит сообщение по умолчанию.

${var?}Конструкция переносит обратно Version 7 UNIX и Bourne Shell (1978 или около этого). Эта ${var:?}конструкция немного новее: я думаю, что она была в System III UNIX примерно в 1981 году, но до этого она могла быть в PWB UNIX. Поэтому он находится в оболочке Korn и в оболочках POSIX, включая, в частности, Bash.

Обычно это документируется на справочной странице оболочки в разделе под названием « Расширение параметров» . Например, bashруководство говорит:

${parameter:?word}

Ошибка дисплея, если ноль или не установлен. Если параметр равен нулю или не задан, расширение слова (или сообщение на этот счет, если слово отсутствует) записывается в стандартную ошибку, и оболочка, если она не является интерактивной, завершается. В противном случае значение параметра подставляется.

Колонское командование

Я, вероятно, должен добавить, что команда двоеточия просто оценивает свои аргументы и затем успешно. Это оригинальная запись комментария оболочки (перед ' #' до конца строки). Долгое время сценарии оболочки Bourne имели двоеточие в качестве первого символа. Оболочка C будет читать сценарий и использовать первый символ, чтобы определить, относится ли он к оболочке C ( #хэш ') или к оболочке Борна ( :двоеточие'). Затем ядро ​​приняло участие и добавило поддержку комментариев ' #!/path/to/program', а оболочка Bourne получила ' #', и соглашение о двоеточии ушло на второй план. Но если вы столкнетесь со сценарием, который начинается с двоеточия, теперь вы будете знать, почему.

Положение двойных кавычек

blong спросил в комментарии :

Есть мысли по поводу этой дискуссии? https://github.com/koalaman/shellcheck/issues/380#issuecomment-145872749

Суть обсуждения такова:

… Однако, когда я shellcheckэто (с версией 0.4.1), я получаю это сообщение:

In script.sh line 13:
: ${FOO:?"The environment variable 'FOO' must be set and non-empty"}
  ^-- SC2086: Double quote to prevent globbing and word splitting.

Любой совет, что мне делать в этом случае?

Краткий ответ «делай как shellcheckподсказывает»:

: "${STATE?Need to set STATE}"
: "${DEST:?Need to set DEST non-empty}"

Чтобы проиллюстрировать почему, изучите следующее. Обратите внимание, что :команда не отображает свои аргументы (но оболочка оценивает аргументы). Мы хотим видеть аргументы, поэтому код ниже использует printf "%s\n"вместо :.

$ mkdir junk
$ cd junk
$ > abc
$ > def
$ > ghi
$ 
$ x="*"
$ printf "%s\n" ${x:?You must set x}    # Careless; not recommended
abc
def
ghi
$ unset x
$ printf "%s\n" ${x:?You must set x}    # Careless; not recommended
bash: x: You must set x
$ printf "%s\n" "${x:?You must set x}"  # Careful: should be used
bash: x: You must set x
$ x="*"
$ printf "%s\n" "${x:?You must set x}"  # Careful: should be used
*
$ printf "%s\n" ${x:?"You must set x"}  # Not quite careful enough
abc
def
ghi
$ x=
$ printf "%s\n" ${x:?"You must set x"}  # Not quite careful enough
bash: x: You must set x
$ unset x
$ printf "%s\n" ${x:?"You must set x"}  # Not quite careful enough
bash: x: You must set x
$ 

Обратите внимание, что значение in $xрасширяется до первого, *а затем списка имен файлов, когда общее выражение не в двойных кавычках. Это то, что shellcheckрекомендуется исправить. Я не проверял, что он не возражает против формы, в которой выражение заключено в двойные кавычки, но разумно предположить, что все будет в порядке.

Попробуй это:

[ -z "$STATE" ] && echo "Need to set STATE" && exit 1;

Ваш вопрос зависит от оболочки, которую вы используете.

Оболочка Борна оставляет очень мало того, что вы ищете.

НО...

Это работает, почти везде.

Просто попробуйте и держитесь подальше от csh. Это было хорошо для добавленных прибамбасов, по сравнению с панцирем Борна, но сейчас он действительно скрипит. Если вы мне не верите, просто попытайтесь выделить STDERR в csh! (-:

Здесь есть две возможности. Пример выше, а именно с использованием:

${MyVariable:=SomeDefault}

в первый раз вам нужно обратиться к $ MyVariable. Это занимает env. var MyVariable и, если он в данный момент не задан, присваивает значение SomeDefault переменной для последующего использования.

У вас также есть возможность:

${MyVariable:-SomeDefault}

который просто заменяет SomeDefault на переменную, в которой вы используете эту конструкцию. Он не присваивает значение SomeDefault переменной, и значение MyVariable будет по-прежнему равно нулю после того, как встретится этот оператор.

Конечно, самый простой подход - добавить -uпереключатель к шебангу (строка вверху вашего скрипта), предполагая, что вы используете bash:

#!/bin/sh -u

Это приведет к завершению работы скрипта, если в нем скрываются какие-либо несвязанные переменные.

${MyVariable:=SomeDefault}

Если MyVariableустановлено и не равно нулю, будет сброшено значение переменной (= ничего не происходит).
Остальное MyVariableустановлено SomeDefault.

Вышеприведенное попытается выполнить ${MyVariable}, так что если вы просто хотите установить переменную do:

MyVariable=${MyVariable:=SomeDefault}

На мой взгляд, самая простая и совместимая проверка для #! / Bin / sh :

if [ "$MYVAR" = "" ]
then
   echo "Does not exist"
else
   echo "Exists"
fi

Опять же, это для / bin / sh и совместимо также со старыми системами Solaris.

bashВ 4.2 введен -vоператор, который проверяет, задано ли для имени какое-либо значение, даже пустую строку.

$ unset a
$ b=
$ c=
$ [[ -v a ]] && echo "a is set"
$ [[ -v b ]] && echo "b is set"
b is set
$ [[ -v c ]] && echo "c is set"
c is set

Я всегда использовал:

if [ "x$STATE" == "x" ]; then echo "Need to set State"; exit 1; fi

Боюсь, не так уж и кратко.

Под CSH у вас есть $? STATE.

Для будущих людей, таких как я, я хотел сделать шаг вперед и параметризовать имя переменной, чтобы я мог перебрать список имен переменных переменного размера:

#!/bin/bash
declare -a vars=(NAME GITLAB_URL GITLAB_TOKEN)

for var_name in "${vars[@]}"
do
  if [ -z "$(eval "echo \$$var_name")" ]; then
    echo "Missing environment variable $var_name"
    exit 1
  fi
done

Мы можем написать хорошее утверждение, чтобы проверить сразу несколько переменных:

#
# assert if variables are set (to a non-empty string)
# if any variable is not set, exit 1 (when -f option is set) or return 1 otherwise
#
# Usage: assert_var_not_null [-f] variable ...
#
function assert_var_not_null() {
  local fatal var num_null=0
  [[ "$1" = "-f" ]] && { shift; fatal=1; }
  for var in "$@"; do
    [[ -z "${!var}" ]] &&
      printf '%s\n' "Variable '$var' not set" >&2 &&
      ((num_null++))
  done

  if ((num_null > 0)); then
    [[ "$fatal" ]] && exit 1
    return 1
  fi
  return 0
}

Пример вызова:

one=1 two=2
assert_var_not_null one two
echo test 1: return_code=$?
assert_var_not_null one two three
echo test 2: return_code=$?
assert_var_not_null -f one two three
echo test 3: return_code=$? # this code shouldn't execute

Вывод:

test 1: return_code=0
Variable 'three' not set
test 2: return_code=1
Variable 'three' not set

Больше таких утверждений здесь: https://github.com/codeforester/base/blob/master/lib/assertions.sh

Это тоже может быть способом:

if (set -u; : $HOME) 2> /dev/null
...
...

http://unstableme.blogspot.com/2007/02/checks-whether-envvar-is-set-or-not.html

Ни одно из вышеперечисленных решений не сработало для моих целей, отчасти потому, что я проверил среду на наличие открытого списка переменных, которые необходимо установить перед началом длительного процесса. Я закончил с этим:

mapfile -t arr < variables.txt

EXITCODE=0

for i in "${arr[@]}"
do
   ISSET=$(env | grep ^${i}= | wc -l)
   if [ "${ISSET}" = "0" ];
   then
      EXITCODE=-1
      echo "ENV variable $i is required."
   fi
done

exit ${EXITCODE}

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

is_this_an_env_variable ()
    local var="$1"
    if env |grep -q "^$var"; then
       return 0
    else
       return 1
    fi
 }

$?Синтаксис очень аккуратно:

if [ $?BLAH == 1 ]; then 
    echo "Exists"; 
else 
    echo "Does not exist"; 
fi