Định nghĩa phổ biến

Phần này xác định nhiều 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á mã thông báo shell Bourne

Một số thuộc tính chuỗi của một số quy tắc được chia thành nhiều từ theo quy tắc tạo mã thông báo của shell Bourne: dấu cách không được trích dẫn phân định các từ riêng biệt, còn dấu ngoặc kép đơn và kép cũng như dấu gạch chéo ngược được dùng để ngăn việc tạo mã thông báo.

Các thuộc tính chịu sự điều chỉnh của quy trình mã hoá này được nêu rõ như vậy trong định nghĩa của tài liệu này.

Các thuộc tính chịu sự mở rộng biến "Tạo" và mã hoá mã thông báo của Bourne shell 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 như vậy là cc_library.coptsjava_library.javacopts. Cùng với nhau, các hoạt động thay thế này cho phép một biến chuỗi mở rộng thành một danh sách từ tuỳ chọn dành riêng cho cấu hình.

Mở rộng nhãn

Một số thuộc tính chuỗi của một số rất ít quy tắc có thể được mở rộng nhãn: nếu các chuỗi đó chứa một 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 mục tiêu //mypkg:target.

Các thuộc tính mẫu bao gồm genrule.cmdcc_binary.linkopts. Thông tin chi tiết có thể khác nhau đáng kể trong từng trường hợp, đối với các vấn đề như: nhãn tương đối có được mở rộng hay không; cách xử lý nhãn mở rộng thành 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 thông thường do hầu hết các quy tắc bản dựng xác định

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 Mô tả
data

Danh sách nhãn; mặc định là []

Các tệp mà quy tắc này cần đến 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 được phép.

Đầu ra mặc định và tệp chạy của các mục tiêu trong thuộc tính data sẽ xuất hiện trong vùng *.runfiles của mọi tệp thực thi được tạo ra hoặc có phần phụ thuộc thời gian chạy trên mục tiêu này. Điều này có thể bao gồm các tệp dữ liệu hoặc tệp nhị phân được sử dụng khi srcs của mục tiêu này được thực thi. Hãy xem phần phần phụ thuộc của dữ liệu để biết thêm thông tin về cách phụ thuộc và sử dụng tệp dữ liệu.

Các quy tắc mới phải xác định thuộc tính data nếu chúng xử lý dữ liệu đầu vào có thể sử dụng các dữ liệu đầu vào khác trong thời gian chạy. Các hàm triển khai của quy tắc cũng phải điền sẵn các tập tin chạy (runfile) của mục tiêu từ các dữ liệu đầu ra và tệp chạy của bất kỳ thuộc tính data nào, cũng như các tệp chạy từ bất kỳ thuộc tính phần phụ thuộc nào cung cấp mã nguồn hoặc các phần phụ thuộc trong thời gian chạy.

deps

Danh sách nhãn; mặc định là []

Phần phụ thuộc cho mục tiêu này. Thường chỉ nên liệt kê các mục tiêu của quy tắc. (Mặc dù một số quy tắc cho phép liệt kê trực tiếp các tệp trong deps, nhưng bạn nên tránh thực hiện điều này khi có thể.)

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ó nhà cung cấp cụ thể.

Ngữ nghĩa chính xác về ý nghĩa của một mục tiêu phụ thuộc vào một mục tiêu khác sử dụng deps cụ thể cho loại quy tắc đó và tài liệu dành riêng cho quy tắc sẽ được trình bày chi tiết hơn. Đối với các quy tắc xử lý mã nguồn, deps thường chỉ định các phần phụ thuộc mã mà mã sử dụng trong srcs.

Thông thường, phần phụ thuộc deps được dùng để cho phép một mô-đun sử dụng các ký hiệu được xác định trong một mô-đun khác được viết bằng cùng một ngôn ngữ lập trình và được biên dịch riêng biệt. Các phần phụ thuộc nhiều ngôn ngữ cũng được cho phép trong nhiều trường hợp: Chẳng hạn, mục tiêu java_library có thể phụ thuộc vào mã C++ trong mục tiêu cc_library, bằng cách liệt kê mã sau trong thuộc tính deps. Xem định nghĩa về phần phụ thuộc để biết thêm thông tin.

