Bazel을 사용한 코드 적용 범위

Bazel은 coverage 하위 명령어를 사용하여 bazel coverage로 테스트할 수 있는 저장소에 대한 코드 적용 범위 보고서를 생성합니다. 다양한 언어 생태계의 특이사항으로 인해 특정 프로젝트에 이 작업을 항상 적용하는 것은 사소한 일이 아닙니다.

이 페이지에서는 노출 범위 보고서를 만들고 보는 일반적인 프로세스를 문서화하고 구성이 잘 알려진 언어에 대한 몇 가지 언어별 메모를 제공합니다. 우선 일반 섹션을 읽은 다음 특정 언어의 요구사항을 읽어보는 것이 좋습니다. 또한 추가 고려사항이 필요한 원격 실행 섹션을 참조하세요.

많은 맞춤설정이 가능하지만, 이 문서에서는 현재 가장 잘 지원되는 경로인 lcov 보고서를 생성하고 소비하는 방법을 중점적으로 설명합니다.

노출 범위 보고서 만들기

준비

노출 범위 보고서를 만들기 위한 기본 워크플로에는 다음이 필요합니다.

• 테스트 대상이 있는 기본 저장소
• 언어별 코드 적용 범위 도구가 설치된 도구 모음
• 올바른 '계측 구성'

전자는 두 가지가 언어별로 다르고 대부분 직관적이지만, 후자는 복잡한 프로젝트에서는 더 어려울 수 있습니다.

여기서 'Instrumentation'은 특정 대상에 사용되는 범위 도구를 나타냅니다. 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 project의 일부)를 사용하여 웹브라우저에서 볼 수 있는 보고서를 생성할 수 있습니다.

genhtml --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"

genhtml는 소스 코드도 읽고 이러한 파일에서 누락된 적용 범위에 주석을 답니다. 이 함수가 작동하려면 bazel 프로젝트의 루트에서 genhtml가 실행되어야 합니다.

결과를 보려면 웹브라우저의 genhtml 디렉터리에서 생성된 index.html 파일을 열기만 하면 됩니다.

genhtml 도구 또는 lcov 범위 형식에 대한 자세한 내용과 정보는 lcov 프로젝트를 참고하세요.

원격 실행

원격 테스트 실행으로 실행하는 경우 현재 몇 가지 주의사항이 있습니다.

• 보고서 조합 작업은 아직 원격으로 실행할 수 없습니다. Bazel이 적용 범위 출력 파일을 그래프의 일부로 간주하지 않기 때문에 (이 문제 참고) 이러한 파일을 조합 작업의 입력으로 올바르게 처리할 수 없기 때문입니다. 이 문제를 해결하려면 --strategy=CoverageReport=local를 사용하세요.
  • 참고: Bazel이 전략을 확인하는 방법으로 인해 Bazel이 local,remote를 시도하도록 설정된 경우 대신 --strategy=CoverageReport=local,remote와 같은 것을 지정해야 할 수 있습니다.
• --remote_download_minimal 및 유사한 플래그도 전자의 결과로 사용할 수 없습니다.
• 이전에 테스트가 캐시된 경우 Bazel이 현재 범위 정보를 만들 수 없습니다. 이 문제를 해결하기 위해 적용 범위 실행에 --nocache_test_results를 설정할 수 있지만 이 경우 테스트 시간 측면에서 비용이 많이 듭니다.
• --experimental_split_coverage_postprocessing 및 --experimental_fetch_all_coverage_outputs
  • 일반적으로 커버리지는 테스트 작업의 일부로 실행되므로 기본적으로 모든 커버리지가 기본적으로 원격 실행의 출력으로 반환되지는 않습니다. 이러한 플래그는 기본값을 재정의하고 노출 범위 데이터를 가져옵니다. 자세한 내용은 이 문제를 참고하세요.

언어별 구성

자바

자바는 기본 구성으로 즉시 작동해야 합니다. bazel 도구 모음에는 JUnit을 포함하여 원격 실행에 필요한 모든 것이 포함됩니다.

Python

기본 요건

Python으로 노출 범위를 실행하려면 몇 가지 기본 요건을 충족해야 합니다.

• b01c859를 포함하는 bazel 바이너리로, Bazel 3.0이어야 합니다.
• 노출 범위.py의 수정된 버전.

수정된 적용 범위.py 사용

이렇게 하는 방법은 rules_python을 통하는 것입니다. 이는 requirements.txt 파일을 사용하는 기능을 제공합니다. 그러면 파일에 나열된 요구사항이 pip_install 저장소 규칙을 사용하여 bazel 대상으로 생성됩니다.

requirements.txt에 다음 항목이 포함되어야 합니다.

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

WORKSPACE 파일에서 rules_python, pip_install, requirements.txt 파일을 다음과 같이 사용해야 합니다.

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",
)

그런 다음 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 도구 모음을 사용할 때는 모든 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",
)