Quy tắc kho lưu trữ

Báo cáo sự cố Xem nguồn

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ể được sử dụng trong tệp WORKSPACE và cho phép hoạt động không theo kiểu tuần tự trong 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 BUILD và cấu phần phần mềm riêng. Bạn có thể dùng các tệp này để phụ thuộc vào thư viện của bên thứ ba (chẳng hạn như thư viện đóng gói Maven), cũng như để tạo các 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 dùng hàm repository_rule để tạo quy tắc kho lưu trữ mới và lưu trữ quy tắc đó trong 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 cho kho lưu trữ gốc. Lớp này có 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 sẽ được tải khi bạn tạo một cách rõ ràng hoặc nếu quy tắc là 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 trong kho lưu trữ đó.

Thuộc tính

Thuộc tính là các đối số quy tắc được truyền dưới dạng câu lệnh cho đối số quy tắc attrs. Các thuộc tính và loại của các thuộc tính đó sẽ được xác định khi bạn xác định quy tắc lưu trữ. Ví dụ về việc xác định các thuộc tính url và sha256 dưới dạng chuỗi:

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

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

def _impl(repository_ctx):
    url = repository_ctx.attr.url
    checksum = repository_ctx.attr.sha256

Mọi repository_rule đều có các thuộc tính được xác định ngầm (giống như quy tắc bản dựng). Hai thuộc tính ngầm ẩn là name (tương tự như quy tắc tạo bản dựng) và repo_mapping. 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ư ý nghĩa của 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ì tên đó là thuộc tính riêng tư và người dùng không thể đặt được.

Hàm triển khai

Mọi quy tắc kho lưu trữ yêu cầu một hàm implementation. Thành phần 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 có đúng một tham số đầu vào là repository_ctx. Hàm trả về None để biểu thị rằng quy tắc có thể tạo lại nhờ các tham số đã chỉ định hoặc một lệnh với tập hợp các tham số cho quy tắc đó sẽ chuyển quy tắc đó thành quy tắc có thể mô phỏng 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, tức là trả về một giá trị 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 ẩ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?

Hàm triển khai của một kho lưu trữ được thực thi khi Bazel cần một mục tiêu từ kho lưu trữ đó, chẳng hạn như khi một mục tiêu khác (trong một kho lưu trữ khác) phụ thuộc vào kho lưu trữ đó hoặc nếu mục tiêu đó được đề cập trên dòng lệnh. Sau đó, hàm triển khai dự kiến sẽ tạo kho lưu trữ trong hệ thống tệp. Quá trình này được gọi là "tìm nạp" kho lưu trữ.

Trái ngược với các mục tiêu thông thường, kho lưu trữ không nhất thiết phải tìm nạp lại khi có thay đổi nào đó khiến kho lưu trữ khác đi. Nguyên nhân là do có những thứ mà Bazel không thể phát hiện được các thay đổi hoặc sẽ gây ra quá nhiều chi phí cho mỗi bản dựng (ví dụ: những thứ được tìm nạp từ mạng). Do đó, kho lưu trữ chỉ được tìm nạp lại nếu một trong những điều sau thay đổi:

• Các tham số được truyền đến phần khai báo của kho lưu trữ trong tệp WORKSPACE.
• Mã Starlark bao gồm việc triển khai kho lưu trữ.
• 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 repository_rule. Giá trị của các biến môi trường này có thể được cố định trong 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 mọi tệp được truyền đến read(), execute() và các phương thức tương tự của repository_ctx được một nhãn tham chiếu (ví dụ: //mypkg:label.txt chứ không phải mypkg/label.txt)
• Khi bazel sync được thực thi.

Có 2 tham số của repository_rule kiểm soát thời điểm tìm nạp lại kho lưu trữ:

• Nếu cờ configure được thiết lập, kho lưu trữ chỉ được tìm nạp lại trên bazel sync khi tham số --configure được truyền vào kho lưu trữ đó (nếu thuộc tính không được đặt, lệnh này sẽ không gây ra việc tìm nạp lại)

• Nếu cờ local được thiết lập, thì ngoài các trường hợp trên, kho lưu trữ cũng được tìm nạp lại khi máy chủ Bazel khởi động lại hoặc khi bất kỳ tệp nào ảnh hưởng đến việc khai báo kho lưu trữ thay đổi (ví dụ: tệp WORKSPACE hoặc tệp tải), bất kể các thay đổi đó có dẫn đến thay đổi đối với nội dung khai báo kho lưu trữ hoặc mã của kho lưu trữ hay không.

  Kho lưu trữ không phải cục bộ sẽ không được tìm nạp lại trong các trường hợp này. Điều này là do các kho lưu trữ này được giả định là sẽ giao tiếp với mạng hoặc gây tốn kém.

Khởi động lại hàm triển khai

Bạn có thể khởi động lại hàm triển khai trong khi kho lưu trữ đang được tìm nạp nếu một phần phụ thuộc mà kho lưu trữ yêu cầu bị thiếu. Trong trường hợp đó, quá trình thực thi hàm triển khai sẽ dừng lại, phần phụ thuộc bị thiếu sẽ được giải quyết và hàm sẽ được thực thi lại sau khi phần phụ thuộc đã được giải quyết. Để tránh việc khởi động lại không cần thiết (tốn kém, vì quyền truy cập mạng có thể phải lặp lại), đối số nhãn sẽ được tìm nạp trước, miễn là tất cả đối số nhãn đều có thể được phân giải thành 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 một nhãn chỉ được tạo trong quá trình thực thi hàm vẫn có thể gây ra việc khởi động lại.

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

Ví dụ

• Chuỗi công cụ định cấu hình tự động C++: 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 quy tắc Go.

• rules_jvm_external sẽ 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 tạo 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.