licenses

Danh sách chuỗi; không thể định cấu hình; giá trị mặc định là ["none"]

Danh sách các chuỗi loại giấy phép sẽ được sử 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. Đừng sử dụng tính năng này.

srcs

Danh sách nhãn; mặc định là []

Tệp được xử lý hoặc đưa vào quy tắc này. Thường liệt kê các tệp trực tiếp, nhưng có thể liệt kê các mục tiêu quy tắc (như filegroup hoặc genrule) để bao gồm các đầu ra mặc định của chúng.

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ê có đuôi tệp cụ thể.

Thuộc tính chung cho mọi quy tắc bản dựng

Phần này mô tả các thuộc tính được ngầm thêm vào tất cả quy tắc xây dựng.

Thuộc tính Mô tả
compatible_with

Danh sách nhãn; không thể định cấu hình; mặc định là []

Danh sách các môi trường có thể tạo mục tiêu này, ngoài các môi trường được hỗ trợ mặc định.

Đây là một phần của hệ thống quy tắc ràng buộc của Bazel, cho phép người dùng khai báo mục tiêu nào có thể và không thể phụ thuộc vào nhau. Ví dụ: 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. Hãy 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; giá trị mặc định là None

Một thông báo cảnh báo giải thích liên quan đến mục tiêu này. Thông thường, lệnh này dùng để thông báo cho người dùng rằng một mục tiêu đã trở nên lỗi thời hoặc đã được thay thế bằng một quy tắc khác, là mục tiêu riêng tư của gói hoặc có thể bị coi là có hại vì lý do nào đó. Bạn nên cung cấp một số tài liệu tham khảo (chẳng hạn như trang web, số lỗi hoặc CL di chuyển mẫu) để người dùng có thể dễ dàng tìm ra những thay đổi cần thực hiện nhằm tránh thông báo này. Nếu có một mục tiêu mới có thể dùng làm mục tiêu giảm 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 mọi thứ, 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 deprecation được một mục tiêu trong một gói khác phụ thuộc vào.

Các phần phụ thuộc trong gói được miễn trừ khỏi cảnh báo này. Do đó, chẳng hạn như khi tạo hoạt động kiểm thử của một quy tắc không dùng nữa, thì không gặp phải 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ông dùng nữa khác, thì hệ thống sẽ không đưa ra thông báo cảnh báo.

Sau khi người dùng ngừng sử dụng, bạn có thể xoá mục tiêu đó.

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 sẽ được sử dụng cho mục tiêu cụ thể này. Đây là một phần của một API cấp phép không dùng nữa mà Bazel không còn sử dụng nữa. Đừng sử dụng thuộc tính này.

exec_compatible_with

Danh sách nhãn; không thể định cấu hình; giá trị mặc định là []

Danh sách constraint_values phải có trong nền tảng thực thi cho mục tiêu này. Điều này ngoài mọi quy tắc ràng buộc đã được đặt theo loại quy tắc. Các điều kiện ràng buộc được dùng để hạn chế danh sách các nền tảng thực thi có sẵn. Để biết thêm thông tin chi tiết, hãy xem nội dung mô tả về giải pháp chuỗi công cụ.

exec_properties

Từ điển chuỗi; giá trị mặc định là {}

Từ điển các chuỗi sẽ được thêm vào exec_properties của một nền tảng đã chọn cho mục tiêu này. Xem exec_properties của quy tắc nền tảng.

Nếu một khoá có trong cả thuộc tính nền tảng và thuộc tính cấp mục tiêu, thì giá trị sẽ được lấy từ mục tiêu.

features

Danh sách các chuỗi feature; 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 features này được kết hợp với thuộc tính features cấp gói. Ví dụ: nếu các tính năng ["a", "b"] được bật ở cấp gói và thuộc tính features của mục tiêu chứa ["-a", "c"], thì các tính năng được bật cho quy tắc sẽ là "b" và "c". Xem ví dụ.

restricted_to

Danh sách nhãn; không thể định cấu hình; giá trị mặc định là []

Danh sách các môi trường có thể tạo mục tiêu này, thay vì các môi trường được hỗ trợ mặc định.

