Biến Makefile là điều kiện tiên quyết

Trong Makefile, một deploycông thức cần một biến môi trường ENVđược thiết lập để tự thực thi chính xác, trong khi các công thức khác không quan tâm, ví dụ:

ENV = 

.PHONY: deploy hello

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

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

Làm cách nào để đảm bảo biến này được đặt, ví dụ: có cách nào để khai báo biến makefile này như một điều kiện tiên quyết của công thức triển khai, như:

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

?

Cảm ơn bạn.

Điều này sẽ gây ra một lỗi nghiêm trọng nếu ENVkhông được xác định và một cái gì đó cần nó (trong GNUMake, dù sao).

.PHONY: triển khai kiểm tra-env

triển khai: check-env
	...

other-thing-that-cần-env: check-env
	...

kiểm tra-env:
ENV
	$ (lỗi ENV không xác định)
endif

(Lưu ý rằng ifndef và endif không được thụt lề - chúng kiểm soát những gì tạo ra "nhìn thấy" , có hiệu lực trước khi Makefile được chạy. "$ (Lỗi" được thụt vào bằng một tab để nó chỉ chạy trong ngữ cảnh của quy tắc.)

Bạn có thể tạo một mục tiêu bảo vệ ngầm, kiểm tra xem biến trong thân được xác định, như sau:

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

Sau đó, bạn thêm một guard-ENVVARmục tiêu bất cứ nơi nào bạn muốn để xác nhận rằng một biến được xác định, như thế này:

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

Nếu bạn gọi make change-hostname, không thêm HOSTNAME=somehostnamecuộc gọi, bạn sẽ gặp lỗi và quá trình xây dựng sẽ thất bại.

Biến thể nội tuyến

Trong tệp tạo tệp của tôi, tôi thường sử dụng một biểu thức như:

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

Những lý do:

• nó là một lớp lót đơn giản
• nó nhỏ gọn
• Nó nằm gần các lệnh sử dụng biến

Đừng quên bình luận quan trọng để gỡ lỗi:

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

... buộc bạn phải tra cứu Makefile trong khi ...

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

... giải thích trực tiếp những gì sai

Biến thể toàn cầu (cho đầy đủ, nhưng không được hỏi)

Trên Makefile của bạn, bạn cũng có thể viết:

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

Cảnh báo:

• không sử dụng tab trong khối đó
• sử dụng cẩn thận: thậm chí cleanmục tiêu sẽ thất bại nếu ENV không được đặt. Nếu không, hãy xem câu trả lời của Hudon phức tạp hơn

Một vấn đề có thể xảy ra với các câu trả lời cho đến nay là thứ tự phụ thuộc trong thực hiện không được xác định. Ví dụ: đang chạy:

make -j target

khi targetcó một vài phụ thuộc không đảm bảo rằng chúng sẽ chạy theo bất kỳ thứ tự nào.

Giải pháp cho việc này (để đảm bảo rằng ENV sẽ được kiểm tra trước khi chọn công thức nấu ăn) là kiểm tra ENV trong lần thực hiện đầu tiên, bên ngoài bất kỳ công thức nào:

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

Bạn có thể đọc về các hàm / biến khác nhau được sử dụng ở đây và $()chỉ là một cách để tuyên bố rõ ràng rằng chúng ta đang so sánh với "không có gì".

Tôi đã tìm thấy với câu trả lời tốt nhất không thể được sử dụng như một yêu cầu, ngoại trừ các mục tiêu PHONY khác. Nếu được sử dụng làm phụ thuộc cho mục tiêu là một tệp thực tế, sử dụngcheck-env sẽ buộc mục tiêu tệp đó được xây dựng lại.

Các câu trả lời khác là toàn cục (ví dụ: biến được yêu cầu cho tất cả các mục tiêu trong Makefile) hoặc sử dụng shell, ví dụ: nếu ENV bị thiếu, sẽ chấm dứt bất kể mục tiêu.

Một giải pháp tôi tìm thấy cho cả hai vấn đề là

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

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

.PHONY: build
build:
    echo "building"

Đầu ra trông như

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

value có một số cảnh báo đáng sợ, nhưng với cách sử dụng đơn giản này, tôi tin rằng đó là sự lựa chọn tốt nhất.

Như tôi thấy lệnh chính nó cần biến ENV để bạn có thể kiểm tra nó trong chính lệnh đó:

.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

Tôi biết điều này đã cũ, nhưng tôi nghĩ tôi sẽ hòa nhập với những trải nghiệm của riêng mình cho những vị khách tương lai, vì nó là IMHO gọn gàng hơn một chút.

Thông thường, makesẽ sử dụng shlàm vỏ mặc định của nó ( được đặt thông qua SHELLbiến đặc biệt ). Trong shvà các dẫn xuất của nó, việc thoát ra với một thông báo lỗi là không đáng kể khi truy xuất một biến môi trường nếu nó không được đặt hoặc null bằng cách thực hiện:${VAR?Variable VAR was not set or null} .

Mở rộng điều này, chúng ta có thể viết một mục tiêu tạo có thể tái sử dụng có thể được sử dụng để thất bại các mục tiêu khác nếu một biến môi trường không được đặt:

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

Những điều cần lưu ý:

• Ký hiệu đô la thoát ( $$) được yêu cầu để trì hoãn việc mở rộng sang vỏ thay vì bên trongmake
• Việc sử dụng testchỉ là để ngăn vỏ cố gắng thực thi nội dung của VAR(nó không phục vụ mục đích quan trọng nào khác)
• .check-env-varscó thể được mở rộng một cách tầm thường để kiểm tra thêm các biến môi trường, mỗi biến chỉ thêm một dòng (ví dụ @test $${NEWENV?Please set environment variable NEWENV})

Bạn có thể sử dụng ifdefthay vì một mục tiêu khác.

.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