การครอบคลุมของโค้ดด้วย Bazel

Bazel มีคำสั่งย่อย coverage เพื่อสร้างรายงานการครอบคลุมของโค้ดในที่เก็บซึ่งทดสอบด้วย bazel coverage ได้ เนื่องจากการทํางานของระบบนิเวศภาษาต่างๆ มีความเฉพาะตัว จึงไม่ใช่เรื่องง่ายเสมอไปที่จะทําให้วิธีนี้ได้ผลสําหรับโปรเจ็กต์หนึ่งๆ

หน้านี้บันทึกขั้นตอนทั่วไปในการสร้างและดูรายงานการครอบคลุม นอกจากนี้ยังมีหมายเหตุเฉพาะภาษาสำหรับภาษาที่มีการกำหนดค่าซึ่งเป็นที่รู้จักกันดี วิธีที่ดีที่สุดคือการอ่านส่วนทั่วไปก่อน แล้วจึงอ่านเกี่ยวกับข้อกำหนดสำหรับภาษาใดภาษาหนึ่ง โปรดดูส่วนการดำเนินการระยะไกลด้วย ซึ่งต้องมีข้อควรพิจารณาเพิ่มเติม

แม้ว่าคุณจะปรับแต่งได้หลายอย่าง แต่เอกสารนี้จะมุ่งเน้นที่การสร้างและการใช้รายงาน lcov ซึ่งเป็นเส้นทางที่รองรับมากที่สุดในปัจจุบัน

การสร้างรายงานความครอบคลุม

การเตรียมพร้อม

เวิร์กโฟลว์พื้นฐานในการสร้างรายงานความครอบคลุมต้องใช้ข้อมูลต่อไปนี้

• ที่เก็บข้อมูลพื้นฐานที่มีเป้าหมายการทดสอบ
• เครื่องมือทางเทคนิคที่ติดตั้งเครื่องมือการครอบคลุมโค้ดเฉพาะภาษา
• การกำหนดค่า "การใช้เครื่องมือ" ที่ถูกต้อง

2 ตัวเลือกแรกเจาะจงภาษาและตรงไปตรงมาที่สุด อย่างไรก็ตาม แบบหลังอาจทำได้ยากสำหรับโครงการที่ซับซ้อน

"เครื่องมือวัด" ในกรณีนี้หมายถึงเครื่องมือการครอบคลุมที่ใช้กับเป้าหมายที่เฉพาะเจาะจง Bazel อนุญาตให้เปิดใช้ตัวเลือกนี้สำหรับไฟล์ชุดย่อยที่เฉพาะเจาะจงโดยใช้ Flag --instrumentation_filter ซึ่งระบุตัวกรองสำหรับเป้าหมายที่ทดสอบโดยเปิดใช้เครื่องมือวัด หากต้องการเปิดใช้เครื่องมือวัดผลสําหรับการทดสอบ คุณต้องใช้ Flag --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 ไม่ถือว่าไฟล์เอาต์พุตการครอบคลุมเป็นส่วนหนึ่งของกราฟ (ดูปัญหานี้) จึงไม่สามารถถือว่าไฟล์เหล่านี้เป็นอินพุตสําหรับการดำเนินการรวมได้อย่างถูกต้อง หากต้องการแก้ปัญหานี้ ให้ใช้ --strategy=CoverageReport=local
  • หมายเหตุ: คุณอาจต้องระบุค่าอย่างเช่น --strategy=CoverageReport=local,remote แทนหากตั้งค่า Bazel ให้ลองใช้ local,remote เนื่องจากวิธีที่ Bazel แก้ปัญหา
• --remote_download_minimal และธงที่คล้ายกันก็ใช้ไม่ได้เช่นกันเนื่องจากข้อจำกัดดังกล่าว
• ปัจจุบัน Bazel จะสร้างข้อมูลการครอบคลุมไม่สำเร็จหากมีการแคชการทดสอบไว้ก่อนหน้านี้ เพื่อหลีกเลี่ยงปัญหานี้ คุณตั้งค่า --nocache_test_results สำหรับการเรียกใช้การครอบคลุมโดยเฉพาะได้ แม้ว่าการดำเนินการนี้จะมีค่าใช้จ่ายสูงในแง่ของเวลาการทดสอบ
• --experimental_split_coverage_postprocessing และ --experimental_fetch_all_coverage_outputs
  • โดยปกติแล้ว การครอบคลุมจะทำงานเป็นส่วนหนึ่งของการดำเนินการทดสอบ ดังนั้นโดยค่าเริ่มต้น เราจะไม่ได้รับการครอบคลุมทั้งหมดเป็นเอาต์พุตของการดำเนินการจากระยะไกล Flag เหล่านี้จะลบล้างค่าเริ่มต้นและรับข้อมูลความครอบคลุม ดูรายละเอียดเพิ่มเติมจากปัญหานี้

การกำหนดค่าเฉพาะภาษา

Java

Java ควรทํางานได้ทันทีโดยใช้การกําหนดค่าเริ่มต้น ชุดเครื่องมือ Bazel มีทุกอย่างที่จำเป็นสำหรับการเรียกใช้จากระยะไกล รวมถึง JUnit ด้วย

Python

ดูขั้นตอนเพิ่มเติมที่จำเป็นในการเปิดใช้การรองรับการครอบคลุมใน Python ได้ที่rules_pythonเอกสารการครอบคลุม