A mục tiêu 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ời gian thực thi. Mối quan hệ phụ thuộc vào tạo ra Đồ thị không chu trình có hướng (DAG) trên các mục tiêu và nó đượ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ể tiếp cận được bằng đường dẫn có độ dài bằng 1 trong biểu đồ phần phụ thuộc. Các phần phụ thuộc ngoại tuyến của một mục tiêu là các mục tiêu mà nó phụ thuộc vào thông qua một đường dẫn có độ dài bất kỳ thông qua biểu đồ.
Trên thực tế, trong ngữ cảnh bản dựng, có 2 biểu đồ phần phụ thuộc là biểu đồ về phần phụ thuộc thực tế và biểu đồ về các phần phụ thuộc đã khai báo. Trong hầu hết trường hợp, 2 biểu đồ rất giống nhau nên bạn không cần phải đưa ra sự khác biệt này, nhưng cách này sẽ hữu ích cho phần thảo luận dưới đây.
Các phần phụ thuộc thực tế và phần phụ thuộc đã khai báo
X mục tiêu thực sự phụ thuộc vào Y mục tiêu nếu Y phải có mặt, được tạo và được cập nhật để X được tạo một cách chính xác. Được tạo có thể là 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 diễn ra trong một bản dựng.
X mục tiêu có phần phụ thuộc đã khai báo trên mục tiêu Y nếu có cạnh phụ thuộc từ X đến Y trong gói X.
Để có bản dựng chính xác, biểu đồ các phần phụ thuộc thực tế A phải là đồ thị con của biểu đồ của các phần phụ thuộc đã khai báo D. Điều đó 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à sự gần đúng của A.
Trình ghi tệp BUILD phải khai báo rõ ràng tất cả phần phụ thuộc trực tiếp thực tế cho mọi quy tắc cho hệ thống xây dựng, ngoài ra còn không các phần phụ thuộc khác.
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, bản dựng có thể phụ thuộc vào một số thao tác trước đó hoặc dựa trên các phần phụ thuộc được khai báo bắc cầu mà mục tiêu có. 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 quy trình kiểm tra này không thể hoàn tất trong mọi trường hợp.
Bạn không cần (và không nên) cố gắng liệt kê mọi thứ được nhập gián tiếp, ngay cả khi A cần nhập tại thời điểm thực thi.
Trong quá trình tạo bản dựng của X mục tiêu, 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 chất trung gian nếu cần.
Bản chất bắc cầu của các phần phụ thuộc là 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 cạnh bắc cầu nhưng không 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 ví dụ sau đây:
1. Các phần phụ thuộc đã khai báo khớp với các phần phụ thuộc thực tế
Ban đầu, mọi thứ đều hoạt động. Mã trong gói a dùng mã trong gói b.
Mã trong gói b sử dụng mã trong gói c, và 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 ước tính quá mức các phần phụ thuộc thực tế. Mọi thứ đều ổn.
2. Thêm phần phụ thuộc chưa được khai báo
Mối nguy hiểm tiềm ẩn sẽ xuất hiện khi có người thêm mã vào a tạo ra phần phụ thuộc thực tế trực tiếp trên c, nhưng lại quên khai báo điều này 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 được khai báo không còn ước tính quá mức các phần phụ thuộc thực tế nữa.
Điều này có thể chấp nhận được vì mức đóng bắc cầu của hai biểu đồ là bằng nhau, nhưng lại che giấu 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. Sự khác biệt giữa biểu đồ phần phụ thuộc thực tế và đã khai báo
Mối nguy hiểm sẽ lộ ra khi người nào đó tái cấu trúc b để không còn phụ thuộc vào c, vô tình phá vỡ a mà không xảy ra lỗi của chính 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 được khai báo hiện là mức ước tính thấp 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.
Chúng tôi có thể ngăn chặn sự cố này 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 quy tắc xây dựng đều có 3 thuộc tính để chỉ định các loại phần phụ thuộc chung: srcs, deps và data. Những thông tin này sẽ được giải thích ở bên dưới. Để biết thêm thông tin, hãy xem phần Các thuộc tính chung cho mọi quy tắc.
Nhiều quy tắc cũng có các 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 thông tin này được trình bày chi tiết trong Xây dựng Bách khoa toàn thư.
Phần phụ thuộc srcs
Các tệp do quy tắc hoặc các quy tắc xuất ra tệp nguồn sử dụng trực tiếp.
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 đúng cách. 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ụ: bài 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 tệp. Khi tạo kiểm thử đơn vị, bạn không cần tệp này, nhưng lại cần tệp khi chạy kiểm thử. Điều này cũng áp dụng cho 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 tách biệt, trong đó 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 của kiểm thử với đường dẫn tương đối với không gian làm việc, chẳng hạn như ${TEST_SRCDIR}/workspace/path/to/data/file.
Sử dụng nhãn để tham chiếu đến các thư mục
Khi xem qua các tệp BUILD, bạn có thể nhận thấy rằng 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à cho các kiểm thử vì nó cho phép kiểm thử sử dụng tất cả các tệp dữ liệu trong thư mục.
Tuy nhiên, hãy cố gắng không làm việc này. Để đảm bảo tạo lại dần dần 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 đầy đủ các tệp 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ỉ thực hiện việc tạo lại khi chính thư mục đó
thay đổi (do việc thêm hoặc xoá các tệp), nhưng sẽ không thể phát hiện
nội dung chỉnh sửa cho 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() phải là đệ quy.)
Nên dùng –
data = glob(["testdata/**"])
Rất tiếc, có một số trường hợp bắt buộc 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 theo cú pháp nhãn, thì việc liệt kê tệp rõ ràng hoặc sử dụng hàm glob() sẽ tạo ra lỗi nhãn không hợp lệ. Trong trường hợp này, bạn phải sử dụng các nhãn thư mục, nhưng hãy lưu ý đến rủi ro liên quan đến việc tạo lại 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 một đườ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 trình 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 của nó 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 dưới dạng 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ị |