Đây là một phần của hệ thống quy tắc ràng buộc của Bazel. Hãy xem compatible_with để biết thông tin chi tiết.

tags

Danh sách chuỗi; không thể định cấu hình; mặc định là []

Bạn có thể sử dụng thẻ trên bất kỳ quy tắc nào. Thẻ trên quy tắc kiểm thử và test_suite rất hữu ích để phân loại các quy tắc kiểm thử. Thẻ trên các mục tiêu không phải mục tiêu kiểm thử được dùng để kiểm soát việc thực thi trong hộp cát của các thao tác genruleStarlark, cũng như để phân tích cú pháp bằng con người và/hoặc các công cụ bên ngoài.

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 tags của bất kỳ mục tiêu kiểm thử hoặc genrule nào hoặc các khoá của execution_requirements cho bất kỳ thao tác Starlark nào.

  • Từ khoá no-sandbox dẫn đến hành động hoặc hoạt động kiểm thử không bao giờ trong hộp cát; vẫn có thể lưu vào bộ nhớ đệm hoặc chạy từ xa. Hãy sử dụng no-cache hoặc no-remote để ngăn chặn một hoặc cả hai trường hợp trên.
  • Từ khoá no-cache dẫn đến hành động hoặc bài kiểm thử không bao giờ được lưu vào bộ nhớ đệm (từ xa hoặc cục bộ)
  • Từ khoá no-remote-cache khiến thao tác hoặc kiểm thử không bao giờ được lưu vào bộ nhớ đệm từ xa (nhưng có thể được lưu vào bộ nhớ đệm cục bộ; cũng có thể được thực thi từ xa). Lưu ý: đối với thẻ này, bộ nhớ đệm trên ổ đĩa được coi là bộ nhớ đệm cục bộ, còn bộ nhớ đệm http và gRPC được coi là bộ nhớ đệm từ xa. Nếu bạn sử dụng kết hợp bộ nhớ đệm ổ đĩa cục bộ và bộ nhớ đệm từ xa (bộ nhớ đệm kết hợp), thì bộ nhớ đệm đó sẽ được coi là bộ nhớ đệm từ xa và bị tắt hoàn toàn, trừ phi bạn thiết lập --incompatible_remote_results_ignore_disk. Trong trường hợp đó, các thành phần cục bộ sẽ được sử dụng.
  • Từ khoá no-remote-exec khiến thao tác hoặc kiểm thử không bao giờ được thực thi từ xa (nhưng có thể được lưu vào bộ nhớ đệm từ xa).
  • Từ khoá no-remote ngăn việc thực thi hành động hoặc kiểm thử từ xa hoặc lưu vào bộ nhớ đệm từ xa. Điều này tương đương với việc sử dụng cả no-remote-cacheno-remote-exec.
  • Từ khoá no-remote-cache-upload tắt phần tải lên của quá trình lưu vào bộ nhớ đệm từ xa của một quá trình tạo. không tắt tính năng thực thi từ xa.
  • Từ khoá local ngăn hành động hoặc hoạt động kiểm thử được lưu vào bộ nhớ đệm từ xa, thực thi từ xa hoặc chạy bên trong hộp cát. Đối với quy tắc tạo và quy trình kiểm thử, việc đánh dấu quy tắc bằng thuộc tính local = True cũng có tác dụng tương tự.
  • Từ khoá requires-network cho phép truy cập vào mạng bên ngoài từ bên trong hộp cát. Thẻ này chỉ có hiệu lực nếu bạn bật hộp cát.
  • Từ khoá block-network chặn quyền truy cập vào mạng bên ngoài từ bên trong hộp cát. Trong trường hợp này, chỉ cho phép giao tiếp với localhost. Thẻ này chỉ có hiệu lực nếu bạn bật tính năng hộp cát.
  • requires-fakeroot chạy kiểm thử hoặc hành động dưới dạng uid và gid 0 (tức là người dùng gốc). Tính năng này chỉ được hỗ trợ trên Linux. Thẻ này được ưu tiên hơn tuỳ chọn dòng lệnh --sandbox_fake_username.

