Improvements to gen_coverage.py helper script.

  -- Add an option to specify custom gtest installation.
  -- FindLLVMCov offers a way to specify where to look
     for llvm-cov. If `bin-llvm` is provided, set the
     `LLVM_TOOL_DIR` envar as well to help FindLLVMCov.
     Otherwise, just adding to PATH is not enough.
  -- Some formatting fixes to coverage workflow.

Author: Diptorup Deb

.github/workflows/generate-coverage.yaml

@@ -87,7 +87,15 @@ jobs:
           source /opt/intel/oneapi/setvars.sh
           export _SAVED_PATH=${PATH}
           export PATH=$(dirname $(dirname $(which icx)))/bin-llvm:${PATH}
-          python setup.py develop -- -G "Ninja" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_GENERATE_COVERAGE=ON -DDPCTL_BUILD_CAPI_TESTS=ON -DDPCTL_COVERAGE_REPORT_OUTPUT_DIR=$(pwd)
+          python setup.py develop --                                           \
+          -G "Ninja"                                                           \
+          -DCMAKE_BUILD_TYPE=Debug                                             \
+          -DCMAKE_C_COMPILER:PATH=icx                                          \
+          -DCMAKE_CXX_COMPILER:PATH=icpx                                       \
+          -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON                                \
+          -DDPCTL_GENERATE_COVERAGE=ON                                         \
+          -DDPCTL_BUILD_CAPI_TESTS=ON                                          \
+          -DDPCTL_COVERAGE_REPORT_OUTPUT_DIR=$(pwd)
           pushd $(find _skbuild -name tests)
           cmake --build . --target lcov-genhtml || exit 1
           popd

scripts/gen_coverage.py

@@ -27,6 +27,7 @@ def run(
     compiler_root=None,
     run_pytest=False,
     bin_llvm=None,
+    gtest_config=None,
 ):
     IS_LIN = False
 
@@ -66,18 +67,14 @@ def run(
     if bin_llvm:
         env = {
             "PATH": ":".join((os.environ.get("PATH", ""), bin_llvm)),
+            "LLVM_TOOLS_HOME": bin_llvm,
         }
         env.update({k: v for k, v in os.environ.items() if k != "PATH"})
+    if gtest_config:
+        cmake_args += ["-DCMAKE_PREFIX_PATH=" + gtest_config]
     subprocess.check_call(cmake_args, shell=False, cwd=setup_dir, env=env)
-    test_dir = (
-        subprocess.check_output(
-            ["find", "_skbuild", "-name", "tests"], cwd=setup_dir
-        )
-        .decode("utf-8")
-        .strip("\n")
-    )
     subprocess.check_call(
-        ["make", "-C", test_dir, "lcov-genhtml"], cwd=setup_dir
+        ["cmake", "--build", ".", "--target", "lcov-genhtml"], cwd=setup_dir
     )
     subprocess.check_call(
         [
@@ -135,6 +132,11 @@ def run(
     driver.add_argument(
         "--bin-llvm", help="Path to folder where llvm-cov can be found"
     )
+    driver.add_argument(
+        "--gtest-config",
+        help="Path to the GTestConfig.cmake file to locate a "
+        + "custom GTest installation.",
+    )
     args = parser.parse_args()
 
     if args.oneapi:
@@ -170,4 +172,5 @@ def run(
         compiler_root=args.compiler_root,
         run_pytest=args.run_pytest,
         bin_llvm=args.bin_llvm,
+        gtest_config=args.gtest_config,
     )