Quy tắc kho lưu trữ

Báo cáo vấn đề Xem nguồn Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Trang này trình bày cách tạo các quy tắc về kho lưu trữ và cung cấp ví dụ để bạn biết thêm thông tin chi tiết.

Kho lưu trữ bên ngoài là một quy tắc chỉ có thể được sử dụng trong tệp WORKSPACE và cho phép hoạt động không kín trong giai đoạn tải Bazel. Mỗi quy tắc kho lưu trữ bên ngoài sẽ tạo không gian làm việc riêng, với các tệp và cấu phần phần mềm BUILD riêng. Bạn có thể dùng các tệp này để phụ thuộc vào thư viện bên thứ ba (chẳng hạn như thư viện đóng gói Maven) nhưng cũng có thể dùng để tạo tệp BUILD dành riêng cho máy chủ lưu trữ mà Bazel đang chạy.

Tạo quy tắc kho lưu trữ

Trong tệp .bzl, hãy sử dụng hàm repository_rule để tạo một quy tắc mới cho kho lưu trữ và lưu trữ quy tắc đó trong một biến toàn cục.

Bạn có thể sử dụng quy tắc kho lưu trữ tuỳ chỉnh giống như quy tắc kho lưu trữ gốc. Tệp này có một thuộc tính name bắt buộc và mọi mục tiêu có trong tệp bản dựng của tệp này có thể được gọi là @<name>//package:target, trong đó <name> là giá trị của thuộc tính name.

Quy tắc này sẽ được tải khi bạn tạo bản dựng một cách rõ ràng hoặc nếu quy tắc là một phần phụ thuộc của bản dựng. Trong trường hợp này, Bazel sẽ thực thi hàm implementation. Hàm này mô tả cách tạo kho lưu trữ, nội dung và tệp BUILD của kho lưu trữ đó.

Thuộc tính

Thuộc tính là đối số quy tắc, chẳng hạn như url hoặc sha256. Bạn phải liệt kê các thuộc tính và kiểu của các thuộc tính đó khi xác định quy tắc về kho lưu trữ.

local_repository = repository_rule(
    implementation=_impl,
    local=True,
    attrs={"path": attr.string(mandatory=True)})

Để truy cập vào một thuộc tính, hãy sử dụng repository_ctx.attr.<attribute_name>.

Tất cả repository_rule đều đã ngầm xác định các thuộc tính (giống như quy tắc bản dựng). Hai thuộc tính ngầm ẩn là name (cũng giống như đối với các quy tắc xây dựng) và repo_mapping. Bạn có thể truy cập tên của quy tắc kho lưu trữ bằng repository_ctx.name. Ý nghĩa của repo_mapping giống như đối với các quy tắc kho lưu trữ gốc local_repository và new_local_repository.

Nếu tên thuộc tính bắt đầu bằng _, thì thuộc tính đó là thuộc tính riêng tư và người dùng không thể đặt thuộc tính đó.

Hàm triển khai

Mỗi quy tắc kho lưu trữ đều yêu cầu một hàm implementation. Tệp này chứa logic thực tế của quy tắc và được thực thi nghiêm ngặt trong Giai đoạn tải.

Hàm này có đúng một tham số đầu vào là repository_ctx. Hàm này trả về None để cho biết quy tắc có thể tái tạo được với các tham số đã chỉ định hoặc một dict có một tập hợp tham số cho quy tắc đó sẽ biến quy tắc đó thành một quy tắc có thể tái tạo tạo ra cùng một kho lưu trữ. Ví dụ: đối với một quy tắc theo dõi kho lưu trữ git, điều đó có nghĩa là trả về một mã nhận dạng thay đổi cụ thể thay vì một nhánh nổi ban đầu được chỉ định.

Bạn có thể sử dụng tham số đầu vào repository_ctx để truy cập vào các giá trị thuộc tính và các hàm không kín (tìm tệp nhị phân, thực thi tệp nhị phân, tạo tệp trong kho lưu trữ hoặc tải tệp xuống từ Internet). Hãy xem thư viện để biết thêm thông tin. Ví dụ:

