gcovr

gcovr

สร้างรายงานการครอบคลุมรหัส GCC

เว็บไซต์และเอกสารประกอบ • bugtracker • GitHub

Gcovr จัดเตรียมยูทิลิตี้สำหรับจัดการการใช้งานยูทิลิตี้ GNU gcov และสร้างผลลัพธ์การครอบคลุมโค้ดโดยสรุป คำสั่งนี้ได้รับแรงบันดาลใจจากแพ็คเกจ Python Covers.py ซึ่งมียูทิลิตี้ที่คล้ายกันสำหรับ Python

คำสั่ง gcovr สามารถสร้างรายงานความครอบคลุมประเภทต่างๆ ได้:

ตัวเลือก CLI	คู่มือการใช้งาน	คำอธิบาย
ค่าเริ่มต้น --txt	เอาท์พุทข้อความ	ข้อมูลสรุปขนาดกะทัดรัดที่มนุษย์สามารถอ่านได้
--html	เอาท์พุต HTML	ภาพรวมของไฟล์ทั้งหมด
--html-details	เอาท์พุต HTML	ไฟล์ต้นฉบับที่มีคำอธิบายประกอบ
--html-template-dir	เอาท์พุต HTML	ใช้ชุดเทมเพลต Jinja2 ที่กำหนดเอง
--csv	เอาต์พุต CSV	รายงาน CSV สรุปความครอบคลุมของแต่ละไฟล์
--json	เอาต์พุต JSON	รายงาน JSON พร้อมโครงสร้างไฟล์ต้นฉบับและความครอบคลุม
--json-summary	เอาต์พุต JSON	รายงานความครอบคลุมสรุป JSON
--clover	เอาท์พุต XML ของโคลเวอร์	รายงาน XML ที่เครื่องอ่านได้ในรูปแบบ Clover
--cobertura	เอาต์พุต XML ของ Cobertura	รายงาน XML ที่เครื่องอ่านได้ในรูปแบบ Cobertura
--coveralls	ครอบคลุมเอาต์พุต JSON	รายงาน JSON ที่เครื่องอ่านได้ในรูปแบบ Coveralls
--jacoco	เอาต์พุต XML ของ JaCoCo	รายงาน XML ที่เครื่องอ่านได้ในรูปแบบ JaCoCo
--lcov	ข้อมูล LCOV เอาต์พุต	รายงานที่เครื่องอ่านได้ในรูปแบบข้อมูล LCOV
--sonarqube	เอาต์พุต XML ของ SonarQube	รายงาน XML ที่เครื่องอ่านได้ในรูปแบบ SonarQube

ดังนั้น gcovr จึงสามารถดูเป็นทางเลือกบรรทัดคำสั่งแทนยูทิลิตี lcov ซึ่งรัน gcov และสร้างรายงานในรูปแบบ HTML การพัฒนา gcovr ได้รับแรงบันดาลใจจากความต้องการข้อความสรุปและรายงาน XML

ตัวอย่างสรุป HTML:

ตัวอย่างรายละเอียด HTML:

การติดตั้ง

Gcovr มีให้บริการในรูปแบบแพ็คเกจ Python ที่สามารถติดตั้งผ่าน pip

ติดตั้ง gcovr ที่เสถียรใหม่ล่าสุดจาก PyPI:

pip install gcovr

ติดตั้งเวอร์ชันการพัฒนาจาก GitHub (ต้องการ pip เวอร์ชันอย่างน้อย 21.3):

pip install git+https://github.com/gcovr/gcovr.git

เริ่มต้นอย่างรวดเร็ว

GCC สามารถกำหนดเครื่องมือปฏิบัติการเพื่อปล่อยข้อมูลความครอบคลุมได้ คุณต้องคอมไพล์โค้ดของคุณใหม่ด้วยแฟล็กต่อไปนี้:

 --ความคุ้มครอง-g-O0

ถัดไป เรียกใช้ชุดทดสอบของคุณ สิ่งนี้จะสร้างไฟล์ความครอบคลุมแบบดิบ

สุดท้ายให้เรียกใช้ gcovr สิ่งนี้จะพิมพ์รายงานแบบตารางบนคอนโซล

 gcovr

คุณยังสามารถสร้างรายงาน HTML แบบละเอียดหรือแบบซ้อนได้:

 gcovr --html-รายละเอียดครอบคลุม.html
gcovr --html-ครอบคลุมครอบคลุม.html

Gcovr จะสร้างรายงาน HTML หนึ่งรายงานต่อไฟล์ต้นฉบับและสำหรับ --html-nested ต่อไดเรกทอรีถัดจากสรุป Coverage.html

คุณควรรัน gcovr จากไดเร็กทอรี build ตัวเลือก -r ควรชี้ไปที่รากของโครงการของคุณ สิ่งนี้สำคัญหากคุณมีไดเร็กทอรี build แยกต่างหาก ตัวอย่างเช่น:

 สร้างซีดี; gcovr -r ..

หากต้องการเอกสารฉบับสมบูรณ์ โปรดอ่านคู่มือ

มีส่วนร่วม

หากคุณต้องการรายงานข้อบกพร่องหรือมีส่วนร่วมในการพัฒนา gcovr โปรดอ่านหลักเกณฑ์การสนับสนุนของเราก่อน: https://gcovr.com/en/latest/contributing.html

ใบอนุญาต

ซอฟต์แวร์นี้เผยแพร่ภายใต้ใบอนุญาต BSD 3 ข้อ ดู https://gcovr.com/en/latest/license.html#license-terms เพื่อดูรายละเอียด ดู https://gcovr.com/en/latest/license.html#acknowledgements สำหรับรายชื่อผู้ร่วมให้ข้อมูลทั้งหมด