Quy tắc kho lưu trữ

Báo cáo vấn đề Xem nguồn Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Trang này trình bày cách tạo quy tắc kho lưu trữ và cung cấp ví dụ để 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ể dùng trong tệp WORKSPACE và cho phép hoạt động không khép kín ở giai đoạn tải của 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 các thư viện bên thứ ba (chẳng hạn như các thư viện được đóng gói Maven) nhưng cũng có thể dùng để tạo các tệp BUILD dành riêng cho máy chủ mà Bazel đang chạy.

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

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

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. Thư viện 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 đều 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 được tải khi bạn tạo rõ ràng hoặc nếu đó 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à các tệp BUILD của kho lưu trữ đó.

Thuộc tính

Thuộc tính là một đố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à loại thuộc tính khi xác định một quy tắc 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 có các thuộc tính được xác định ngầm (giống như các quy tắc xây dựng). Hai thuộc tính ngầm ẩn là name (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 một quy tắc kho lưu trữ bằng repository_ctx.name. Ý nghĩa của repo_mapping cũng 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ì đó là tên riêng tư và người dùng không thể đặt tên đó.

Hàm triển khai

Mọi quy tắc kho lưu trữ đều yêu cầu một hàm implementation. Nội dung 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, repository_ctx. Hàm này trả về None để biểu thị rằng quy tắc có thể tái tạo với các tham số đã chỉ định, hoặc một từ điển có một tập hợp các 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 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 cam kết cụ thể thay vì một nhánh nổi được chỉ định ban đầu.

Bạn có thể 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 ngữ cảnh. 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ả chính tệp WORKSPACE) sẽ khiến hàm triển khai được thực thi.

Hàm triển khai có thể được khởi động lại nếu một phần phụ thuộc mà hàm này yêu cầu bị thiế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 các lần khởi động lại không cần thiế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 sẽ được tìm nạp trước, miễn là tất cả các đối số nhãn đều 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 một đườ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ể khiến 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ỉ có thay đổi trong các phần phụ thuộc sau đây mới có thể khiến quá trình 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 mọi biến môi trường đượ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ẽ làm mất hiệu lực mọi thao tác của bản dựng).
  • Nội dung của mọi tệp đượ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 các 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 các phần phụ thuộc của kho lưu trữ đó. Ví dụ: một kho lưu trữ tìm nạp các nguồn có thể tuân theo một nhánh cụ thể của kho lưu trữ bên thứ ba và các cam kết 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 vô điều kiện bằng cách gọi bazel sync.

Ngoài ra, 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 những kho lưu trữ bên ngoài mà định nghĩa repository_rule có thuộc tính configure được đặt, hãy sử dụng bazel sync --configure.

Ví dụ

  • Chuỗi công cụ C++ được định cấu hình tự động: chuỗi công cụ này sử dụng một 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ác 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.

  • rules_jvm_external tạo một kho lưu trữ bên ngoài có tên là @maven theo mặc định, 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.