Zmienna Makefile jako warunek wstępny

W pliku Makefile deployreguła wymaga ustawienia zmiennej środowiskowej, ENVaby poprawnie się wykonywała, podczas gdy innych to nie obchodzi, np .:

ENV = 

.PHONY: deploy hello

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

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

Jak mogę się upewnić, że ta zmienna jest ustawiona, np .: czy istnieje sposób na zadeklarowanie tej zmiennej makefile jako warunku wstępnego reguły wdrażania, na przykład:

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

?

Dziękuję Ci.

Spowoduje to fatalny błąd, jeśli ENVjest niezdefiniowany i coś tego potrzebuje (w każdym razie w GNUMake).

.PHONY: wdrażanie check-env

wdrożyć: check-env
	...

inna-rzecz-potrzeb-env: check-env
	...

check-env:
ifndef ENV
	$ (błąd ENV jest niezdefiniowany)
endif

(Zauważ, że ifndef i endif nie są wcięte - kontrolują to, co sprawia, że ​​"widzi" , działając przed uruchomieniem pliku Makefile. "$ (Błąd" jest wcięty za pomocą tabulatora, więc działa tylko w kontekście reguły).

Możesz utworzyć niejawny cel ochronny, który sprawdza, czy zmienna w rdzeniu jest zdefiniowana, na przykład:

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

Następnie dodajesz guard-ENVVARcel w dowolnym miejscu, w którym chcesz potwierdzić, że zmienna jest zdefiniowana, na przykład:

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

Jeśli zadzwonisz make change-hostnamebez dodawania HOSTNAME=somehostnamewywołania, pojawi się błąd, a kompilacja się nie powiedzie.

Wariant Inline

W moich plikach makefile zwykle używam wyrażenia takiego jak:

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

Powody:

• jest to prosta jedna linijka
• jest kompaktowy
• znajduje się blisko poleceń używających tej zmiennej

Nie zapomnij komentarza, który jest ważny przy debugowaniu:

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

... zmusza cię do wyszukania Makefile podczas ...

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

... wyjaśnia bezpośrednio, co się stało

Wariant globalny (dla kompletności, ale bez pytania)

Oprócz pliku Makefile możesz również napisać:

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

Ostrzeżenia:

• nie używaj tabulatora w tym bloku
• używaj ostrożnie: nawet cleancel nie powiedzie się, jeśli ENV nie jest ustawiony. W przeciwnym razie zobacz odpowiedź Hudona, która jest bardziej złożona

Jednym z możliwych problemów z dotychczas udzielonymi odpowiedziami jest to, że kolejność zależności w make nie jest zdefiniowana. Na przykład bieganie:

make -j target

when targetma kilka zależności, nie gwarantuje, że będą one działać w dowolnej kolejności.

Rozwiązaniem tego problemu (aby zagwarantować, że ENV zostanie sprawdzone przed wybraniem receptury) jest sprawdzenie ENV podczas pierwszego przejścia marki, poza jakąkolwiek recepturą:

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

Możesz przeczytać o różnych funkcjach / zmiennych używanych tutaj i $()jest to tylko sposób na wyraźne stwierdzenie, że porównujemy z „niczym”.

Uważam, że z najlepszą odpowiedzią nie można użyć jako wymagania, z wyjątkiem innych celów PHONY. Jeśli jest używany jako zależność dla celu, który jest rzeczywistym plikiem, użycie check-envwymusi odbudowanie tego celu pliku.

Inne odpowiedzi są globalne (np. Zmienna jest wymagana dla wszystkich celów w Makefile) lub używają powłoki, np. Gdyby brakowało ENV, make zakończy działanie niezależnie od celu.

Rozwiązaniem obu problemów, które znalazłem, jest

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

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

.PHONY: build
build:
    echo "building"

Wynik wygląda jak

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

value ma kilka przerażających zastrzeżeń, ale w przypadku tego prostego zastosowania uważam, że jest to najlepszy wybór.

Jak widzę, samo polecenie potrzebuje zmiennej ENV, więc możesz to sprawdzić w samym poleceniu:

.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

Wiem, że to jest stare, ale pomyślałem, że wtrącę się z własnymi doświadczeniami dla przyszłych gości, ponieważ jest trochę schludniejszy IMHO.

Zwykle makeużyje shpowłoki domyślnej ( ustawianej przez specjalną SHELLzmienną ). W shi jego pochodne, to trywialny wyjść z komunikatem o błędzie podczas pobierania zmiennej środowiskowej, jeśli nie jest ustawiona lub null, wykonując: ${VAR?Variable VAR was not set or null}.

Rozszerzając to, możemy napisać make target wielokrotnego użytku, który może być użyty do zawodzenia innych celów, jeśli zmienna środowiskowa nie została ustawiona:

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

Uwagi:

• Znak dolara uciekającego ( $$) jest wymagany do odroczenia rozwinięcia do powłoki zamiast do wewnątrzmake
• Użycie testjest tylko po to, aby zapobiec próbom wykonania przez powłokę zawartości VAR(nie służy to żadnemu innemu znaczącemu celowi)
• .check-env-varsmożna w trywialny sposób rozszerzyć, aby sprawdzić więcej zmiennych środowiskowych, z których każda dodaje tylko jedną linię (np. @test $${NEWENV?Please set environment variable NEWENV})

Możesz użyć ifdefzamiast innego celu.

.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