Makefile-Variable als Voraussetzung

In einem Makefile muss für ein deployRezept eine Umgebungsvariable ENVfestgelegt werden, damit sie sich selbst ordnungsgemäß ausführt, während es anderen egal ist, z.

ENV = 

.PHONY: deploy hello

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

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

Wie kann ich sicherstellen, dass diese Variable festgelegt ist, z. B.: Gibt es eine Möglichkeit, diese Makefile-Variable als Voraussetzung für das Bereitstellungsrezept zu deklarieren, z.

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

?

Danke dir.

Dies führt zu einem schwerwiegenden Fehler, wenn er nicht ENVdefiniert ist und von etwas benötigt wird (jedenfalls in GNUMake).

.PHONY: Check-env bereitstellen

Bereitstellen: check-env
	...

andere-Sache-die-braucht-env: check-env
	...

check-env:
ifndef ENV
	$ (Fehler ENV ist undefiniert)
endif

(Beachten Sie, dass ifndef und endif nicht eingerückt sind - sie steuern, was make "sieht" und werden wirksam, bevor das Makefile ausgeführt wird. "$ (Fehler" wird mit einer Registerkarte eingerückt, sodass es nur im Kontext der Regel ausgeführt wird.)

Sie können ein implizites Schutzziel erstellen, das überprüft, ob die Variable im Stamm wie folgt definiert ist:

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

Anschließend fügen Sie ein guard-ENVVARZiel an einer beliebigen Stelle hinzu, an der Sie behaupten möchten, dass eine Variable wie folgt definiert ist:

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

Wenn Sie aufrufen make change-hostname, ohne HOSTNAME=somehostnameden Aufruf hinzuzufügen , wird eine Fehlermeldung angezeigt, und der Build schlägt fehl.

Inline-Variante

In meinen Makefiles verwende ich normalerweise einen Ausdruck wie:

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

Die Gründe:

• Es ist ein einfacher Einzeiler
• es ist kompakt
• Es befindet sich in der Nähe der Befehle, die die Variable verwenden

Vergessen Sie nicht den Kommentar, der für das Debuggen wichtig ist:

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

... zwingt dich, das Makefile nachzuschlagen, während ...

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

... erklärt direkt, was los ist

Globale Variante (der Vollständigkeit halber, aber nicht gefragt)

Über Ihr Makefile können Sie auch schreiben:

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

Warnungen:

• Verwenden Sie in diesem Block keine Registerkarte
• Vorsichtig cleananwenden : Auch das Ziel schlägt fehl, wenn ENV nicht eingestellt ist. Ansonsten siehe Hudons Antwort, die komplexer ist

Ein mögliches Problem mit den gegebenen Antworten ist bisher, dass die Abhängigkeitsreihenfolge in make nicht definiert ist. Zum Beispiel:

make -j target

Wenn targeteinige Abhängigkeiten vorliegen, kann nicht garantiert werden, dass diese in einer bestimmten Reihenfolge ausgeführt werden.

Die Lösung hierfür (um sicherzustellen, dass ENV überprüft wird, bevor Rezepte ausgewählt werden) besteht darin, ENV während des ersten Durchgangs von make außerhalb eines Rezepts zu überprüfen:

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

Sie können sich über die verschiedenen Funktionen / Variablen informieren, die hier verwendet werden, und können $()nur explizit angeben, dass wir mit "nichts" vergleichen.

Ich habe festgestellt, dass die beste Antwort nicht als Voraussetzung verwendet werden kann, außer für andere PHONY-Ziele. Wenn es als Abhängigkeit für ein Ziel verwendet wird, das eine tatsächliche Datei ist, erzwingt check-envdie Verwendung , dass dieses Dateiziel neu erstellt wird.

Andere Antworten sind global (z. B. ist die Variable für alle Ziele im Makefile erforderlich ) oder verwenden die Shell, z. B. wenn ENV fehlte, würde make unabhängig vom Ziel beendet.

Eine Lösung, die ich für beide Probleme gefunden habe, ist

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

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

.PHONY: build
build:
    echo "building"

Die Ausgabe sieht aus wie

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

value hat einige beängstigende Vorbehalte, aber für diese einfache Verwendung glaube ich, dass es die beste Wahl ist.

Wie ich sehe, benötigt der Befehl selbst die Variable ENV, damit Sie sie im Befehl selbst überprüfen können:

.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

Ich weiß, dass dies alt ist, aber ich dachte, ich würde meine eigenen Erfahrungen für zukünftige Besucher einbringen, da es meiner Meinung nach etwas ordentlicher ist.

Typischerweise makewird verwenden shals Standardschale ( eingestellt über die spezielle SHELLVariable ). In shund seinen Derivaten, ist es trivial , um mit einer Fehlermeldung beendet , wenn eine Umgebungsvariable abzurufen , wenn es nicht gesetzt ist oder null , indem Sie: ${VAR?Variable VAR was not set or null}.

Wenn Sie dies erweitern, können Sie ein wiederverwendbares make-Ziel schreiben, mit dem andere Ziele fehlgeschlagen werden können, wenn keine Umgebungsvariable festgelegt wurde:

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

Bemerkenswerte Dinge:

• Das maskierte Dollarzeichen ( $$) ist erforderlich, um die Erweiterung auf die Shell anstatt auf die Shell zu verschiebenmake
• Die Verwendung von testdient nur dazu, zu verhindern, dass die Shell versucht, den Inhalt von auszuführen VAR(es dient keinem anderen wichtigen Zweck).
• .check-env-varskann trivially zu überprüfen , um weitere Umgebungsvariablen erweitert werden, fügt die jeweils nur eine Zeile (z @test $${NEWENV?Please set environment variable NEWENV})

Sie können ifdefanstelle eines anderen Ziels verwenden.

.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