Bazel menampilkan sub-perintah coverage
untuk menghasilkan laporan cakupan
kode pada repositori yang dapat diuji dengan bazel coverage
. Karena
idiosinkronisasi berbagai ekosistem bahasa, membuat
aplikasi ini berfungsi untuk project tertentu tidak selalu sepele.
Halaman ini mendokumentasikan proses umum untuk membuat dan melihat laporan cakupan, serta menampilkan beberapa catatan khusus bahasa untuk bahasa yang konfigurasinya sudah dikenal. Sebaiknya baca dengan membaca bagian umum terlebih dahulu, lalu membaca persyaratan untuk bahasa tertentu. Perhatikan juga bagian eksekusi jarak jauh, yang memerlukan beberapa pertimbangan tambahan.
Meskipun banyak penyesuaian dapat dilakukan, dokumen ini berfokus pada
pembuatan dan penggunaan laporan lcov
, yang saat ini
merupakan rute yang paling didukung dengan baik.
Membuat laporan cakupan
Persiapan
Alur kerja dasar untuk membuat laporan cakupan memerlukan hal berikut:
- Repositori dasar dengan target pengujian
- Toolchain dengan alat cakupan kode khusus bahasa terinstal
- Konfigurasi "instrumentasi" yang benar
Dua yang pertama bersifat spesifik per bahasa dan sebagian besar mudah, tetapi yang kedua mungkin lebih sulit untuk project yang kompleks.
"Instrumentasi" dalam hal ini mengacu pada alat cakupan yang digunakan untuk target tertentu. Bazel memungkinkan pengaktifan ini untuk
subset file tertentu menggunakan tanda
--instrumentation_filter
, yang menentukan filter untuk target yang diuji dengan
instrumentasi yang diaktifkan. Untuk mengaktifkan instrumentasi pengujian, flag --instrument_test_targets
diperlukan.
Secara default, bazel mencoba mencocokkan paket target, dan mencetak
filter yang relevan sebagai pesan INFO
.
Cakupan lari
Untuk membuat laporan cakupan, gunakan bazel coverage
--combined_report=lcov
[target]
. Tindakan ini akan menjalankan
pengujian untuk target, yang menghasilkan laporan cakupan dalam format lcov
untuk setiap file.
Setelah selesai, bazel menjalankan tindakan yang mengumpulkan semua file
cakupan yang dihasilkan, dan menggabungkannya menjadi satu, yang kemudian
dibuat dengan $(bazel info
output_path)/_coverage/_coverage_report.dat
.
Laporan cakupan juga dibuat jika pengujian gagal, tetapi perhatikan bahwa ini tidak mencakup pengujian yang gagal - hanya pengujian yang lulus yang dilaporkan.
Melihat liputan
Laporan cakupan hanya dihasilkan dalam format lcov
yang tidak dapat dibaca manusia. Dari sini, kita dapat menggunakan utilitas genhtml
(bagian dari project
lcov) untuk menghasilkan laporan yang dapat dilihat di browser
web:
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
Perhatikan bahwa genhtml
juga membaca kode sumber, untuk menganotasi cakupan yang tidak ada dalam file ini. Agar berfungsi, genhtml
diharapkan
dieksekusi di root project bazel.
Untuk melihat hasilnya, cukup buka file index.html
yang dihasilkan dalam direktori genhtml
di browser web mana pun.
Untuk bantuan dan informasi lebih lanjut seputar alat genhtml
, atau
format cakupan lcov
, lihat project lcov.
Eksekusi jarak jauh
Menjalankan dengan eksekusi uji jarak jauh saat ini memiliki beberapa peringatan:
- Tindakan kombinasi laporan belum dapat dijalankan dari jarak jauh. Hal ini
karena Bazel tidak menganggap file output cakupan sebagai bagian dari
grafiknya (lihat masalah ini), dan karena itu
tidak dapat memperlakukannya dengan benar sebagai input untuk tindakan kombinasi. Untuk
mengatasi hal ini, gunakan
--strategy=CoverageReport=local
.- Catatan: Anda mungkin perlu menentukan sesuatu seperti
--strategy=CoverageReport=local,remote
, jika Bazel disiapkan untuk mencobalocal,remote
, karena cara Bazel menyelesaikan strategi.
- Catatan: Anda mungkin perlu menentukan sesuatu seperti
--remote_download_minimal
dan flag serupa juga tidak dapat digunakan sebagai konsekuensi dari flag tersebut.- Bazel saat ini akan gagal membuat informasi cakupan jika pengujian
telah di-cache sebelumnya. Untuk mengatasi hal ini,
--nocache_test_results
dapat ditetapkan secara khusus untuk operasi cakupan, meskipun tentu saja menimbulkan biaya yang besar dalam hal waktu pengujian. --experimental_split_coverage_postprocessing
dan--experimental_fetch_all_coverage_outputs
- Biasanya cakupan dijalankan sebagai bagian dari tindakan pengujian sehingga secara default, kita tidak mendapatkan semua cakupan kembali sebagai output dari eksekusi jarak jauh secara default. Flag ini menggantikan default dan mendapatkan data cakupan. Lihat masalah ini untuk mengetahui detail selengkapnya.
Konfigurasi khusus bahasa
Java
Java harus berfungsi secara langsung dengan konfigurasi default. Toolchain bazel juga berisi semua yang diperlukan untuk eksekusi jarak jauh, termasuk JUnit.
Python
Lihat dokumen cakupan rules_python
untuk mengetahui langkah tambahan yang diperlukan guna mengaktifkan dukungan cakupan di Python.