Bazel มีคำสั่งย่อย coverage เพื่อสร้างรายงานการครอบคลุมของโค้ด
ในที่เก็บที่ทดสอบได้ด้วย bazel coverage เนื่องจากลักษณะเฉพาะของระบบนิเวศของภาษาต่างๆ การทำให้ฟีเจอร์นี้ใช้งานได้กับโปรเจ็กต์หนึ่งๆ จึงไม่ใช่เรื่องง่ายเสมอไป
หน้านี้จะอธิบายกระบวนการทั่วไปในการสร้างและดูรายงานการครอบคลุม รวมถึงมีหมายเหตุเฉพาะภาษาสำหรับภาษาที่มีการกำหนดค่าที่ทราบกันดี คุณควรอ่านส่วนทั่วไปก่อน แล้วจึงอ่านเกี่ยวกับข้อกำหนดของภาษาที่ต้องการ
แม้ว่าคุณจะปรับแต่งได้หลายอย่าง แต่เอกสารนี้จะเน้นที่การสร้างและใช้
lcovรายงาน ซึ่งเป็นวิธีที่ได้รับการสนับสนุนมากที่สุดในปัจจุบัน
การสร้างรายงานการครอบคลุม
การเตรียมพร้อม
เวิร์กโฟลว์พื้นฐานสำหรับการสร้างรายงานการครอบคลุมต้องมีสิ่งต่อไปนี้
- ที่เก็บข้อมูลพื้นฐานที่มีเป้าหมายการทดสอบ
- ชุดเครื่องมือที่มีเครื่องมือการครอบคลุมโค้ดเฉพาะภาษาติดตั้งอยู่
- การกำหนดค่า "การวัดประสิทธิภาพ" ที่ถูกต้อง
2 ข้อแรกเป็นแบบเฉพาะภาษาและค่อนข้างตรงไปตรงมา แต่ข้อสุดท้ายอาจยากกว่าสำหรับโปรเจ็กต์ที่ซับซ้อน
"การวัดประสิทธิภาพ" ในที่นี้หมายถึงเครื่องมือการครอบคลุมที่ใช้กับเป้าหมายหนึ่งๆ Bazel อนุญาตให้เปิดใช้ฟีเจอร์นี้กับไฟล์ชุดย่อยที่เฉพาะเจาะจงโดยใช้แฟล็ก
--instrumentation_filter
ซึ่งระบุตัวกรองสำหรับเป้าหมายที่ทดสอบโดยเปิดใช้การวัดประสิทธิภาพ หากต้องการเปิดใช้การวัดประสิทธิภาพสำหรับการทดสอบ คุณต้องใช้
--instrument_test_targets
แฟล็ก
โดยค่าเริ่มต้น Bazel จะพยายามจับคู่แพ็กเกจเป้าหมายและพิมพ์ตัวกรองที่เกี่ยวข้องเป็นข้อความ INFO
การครอบคลุมการทำงาน
หากต้องการสร้างรายงานการครอบคลุม ให้ใช้ bazel coverage
--combined_report=lcov
[target] คำสั่งนี้จะเรียกใช้การทดสอบสำหรับเป้าหมาย โดยสร้างรายงานการครอบคลุมในรูปแบบ lcov สำหรับแต่ละไฟล์
เมื่อเสร็จแล้ว Bazel จะเรียกใช้การดำเนินการที่รวบรวมไฟล์การครอบคลุมทั้งหมดที่สร้างขึ้น
และผสานไฟล์เหล่านั้นเป็นไฟล์เดียว ซึ่งจะสร้างขึ้นในที่สุด
ภายใต้ $(bazel info
output_path)/_coverage/_coverage_report.dat
ระบบจะสร้างรายงานการครอบคลุมแม้ว่าการทดสอบจะล้มเหลวก็ตาม แต่โปรดทราบว่ารายงานนี้จะไม่รวมการทดสอบที่ล้มเหลว โดยจะรายงานเฉพาะการทดสอบที่ผ่านเท่านั้น
การดูการครอบคลุม
ระบบจะแสดงผลรายงานการครอบคลุมในรูปแบบ lcov ที่ไม่ใช่รูปแบบที่มนุษย์อ่านได้เท่านั้น จากรายงานนี้ เราสามารถใช้ยูทิลิตี genhtml (ซึ่งเป็นส่วนหนึ่งของ โปรเจ็กต์ lcov) เพื่อสร้างรายงานที่ดูได้ในเว็บเบราว์เซอร์
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
โปรดทราบว่า genhtml จะอ่านซอร์สโค้ดด้วยเพื่อใส่คำอธิบายประกอบการครอบคลุมที่ขาดหายไปในไฟล์เหล่านี้ เพื่อให้ฟีเจอร์นี้ทำงานได้ คุณต้องเรียกใช้ genhtml ในรูทของโปรเจ็กต์ Bazel
หากต้องการดูผลลัพธ์ ให้เปิดไฟล์ index.html ที่สร้างขึ้นในไดเรกทอรี genhtml ในเว็บเบราว์เซอร์ใดก็ได้
หากต้องการความช่วยเหลือและข้อมูลเพิ่มเติมเกี่ยวกับเครื่องมือ genhtml หรือรูปแบบการครอบคลุม
lcov โปรดดู โปรเจ็กต์ lcov
การกำหนดค่าเฉพาะภาษา
ส่วนต่อไปนี้จะแสดงรายละเอียดข้อควรพิจารณาเฉพาะภาษาสำหรับการตั้งค่าการครอบคลุมของโค้ดด้วย Bazel
C++
Linux
การครอบคลุม C++ ควรทำงานได้ทันทีด้วยการกำหนดค่าเริ่มต้น
macOS
ค่าเริ่มต้นของ GCOV_PREFIX_STRIP เกือบจะแน่นอนว่าไม่ถูกต้องและต้องปรับด้วยตนเอง เนื่องจากค่าที่ถูกต้องจะขึ้นอยู่กับการตั้งค่าของคุณ
เมื่อค่าไม่ถูกต้อง ระบบจะไม่พบข้อมูลการครอบคลุม
ตัวอย่างการตั้งค่า GCOV_PREFIX_STRIP=10
bazel coverage //foo:foo_test --test_env=GCOV_PREFIX_STRIP=10`
Java
Java ควรทำงานได้ทันทีด้วยการกำหนดค่าเริ่มต้น ชุดเครื่องมือ Bazel มีทุกสิ่งที่จำเป็นสำหรับการดำเนินการ ระยะไกล รวมถึง JUnit
Python
ดูเอกสารการครอบคลุม rules_python
สำหรับขั้นตอนเพิ่มเติมที่จำเป็นในการเปิดใช้การรองรับการครอบคลุมใน Python