Переменная Makefile как необходимое условие

В Makefile deployрецепту нужна переменная окружения, которая ENVдолжна быть настроена для правильного выполнения, в то время как другим все равно, например:

ENV = 

.PHONY: deploy hello

deploy:
    rsync . $(ENV).example.com:/var/www/myapp/

hello:
    echo "I don't care about ENV, just saying hello!"

Как я могу убедиться, что эта переменная установлена, например: есть ли способ объявить эту переменную makefile как обязательное условие рецепта развертывания, например:

deploy: make-sure-ENV-variable-is-set

?

Спасибо.

Это приведет к фатальной ошибке, если ENVона не определена и что-то нужно (в любом случае в GNUMake).

.PHONY: развернуть check-env

развернуть: check-env
	...

другое-что-нужно-env: check-env
	...

чек-ENV:
ifndef ENV
	$ (ошибка ENV не определена)
ENDIF

(Обратите внимание, что ifndef и endif не имеют отступов - они управляют тем, что make «видит» , вступая в силу перед запуском Makefile. «$ (Error» имеет отступ с вкладкой, поэтому он запускается только в контексте правила.)

Вы можете создать неявную защитную цель, которая проверяет, что переменная в стебле определена, например так:

guard-%:
    @ if [ "${${*}}" = "" ]; then \
        echo "Environment variable $* not set"; \
        exit 1; \
    fi

Затем вы добавляете guard-ENVVARцель везде, где хотите утверждать, что переменная определена, например так:

change-hostname: guard-HOSTNAME
        ./changeHostname.sh ${HOSTNAME}

Если вы позвоните make change-hostnameбез добавления HOSTNAME=somehostnameзвонка, вы получите сообщение об ошибке, и сборка не удастся.

Встроенный вариант

В моих make-файлах я обычно использую выражение вроде:

deploy:
    test -n "$(ENV)"  # $$ENV
    rsync . $(ENV).example.com:/var/www/myapp/

Причины:

• это простой однострочник
• это компактно
• он расположен близко к командам, которые используют переменную

Не забудьте комментарий, который важен для отладки:

test -n ""
Makefile:3: recipe for target 'deploy' failed
make: *** [deploy] Error 1

... заставляет вас искать Makefile, пока ...

test -n ""  # $ENV
Makefile:3: recipe for target 'deploy' failed
make: *** [deploy] Error 1

... объясняет прямо, что не так

Глобальный вариант (для полноты, но не задан)

В верхней части вашего Makefile вы также можете написать:

ifeq ($(ENV),)
  $(error ENV is not set)
endif

Предупреждения:

• не используйте вкладку в этом блоке
• используйте с осторожностью: даже cleanцель потерпит неудачу, если ENV не установлен. В противном случае см. Ответ Гудона, который является более сложным

Пока что возможной проблемой с данными ответами является то, что порядок зависимости в make не определен. Например, работает:

make -j target

когда target есть несколько зависимостей, это не гарантирует, что они будут работать в любом заданном порядке.

Решением для этого (чтобы гарантировать, что ENV будет проверен до выбора рецептов) является проверка ENV во время первого прохода make вне любого рецепта:

## Are any of the user's goals dependent on ENV?
ifneq ($(filter deploy other-thing-that-needs-ENV,$(MAKECMDGOALS)),$())
ifndef ENV 
$(error ENV not defined)
endif
endif

.PHONY: deploy

deploy: foo bar
    ...

other-thing-that-needs-ENV: bar baz bono
    ...

Вы можете прочитать о различных функциях / переменных, используемых здесь, и $()это просто способ явно заявить, что мы сравниваем с «ничем».

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

Другие ответы являются глобальными (например, переменная требуется для всех целей в Makefile) или используют оболочку, например, если ENV отсутствовал, make завершится независимо от цели.

Решение, которое я нашел для обеих проблем:

ndef = $(if $(value $(1)),,$(error $(1) not set))

.PHONY: deploy
deploy:
    $(call ndef,ENV)
    echo "deploying $(ENV)"

.PHONY: build
build:
    echo "building"

Выход выглядит как

$ make build
echo "building"
building
$ make deploy
Makefile:5: *** ENV not set.  Stop.
$ make deploy ENV="env"
echo "deploying env"
deploying env
$

value есть некоторые страшные предостережения, но для этого простого использования я считаю, что это лучший выбор.

Как я вижу, самой команде нужна переменная ENV, чтобы вы могли проверить это в самой команде:

.PHONY: deploy check-env

deploy: check-env
    rsync . $(ENV).example.com:/var/www/myapp/

check-env:
    if test "$(ENV)" = "" ; then \
        echo "ENV not set"; \
        exit 1; \
    fi

Я знаю, что это старо, но я подумала, что поделюсь своим собственным опытом для будущих посетителей, так как это немного аккуратнее ИМХО.

Как правило, make будет использоваться в shкачестве оболочки по умолчанию ( устанавливается через специальную SHELLпеременную ). В shи его производных, это тривиально выйти с сообщением об ошибке при извлечении переменного окружения , если он не установлен или нулевой , выполнив: ${VAR?Variable VAR was not set or null}.

Расширяя это, мы можем написать повторно используемую цель make, которая может использоваться для сбоя других целей, если переменная окружения не была установлена:

.check-env-vars:
    @test $${ENV?Please set environment variable ENV}


deploy: .check-env-vars
    rsync . $(ENV).example.com:/var/www/myapp/


hello:
    echo "I don't care about ENV, just saying hello!"

Вещи примечания:

• Экранированный знак доллара ( $$) необходим для отсрочки расширения в оболочку, а не вmake
• Использование testпросто предотвращает попытки оболочки выполнить содержимое VAR(это не служит никакой другой важной цели)
• .check-env-varsможет быть тривиально расширен для проверки большего количества переменных среды, каждая из которых добавляет только одну строку (например @test $${NEWENV?Please set environment variable NEWENV})

Вы можете использовать ifdefвместо другой цели.

.PHONY: deploy
deploy:
    ifdef ENV
        rsync . $(ENV).example.com:/var/www/myapp/
    else
        @echo 1>&2 "ENV must be set"
        false                            # Cause deploy to fail
    endif