Bazel có một lệnh con coverage để tạo báo cáo về mức độ phù hợp của mã trên những kho lưu trữ có thể được kiểm thử bằng bazel coverage. Do đặc thù của nhiều hệ sinh thái ngôn ngữ, nên không phải lúc nào cũng dễ dàng để thực hiện việc này cho một dự án nhất định.
Trang này ghi lại quy trình chung để tạo và xem báo cáo về mức độ phù hợp, đồng thời cũng có một số ghi chú dành riêng cho ngôn ngữ đối với những ngôn ngữ có cấu hình đã biết. Bạn nên đọc phần chung trước, sau đó đọc về các yêu cầu đối với một ngôn ngữ cụ thể. Cũng lưu ý đến phần thực thi từ xa, phần này yêu cầu một số điểm cần cân nhắc bổ sung.
Mặc dù có thể tuỳ chỉnh nhiều, nhưng tài liệu này tập trung vào việc tạo và sử dụng báo cáo lcov. Đây hiện là cách được hỗ trợ tốt nhất.
Tạo báo cáo về mức độ phù hợp
Chuẩn bị
Quy trình làm việc cơ bản để tạo báo cáo về mức độ phù hợp yêu cầu những điều sau:
- Kho lưu trữ cơ bản có các mục tiêu kiểm thử
- Một chuỗi công cụ đã cài đặt các công cụ đo lường mức độ bao phủ mã theo ngôn ngữ cụ thể
- Cấu hình "đo lường" chính xác
Hai loại trước đây là dành riêng cho ngôn ngữ và hầu hết đều đơn giản, tuy nhiên, loại sau có thể khó hơn đối với các dự án phức tạp.
Trong trường hợp này, "đo lường" đề cập đến các công cụ đo lường được dùng cho một mục tiêu cụ thể. Bazel cho phép bật tính năng này cho một nhóm nhỏ tệp cụ thể bằng cách sử dụng cờ --instrumentation_filter. Cờ này chỉ định một bộ lọc cho các mục tiêu được kiểm thử khi bật tính năng đo lường. Để bật tính năng đo lường cho các kiểm thử, bạn cần có cờ --instrument_test_targets.
Theo mặc định, bazel sẽ cố gắng so khớp(các) gói mục tiêu và in bộ lọc có liên quan dưới dạng thông báo INFO.
Phạm vi bao phủ khi chạy
Để tạo báo cáo phạm vi lập chỉ mục, hãy sử dụng bazel coverage
--combined_report=lcov
[target]. Thao tác này sẽ chạy các kiểm thử cho mục tiêu, tạo báo cáo về mức độ phù hợp ở định dạng lcov cho từng tệp.
Sau khi hoàn tất, bazel sẽ chạy một thao tác thu thập tất cả các tệp mức độ phù hợp đã tạo và hợp nhất các tệp đó thành một tệp. Sau đó, tệp này sẽ được tạo trong $(bazel info
output_path)/_coverage/_coverage_report.dat.
Báo cáo mức độ phù hợp cũng được tạo nếu các kiểm thử không đạt, mặc dù lưu ý rằng điều này không mở rộng sang các kiểm thử không đạt – chỉ các kiểm thử đạt mới được báo cáo.
Xem tin tức
Báo cáo mức độ phù hợp chỉ được xuất ở định dạng lcov không đọc được. Từ đó, chúng ta có thể sử dụng tiện ích genhtml (thuộc dự án lcov) để tạo một báo cáo có thể xem được trong trình duyệt web:
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
Xin lưu ý rằng genhtml cũng đọc mã nguồn để chú thích phạm vi còn thiếu trong các tệp này. Để điều này hoạt động, bạn cần thực thi genhtml ở gốc của dự án bazel.
Để xem kết quả, bạn chỉ cần mở tệp index.html được tạo trong thư mục genhtml bằng bất kỳ trình duyệt web nào.
Để được trợ giúp và biết thêm thông tin về công cụ genhtml hoặc định dạng phạm vi lcov, hãy xem dự án lcov.
Thực thi từ xa
Việc chạy với tính năng thực thi kiểm thử từ xa hiện có một số điểm hạn chế:
- Hành động kết hợp báo cáo hiện chưa thể chạy từ xa. Điều này là do Bazel không coi các tệp đầu ra về mức độ phù hợp là một phần của biểu đồ (xem vấn đề này), do đó, không thể xử lý chính xác các tệp này dưới dạng dữ liệu đầu vào cho thao tác kết hợp. Để giải quyết vấn đề này, hãy sử dụng
--strategy=CoverageReport=local.- Lưu ý: Bạn có thể cần chỉ định một nội dung nào đó như
--strategy=CoverageReport=local,remotethay vào đó, nếu Bazel được thiết lập để thửlocal,remote, do cách Bazel giải quyết các chiến lược.
- Lưu ý: Bạn có thể cần chỉ định một nội dung nào đó như
--remote_download_minimalvà các cờ tương tự cũng không thể được dùng do hậu quả của cờ trước.- Bazel hiện sẽ không tạo được thông tin về mức độ phù hợp nếu các kiểm thử đã được lưu vào bộ nhớ đệm trước đó. Để giải quyết vấn đề này, bạn có thể đặt
--nocache_test_resultsmột cách cụ thể cho các lần chạy phạm vi, mặc dù điều này tất nhiên sẽ tốn nhiều thời gian kiểm thử. --experimental_split_coverage_postprocessingvà--experimental_fetch_all_coverage_outputs- Thông thường, mức độ phù hợp được chạy như một phần của thao tác kiểm thử, do đó, theo mặc định, chúng ta không nhận được tất cả mức độ phù hợp dưới dạng đầu ra của quá trình thực thi từ xa theo mặc định. Các cờ này sẽ ghi đè giá trị mặc định và lấy dữ liệu về mức độ phù hợp. Hãy xem vấn đề này để biết thêm thông tin chi tiết.
Cấu hình theo ngôn ngữ cụ thể
Java
Java sẽ hoạt động ngay khi xuất xưởng với cấu hình mặc định. Chuỗi công cụ bazel chứa mọi thứ cần thiết cho quá trình thực thi từ xa, cũng như JUnit.
Python
Hãy xem rules_pythontài liệu về phạm vi để biết các bước bổ sung cần thiết để bật tính năng hỗ trợ phạm vi trong Python.