Thẻ trên kiểm thử thường được dùng để chú thích vai trò của kiểm thử trong quá trình gỡ lỗi và phát hành. Thông thường, các thẻ hữu ích nhất cho các chương trình kiểm thử C++ và Python. Các thẻ này không có bất kỳ chức năng chú giải nào trong thời gian chạy. Việc sử dụng thẻ và phần tử kích thước giúp bạn linh hoạt tập hợp các bộ kiểm thử dựa trên chính sách kiểm tra cơ sở mã.

Bazel sửa đổi hành vi đang chạy kiểm thử nếu tìm thấy các từ khoá sau trong thuộc tính tags của quy tắc kiểm thử:

  • exclusive sẽ buộc chạy kiểm thử ở chế độ "độc quyền", đảm bảo rằng không có kiểm thử nào khác đang chạy cùng lúc. Các kiểm thử như vậy sẽ được thực thi theo tuần tự sau khi tất cả hoạt động bản dựng và kiểm thử không độc quyền đã hoàn tất. Tính năng thực thi từ xa bị tắt đối với các kiểm thử như vậy vì Bazel không có quyền kiểm soát đối với những gì đang chạy trên máy từ xa.
  • exclusive-if-local sẽ buộc chạy kiểm thử ở chế độ "riêng biệt" nếu kiểm thử được thực thi cục bộ, nhưng sẽ chạy kiểm thử song song nếu kiểm thử được thực thi từ xa.
  • Từ khoá manual sẽ loại trừ mục tiêu khỏi việc mở rộng các ký tự đại diện mẫu mục tiêu (..., :*, :all, v.v.) và các quy tắc test_suite không liệt kê hoạt động kiểm thử một cách rõ ràng khi tính toán tập hợp các mục tiêu cấp cao nhất để tạo/chạy cho các lệnh build, testcoverage. Điều này không ảnh hưởng đến ký tự đại diện mục tiêu hoặc việc mở rộng bộ thử nghiệm trong các ngữ cảnh khác, bao gồm cả lệnh query. Xin lưu ý rằng manual không có nghĩa là mục tiêu không được tạo/chạy tự động bằng các hệ thống xây dựng/kiểm thử liên tục. Ví dụ: bạn nên loại trừ một mục tiêu khỏi bazel test ... vì mục tiêu này yêu cầu các cờ Bazel cụ thể, nhưng vẫn đưa mục tiêu đó vào các lần chạy kiểm thử liên tục hoặc gửi trước được định cấu hình đúng cách.
  • Từ khoá external sẽ buộc kiểm thử được thực thi vô điều kiện (bất kể giá trị --cache_test_results).
Xem phần Quy ước về thẻ trong Bách khoa toàn thư kiểm thử để biết thêm quy ước về các thẻ được đính kèm với mục tiêu thử nghiệm.
target_compatible_with

Danh sách nhãn; mặc định là []

