variable de Makefile como requisito previo

Question

En un Makefile, una receta deploy necesita una variable de entorno ENV ser configurado para ejecutar correctamente en sí, mientras que otros no les importa, por ejemplo:

ENV = 

.PHONY: deploy hello 

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

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

¿Cómo puedo asegurarme de esta variable se establece, por ejemplo: ¿hay una forma de declarar esta variable makefile como requisito previo de la receta de despliegue, como:

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

?

Gracias.

Answer 1

Esto provocará un error fatal si ENV no está definido y algo que lo necesita (en GNUMake, de todos modos).

.PHONY: deploy check-env 

deploy: check-env 
    ... 

other-thing-that-needs-env: check-env 
    ... 

check-env: 
ifndef ENV 
    $(error ENV is undefined) 
endif 

(Tenga en cuenta que ifndef y endif no están sangría, "$ (error" se escribe con márgenes, no una ficha -. they control what make "sees", taking effect before the Makefile is run)

Answer 2

Puede usar ifdef en lugar de un objetivo 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 

Answer 3

Como veo el comando en sí necesita la variable ENV para que pueda comprobar en el propio 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 

Answer 4

Se puede crear un objetivo de protección implícita, que comprueba que el variable en el tallo se define, como esto:

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

a continuación, agregue un objetivo guardia-ENVVAR cualquier lugar que desee para afirmar que se define una variable, como esto:

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

Si llama 'make change-hostname', sin agregar HOSTNAME = somehostname en la llamada, obtendrá un error y la compilación fallará.

Answer 5

Un posible problema con las respuestas dadas hasta el momento es que el orden de dependencia en make no está definido. Por ejemplo, ejecutando:

make -j target 

cuando target tiene algunas dependencias no garantiza que éstas se ejecutarán en cualquier orden dado.

La solución para esto (para garantizar que la ENV se comprueba antes se eligen recetas) es comprobar ENV en la primera pasada de maquillaje, fuera de cualquier receta:

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

se puede leer sobre las diferentes funciones/las variables utilizadas here y $() son solo una forma de indicar explícitamente que estamos comparando contra "nada".

Answer 6

Inline variante

En mis makefiles, normalmente utilizo una expresión como:

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

Las razones:

• Es un simple de una sola línea
• es compacto
• se encuentra cerca de los comandos que utilizan la variable

No olvide el comentario que es importante para la depuración:

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

... te obliga a buscar el Makefile tiempo ...

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

... explica directamente lo que está mal

variante Global (por exhaustividad, pero no se le preguntó)

En la parte superior de su Makefile, también se puede escribir:

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

Advertencias:

• pestaña no utilice en ese bloque
• uso con cuidado : incluso el objetivo clean fallará si ENV no está configurado. De lo contrario, vea la respuesta de Hudon que es más compleja