def _impl(repository_ctx):
  repository_ctx.symlink(repository_ctx.attr.path, "")

local_repository = repository_rule(
    implementation=_impl,
    ...)

Khi nào hàm triển khai được thực thi?

Nếu kho lưu trữ được khai báo là local, thì thay đổi trong một phần phụ thuộc trong biểu đồ phần phụ thuộc (bao gồm cả tệp WORKSPACE) sẽ thực thi hàm triển khai.

Bạn có thể khởi động lại hàm triển khai nếu thiếu một phần phụ thuộc mà hàm đó yêu cầu. Phần đầu của hàm triển khai sẽ được thực thi lại sau khi phần phụ thuộc được phân giải. Để tránh khởi động lại không cần thiết (rất tốn kém vì có thể phải lặp lại quyền truy cập mạng), các đối số nhãn được tìm nạp trước, miễn là tất cả đối số nhãn có thể được phân giải thành một tệp hiện có. Xin lưu ý rằng việc phân giải đường dẫn từ một chuỗi hoặc nhãn chỉ được tạo trong quá trình thực thi hàm vẫn có thể gây ra quá trình khởi động lại.

Cuối cùng, đối với các kho lưu trữ không phải local, chỉ thay đổi trong các phần phụ thuộc sau đây mới có thể khiến bạn phải khởi động lại:

Các tệp .bzl cần thiết để xác định quy tắc kho lưu trữ.
Khai báo quy tắc kho lưu trữ trong tệp WORKSPACE.
Giá trị của bất kỳ biến môi trường nào được khai báo bằng thuộc tính environ của hàm repository_rule. Bạn có thể thực thi giá trị của các biến môi trường đó từ dòng lệnh bằng cờ --action_env (nhưng cờ này sẽ vô hiệu hoá mọi hành động của bản dựng).
Nội dung của bất kỳ tệp nào được nhãn sử dụng và tham chiếu (ví dụ: //mypkg:label.txt chứ không phải mypkg/label.txt).

Buộc tìm nạp lại kho lưu trữ bên ngoài

Đôi khi, một kho lưu trữ bên ngoài có thể trở nên lỗi thời mà không có bất kỳ thay đổi nào đối với định nghĩa hoặc phần phụ thuộc của kho lưu trữ đó. Ví dụ: một kho lưu trữ tìm nạp nguồn có thể theo một nhánh cụ thể của kho lưu trữ bên thứ ba và các thay đổi mới có sẵn trên nhánh đó. Trong trường hợp này, bạn có thể yêu cầu bazel tìm nạp lại tất cả các kho lưu trữ bên ngoài một cách vô điều kiện bằng cách gọi bazel sync.

Hơn nữa, một số quy tắc kiểm tra máy cục bộ và có thể trở nên lỗi thời nếu máy cục bộ được nâng cấp. Tại đây, bạn có thể yêu cầu bazel chỉ tìm nạp lại các kho lưu trữ bên ngoài đó mà định nghĩa repository_rule có thuộc tính configure được đặt, sử dụng bazel sync --configure.

Ví dụ

Chuỗi công cụ được tự động định cấu hình C++: hệ thống này sử dụng quy tắc kho lưu trữ để tự động tạo các tệp cấu hình C++ cho Bazel bằng cách tìm trình biên dịch C++ cục bộ, môi trường và cờ mà trình biên dịch C++ hỗ trợ.
Kho lưu trữ Go sử dụng một số repository_rule để xác định danh sách các phần phụ thuộc cần thiết để sử dụng các quy tắc Go.
Theo mặc định, rules_jvm_external sẽ tạo một kho lưu trữ bên ngoài có tên là @maven. Kho lưu trữ này sẽ tạo các mục tiêu bản dựng cho mọi cấu phần phần mềm Maven trong cây phần phụ thuộc bắc cầu.