Danh sách constraint_value phải có trong nền tảng mục tiêu để mục tiêu này được coi là tương thích. Việc này bổ sung cho mọi quy tắc ràng buộc đã đặt ra theo loại quy tắc. Nếu nền tảng mục tiêu không đáp ứng được tất cả điều kiện ràng buộc được liệt kê, thì mục tiêu được coi là không tương thích. Các mục tiêu không tương thích sẽ bị bỏ qua để tạo bản dựng và kiểm thử khi mẫu mục tiêu được mở rộng (ví dụ: //..., :all). Khi được chỉ định rõ ràng trên dòng lệnh, các mục tiêu không tương thích sẽ khiến Bazel in lỗi và gây ra lỗi bản dựng hoặc kiểm thử.

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 sẽ bị coi là không tương thích. Các lớp này cũng bị bỏ qua khi tạo và kiểm thử.

Danh sách trống (mặc định) cho biết mục tiêu tương thích với tất cả nền tảng.

Tất cả quy tắc ngoại trừ Quy tắc 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. Ví dụ: việc chỉ định target_compatible_with cho cc_toolchain là không hữu ích.

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à False ngoại trừ các mục tiêu của bộ thử nghiệm và bộ thử nghiệm

Nếu là True, thì chỉ các mục tiêu testonly (chẳng hạn như kiểm thử) mới có thể phụ thuộc vào mục tiêu này.

Tương tự như vậy, một quy tắc không phải là testonly sẽ không được phép phụ thuộc vào bất kỳ quy tắc nào là testonly.

Theo mặc định, các chương trình kiểm thử (quy tắc *_test) và bộ kiểm thử (quy tắc test_suite) là testonly.

Thuộc tính này có nghĩa là mục tiêu không được chứa trong các tệp nhị phân được phát hành cho bản phát hành chính thức.

Do chỉ kiểm thử được thực thi tại thời điểm xây dựng, chứ không phải thời gian chạy và truyền tải một cách hiệu quả thông qua cây phụ thuộc, nên bạn cần áp dụng phương thức này một cách 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ùng các tệp nhị phân sẽ được phát hành chính thức, 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 ngay cả khi liên kết, có thể là do các quy tắc này ghi đè hành vi bình thường một cách vô điều kiện, chắc chắn phải được đánh dấu là chỉ kiểm thử.

toolchains

Danh sách nhãn; không thể định cấu hình; giá trị mặc định là []

Tập hợp các mục tiêu có Tạo biến mà mục tiêu này được phép truy cập. Các mục tiêu này là các thực thể của quy tắc cung cấp TemplateVariableInfo hoặc mục tiêu đặc biệt cho các loại chuỗi công cụ được tích hợp vào Bazel. Các tính năng này bao gồm:

  • @bazel_tools//tools/cpp:current_cc_toolchain
  • @bazel_tools//tools/jdk:current_java_runtime

Xin lưu ý rằng điều này khác với khái niệm độ phân giải chuỗi công cụ mà các hoạt động triển khai quy tắc sử dụng 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 cc_toolchain hoặc java_toolchain cụ thể mà mục tiêu sẽ sử dụng.

visibility

Danh sách nhãn; không thể định cấu hình; mặc định là default_visibility từ gói nếu được chỉ định, hoặc "//visibility:private" nếu không

Thuộc tính visibility trên một mục tiêu kiểm soát xem mục tiêu đó có thể được sử dụng trong các gói khác hay không. Xem tài liệu về chế độ hiển thị.

Các thuộc tính phổ biến cho tất cả quy tắc kiểm thử (*_test)

Phần này mô tả các thuộc tính chung cho mọi quy tắc kiểm thử.

Thuộc tính Mô tả
args

Danh sách chuỗi; tuân theo $(location)"Tạo biến" thay thế và Tạo mã thông báo shell Bourne; mặc định là []

Các đối số dòng lệnh mà Bazel truyền đến mục tiêu khi được thực thi bằng bazel test.

Các đối số này được truyền trước mọi giá trị --test_arg được chỉ định trên dòng lệnh bazel test.

env

Từ điển chuỗi; các giá trị có sự thay thế $(location)"Tạo biến"; mặc định là []

Chỉ định các biến môi trường khác cần đặt khi bazel test thực thi kiểm thử.

Thuộc tính này chỉ áp dụng cho các quy tắc gốc, chẳng hạn như cc_test, py_testsh_test. Hướng dẫn này không áp dụng cho các quy tắc kiểm thử do Starlark xác định. Đối với các quy tắc Starlark của riêng mình, bạn có thể thêm thuộc tính "env" và sử dụng thuộc tính này để điền vào Nhà cung cấp TestEnvironment.

env_inherit

Danh sách chuỗi; mặc định là []

Chỉ định các biến môi trường khác để kế thừa từ môi trường bên ngoài khi quy trình kiểm thử được bazel test thực thi.

Thuộc tính này chỉ áp dụng cho các quy tắc gốc, như cc_test, py_testsh_test. chứ không áp dụng cho các quy tắc kiểm thử do Starlark xác định.

size

Chuỗi "enormous", "large", "medium" hoặc "small"; không thể định cấu hình; mặc định là "medium"

Chỉ định "độ nặng" của mục tiêu kiểm thử: lượng thời gian/tài nguyên cần thiết để chạy mục tiêu đó.

Kiểm thử đơn vị được coi là "nhỏ", kiểm thử tích hợp là "vừa" và kiểm thử toàn diện là "lớn" hoặc "rất lớn". Bazel sử dụng kích thước này để xác định thời gian chờ mặc định. Bạn có thể ghi đè thời gian chờ này bằng thuộc tính timeout. Thời gian chờ là dành cho tất cả chương trình kiểm thử trong mục tiêu BUILD, không phải cho từng kiểm thử riêng lẻ. Khi kiểm thử được chạy cục bộ, size cũng được dùng cho mục đích lên lịch: Bazel cố gắng tôn trọng --local_{ram,cpu}_resources và không gây choáng ngợp máy cục bộ bằng cách chạy nhiều quy trình kiểm thử nặng cùng một lúc.

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:

Kích thước RAM (tính bằng MB) CPU (trong lõi CPU) Thời gian chờ mặc định
nhỏ 20 1 ngắn (1 phút)
trung bình 100 1 vừa phải (5 phút)
lớn 300 1 dài (15 phút)
rất lớn 800 1 vĩnh viễn (60 phút)

Biến môi trường TEST_SIZE sẽ được đặt thành giá trị của thuộc tính này khi tạo chương trình kiểm thử.

timeout

Chuỗi "short", "moderate", "long" hoặc "eternal"; không thể định cấu hình; mặc định được lấy từ thuộc tính size của kiểm thử

Thời gian chạy bài kiểm thử dự kiến trước khi quay lại.

Mặc dù thuộc tính kích thước của kiểm thử kiểm soát việc ước tính tài nguyên, nhưng bạn có thể đặt thời gian chờ của kiểm thử 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 kiểm thử. Bạn có thể ghi đè thời gian chờ kiểm thử bằng cờ --test_timeout, ví dụ: để chạy trong một số điều kiện nhất định được biết là chậm. Giá trị thời gian chờ kiểm thử tương ứng với các khoảng thời gian sau:

Giá trị thời gian chờ Khoảng thời gian
ngắn 1 phút
vừa 5 phút
long 15 phút
vĩnh cửu 60 phút

Đối với các thời gian khác với thời gian nêu trên, bạn có thể ghi đè thời gian chờ kiểm thử bằng cờ bazel --test_timeout, ví dụ: để chạy theo cách thủ công trong các điều kiện được biết là chậm. Các giá trị --test_timeout được tính bằng giây. Ví dụ: --test_timeout=120 sẽ đặt thời gian chờ kiểm thử thành 2 phút.

Biến môi trường TEST_TIMEOUT sẽ được đặt thành thời gian chờ kiểm thử (tính bằng giây) khi tạo chương trình kiểm thử.

flaky

Boolean; không thể định cấu hình; giá trị mặc định là False

Đánh dấu kết quả 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, chỉ đánh dấu kiểm thử là không thành công nếu kiểm thử không thành công mỗi lần. Theo mặc định, thuộc tính này được đặt thành False và quy trình kiểm thử chỉ được thực thi một lần. Xin lưu ý rằng bạn không nên sử dụng thuộc tính này – các bài kiểm thử phải truyền một cách đáng tin cậy khi câu nhận định được giữ nguyên.

shard_count

Số nguyên không âm nhỏ hơn hoặc bằng 50; mặc định là -1

Chỉ định số lượng phân đoạn song song cần dùng để chạy kiểm thử.

Nếu được đặt, giá trị này sẽ ghi đè mọi phương pháp phỏng đoán được dùng để xác định số lượng phân đoạn song song để chạy kiểm thử. Xin lưu ý rằng đối với một số quy tắc kiểm thử, bạn có thể cần tham số này để bật tính năng phân đoạn ngay từ đầu. Xem thêm --test_sharding_strategy.

Nếu bạn bật tính năng phân đoạn kiểm thử, biến môi trường TEST_TOTAL_SHARDS sẽ được đặt thành giá trị này khi tạo kiểm thử.

Tính năng phân đoạn cần có trình chạy kiểm thử để hỗ trợ giao thức phân đoạn kiểm thử. Nếu không, rất có thể chương trình này sẽ chạy mọi quy trình kiểm thử trong mọi phân đoạn, đây không phải là điều bạn muốn.

Vui lòng xem phần Kiểm thử phân đoạn trong Bách khoa toàn thư kiểm thử để biết thông tin chi tiết về tính năng phân đoạn.

local

Boolean; không thể định cấu hình; giá trị mặc định là False

Buộc chạy kiểm thử cục bộ mà không cần hộp cát.

Việc đặt giá trị này thành True tương đương với việc cung cấp "local" làm thẻ (tags=["local"]).

Những thuộc tính chung cho mọi quy tắc nhị phân (*_binary)

Phần này mô tả các thuộc tính chung cho tất cả các quy tắc nhị phân.

Thuộc tính Mô tả
args

Danh sách chuỗi; tuân theo việc thay thế $(location)"Tạo biến" cũng như mã hoá mã thông báo shell Bourne; không thể định cấu hình; mặc định là []

Các đối số dòng lệnh mà Bazel sẽ truyền đến mục tiêu khi mục tiêu đó được thực thi bằng lệnh run hoặc dưới dạng kiểm thử. Các đối số này được truyền trước các đối số được chỉ định trên dòng lệnh bazel run hoặc bazel test.

LƯU Ý: Các đối số 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 trong bazel-bin/ theo cách thủ công).

