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

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

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

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

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

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

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

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

2 ตัวแรกเป็นภาษาเฉพาะและตรงไปตรงมาเป็นส่วนใหญ่ แต่ตัวหลังอาจยากกว่าสำหรับโปรเจ็กต์ที่ซับซ้อน

"การวัดประสิทธิภาพ" ในกรณีนี้หมายถึงเครื่องมือครอบคลุมที่ใช้สำหรับเป้าหมายที่เฉพาะเจาะจง Bazel อนุญาตให้เปิดใช้ตัวเลือกนี้สำหรับ ชุดย่อยของไฟล์ที่เฉพาะเจาะจงโดยใช้แฟล็ก --instrumentation_filter ซึ่งระบุตัวกรองสำหรับเป้าหมายที่ทดสอบโดยเปิดใช้ การตรวจสอบ ต้องใช้แฟล็ก --instrument_test_targets เพื่อเปิดใช้การวัดผลสำหรับการทดสอบ

โดยค่าเริ่มต้น Bazel จะพยายามจับคู่แพ็กเกจเป้าหมายและพิมพ์ตัวกรองที่เกี่ยวข้องเป็นข้อความ INFO

การรายงานข่าวที่กำลังดำเนินอยู่

หากต้องการสร้างรายงานความครอบคลุม ให้ใช้ bazel coverage --combined_report=lcov [target] ซึ่งจะเรียกใช้ การทดสอบสำหรับเป้าหมาย โดยสร้างรายงานความครอบคลุมในรูปแบบ lcov สำหรับแต่ละไฟล์

เมื่อเสร็จแล้ว Bazel จะเรียกใช้การดำเนินการที่รวบรวมไฟล์ Coverage ทั้งหมดที่สร้างขึ้น และผสานรวมเป็นไฟล์เดียว ซึ่งจะสร้างขึ้นใน $(bazel info output_path)/_coverage/_coverage_report.dat ในที่สุด

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

การดูความครอบคลุม

รายงานความครอบคลุมจะแสดงในรูปแบบที่มนุษย์อ่านไม่ได้เท่านั้น lcov จากนั้นเราจะใช้ยูทิลิตี genhtml (ส่วนหนึ่งของโปรเจ็กต์ lcov) เพื่อสร้างรายงานที่ดูได้ในเว็บเบราว์เซอร์

genhtml --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 สำหรับการเรียกใช้ Coverage โดยเฉพาะได้ แม้ว่าวิธีนี้จะมีค่าใช้จ่ายสูงในแง่ของเวลาทดสอบก็ตาม
• --experimental_split_coverage_postprocessing และ --experimental_fetch_all_coverage_outputs
  • โดยปกติแล้ว ความครอบคลุมจะทำงานเป็นส่วนหนึ่งของการดำเนินการทดสอบ ดังนั้นโดยค่าเริ่มต้น เราจึงไม่ได้รับความครอบคลุมทั้งหมดกลับมาเป็นเอาต์พุตของการดำเนินการระยะไกลโดยค่าเริ่มต้น โดยการแจ้งเตือนเหล่านี้จะลบล้างค่าเริ่มต้นและรับข้อมูลความครอบคลุม ดูรายละเอียดเพิ่มเติมได้ที่ปัญหานี้

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

Java

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

Python

ข้อกำหนดเบื้องต้น

การเรียกใช้ Coverage ด้วย Python มีข้อกำหนดเบื้องต้นบางอย่างดังนี้

• ไบนารี Bazel ที่มี b01c859 ซึ่งควรเป็น Bazel เวอร์ชันที่สูงกว่า 3.0
• เวอร์ชันที่แก้ไขแล้วของ coverage.py

การใช้ coverage.py ที่แก้ไขแล้ว

วิธีหนึ่งในการทำเช่นนี้คือผ่าน rules_python ซึ่งจะช่วยให้คุณใช้ไฟล์ requirements.txt ได้ จากนั้นข้อกำหนดที่ระบุไว้ในไฟล์จะได้รับการสร้างเป็นเป้าหมาย Bazel โดยใช้กฎที่เก็บ pip_install

requirements.txt ควรมีรายการต่อไปนี้

git+https://github.com/ulfjack/coveragepy.git@lcov-support

จากนั้นควรใช้ไฟล์ rules_python, pip_install และ requirements.txt ในไฟล์ WORKSPACE ดังนี้

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_python",
    url = "https://github.com/bazelbuild/rules_python/releases/download/0.5.0/rules_python-0.5.0.tar.gz",
    sha256 = "cd6730ed53a002c56ce4e2f396ba3b3be262fd7cb68339f0377a45e8227fe332",
)

load("@rules_python//python:pip.bzl", "pip_install")

pip_install(
   name = "python_deps",
   requirements = "//:requirements.txt",
)

จากนั้นเป้าหมายการทดสอบจะใช้ข้อกำหนด coverage.py ได้โดย ตั้งค่าต่อไปนี้ในไฟล์ BUILD

load("@python_deps//:requirements.bzl", "entry_point")

alias(
    name = "python_coverage_tools",
    actual = entry_point("coverage"),
)

py_test(
    name = "test",
    srcs = ["test.py"],
    env = {
        "PYTHON_COVERAGE": "$(location :python_coverage_tools)",
    },
    deps = [
        ":main",
        ":python_coverage_tools",
    ],
)

หากใช้เครื่องมือ Python แบบปิด คุณสามารถเพิ่มเครื่องมือครอบคลุมลงในการกำหนดค่า Toolchain แทนที่จะเพิ่มการอ้างอิงการครอบคลุม ไปยังเป้าหมาย py_test ทุกรายการ

เนื่องจากกฎ pip_install ขึ้นอยู่กับเครื่องมือเชนของ Python จึงไม่สามารถใช้เพื่อดึงข้อมูลโมดูล coverage ได้ แต่ให้เพิ่มใน WORKSPACE เช่น

http_archive(
    name = "coverage_linux_x86_64"",
    build_file_content = """
py_library(
    name = "coverage",
    srcs = ["coverage/__main__.py"],
    data = glob(["coverage/*", "coverage/**/*.py"]),
    visibility = ["//visibility:public"],
)
""",
    sha256 = "84631e81dd053e8a0d4967cedab6db94345f1c36107c71698f746cb2636c63e3",
    type = "zip",
    urls = [
        "https://files.pythonhosted.org/packages/74/0d/0f3c522312fd27c32e1abe2fb5c323b583a5c108daf2c26d6e8dfdd5a105/coverage-6.4.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
    ],
)

จากนั้นกำหนดค่าเครื่องมือ Python เช่น

py_runtime(
    name = "py3_runtime_linux_x86_64",
    coverage_tool = "@coverage_linux_x86_64//:coverage",
    files = ["@python3_9_x86_64-unknown-linux-gnu//:files"],
    interpreter = "@python3_9_x86_64-unknown-linux-gnu//:bin/python3",
    python_version = "PY3",
)

py_runtime_pair(
    name = "python_runtimes_linux_x86_64",
    py2_runtime = None,
    py3_runtime = ":py3_runtime_linux_x86_64",
)

toolchain(
    name = "python_toolchain_linux_x86_64",
    exec_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":python_runtimes_linux_x86_64",
    toolchain_type = "@bazel_tools//tools/python:toolchain_type",
)