Makefile variable como requisito previo

En un Makefile, una deployreceta necesita ENVque se configure una variable de entorno para ejecutarse correctamente, mientras que a 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 que esta variable esté configurada?

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

?

Gracias.

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

.PHONY: despliegue check-env

desplegar: check-env
	...

otra cosa que necesita env: check-env
	...

check-env:
ifndef ENV
	$ (error ENV no está definido)
terminara si

(Tenga en cuenta que si ifndef y endif no están sangrados, controlan lo que hace "ve" , surten efecto antes de que se ejecute el Makefile. "$ (Error" está sangrado con una pestaña para que solo se ejecute en el contexto de la regla).

Puede crear un objetivo de protección implícito, que verifique que la variable en la raíz esté definida, así:

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

Luego agrega un guard-ENVVARobjetivo en cualquier lugar donde desee afirmar que una variable está definida, como esta:

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

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

Variante en línea

En mis archivos MAKE, normalmente uso una expresión como:

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

Las razones:

• es una simple línea
• es compacto
• se encuentra cerca de los comandos que usan 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 mientras ...

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

... explica directamente lo que está mal

Variante global (para completar, pero no solicitada)

Además de tu Makefile, también puedes escribir:

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

Advertencias:

• no use la pestaña en ese bloque
• usar con cuidado: incluso el cleanobjetivo fallará si no se establece ENV. De lo contrario, vea la respuesta de Hudon, que es más compleja

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

make -j target

cuando targettiene algunas dependencias no garantiza que se ejecutarán en un orden determinado.

La solución para esto (para garantizar que se verifique el ENV antes de elegir las recetas) es verificar el ENV durante la primera pasada, 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
    ...

Puede leer sobre las diferentes funciones / variables utilizadas aquí y $()es solo una forma de declarar explícitamente que estamos comparando con "nada".

He encontrado que la mejor respuesta no se puede usar como un requisito, a excepción de otros objetivos PHONY. Si se usa como una dependencia para un objetivo que es un archivo real, el uso check-envforzará la reconstrucción del objetivo del archivo.

Otras respuestas son globales (por ejemplo, la variable se requiere para todos los objetivos en el Makefile) o usan el shell, por ejemplo, si faltaba ENV, make terminaría independientemente del objetivo.

Una solución que encontré para ambos problemas es

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

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

.PHONY: build
build:
    echo "building"

La salida se ve como

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

value tiene algunas advertencias de miedo, pero para este uso simple, creo que es la mejor opción.

Como veo, el comando en sí necesita la variable ENV para que pueda verificarlo en el comando en sí:

.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

Sé que esto es viejo, pero pensé en compartir con mis propias experiencias para futuros visitantes, ya que es un poco más ordenado en mi humilde opinión.

Normalmente, makese usará shcomo su shell predeterminado ( establecido a través de la SHELLvariable especial ). En shy sus derivados, es trivial salir con un mensaje de error al recuperar una variable de entorno si no se establece o es nulo al hacer:${VAR?Variable VAR was not set or null} .

Extendiendo esto, podemos escribir un objetivo de fabricación reutilizable que se puede utilizar para fallar otros objetivos si no se estableció una variable de entorno:

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

Cosas de nota:

• Se $$requiere el signo de dólar escapado ( ) para diferir la expansión al shell en lugar de dentro demake
• El uso de testes solo para evitar que el shell intente ejecutar el contenido de VAR(no sirve para ningún otro propósito significativo)
• .check-env-varsse puede extender trivialmente para buscar más variables de entorno, cada una de las cuales agrega solo una línea (por ejemplo @test $${NEWENV?Please set environment variable NEWENV})

Puede usar en ifdeflugar 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