如何确保将 Makefile 变量设置为先决条件？

Question

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!"

如何确保设置了这个 ENV 变量？有没有办法将此 makefile 变量声明为部署配方的先决条件？例如，

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

Answer 1

如果 ENV 未定义并且需要它（无论如何在 GNUMake 中），这将导致致命错误。

.PHONY：部署检查环境 部署：检查环境 ... 其他需要环境的东西：检查环境 ... 检查环境： ifndef ENV $（错误 ENV 未定义） 万一

（注意 ifndef 和 endif 没有缩进 - they control what make "sees"，在 Makefile 运行之前生效。“$(error” 用制表符缩进，因此它只在规则的上下文中运行。）

Answer 2

您可以创建一个隐式保护目标，检查词干中的变量是否已定义，如下所示：

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，那么你会得到一个错误，并且构建会失败。

Answer 3

内联变体

在我的 makefile 中，我通常使用如下表达式：

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

警告：

• 不要在该块中使用标签
• 谨慎使用：如果未设置 ENV，即使 clean 目标也会失败。否则，请参阅更复杂的 Hudon 的答案

Answer 4

我知道这已经过时了，但我想我会为未来的访客提供自己的经验，因为恕我直言，它更简洁一些。

通常，make 将使用 sh 作为其默认 shell (set via the special SHELL variable)。在sh 及其派生词中，exit with an error message when retrieving an environment variable if it is not set or null 的操作很简单：${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!"

注意事项：

• 需要转义的美元符号 ($$) 才能将扩展推迟到 shell，而不是在 make 内
• test 的使用只是为了防止 shell 尝试执行 VAR 的内容（它没有其他重要用途）
• .check-env-vars 可以简单地扩展以检查更多环境变量，每个环境变量只添加一行（例如@test $${NEWENV?Please set environment variable NEWENV}）

Answer 5

正如我所见，命令本身需要 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

Answer 6

到目前为止，给定答案的一个可能问题是未定义 make 中的依赖顺序。例如，运行：

make -j target

当target 有一些依赖项时，并不能保证它们会以任何给定的顺序运行。

解决方案（确保在选择配方之前检查 ENV）是在 make 的第一次通过期间检查 ENV，在任何配方之外：

## 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
    ...

您可以阅读here 和$() 使用的不同函数/变量，这只是一种明确声明我们正在与“无”进行比较的方式。

Answer 7

我发现除了其他 PHONY 目标之外，不能将最佳答案用作要求。如果用作实际文件目标的依赖项，则使用check-env 将强制重建该文件目标。

其他答案是全局的（例如，Makefile 中的 all 目标需要该变量）或使用 shell，例如如果 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 有一些可怕的警告，但对于这个简单的用途，我相信它是最好的选择。

Answer 8

您可以使用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