Phần này định nghĩa các thuật ngữ và khái niệm phổ biến đối với nhiều hàm hoặc quy tắc xây dựng.
Nội dung
- Mã hoá shell Bourne
- Mở rộng nhãn
- Các thuộc tính điển hình được xác định theo hầu hết các quy tắc xây dựng
- Thuộc tính phổ biến cho tất cả quy tắc xây dựng
- Thuộc tính chung cho mọi quy tắc kiểm thử (*_test)
- Thuộc tính chung cho mọi quy tắc nhị phân (*_binary)
- Thuộc tính có thể định cấu hình
- Mục tiêu đầu ra ngầm ẩn
Mã hoá shell Bourne
Một số thuộc tính chuỗi nhất định của một số quy tắc được chia thành nhiều từ theo quy tắc mã hoá trong shell Bourne: dấu cách không trong dấu ngoặc kép phân tách các từ riêng biệt, ký tự dấu ngoặc đơn và dấu ngoặc kép cũng như dấu gạch chéo ngược được dùng để ngăn việc mã hoá.
Các thuộc tính chịu sự tác động của quá trình mã hoá này sẽ được nêu rõ trong phần định nghĩa của tài liệu này.
Các thuộc tính phải mở rộng biến "Make" và mã hoá shell Bourne thường được dùng để truyền các tuỳ chọn tuỳ ý đến trình biên dịch và các công cụ khác. Ví dụ về các thuộc tính này: cc_library.copts
và java_library.javacopts
.
Các phương thức thay thế này cùng nhau cho phép một biến chuỗi đơn mở rộng thành danh sách các từ tuỳ chọn theo cấu hình cụ thể.
Mở rộng nhãn
Một số thuộc tính chuỗi của một số ít quy tắc có thể phải mở rộng nhãn: nếu các chuỗi đó chứa nhãn hợp lệ dưới dạng chuỗi con, chẳng hạn như //mypkg:target
và nhãn đó là điều kiện tiên quyết được khai báo của quy tắc hiện tại, thì nhãn đó sẽ được mở rộng thành tên đường dẫn của tệp được biểu thị bằng //mypkg:target
mục tiêu.
Ví dụ về các thuộc tính bao gồm genrule.cmd
và cc_binary.linkopts
. Thông tin chi tiết có thể khác nhau đáng kể trong từng trường hợp, về các vấn đề như: nhãn tương đối có được mở rộng hay không; cách xử lý những nhãn mở rộng ra nhiều tệp, v.v. Hãy tham khảo tài liệu về thuộc tính quy tắc để biết thông tin cụ thể.
Các thuộc tính điển hình được xác định theo hầu hết các quy tắc xây dựng
Phần này mô tả các thuộc tính được xác định theo nhiều quy tắc xây dựng, nhưng không phải tất cả.
Thuộc tính | Nội dung mô tả |
---|---|
data |
Danh sách nhãn; mặc định là Các tệp cần thiết cho quy tắc này trong thời gian chạy. Có thể liệt kê các mục tiêu tệp hoặc quy tắc. Nhìn chung, mọi mục tiêu đều cho phép.
Các đầu ra và tệp chạy mặc định của các mục tiêu trong thuộc tính
Các quy tắc mới sẽ xác định thuộc tính |
deps |
Danh sách nhãn; mặc định là
Các phần phụ thuộc cho mục tiêu này. Thường thì bạn chỉ nên liệt kê các mục tiêu theo quy tắc. (Mặc dù một số quy tắc cho phép các tệp được liệt kê trực tiếp trong Các quy tắc theo ngôn ngữ cụ thể thường giới hạn các mục tiêu được liệt kê ở những mục tiêu có trình cung cấp cụ thể.
Ngữ nghĩa chính xác về ý nghĩa của việc một mục tiêu phụ thuộc vào một mục tiêu khác sử dụng
Thông thường, phần phụ thuộc |
licenses |
Danh sách chuỗi; không thể định cấu hình; giá trị mặc định là Danh sách các chuỗi loại giấy phép dùng cho mục tiêu cụ thể này. Đây là một phần của API cấp phép không dùng nữa mà Bazel không còn sử dụng nữa. Đừng dùng tính năng này. |
srcs |
Danh sách nhãn; mặc định là
Các tệp được xử lý hoặc đưa vào quy tắc này. Thường thì liệt kê trực tiếp các tệp, nhưng có thể liệt kê các mục tiêu quy tắc (như Các quy tắc dành riêng cho ngôn ngữ thường yêu cầu các tệp được liệt kê phải có đuôi tệp cụ thể. |
Thuộc tính chung cho mọi quy tắc xây dựng
Phần này mô tả các thuộc tính ngầm ẩn được thêm vào tất cả quy tắc bản dựng.
Thuộc tính | Nội dung mô tả |
---|---|
compatible_with |
Danh sách nhãn;
không thể định cấu hình; mặc định là Ngoài các môi trường được hỗ trợ mặc định, danh sách môi trường có thể tạo mục tiêu này. Đây là một phần của hệ thống ràng buộc của Bazel, cho phép người dùng khai báo các mục tiêu nào có thể và không thể phụ thuộc lẫn nhau. Ví dụ: các tệp nhị phân có thể triển khai bên ngoài không được phụ thuộc vào các thư viện có mã bí mật của công ty. Vui lòng xem bài viết ConstraintSemantics để biết thông tin chi tiết. |
deprecation |
Chuỗi; không thể định cấu hình; mặc định là Một thông báo cảnh báo giải thích về mục tiêu này. Thông thường, thuộc tính này được dùng để thông báo cho người dùng rằng một mục tiêu đã lỗi thời hoặc đã được thay thế bằng một quy tắc khác, dành riêng cho một gói hoặc có thể bị coi là gây hại vì lý do nào đó. Bạn nên thêm một số tệp đối chiếu (như trang web, số lỗi hoặc ví dụ về CL di chuyển) để có thể dễ dàng tìm ra những thay đổi cần thiết để tránh thông báo này. Nếu có một mục tiêu mới có thể dùng để thay thế, bạn chỉ nên di chuyển tất cả người dùng của mục tiêu cũ.
Thuộc tính này không ảnh hưởng đến cách xây dựng các tính năng nhưng có thể ảnh hưởng đến kết quả chẩn đoán của công cụ xây dựng. Công cụ bản dựng đưa ra cảnh báo khi một quy tắc có thuộc tính Các phần phụ thuộc trong gói được miễn trừ khỏi cảnh báo này để chẳng hạn như việc tạo kiểm thử của một quy tắc không dùng nữa sẽ không gặp cảnh báo. Nếu một mục tiêu không dùng nữa phụ thuộc vào một mục tiêu khác không dùng nữa, thì sẽ không có thông báo cảnh báo nào được đưa ra. Sau khi người dùng ngừng sử dụng mục tiêu, bạn có thể xoá mục tiêu này. |
distribs |
Danh sách chuỗi; không thể định cấu hình; giá trị mặc định là Danh sách các chuỗi phương thức phân phối được dùng cho mục tiêu cụ thể này. Đây là một phần của API cấp phép không dùng nữa mà Bazel không còn sử dụng nữa. Đừng dùng tính năng này. |
exec_compatible_with |
Danh sách nhãn;
không thể định cấu hình; mặc định là
Danh sách |
exec_properties |
Từ điển chuỗi; giá trị mặc định là Từ điển chuỗi sẽ được thêm vào Nếu một khoá có trong cả tài sản nền tảng và tài sản cấp mục tiêu, thì giá trị sẽ được lấy từ mục tiêu. |
features |
Danh sách chuỗi tính năng; giá trị mặc định là Tính năng là thẻ chuỗi có thể được bật hoặc tắt trên một mục tiêu. Ý nghĩa của một tính năng phụ thuộc vào chính quy tắc đó. Thuộc tính |
restricted_to |
Danh sách nhãn;
không thể định cấu hình; mặc định là Danh sách môi trường có thể tạo mục tiêu này, thay vì môi trường được hỗ trợ mặc định.
Đây là một phần trong hệ thống ràng buộc của Bazel. Hãy xem |
tags |
Danh sách chuỗi; không thể định cấu hình; giá trị mặc định là
Có thể sử dụng Thẻ trên bất kỳ quy tắc nào. Các thẻ kiểm thử và quy tắc
Bazel sửa đổi hành vi của mã hộp cát nếu tìm thấy các từ khoá sau trong thuộc tính
Thẻ trên quy trình kiểm thử thường được dùng để chú thích vai trò của chương trình kiểm thử trong quy trình gỡ lỗi và phát hành. Thông thường, thẻ hữu ích nhất cho các kiểm thử C++ và Python, trong đó thiếu tính năng chú giải trong thời gian chạy. Việc sử dụng thẻ và các phần tử kích thước mang lại sự linh hoạt trong việc tập hợp các bộ kiểm thử dựa trên chính sách đăng ký cơ sở mã.
Bazel sửa đổi hành vi chạy kiểm thử nếu tìm thấy các từ khoá sau trong thuộc tính
|
target_compatible_with |
Danh sách nhãn; mặc định là
Danh sách Các mục tiêu phụ thuộc bắc cầu vào các mục tiêu không tương thích thì được coi là không tương thích. Các phiên bản này cũng bị bỏ qua để tạo và thử nghiệm. Danh sách trống (là danh sách mặc định) biểu thị mục tiêu tương thích với tất cả các nền tảng.
Tất cả quy tắc ngoài Quy tắc của Workspace đều hỗ trợ thuộc tính này.
Đối với một số quy tắc, thuộc tính này không có hiệu lực. Chẳng hạn, việc chỉ định
Hãy xem trang Nền tảng để biết thêm thông tin về việc bỏ qua mục tiêu không tương thích. |
testonly |
Boolean; không thể định cấu hình; giá trị mặc định là
Nếu là
Tương đương, một quy tắc không phải là
Theo mặc định, các kiểm thử (quy tắc Thuộc tính này nhằm có nghĩa là mục tiêu không được nằm trong tệp nhị phân được phát hành chính thức. Vì chỉ kiểm thử được thực thi tại thời điểm tạo bản dựng chứ không phải thời gian chạy và được truyền rộng rãi thông qua cây phần phụ thuộc, nên bạn cần áp dụng thận trọng. Ví dụ: các mã giả lập và mã giả lập hữu ích cho việc kiểm thử đơn vị cũng có thể hữu ích cho các kiểm thử tích hợp liên quan đến các tệp nhị phân tương tự sẽ được phát hành chính thức, và do đó, có thể không nên được đánh dấu là chỉ kiểm thử. Ngược lại, các quy tắc nguy hiểm khi liên kết (có thể là vì các quy tắc đó ghi đè vô điều kiện hành vi thông thường) chắc chắn nên được đánh dấu là chỉ dùng cho mục đích kiểm thử. |
toolchains |
Danh sách nhãn;
không thể định cấu hình; mặc định là
Tập hợp mục tiêu có Tạo các biến mà mục tiêu này
được phép truy cập. Các mục tiêu này là thực thể của quy tắc cung cấp
Lưu ý rằng điều này khác với khái niệm độ phân giải của chuỗi công cụ được sử dụng trong các quá trình triển khai quy tắc cho cấu hình phụ thuộc vào nền tảng. Bạn không thể sử dụng thuộc tính
này để xác định |
visibility |
Danh sách nhãn;
không thể định cấu hình;
giá trị mặc định là
Thuộc tính |
Thuộc tính chung cho tất cả quy tắc kiểm thử (*_test)
Phần này mô tả thuộc tính chung cho tất cả các quy tắc kiểm thử.
Thuộc tính | Nội dung mô tả | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Danh sách các chuỗi; tuân theo $(location) và "Tạo biến" và mã thông báo shell Bourne; giá trị mặc định là Các đối số dòng lệnh mà Bazel truyền đến mục tiêu khi thực thi bằng
Các đối số này được chuyển trước bất kỳ giá trị |
||||||||||||||||||||
env |
Từ điển của chuỗi; các giá trị có thể được thay thế $(location) và "Tạo biến"; giá trị mặc định là
Chỉ định các biến môi trường bổ sung cần thiết lập khi hoạt động kiểm thử được
Thuộc tính này chỉ áp dụng cho các quy tắc gốc, như |
||||||||||||||||||||
env_inherit |
Danh sách chuỗi; giá trị mặc định là Chỉ định các biến môi trường bổ sung để kế thừa từ môi trường bên ngoài khi
Thuộc tính này chỉ áp dụng cho các quy tắc gốc, như |
||||||||||||||||||||
size |
Chuỗi Chỉ định "mức độ nặng" của mục tiêu kiểm thử: thời gian/tài nguyên cần thiết để chạy. Kiểm thử đơn vị được coi là "nhỏ", kiểm thử tích hợp "trung bình" và kiểm thử toàn diện được coi là "lớn" hoặc "lớn". Bazel sử dụng kích thước để xác định thời gian chờ mặc định (có thể bị ghi đè bằng thuộc tính Kích thước kiểm thử tương ứng với thời gian chờ mặc định sau đây và mức sử dụng tài nguyên cục bộ cao nhất được giả định:
Biến môi trường |
||||||||||||||||||||
timeout |
Chuỗi Khoảng thời gian dự kiến bài kiểm thử sẽ chạy trước khi quay lại.
Mặc dù thuộc tính kích thước của chương trình kiểm thử kiểm soát việc ước tính tài nguyên, nhưng thời gian chờ của chương trình kiểm thử có thể được đặt một cách độc lập. Nếu không được chỉ định rõ ràng, thời gian chờ sẽ dựa trên kích thước của chương trình kiểm thử. Bạn có thể ghi đè thời gian chờ kiểm thử bằng cờ
Đối với những lần khác, thời gian chờ kiểm thử có thể được ghi đè bằng cờ bazel
Biến môi trường |
||||||||||||||||||||
flaky |
Boolean; không thể định cấu hình; mặc định là Đánh dấu kiểm tra là không ổn định. Nếu được đặt, hãy thực thi kiểm thử tối đa 3 lần và chỉ đánh dấu kiểm thử là không thành công nếu mỗi lần không thành công. Theo mặc định, thuộc tính này được đặt thành False và chương trình kiểm thử chỉ được thực thi một lần. Xin lưu ý rằng bạn thường không nên sử dụng thuộc tính này – các bài kiểm thử phải đạt một cách đáng tin cậy khi xác nhận của chúng được giữ nguyên. |
||||||||||||||||||||
shard_count |
Số nguyên không âm nhỏ hơn hoặc bằng 50; giá trị mặc định là Chỉ định số lượng phân đoạn song song cần sử dụng để chạy kiểm thử. Nếu được đặt, giá trị này sẽ ghi đè mọi thông tin phỏng đoán dùng để xác định số lượng phân đoạn song song cần chạy kiểm thử. Lưu ý rằng đối với một số quy tắc kiểm thử, bạn có thể phải sử dụng tham số này để bật tính năng phân đoạn ngay từ đầu. Xem thêm Nếu tính năng phân đoạn kiểm thử được bật, biến môi trường Việc phân đoạn yêu cầu trình chạy kiểm thử hỗ trợ giao thức phân đoạn kiểm thử. Nếu không, thì nhiều khả năng trình kiểm thử sẽ chạy trong mọi phân đoạn. Đây không phải là điều bạn muốn. Hãy xem phần Phân đoạn kiểm thử trong Bách khoa toàn thư kiểm thử để biết thông tin chi tiết về cách phân đoạn. |
||||||||||||||||||||
local |
Boolean; không thể định cấu hình; mặc định là Buộc kiểm thử chạy cục bộ mà không có hộp cát. Việc đặt thuộc tính này thành True tương đương với việc cung cấp "local" dưới dạng thẻ ( |
Thuộc tính chung cho tất cả các quy tắc nhị phân (*_binary)
Phần này mô tả thuộc tính chung cho tất cả các quy tắc nhị phân.
Thuộc tính | Nội dung mô tả |
---|---|
args |
Danh sách các chuỗi; chịu sự thay thế $(location) và "Tạo biến" và mã thông báo mã hoá shell Bourne; không thể định cấu hình; giá trị mặc định là
Các đối số dòng lệnh mà Bazel sẽ truyền đến mục tiêu khi được thực thi bằng lệnh
LƯU Ý: Các đối số không được truyền khi bạn chạy mục tiêu bên ngoài Bazel (ví dụ: bằng cách thực thi tệp nhị phân theo cách thủ công trong |
env |
Từ điển của chuỗi; các giá trị có thể được thay thế $(location) và "Tạo biến"; mặc định là Chỉ định các biến môi trường bổ sung cần thiết lập khi mục tiêu được
Thuộc tính này chỉ áp dụng cho các quy tắc gốc, như
LƯU Ý: Các biến môi trường không được đặt khi bạn chạy mục tiêu bên ngoài Bazel (ví dụ: bằng cách thực thi tệp nhị phân theo cách thủ công trong |
output_licenses |
Danh sách chuỗi; giá trị mặc định là Giấy phép của các tệp đầu ra mà tệp nhị phân này tạo ra. Đây là một phần của API cấp phép không dùng nữa mà Bazel không còn sử dụng nữa. Đừng dùng tính năng này. |
Thuộc tính có thể định cấu hình
Hầu hết các thuộc tính đều "có thể định cấu hình", nghĩa là giá trị của các thuộc tính đó có thể thay đổi khi mục tiêu được xây dựng theo nhiều cách. Cụ thể, các thuộc tính có thể định cấu hình có thể khác nhau dựa trên các cờ được truyền đến dòng lệnh Bazel hoặc phần phụ thuộc hạ nguồn đang yêu cầu mục tiêu. Ví dụ: bạn có thể dùng tính năng này để tuỳ chỉnh mục tiêu cho nhiều nền tảng hoặc chế độ biên dịch.
Ví dụ sau đây khai báo các nguồn khác nhau cho các cấu trúc mục tiêu khác nhau. Việc chạy bazel build :multiplatform_lib --cpu x86
sẽ tạo mục tiêu bằng cách sử dụng x86_impl.cc
, trong khi việc thay thế --cpu arm
sẽ khiến mục tiêu sử dụng arm_impl.cc
.
cc_library( name = "multiplatform_lib", srcs = select({ ":x86_mode": ["x86_impl.cc"], ":arm_mode": ["arm_impl.cc"] }) ) config_setting( name = "x86_mode", values = { "cpu": "x86" } ) config_setting( name = "arm_mode", values = { "cpu": "arm" } )
Hàm select()
chọn trong số nhiều giá trị thay thế cho một thuộc tính có thể định cấu hình dựa trên tiêu chí config_setting
hoặc constraint_value
mà cấu hình của mục tiêu đáp ứng.
Bazel đánh giá các thuộc tính có thể định cấu hình sau khi xử lý macro và trước khi xử lý các quy tắc (về mặt kỹ thuật là giữa
giai đoạn tải và phân tích).
Mọi quá trình xử lý trước khi đánh giá select()
đều không biết select()
chọn nhánh nào. Ví dụ: các macro không thể thay đổi hành vi dựa trên nhánh đã chọn và bazel query
chỉ có thể đưa ra phán đoán thận trọng về các phần phụ thuộc có thể định cấu hình của mục tiêu. Xem phần
Câu hỏi thường gặp này để biết thêm về cách sử dụng select()
với các quy tắc và macro.
Các thuộc tính được đánh dấu là nonconfigurable
trong tài liệu tương ứng không thể sử dụng tính năng này. Thông thường, một thuộc tính không thể định cấu hình vì nội bộ Bazel cần biết giá trị của thuộc tính đó trước khi có thể xác định cách phân giải select()
.
Hãy xem bài viết Thuộc tính bản dựng có thể định cấu hình để biết thông tin tổng quan chi tiết.
Mục tiêu đầu ra ngầm ẩn
Kết quả đầu ra ngầm ẩn trong C++ không còn được dùng nữa. Vui lòng không dùng thuộc tính này bằng các ngôn ngữ khác nếu có thể. Chúng tôi chưa có đường dẫn về việc ngừng sử dụng nhưng cuối cùng các đường dẫn này cũng sẽ không được dùng nữa.
Khi xác định quy tắc bản dựng trong tệp BUILD, bạn đang khai báo rõ ràng mục tiêu quy tắc mới được đặt tên trong gói. Nhiều hàm quy tắc tạo bản dựng cũng ngầm đòi hỏi một hoặc nhiều mục tiêu tệp đầu ra, có nội dung và ý nghĩa riêng cho từng quy tắc.
Ví dụ: khi khai báo rõ ràng quy tắc java_binary(name='foo', ...)
, bạn cũng sẽ ngầm khai báo một tệp đầu ra nhắm mục tiêu foo_deploy.jar
là thành viên của cùng một gói.
(Mục tiêu cụ thể này là một kho lưu trữ Java độc lập, phù hợp để triển khai.)
Các mục tiêu đầu ra ngầm ẩn là thành phần hạng nhất của biểu đồ mục tiêu toàn cầu. Cũng giống như các mục tiêu khác, các mục tiêu này được tạo theo yêu cầu, khi được chỉ định trong lệnh tạo cấp cao nhất hoặc khi là những điều kiện tiên quyết cần thiết cho các mục tiêu bản dựng khác. Bạn có thể tham chiếu các phần tử này dưới dạng phần phụ thuộc trong tệp BUILD và bạn có thể quan sát chúng trong kết quả của các công cụ phân tích như bazel query
.
Đối với mỗi loại quy tắc xây dựng, tài liệu về quy tắc sẽ chứa một phần đặc biệt nêu chi tiết tên và nội dung của mọi kết quả ngầm ẩn do việc khai báo loại quy tắc đó đòi hỏi.
Một điểm khác biệt quan trọng nhưng hơi khó thấy giữa hai không gian tên mà hệ thống xây dựng sử dụng: nhãn xác định mục tiêu (có thể là các quy tắc hoặc tệp), và mục tiêu tệp có thể được chia thành mục tiêu tệp nguồn (hoặc đầu vào) và mục tiêu tệp phát sinh (hoặc đầu ra). Đây là những điều bạn có thể đề cập trong các tệp BUILD, tạo từ dòng lệnh hoặc kiểm tra bằng bazel query
; đây là không gian tên mục tiêu. Mỗi mục tiêu tệp tương ứng với một tệp thực tế trên ổ đĩa ("không gian tên hệ thống tệp"); mỗi mục tiêu quy tắc có thể tương ứng với một hoặc nhiều tệp thực tế trên ổ đĩa.
Có thể có các tệp trên ổ đĩa không có mục tiêu tương ứng;
ví dụ: không thể tham chiếu các tệp đối tượng .o
được tạo trong quá trình biên dịch C++
từ trong các tệp BUILD hoặc từ dòng lệnh.
Bằng cách này, công cụ xây dựng có thể ẩn một số chi tiết triển khai nhất định về cách công cụ xây dựng thực hiện công việc của mình. Điều này được giải thích đầy đủ hơn trong Tài liệu tham khảo về tính năng XÂY DỰNG.