Mục tiêu A phụ thuộc vào B mục tiêu nếu A cần B tại thời điểm tạo hoặc thực thi. Mối quan hệ phụ thuộc sẽ tạo ra Đồ thị tuần hoàn có hướng (DAG) qua các mục tiêu và được gọi là biểu đồ phần phụ thuộc.
Các phần phụ thuộc trực tiếp của mục tiêu là các mục tiêu khác có thể truy cập được bằng đường dẫn có độ dài 1 trong biểu đồ phần phụ thuộc. Các phần phụ thuộc bắc cầu của mục tiêu là các mục tiêu mà mục tiêu phụ thuộc thông qua một đường dẫn có độ dài bất kỳ qua biểu đồ.
Trên thực tế, trong ngữ cảnh bản dựng, có hai biểu đồ phần phụ thuộc, đó là biểu đồ về phần phụ thuộc thực tế và biểu đồ phần phụ thuộc đã khai báo. Thông thường, 2 biểu đồ rất giống nhau nên bạn không cần phải phân biệt như vậy, nhưng biểu đồ này rất hữu ích cho các cuộc thảo luận dưới đây.
Phần phụ thuộc thực tế và đã khai báo
X mục tiêu thực sự phụ thuộc vào mục tiêu Y nếu Y phải hiện diện, được tạo và cập nhật để X được tạo một cách chính xác. Đã tạo có thể là các tác vụ được tạo, xử lý, biên dịch, liên kết, lưu trữ, nén, thực thi hoặc bất kỳ loại tác vụ nào khác thường xuyên diễn ra trong một bản dựng.
Mục tiêu X có phần phụ thuộc đã khai báo trên mục tiêu Y nếu có cạnh phần phụ thuộc từ X đến Y trong gói X.
Đối với các bản dựng chính xác, biểu đồ của các phần phụ thuộc thực tế A phải là đồ thị con của biểu đồ các phần phụ thuộc D đã khai báo. Điều này có nghĩa là mọi cặp nút được kết nối trực tiếp x --> y trong A cũng phải được kết nối trực tiếp trong D. Có thể nói D là quá mức của A.
Người viết tệp BUILD phải khai báo rõ ràng tất cả các phần phụ thuộc trực tiếp thực tế cho mọi quy tắc đối với hệ thống xây dựng và không hơn nữa.
Việc không tuân thủ nguyên tắc này sẽ dẫn đến hành vi không xác định: bản dựng có thể không thành công, nhưng tệ hơn là bản dựng có thể phụ thuộc vào một số thao tác trước đó hoặc phụ thuộc vào các phần phụ thuộc khai báo bắc cầu mà mục tiêu sẽ gặp phải. Bazel kiểm tra để tìm các phần phụ thuộc bị thiếu và báo cáo lỗi, nhưng không thể hoàn thành quy trình kiểm tra này trong mọi trường hợp.
Bạn không cần (và không nên) tìm cách liệt kê mọi dữ liệu được nhập gián tiếp, ngay cả khi A cần có tại thời điểm thực thi.
Trong quá trình tạo mục tiêu X, công cụ bản dựng sẽ kiểm tra toàn bộ trạng thái đóng bắc cầu của các phần phụ thuộc của X để đảm bảo rằng mọi thay đổi trong các mục tiêu đó đều được phản ánh trong kết quả cuối cùng, tạo lại các thực thể trung gian nếu cần.
Tính chất bắc cầu của các phần phụ thuộc dẫn đến một lỗi phổ biến. Đôi khi, mã trong một tệp có thể sử dụng mã do phần phụ thuộc gián tiếp cung cấp – một thuộc tính bắc cầu nhưng không phải cạnh trực tiếp trong biểu đồ phần phụ thuộc đã khai báo. Các phần phụ thuộc gián tiếp không xuất hiện trong tệp BUILD. Vì quy tắc này không trực tiếp phụ thuộc vào trình cung cấp, nên không có cách nào để theo dõi các thay đổi, như minh hoạ trong tiến trình mẫu sau:
1. Phần phụ thuộc đã khai báo khớp với phần phụ thuộc thực tế
Lúc đầu, mọi thứ đều hoạt động. Mã trong gói a sử dụng mã trong gói b.
Mã trong gói b sử dụng mã trong gói c, do đó a phụ thuộc bắc cầu vào c.
a/BUILD |
b/BUILD |
|---|---|
rule(
name = "a",
srcs = "a.in",
deps = "//b:b",
)
|
rule(
name = "b",
srcs = "b.in",
deps = "//c:c",
)
|
a / a.in |
b / b.in |
import b;
b.foo();
|
import c;
function foo() {
c.bar();
}
|
|
|
Các phần phụ thuộc đã khai báo vượt quá phần phụ thuộc thực tế. Mọi thứ đều ổn.
2. Thêm phần phụ thuộc chưa khai báo
Mối nguy hiểm tiềm ẩn sẽ xuất hiện khi ai đó thêm mã vào a để tạo phần phụ thuộc thực tế trực tiếp trên c, nhưng lại quên khai báo trong tệp bản dựng a/BUILD.
a / a.in |
|
|---|---|
import b;
import c;
b.foo();
c.garply();
|
|
|
|
|
Các phần phụ thuộc đã khai báo không còn ước tính quá mức cho các phần phụ thuộc thực tế.
Cách này có thể ổn vì trạng thái đóng bắc cầu của 2 biểu đồ là bằng nhau, nhưng gây ra một vấn đề: a có phần phụ thuộc thực tế nhưng chưa được khai báo trên c.
3. Phân kỳ giữa biểu đồ phần phụ thuộc đã khai báo và thực tế
Mối nguy hiểm sẽ được tiết lộ khi ai đó tái cấu trúc b để nó không còn phụ thuộc vào c, vô tình làm hỏng a mà không phải do lỗi của họ.
b/BUILD |
|
|---|---|
rule(
name = "b",
srcs = "b.in",
deps = "//d:d",
)
|
|
b / b.in |
|
import d;
function foo() {
d.baz();
}
|
|
|
|
Biểu đồ phần phụ thuộc đã khai báo hiện là giá trị ước tính của các phần phụ thuộc thực tế, ngay cả khi đóng bắc cầu; bản dựng có thể sẽ không thành công.
Vấn đề này có thể được giải quyết bằng cách đảm bảo rằng phần phụ thuộc thực tế từ a đến c được giới thiệu ở Bước 2 đã được khai báo đúng cách trong tệp BUILD.
Các loại phần phụ thuộc
Hầu hết các quy tắc xây dựng đều có 3 thuộc tính để xác định các loại phần phụ thuộc chung: srcs, deps và data. Các nội dung này được giải thích bên dưới. Để biết thêm thông tin chi tiết, hãy xem phần Các thuộc tính phổ biến với tất cả quy tắc.
Nhiều quy tắc cũng có thêm thuộc tính bổ sung cho các loại phần phụ thuộc dành riêng cho quy tắc, ví dụ: compiler hoặc resources. Những nội dung này được trình bày chi tiết trong Bách khoa toàn thư xây dựng.
Phần phụ thuộc srcs
Tệp được tiêu thụ trực tiếp theo quy tắc hoặc các quy tắc xuất tệp nguồn.
Phần phụ thuộc deps
Quy tắc trỏ đến các mô-đun được biên dịch riêng cung cấp tệp tiêu đề, biểu tượng, thư viện, dữ liệu, v.v.
Phần phụ thuộc data
Mục tiêu bản dựng có thể cần một số tệp dữ liệu để chạy chính xác. Các tệp dữ liệu này không phải là mã nguồn: chúng không ảnh hưởng đến cách tạo mục tiêu. Ví dụ: mã kiểm thử đơn vị có thể so sánh kết quả của một hàm với nội dung của một tệp. Khi tạo kiểm thử đơn vị, bạn không cần tệp này, nhưng thực sự cần thiết khi chạy kiểm thử. Điều này cũng áp dụng với các công cụ được khởi chạy trong quá trình thực thi.
Hệ thống xây dựng chạy các bài kiểm thử trong một thư mục riêng biệt chỉ có các tệp được liệt kê là data. Do đó, nếu một tệp nhị phân/thư viện/kiểm thử cần một số tệp để chạy, hãy chỉ định các tệp đó (hoặc một quy tắc bản dựng chứa các tệp đó) trong data. Ví dụ:
# I need a config file from a directory named env:
java_binary(
name = "setenv",
...
data = [":env/default_env.txt"],
)
# I need test data from another directory
sh_test(
name = "regtest",
srcs = ["regtest.sh"],
data = [
"//data:file1.txt",
"//data:file2.txt",
...
],
)
Bạn có thể truy cập các tệp này bằng đường dẫn tương đối path/to/data/file. Trong kiểm thử, bạn có thể tham chiếu đến các tệp này bằng cách kết hợp các đường dẫn của thư mục nguồn kiểm thử và đường dẫn tương đối với không gian làm việc, ví dụ: ${TEST_SRCDIR}/workspace/path/to/data/file.
Sử dụng nhãn để tham chiếu thư mục
Khi xem qua các tệp BUILD của chúng tôi, bạn có thể nhận thấy một số nhãn data
tham chiếu đến các thư mục. Các nhãn này kết thúc bằng /. hoặc / như các ví dụ sau (bạn không nên sử dụng các nhãn này:
Không nên –
data = ["//data/regression:unittest/."]
Không nên –
data = ["testdata/."]
Không nên –
data = ["testdata/"]
Điều này có vẻ thuận tiện, đặc biệt là đối với các kiểm thử vì nó cho phép kiểm thử sử dụng mọi tệp dữ liệu trong thư mục.
Tuy nhiên, hãy cố gắng không làm điều này. Để đảm bảo tạo lại gia tăng chính xác (và thực thi lại kiểm thử) sau khi thay đổi, hệ thống xây dựng phải nhận biết được tập hợp tệp hoàn chỉnh là dữ liệu đầu vào cho bản dựng (hoặc kiểm thử). Khi bạn chỉ định một thư mục, hệ thống xây dựng chỉ tạo lại khi chính thư mục đó thay đổi (do thêm hoặc xoá tệp), nhưng sẽ không thể phát hiện nội dung chỉnh sửa đối với từng tệp riêng lẻ vì những thay đổi đó không ảnh hưởng đến thư mục đính kèm.
Thay vì chỉ định các thư mục làm dữ liệu đầu vào cho hệ thống xây dựng, bạn nên liệt kê tập hợp các tệp có trong đó một cách rõ ràng hoặc sử dụng hàm glob(). (Sử dụng ** để buộc glob() trở thành đệ quy.)
Nên dùng –
data = glob(["testdata/**"])
Rất tiếc, có một số trường hợp phải sử dụng nhãn thư mục.
Ví dụ: nếu thư mục testdata chứa các tệp có tên không tuân thủ cú pháp nhãn, thì việc liệt kê rõ ràng các tệp hoặc việc sử dụng hàm glob() sẽ tạo ra lỗi nhãn không hợp lệ. Bạn phải sử dụng nhãn thư mục trong trường hợp này, nhưng hãy lưu ý đến nguy cơ liên quan đến việc tạo lại dữ liệu không chính xác như mô tả ở trên.
Nếu bạn phải sử dụng nhãn thư mục, hãy lưu ý rằng bạn không thể tham chiếu đến gói mẹ bằng đường dẫn ../ tương đối; thay vào đó, hãy sử dụng đường dẫn tuyệt đối như //data/regression:unittest/..
Mọi quy tắc bên ngoài (chẳng hạn như quy tắc kiểm thử) cần sử dụng nhiều tệp đều phải khai báo rõ ràng sự phụ thuộc vào tất cả các tệp đó. Bạn có thể sử dụng filegroup() để nhóm các tệp với nhau trong tệp BUILD:
filegroup(
name = 'my_data',
srcs = glob(['my_unittest_data/*'])
)
Sau đó, bạn có thể tham chiếu nhãn my_data làm phần phụ thuộc dữ liệu trong chương trình kiểm thử.
| XÂY DỰNG tệp | Chế độ hiển thị |