Makefile variabile come prerequisito

In un Makefile, una deployricetta necessita di una variabile d'ambiente ENVda impostare per eseguire correttamente se stessa, mentre ad altri non importa, ad es .:

ENV = 

.PHONY: deploy hello

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

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

Come posso assicurarmi che questa variabile sia impostata, ad esempio: esiste un modo per dichiarare questa variabile makefile come prerequisito della ricetta deploy, come:

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

?

Grazie.

Questo causerà un errore fatale se ENVnon definito e qualcosa ne ha bisogno (in GNUMake, comunque).

.PHONY: distribuire check-env

deploy: check-env
	...

altra cosa che ha bisogno di env: check-env
	...

check-ENV:
ifndef ENV
	$ (errore ENV non definito)
finisci se

(Nota che ifndef e endif non sono rientrati: controllano ciò che rende "vede" , che ha effetto prima che il Makefile venga eseguito. "$ (Errore" è rientrato con una scheda in modo che venga eseguito solo nel contesto della regola.)

È possibile creare un target guard implicito, che controlla che la variabile nello stelo sia definita, in questo modo:

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

Quindi aggiungi una guard-ENVVARdestinazione ovunque desideri affermare che una variabile è definita, in questo modo:

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

Se chiami make change-hostname, senza aggiungere HOSTNAME=somehostnamela chiamata, otterrai un errore e la compilazione fallirà.

Variante in linea

Nei miei makefile, normalmente uso un'espressione come:

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

Le ragioni:

• è un semplice one-liner
• è compatto
• si trova vicino ai comandi che usano la variabile

Non dimenticare il commento che è importante per il debug:

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

... ti costringe a cercare il Makefile mentre ...

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

... spiega direttamente cosa c'è che non va

Variante globale (per completezza, ma non richiesta)

Oltre al tuo Makefile, puoi anche scrivere:

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

Avvertenze:

• non utilizzare la scheda in quel blocco
• usare con cura: anche il cleantarget fallirà se ENV non è impostato. Altrimenti vedi la risposta di Hudon che è più complessa

Un possibile problema con le risposte fornite finora è che l'ordine di dipendenza in make non è definito. Ad esempio, eseguendo:

make -j target

quando targetha alcune dipendenze non garantisce che verranno eseguite in un determinato ordine.

La soluzione per questo (per garantire che ENV verrà controllata prima della scelta delle ricette) è quella di verificare ENV durante il primo passaggio del make, al di fuori di qualsiasi ricetta:

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

Puoi leggere le diverse funzioni / variabili utilizzate qui ed $()è solo un modo per affermare esplicitamente che stiamo confrontando "niente".

Ho trovato con la migliore risposta non può essere utilizzato come requisito, ad eccezione di altri obiettivi PHONY. Se utilizzato come dipendenza per una destinazione che è un file effettivo, l'utilizzo check-envforzerà la ricostruzione di quella destinazione del file.

Altre risposte sono globali (ad es. La variabile è richiesta per tutti i target nel Makefile) o usano la shell, ad esempio se mancava ENV make finirebbe indipendentemente dal target.

Una soluzione che ho trovato per entrambi i problemi è

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

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

.PHONY: build
build:
    echo "building"

L'output è simile

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

value ha alcuni avvertimenti spaventosi, ma per questo semplice uso credo che sia la scelta migliore.

Come vedo il comando stesso ha bisogno della variabile ENV in modo da poterlo controllare nel comando stesso:

.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

So che è vecchio, ma ho pensato di entrare in contatto con le mie esperienze per i futuri visitatori, dal momento che è un po 'più ordinato IMHO.

Tipicamente, makeuserà shcome shell predefinita ( impostata tramite la SHELLvariabile speciale ). In shed i suoi derivati, è banale per chiudere con un messaggio di errore durante il recupero una variabile d'ambiente, se non è impostato o nulla da fare: ${VAR?Variable VAR was not set or null}.

Estendendo questo, possiamo scrivere un target riutilizzabile che può essere usato per fallire altri target se non è stata impostata una variabile d'ambiente:

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

Cose da notare:

• Il simbolo di dollaro con escape ( $$) è necessario per rinviare l'espansione alla shell anziché all'internomake
• L'uso di testè solo per impedire alla shell di provare a eseguire il contenuto di VAR(non ha altri scopi significativi)
• .check-env-varspuò essere banalmente esteso per verificare la presenza di più variabili d'ambiente, ognuna delle quali aggiunge solo una riga (ad es. @test $${NEWENV?Please set environment variable NEWENV})

È possibile utilizzare ifdefinvece di un target diverso.

.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