Variável Makefile como pré-requisito

Em um Makefile, uma deployreceita precisa que uma variável de ambiente ENVseja definida para se executar adequadamente, enquanto outras não se importam, por exemplo:

ENV = 

.PHONY: deploy hello

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

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

Como posso garantir que essa variável seja definida, por exemplo: existe uma maneira de declarar essa variável de makefile como um pré-requisito da receita de implantação, como:

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

?

Obrigado.

Isso causará um erro fatal se não ENVfor definido e algo precisar (no GNUMake, de qualquer maneira).

.PHONY: implantar check-env

deploy: check-env
	...

outra coisa que precisa env: check-env
	...

check-env:
ifndef ENV
	$ (o erro ENV é indefinido)
fim se

(Observe que ifndef e endif não são recuados - eles controlam o que "vê" , entrando em vigor antes da execução do Makefile. "$ (Error" é recuado com uma guia para que seja executado apenas no contexto da regra.)

Você pode criar um destino de guarda implícito, que verifica se a variável no tronco está definida, assim:

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

Em seguida, você adiciona um guard-ENVVARdestino em qualquer lugar que desejar afirmar que uma variável está definida, assim:

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

Se você ligar make change-hostname, sem adicionar HOSTNAME=somehostnamea chamada, você receberá um erro e a compilação falhará.

Variante em linha

Nos meus makefiles, eu normalmente uso uma expressão como:

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

As razões:

• é uma linha simples
• é compacto
• está localizado próximo aos comandos que usam a variável

Não se esqueça do comentário que é importante para a depuração:

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

... força você a procurar o Makefile enquanto ...

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

... explica diretamente o que há de errado

Variante global (por completo, mas não solicitada)

Além do Makefile, você também pode escrever:

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

Advertências:

• não use tab nesse bloco
• use com cuidado: até o cleandestino falhará se ENV não estiver definido. Caso contrário, veja a resposta de Hudon, que é mais complexa

Um possível problema com as respostas dadas até agora é que a ordem de dependência no make não está definida. Por exemplo, executando:

make -j target

Quando targetpossui algumas dependências, não garante que elas sejam executadas em qualquer ordem.

A solução para isso (para garantir que o ENV será verificado antes da escolha das receitas) é verificar o ENV durante o primeiro passe do make, fora de qualquer receita:

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

Você pode ler sobre as diferentes funções / variáveis ​​usadas aqui e $()é apenas uma maneira de declarar explicitamente que estamos comparando "nada".

Descobri que a melhor resposta não pode ser usada como requisito, exceto para outros destinos PHONY. Se usado como uma dependência para um destino que é um arquivo real, o uso check-envforçará a reconstrução desse destino.

Outras respostas são globais (por exemplo, a variável é necessária para todos os destinos no Makefile) ou usam o shell, por exemplo, se ENV estava ausente, o make terminaria independentemente do destino.

Uma solução que encontrei para ambos os problemas é

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

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

.PHONY: build
build:
    echo "building"

A saída parece

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

value tem algumas advertências assustadoras, mas para esse uso simples, acredito que seja a melhor escolha.

Como eu vejo, o próprio comando precisa da variável ENV para que você possa verificá-lo no próprio comando:

.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

Eu sei que isso é antigo, mas achei que iria concorrer com minhas próprias experiências para futuros visitantes, já que é um IMHO um pouco melhor.

Normalmente, makeusará shcomo seu shell padrão ( definido através da SHELLvariável especial ). Em she seus derivados, é trivial para sair com uma mensagem de erro ao recuperar uma variável de ambiente se não for definida ou nulo fazendo: ${VAR?Variable VAR was not set or null}.

Estendendo isso, podemos escrever um destino de reutilização que pode ser usado para falhar em outros destinos se uma variável de ambiente não foi configurada:

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

Coisas de nota:

• O cifrão com escape ( $$) é necessário para adiar a expansão para o shell em vez de dentromake
• O uso de testé apenas para impedir que o shell tente executar o conteúdo de VAR(ele não serve para nenhum outro propósito significativo)
• .check-env-varspode ser estendido trivialmente para verificar se há mais variáveis ​​de ambiente, cada uma das quais adiciona apenas uma linha (por exemplo @test $${NEWENV?Please set environment variable NEWENV})

Você pode usar em ifdefvez de um destino diferente.

.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