menghasilkan laporan cakupan kode GCC
situs web dan dokumentasi • pelacak bug • GitHub
Gcovr menyediakan utilitas untuk mengelola penggunaan utilitas GNU gcov dan menghasilkan ringkasan hasil cakupan kode. Perintah ini terinspirasi oleh paket Python coverage.py, yang menyediakan utilitas serupa untuk Python.
Perintah gcovr
dapat menghasilkan berbagai jenis laporan cakupan:
Opsi CLI | Panduan Pengguna | Keterangan |
---|---|---|
bawaan, --txt | Keluaran Teks | ringkasan ringkas yang dapat dibaca manusia |
--html | Keluaran HTML | ikhtisar semua file |
--html-details | Keluaran HTML | file sumber beranotasi |
--html-template-dir | Keluaran HTML | gunakan kumpulan templat Jinja2 khusus |
--csv | Keluaran CSV | Laporan CSV merangkum cakupan setiap file |
--json | Keluaran JSON | Laporan JSON dengan struktur dan cakupan file sumber |
--json-summary | Keluaran JSON | Laporan cakupan ringkasan JSON |
--clover | Keluaran XML Semanggi | laporan XML yang dapat dibaca mesin dalam format Clover |
--cobertura | Keluaran XML Cobertura | laporan XML yang dapat dibaca mesin dalam format Cobertura |
--coveralls | Baju Keluaran JSON | laporan JSON yang dapat dibaca mesin dalam format Baju |
--jacoco | Keluaran XML JaCoCo | laporan XML yang dapat dibaca mesin dalam format JaCoCo |
--lcov | Keluaran informasi LCOV | laporan yang dapat dibaca mesin dalam format info LCOV |
--sonarqube | Keluaran XML SonarQube | laporan XML yang dapat dibaca mesin dalam format SonarQube |
Oleh karena itu, gcovr dapat dilihat sebagai alternatif baris perintah untuk utilitas lcov, yang menjalankan gcov dan menghasilkan laporan berformat HTML. Perkembangan gcovr dilatarbelakangi oleh kebutuhan akan ringkasan teks dan laporan XML.
Contoh ringkasan HTML:
Contoh detail HTML:
Gcovr tersedia sebagai paket Python yang dapat diinstal melalui pip.
Instal rilis gcovr
stabil terbaru dari PyPI:
pip install gcovr
Instal versi pengembangan dari GitHub (membutuhkan setidaknya pip versi 21.3):
pip install git+https://github.com/gcovr/gcovr.git
GCC dapat menginstrumentasikan executable untuk memancarkan data cakupan. Anda perlu mengkompilasi ulang kode Anda dengan tanda berikut:
--cakupan -g -O0
Selanjutnya, jalankan rangkaian pengujian Anda. Ini akan menghasilkan file cakupan mentah.
Terakhir, aktifkan gcovr. Ini akan mencetak laporan tabel di konsol.
gcovr
Anda juga dapat membuat laporan HTML terperinci atau bertingkat:
gcovr --html-detail cakupan.html gcovr --html-cakupan bersarang.html
Gcovr akan membuat satu laporan HTML per file sumber dan untuk --html-nested
juga per direktori di sebelah ringkasan coverage.html.
Anda harus menjalankan gcovr dari direktori build. Opsi -r
harus menunjuk ke akar proyek Anda. Ini hanya penting jika Anda memiliki direktori build terpisah. Misalnya:
pembuatan cd; gcovr -r ..
Untuk dokumentasi lengkap, baca manualnya.
Jika Anda ingin melaporkan bug atau berkontribusi pada pengembangan gcovr, harap baca pedoman kontribusi kami terlebih dahulu: https://gcovr.com/en/latest/contributing.html
Perangkat lunak ini didistribusikan di bawah Lisensi BSD 3-klausul. Lihat https://gcovr.com/en/latest/license.html#license-terms untuk detailnya. Lihat https://gcovr.com/en/latest/license.html#acknowledgements untuk daftar lengkap kontributor.