Install OneAPI compiler for coverage GitHub action (#1777)

* Install OneAPI compiler for coverage GH action

* Updated coverage script to handle OneAPI compiler

Author: antonwolfy

.github/workflows/generate_coverage.yaml

@@ -21,7 +21,9 @@ jobs:
 
     env:
       python-ver: '3.10'
-      CHANNELS: '-c dppy/label/coverage -c intel -c conda-forge --override-channels'
+      CHANNELS: '-c dppy/label/dev -c intel -c conda-forge --override-channels'
+      # Install the latest oneAPI compiler to work around an issue
+      INSTALL_ONE_API: 'yes'
 
     steps:
       - name: Cancel Previous Runs
@@ -34,6 +36,26 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Add Intel repository
+        if: env.INSTALL_ONE_API == 'yes'
+        run: |
+          wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB
+          sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB
+          rm GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB
+          sudo add-apt-repository "deb https://apt.repos.intel.com/oneapi all main"
+          sudo apt-get update
+
+      - name: Install latest Intel OneAPI
+        if: env.INSTALL_ONE_API == 'yes'
+        run: |
+          sudo apt-get install intel-oneapi-compiler-dpcpp-cpp
+          sudo apt-get install intel-oneapi-mkl-devel
+          sudo apt-get install intel-oneapi-tbb-devel
+
+      - name: Install Lcov
+        run: |
+          sudo apt-get install lcov
+
       - name: Setup miniconda
         uses: conda-incubator/setup-miniconda@030178870c779d9e5e1b4e563269f3aa69b04081 # v3.0.3
         with:
@@ -42,14 +64,17 @@ jobs:
           miniconda-version: 'latest'
           activate-environment: 'coverage'
 
-      - name: Install Lcov
+      - name: Install dpnp dependencies
+        if: env.INSTALL_ONE_API == 'yes'
         run: |
-          sudo apt-get install lcov
+          conda install cython llvm cmake">=3.21" scikit-build ninja pytest pytest-cov coverage[toml] \
+              dpctl">=0.17.0dev0" onedpl-devel ${{ env.CHANNELS }}
 
       - name: Install dpnp dependencies
+        if: env.INSTALL_ONE_API != 'yes'
         run: |
           conda install cython llvm cmake">=3.21" scikit-build ninja pytest pytest-cov coverage[toml] \
-              dpctl">=0.17.0dev0" dpctl dpcpp_linux-64 mkl-devel-dpcpp tbb-devel onedpl-devel ${{ env.CHANNELS }}
+              dpctl">=0.17.0dev0" dpcpp_linux-64 mkl-devel-dpcpp tbb-devel onedpl-devel ${{ env.CHANNELS }}
 
       - name: Conda info
         run: |
@@ -67,8 +92,9 @@ jobs:
           command: |
             . $CONDA/etc/profile.d/conda.sh
             conda activate coverage
+            [ -f /opt/intel/oneapi/setvars.sh ] && source /opt/intel/oneapi/setvars.sh
             git clean -fxd
-            python scripts/gen_coverage.py --pytest-opts="--ignore tests/test_random.py"
+            python scripts/gen_coverage.py --pytest-opts="--ignore tests/test_random.py" --verbose
 
       - name: Total number of coverage attempts
         run: |

scripts/gen_coverage.py

@@ -4,10 +4,13 @@
 
 
 def run(
+    use_oneapi=True,
     c_compiler=None,
     cxx_compiler=None,
+    compiler_root=None,
     bin_llvm=None,
     pytest_opts="",
+    verbose=False,
 ):
     IS_LIN = False
 
@@ -29,11 +32,10 @@ def run(
         sys.executable,
         "setup.py",
         "develop",
-        "-G=Ninja",
+        "--generator=Ninja",
         "--",
         "-DCMAKE_C_COMPILER:PATH=" + c_compiler,
         "-DCMAKE_CXX_COMPILER:PATH=" + cxx_compiler,
-        "-DCMAKE_VERBOSE_MAKEFILE=ON",
         "-DDPNP_GENERATE_COVERAGE=ON",
     ]
 
@@ -47,6 +49,11 @@ def run(
     # extend with global enviroment variables
     env.update({k: v for k, v in os.environ.items() if k != "PATH"})
 
+    if verbose:
+        cmake_args += [
+            "-DCMAKE_VERBOSE_MAKEFILE:BOOL=ON",
+        ]
+
     subprocess.check_call(cmake_args, shell=False, cwd=setup_dir, env=env)
 
     env["LLVM_PROFILE_FILE"] = "dpnp_pytest.profraw"
@@ -125,25 +132,74 @@ def find_objects():
         description="Driver to build dpnp and generate coverage"
     )
     driver = parser.add_argument_group(title="Coverage driver arguments")
+    driver.add_argument("--c-compiler", help="Name of C compiler", default=None)
+    driver.add_argument(
+        "--cxx-compiler", help="Name of C++ compiler", default=None
+    )
+    driver.add_argument(
+        "--not-oneapi",
+        help="Is one-API installation",
+        dest="oneapi",
+        action="store_false",
+    )
+    driver.add_argument(
+        "--compiler-root", type=str, help="Path to compiler home directory"
+    )
+    driver.add_argument(
+        "--bin-llvm", help="Path to folder where llvm-cov can be found"
+    )
     driver.add_argument(
         "--pytest-opts",
         help="Channels through additional pytest options",
         dest="pytest_opts",
         default="",
         type=str,
     )
-
+    driver.add_argument(
+        "--verbose",
+        help="Build using vebose makefile mode",
+        dest="verbose",
+        action="store_true",
+    )
     args = parser.parse_args()
 
-    c_compiler = "icx"
-    cxx_compiler = "icpx"
-    icx_path = subprocess.check_output(["which", "icx"])
-    bin_dir = os.path.dirname(os.path.dirname(icx_path))
-    bin_llvm = os.path.join(bin_dir.decode("utf-8"), "bin-llvm")
+    if args.oneapi:
+        args.c_compiler = "icx"
+        args.cxx_compiler = "icpx"
+        args.compiler_root = None
+        icx_path = subprocess.check_output(["which", "icx"])
+        bin_dir = os.path.dirname(icx_path)
+        compiler_dir = os.path.join(bin_dir.decode("utf-8"), "compiler")
+        if os.path.exists(compiler_dir):
+            args.bin_llvm = os.path.join(bin_dir.decode("utf-8"), "compiler")
+        else:
+            bin_dir = os.path.dirname(bin_dir)
+            args.bin_llvm = os.path.join(bin_dir.decode("utf-8"), "bin-llvm")
+        assert os.path.exists(args.bin_llvm)
+    else:
+        args_to_validate = [
+            "c_compiler",
+            "cxx_compiler",
+            "compiler_root",
+            "bin_llvm",
+        ]
+        for p in args_to_validate:
+            arg = getattr(args, p, None)
+            if not isinstance(arg, str):
+                opt_name = p.replace("_", "-")
+                raise RuntimeError(
+                    f"Option {opt_name} must be provided is "
+                    "using non-default DPC++ layout"
+                )
+            if not os.path.exists(arg):
+                raise RuntimeError(f"Path {arg} must exist")
 
     run(
-        c_compiler=c_compiler,
-        cxx_compiler=cxx_compiler,
-        bin_llvm=bin_llvm,
+        use_oneapi=args.oneapi,
+        c_compiler=args.c_compiler,
+        cxx_compiler=args.cxx_compiler,
+        compiler_root=args.compiler_root,
+        bin_llvm=args.bin_llvm,
         pytest_opts=args.pytest_opts,
+        verbose=args.verbose,
     )