env

Từ điển chuỗi; các giá trị có sự thay thế $(location)"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 bazel run thực thi.

Thuộc tính này chỉ áp dụng cho các quy tắc gốc, như cc_binary, py_binarysh_binary. Quy tắc này không áp dụng cho các quy tắc thực thi do Starlark xá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 bazel-bin/).

output_licenses

Danh sách chuỗi; 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 một API cấp phép không dùng nữa mà Bazel không còn sử dụng nữa. Đừng sử 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 này có thể thay đổi khi mục tiêu được tạo 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. Bạn có thể sử 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 cho nhiều cấu trúc mục tiêu. Việc chạy bazel build :multiplatform_lib --cpu x86 sẽ tạo mục tiêu bằ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ố các giá trị thay thế cho một thuộc tính có thể định cấu hình dựa trên các 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ý quy tắc (về mặt kỹ thuật, giữa giai đoạn tải và phân tích). Mọi hoạt động xử lý trước khi đánh giá select() đều không biết select() chọn nhánh nào. Ví dụ: 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 dự đ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. Hãy xem câu hỏi thường gặp này để biết thêm thông tin 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 của chú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ì Bazel cần biết giá trị của thuộc tính đó trong nội bộ trước khi có thể xác định cách phân giải select().

Hãy xem phần 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.

