Mức độ sử dụng mã với Bazel

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

Bazel có một lệnh con coverage để tạo báo cáo mức độ sử dụng mã trên những kho lưu trữ có thể kiểm thử bằng bazel coverage. Do những đặc điểm đặc trưng của các hệ sinh thái ngôn ngữ khác nhau, nên việc thực hiện điều này cho một dự án nhất định không phải lúc nào cũng đơn giản.

Trang này cung cấp tài liệu về quy trình chung để tạo và xem báo cáo về độ bao phủ, đồng thời cung cấp một số ghi chú theo ngôn ngữ cụ thể cho những ngôn ngữ có cấu hình phổ biến. Tốt nhất là bạn nên đọc trước phần chung rồi đọc về các yêu cầu đối với một ngôn ngữ cụ thể. Ngoài ra, hãy lưu ý rằng phần thực thi từ xa yêu cầu một số điểm cần cân nhắc khác.

Mặc dù có thể tuỳ chỉnh rất 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 (hiện là tuyến được hỗ trợ nhiều nhất).

Tạo báo cáo 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 nội dung 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ụ mức độ sử dụng mã theo ngôn ngữ cụ thể
  • Một cấu hình "đo lường" chính xác

2 phần tử trước là theo ngôn ngữ cụ thể và gần như đơn giản, tuy nhiên, phần sau có thể khó hơn đối với các dự án phức tạp.

"Đo lường" trong trường hợp này là các công cụ về mức độ sử dụ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ỏ các 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 khả năng đo lường cho kiểm thử, bạn cần phải có cờ --instrument_test_targets.

Theo mặc định, bazel sẽ tìm cách so khớp(các) gói mục tiêu và xuất bộ lọc liên quan dưới dạng thông báo INFO.

Mức độ phù hợp đang chạy

Để tạo báo cáo về mức độ phù hợp, hãy sử dụng bazel coverage --combined_report=lcov [target]. Thao tác này sẽ chạy các lượt kiểm thử cho mục tiêu, tạo báo cáo về mức độ sử dụng ở định dạng lcov cho từng tệp.

Sau khi hoàn tất, bazel chạy một thao tác thu thập tất cả các tệp mức độ che phủ đã tạo và hợp nhất các tệp đó thành một. Sau đó, tệp này cuối cùng sẽ được tạo trong $(bazel info output_path)/_coverage/_coverage_report.dat.

Báo cáo về mức độ sử dụng cũng được tạo nếu kiểm thử không thành công, mặc dù lưu ý rằng tình trạng này không bao gồm các lượt kiểm thử không thành công mà chỉ báo cáo các lượt kiểm thử đạt.

Phạm vi xem

Báo cáo mức độ sử dụng chỉ là kết quả ở định dạng lcov mà con người không thể đọc được. Từ đó, chúng ta có thể sử dụng tiện ích genhtml (một phần của dự án lcov) để tạo báo cáo có thể xem trên trình duyệt web:

genhtml --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"

Xin lưu ý rằng genhtml cũng sẽ đọc mã nguồn để chú thích mức độ phù hợp bị thiếu trong các tệp này. Để điều này hoạt động, dự kiến genhtml sẽ được thực thi trong thư mục 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 trên trình duyệt web bất kỳ.

Để được trợ giúp thêm và xem thêm thông tin về công cụ genhtml hoặc định dạng mức độ sử dụng lcov, hãy xem bài viết dự án lcov.

Thực thi từ xa

Hiện tại, quá trình chạy bằng quy trình thực thi kiểm thử từ xa có một số lưu ý sau:

  • Hành động kết hợp báo cáo chưa thể chạy từ xa. Điều này là do Bazel không xem các tệp đầu ra về mức độ sử dụng là một phần của biểu đồ (xem vấn đề này) và do đó không thể coi các tệp đó là dữ liệu đầu vào cho hành động kết hợp một cách chính xác. Để giải quyết vấn đề này, hãy sử dụng --strategy=CoverageReport=local.
    • Lưu ý: Do cách Bazel giải quyết các chiến lược, bạn có thể cần phải chỉ định những nội dung như --strategy=CoverageReport=local,remote nếu Bazel được thiết lập để dùng thử local,remote.
  • Bạn cũng không thể sử dụng --remote_download_minimal và các cờ tương tự do trạng thái cũ.
  • Hiện tại, Bazel sẽ không tạo được thông tin về mức độ sử dụng nếu các hoạt động 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ể thiết lập riêng --nocache_test_results cho các lần chạy mức độ sử dụng, mặc dù tất nhiên phương thức này sẽ làm phát sinh chi phí cao về thời gian kiểm thử.
  • --experimental_split_coverage_postprocessing và --experimental_fetch_all_coverage_outputs
    • Thông thường, mức độ sử dụng được chạy như một phần của hành động kiểm thử. Vì vậy, theo mặc định, chúng ta không lấy lại toàn bộ mức độ sử dụng dưới dạng kết quả của quá trình thực thi từ xa. Những cờ này ghi đè giá trị mặc định và lấy dữ liệu về mức độ sử dụng. 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 phải hoạt động ngay từ đầu 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, bao gồm cả JUnit.

Python

Hãy xem tài liệu về mức độ phù hợp rules_python để biết thêm các bước cần thiết nhằm bật tính năng hỗ trợ mức độ sử dụng trong Python.