Makefile variable comme prérequis

Dans un Makefile, une deployrecette a besoin d'une variable d'environnement ENVà définir pour s'exécuter correctement, alors que d'autres s'en moquent, par exemple:

ENV = 

.PHONY: deploy hello

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

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

Comment puis-je m'assurer que cette variable est définie, par exemple: existe-t-il un moyen de déclarer cette variable makefile comme prérequis de la recette de déploiement, comme:

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

?

Je vous remercie.

Cela causera une erreur fatale si elle ENVn'est pas définie et que quelque chose en a besoin (dans GNUMake, de toute façon).

.PHONY: déployer check-env

déployer: check-env
	...

autre-chose-qui-a-besoin-env: check-env
	...

check-env:
ifndef ENV
	$ (l'erreur ENV n'est pas définie)
fin si

(Notez que ifndef et endif ne sont pas indentés - ils contrôlent ce que make "voit" , prenant effet avant l'exécution du Makefile. "$ (Error" est indenté avec une tabulation de sorte qu'il ne s'exécute que dans le contexte de la règle.)

Vous pouvez créer une cible de garde implicite, qui vérifie que la variable dans le radical est définie, comme ceci:

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

Vous ajoutez ensuite une guard-ENVVARcible partout où vous souhaitez affirmer qu'une variable est définie, comme ceci:

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

Si vous appelez make change-hostname, sans ajouter HOSTNAME=somehostnamel'appel, vous obtiendrez une erreur et la construction échouera.

Variante en ligne

Dans mes makefiles, j'utilise normalement une expression comme:

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

Les raisons:

• c'est un simple one-liner
• c'est compact
• il est situé à proximité des commandes qui utilisent la variable

N'oubliez pas le commentaire qui est important pour le débogage:

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

... vous oblige à rechercher le Makefile pendant que ...

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

... explique directement ce qui ne va pas

Variante globale (par souci d'exhaustivité, mais non demandée)

En plus de votre Makefile, vous pouvez également écrire:

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

Avertissements:

• n'utilisez pas l'onglet dans ce bloc
• à utiliser avec précaution: même la cleancible échouera si ENV n'est pas défini. Sinon, voyez la réponse de Hudon qui est plus complexe

Un problème possible avec les réponses données jusqu'à présent est que l'ordre des dépendances dans make n'est pas défini. Par exemple, exécuter:

make -j target

quand targeta quelques dépendances ne garantit pas que celles-ci s'exécuteront dans un ordre donné.

La solution pour cela (pour garantir que ENV sera vérifié avant que les recettes ne soient choisies) est de vérifier ENV lors du premier passage de make, en dehors de toute recette:

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

Vous pouvez lire sur les différentes fonctions / variables utilisées ici et $()c'est juste un moyen de déclarer explicitement que nous comparons avec "rien".

J'ai trouvé que la meilleure réponse ne peut pas être utilisée comme une exigence, sauf pour les autres cibles PHONY. S'il est utilisé comme dépendance pour une cible qui est un fichier réel, l'utilisation check-envforcera cette cible de fichier à être reconstruite.

D'autres réponses sont globales (par exemple, la variable est requise pour toutes les cibles dans le Makefile) ou utilisent le shell, par exemple si ENV manquait, make se terminerait indépendamment de la cible.

Une solution que j'ai trouvée aux deux problèmes est

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

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

.PHONY: build
build:
    echo "building"

La sortie ressemble à

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

value a quelques mises en garde effrayantes, mais pour cette utilisation simple, je pense que c'est le meilleur choix.

Comme je le vois, la commande elle-même a besoin de la variable ENV afin que vous puissiez la vérifier dans la commande elle-même:

.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

Je sais que c'est vieux, mais j'ai pensé que je ferais écho à mes propres expériences pour les futurs visiteurs, car c'est un peu plus soigné à mon humble avis.

En règle générale, makeutilisera shcomme shell par défaut ( défini via la SHELLvariable spéciale ). Dans shet ses dérivés, il est trivial de quitter avec un message d'erreur lors de la récupération d'une variable d'environnement si elle n'est pas définie ou nulle en faisant:${VAR?Variable VAR was not set or null} .

En prolongeant cela, nous pouvons écrire une cible de création réutilisable qui peut être utilisée pour faire échouer d'autres cibles si une variable d'environnement n'a pas été définie:

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

Choses à noter:

• Le signe dollar échappé ($$ ) est nécessaire pour reporter l'expansion vers le shell au lieu de l'intérieurmake
• L'utilisation de testest juste pour empêcher le shell d'essayer d'exécuter le contenu deVAR (cela ne sert à rien d'autre)
• .check-env-varspeut être étendu de manière triviale pour rechercher plus de variables d'environnement, chacune n'ajoutant qu'une seule ligne (par exemple @test $${NEWENV?Please set environment variable NEWENV})

Vous pouvez utiliser à la ifdefplace d'une cible différente.

.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