Các mục tiêu đầu ra ngầm ẩn

Không dùng đầu ra ngầm ẩn trong C++ nữa. Vui lòng không sử 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ó lộ trình ngừng sử dụng nhưng rồi cũng sẽ không 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ột mục tiêu quy tắc mới, được đặt tên trong một gói. Nhiều hàm quy tắc bản dựng cũng ngầm ẩn bao gồm một hoặc nhiều mục tiêu tệp đầu ra, nội dung và ý nghĩa của các mục tiêu này là dành riêng cho quy tắc. Ví dụ: khi khai báo rõ ràng một quy tắc java_binary(name='foo', ...), bạn cũng ngầm khai báo một tệp đầu ra mục tiêu foo_deploy.jar là một thành phầ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à các thành phần hạng nhất của biểu đồ mục tiêu chung. 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 được tạo cấp cao nhất hoặc khi chúng là đ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. Các phần phụ thuộc này có thể được tham chiếu dưới dạng phần phụ thuộc trong tệp BUILD và có thể được ghi nhận 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 bản dựng, tài liệu của 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 đầu ra ngầm ẩn bắt buộc phải có trong phần khai báo loại quy tắc đó.

Có một điểm khác biệt quan trọng nhưng hơi tinh tế 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à 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 dữ liệu đầu vào) và mục tiêu tệp phái sinh (hoặc đầu ra). Đây là những điều bạn có thể đề cập trong 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 0, 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ó đích tương ứng; ví dụ: các tệp đối tượng .o được tạo trong quá trình biên dịch C++ không thể được tham chiếu 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ố thông tin triển khai nhất định về cách thực hiện công việc. Điều này được giải thích đầy đủ hơn trong Tài liệu tham khảo về khái niệm XÂY DỰNG.