feat(compilers): include C/C++ compilers (#14)

* feat(compilers): include c/c++ compilers
* fix(env): set ONEAPI_ROOT env var
* fix(ci): use shell: bash for pip install

Author: wpbonelli

.github/workflows/ci.yml

@@ -3,11 +3,11 @@ on:
   push:
     branches:
       - main
-      - develop
+      - develop*
   pull_request:
     branches:
       - main
-      - develop
+      - develop*
 jobs:
   test:
     name: Test
@@ -52,19 +52,19 @@ jobs:
           }
 
           echo "TEST_BINDIR=$bindir" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
-      - name: Install ifort
+      - name: Install compilers
         if: matrix.path != 'default'
         uses: ./
         with:
           path: ${{ env.TEST_BINDIR }}
-      - name: Install ifort
+      - name: Install compilers
         if: matrix.path == 'default'
         uses: ./
-      - name: Test ifort (Linux & Mac)
+      - name: Test compilers (Linux & Mac)
         if: runner.os != 'Windows'
         run: |
           ./test/test.sh ${{ env.TEST_BINDIR }}
-      - name: Test ifort (Windows bash)
+      - name: Test compilers (Windows bash)
         if: runner.os == 'Windows'
         shell: bash
         run: |
@@ -89,12 +89,12 @@ jobs:
             echo "unexpected output: $output"
             exit 1
           fi
-      - name: Test ifort (Windows pwsh)
+      - name: Test compilers (Windows pwsh)
         if: runner.os == 'Windows'
         shell: pwsh
         run: |
           ./test/test.ps1 "${{ env.TEST_BINDIR }}"
-      - name: Test ifort (Windows cmd)
+      - name: Test compilers (Windows cmd)
         if: runner.os == 'Windows'
         shell: cmd
         run: |

.github/workflows/integration.yml

@@ -41,8 +41,8 @@ jobs:
           cache: 'pip'
       - name: Install Python dependencies
         if: matrix.env == 'pip'
-        run: |
-          pip3 install -r test/requirements.txt
+        shell: bash
+        run: pip install -r test/requirements.txt
       - name: Install miniconda environment
         if: matrix.env == 'miniconda'
         uses: conda-incubator/setup-miniconda@v2
@@ -60,7 +60,15 @@ jobs:
         with:
           path: ${{ runner.os != 'Windows' && 'bin' || 'C:\Program Files (x86)\Intel\oneAPI' }}
       - name: Build modflow6 (Linux & Mac)
-        if: runner.os != 'Windows'
+        if: runner.os != 'Windows' && matrix.env == 'pip'
+        working-directory: modflow6
+        shell: bash
+        run: |
+          meson setup builddir -Ddebug=false --prefix=$(pwd) --libdir=bin
+          meson compile -v -C builddir
+          meson install -C builddir
+      - name: Build modflow6 (Linux & Mac)
+        if: runner.os != 'Windows' && matrix.env != 'pip'
         working-directory: modflow6
         run: |
           meson setup builddir -Ddebug=false --prefix=$(pwd) --libdir=bin

README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/modflowpy/install-intelfortran-action/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/modflowpy/install-intelfortran-action/actions/workflows/ci.yml)
 
-An action to install and cache the [Intel OneAPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html#gs.bksc2p) Fortran classic compiler via the [HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit.html#gs.g10hgy) and add `ifort` to the path.
+An action to install and cache the [Intel OneAPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html#gs.bksc2p) Fortran and C/C++ classic compilers via the [HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit.html#gs.g10hgy).
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -24,7 +24,7 @@ An action to install and cache the [Intel OneAPI](https://www.intel.com/content/
 
 ## Overview
 
-This action installs the [Intel OneAPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html#gs.bksc2p) Fortran compiler. It does this by downloading and running the [HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit.html#gs.g10hgy) offline installer, selecting only the `ifort-compiler` component. After installing the compiler distribution, the action configures [environment variables](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup.html) necessary to invoke `ifort` from subsequent workflow steps.
+This action installs the [Intel OneAPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html#gs.bksc2p) Fortran and C/C++ classic compilers. It does this by downloading and running the [HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit.html#gs.g10hgy) offline installer, selecting only the `ifort-compiler` component. After installing the compiler distribution, the action configures [environment variables](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup.html) necessary to invoke `ifort` or `icc` (`icl` on Windows) from subsequent workflow steps.
 
 ## Usage
 
@@ -67,6 +67,7 @@ A few additional variables are also set:
 - `INTEL_COMPILER_BIN_PATH` is the location of compiler executables (this is equivalent to `$HPCKIT_INSTALL_PATH/compilers/latest/<mac, linux, or windows>/bin/intel64`, substituting the proper OS)
 - `INTEL_HPCKIT_VERSION` is the oneAPI HPC toolkit version number used (currently `2022.3`)
 - `FC` is set to `ifort`
+- `CC` is set to `icc` on Linux and macOS and `icl` on Windows
 
 **Note:** GitHub Actions does not preserve environment variables between steps by default &mdash; this action persists them via the [`GITHUB_ENV` environment file](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable).
 

action.yml

@@ -31,7 +31,7 @@ runs:
         echo "INTEL_HPCKIT_INSTALL_PATH=$normalized" >> $GITHUB_ENV
         mkdir -p "$normalized"
 
-    - name: Set install path
+    - name: Set install path (Windows)
       if: runner.os == 'Windows'
       shell: pwsh
       run: |
@@ -57,13 +57,13 @@ runs:
         version="2022.3.0"
         if [ "$RUNNER_OS" == "Linux" ]; then
           echo "INTEL_HPCKIT_INSTALLER_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18856/l_HPCKit_p_$version.8751_offline.sh" >> $GITHUB_ENV
-          echo "INTEL_HPCKIT_COMPONENTS=intel.oneapi.lin.ifort-compiler" >> $GITHUB_ENV
+          echo "INTEL_HPCKIT_COMPONENTS=intel.oneapi.lin.dpcpp-cpp-compiler-pro:intel.oneapi.lin.ifort-compiler" >> $GITHUB_ENV
         elif [ "$RUNNER_OS" == "macOS" ]; then
           echo "INTEL_HPCKIT_INSTALLER_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18866/m_HPCKit_p_$version.8685_offline.dmg" >> $GITHUB_ENV
-          echo "INTEL_HPCKIT_COMPONENTS=intel.oneapi.mac.ifort-compiler" >> $GITHUB_ENV
+          echo "INTEL_HPCKIT_COMPONENTS=intel.oneapi.mac.cpp-compiler:intel.oneapi.mac.ifort-compiler" >> $GITHUB_ENV
         else
           echo "INTEL_HPCKIT_INSTALLER_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18857/w_HPCKit_p_$version.9564_offline.exe" >> $GITHUB_ENV
-          echo "INTEL_HPCKIT_COMPONENTS=intel.oneapi.win.ifort-compiler" >> $GITHUB_ENV
+          echo "INTEL_HPCKIT_COMPONENTS=intel.oneapi.win.cpp-compiler:intel.oneapi.win.ifort-compiler" >> $GITHUB_ENV
         fi
  
         echo "using HPC toolkit version $version"
@@ -81,7 +81,7 @@ runs:
       uses: martijnhols/actions-cache/restore@v3
       with:
         path: ${{ env.INTEL_HPCKIT_INSTALL_PATH }}
-        key: ifort-${{ runner.os }}-${{ env.INTEL_HPCKIT_VERSION }}-${{ env.INTEL_HPCKIT_COMPONENTS }}
+        key: intelfortran-${{ runner.os }}-${{ env.INTEL_HPCKIT_VERSION }}-${{ env.INTEL_HPCKIT_COMPONENTS }}
 
     - name: Restore GNU tar
       if: runner.os == 'windows'
@@ -90,15 +90,15 @@ runs:
         # restore GNU tar
         mv "$RUNNER_TEMP\tar.exe" 'C:\Program Files\Git\usr\bin\tar.exe'
 
-    - name: Install Intel fortran
+    - name: Install compilers
       if: runner.os != 'Windows' && steps.cache-ifort.outputs.cache-hit != 'true'
       shell: bash
       run: |
         echo "downloading and running HPC kit installer"
         os=$(echo $RUNNER_OS | tr '[:upper:]' '[:lower:]')
         "${{ github.action_path }}/scripts/install_$os.sh" "${{ env.INTEL_HPCKIT_INSTALL_PATH }}" "${{ env.INTEL_HPCKIT_INSTALLER_URL }}" "${{ env.INTEL_HPCKIT_COMPONENTS }}"
 
-    - name: Install Intel fortran
+    - name: Install compilers (Windows)
       if: runner.os == 'Windows' && steps.cache-ifort.outputs.cache-hit != 'true'
       shell: cmd
       run: |
@@ -110,7 +110,7 @@ runs:
       uses: martijnhols/actions-cache/save@v3
       with:
         path: ${{ env.INTEL_HPCKIT_INSTALL_PATH }}
-        key: ifort-${{ runner.os }}-${{ env.INTEL_HPCKIT_VERSION }}-${{ env.INTEL_HPCKIT_COMPONENTS }}
+        key: intelfortran-${{ runner.os }}-${{ env.INTEL_HPCKIT_VERSION }}-${{ env.INTEL_HPCKIT_COMPONENTS }}
 
     - name: Configure system path
       if: runner.os != 'Windows'
@@ -136,8 +136,10 @@ runs:
         echo "$bindir" >> $GITHUB_PATH
         echo "INTEL_COMPILER_BIN_PATH=$bindir" >> $GITHUB_ENV
         echo "FC=ifort" >> $GITHUB_ENV
+        echo "CC=icc" >> $GITHUB_ENV
+        echo "ONEAPI_ROOT=$INTEL_HPCKIT_INSTALL_PATH" >> $GITHUB_ENV
 
-    - name: Configure system path
+    - name: Configure system path (Windows)
       if: runner.os == 'Windows'
       shell: cmd
       run: |
@@ -148,6 +150,8 @@ runs:
         echo %bindir%>>"%GITHUB_PATH%"
         echo INTEL_COMPILER_BIN_PATH=%bindir%>>"%GITHUB_ENV%"
         echo FC=ifort>>"%GITHUB_ENV%"
+        echo CC=icl>>"%GITHUB_ENV%"
+        echo ONEAPI_ROOT=%INTEL_HPCKIT_INSTALL_PATH%>>"%GITHUB_ENV%"
         
         :: prepend MSVC bindir to path
         set bindir=C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.33.31629\bin\Hostx64\x64

test/hw.cpp

@@ -0,0 +1,6 @@
+#include <iostream>
+using namespace std;
+int main() {
+   cout << "hello world" << endl;
+   return 0;
+}

test/test.bat

@@ -5,7 +5,33 @@ SET output=%%F
 )
 
 if /I "%output:hello=%" neq "%output%" (
-echo compile succeeded
+echo fortran compile succeeded
 ) else (
 echo "unexpected output: %output%" exit /b 1
+)
+
+del hw
+icl test/hw.cpp -o hw
+
+FOR /F "tokens=* USEBACKQ" %%F IN (`hw`) DO (
+SET output=%%F
+)
+
+if /I "%output:hello=%" neq "%output%" (
+echo icl compile succeeded
+) else (
+echo "icl unexpected output: %output%" exit /b 1
+)
+
+del hw
+icx test/hw.cpp -o hw
+
+FOR /F "tokens=* USEBACKQ" %%F IN (`hw`) DO (
+SET output=%%F
+)
+
+if /I "%output:hello=%" neq "%output%" (
+echo icx compile succeeded
+) else (
+echo "icx unexpected output: %output%" exit /b 1
 )

test/test.ps1

@@ -20,12 +20,50 @@ if ((get-command "ifort" -ErrorAction SilentlyContinue) -eq $null) {
     ifort /QV
 }
 
-ifort test/hw.f90 -o hw
-$output=$(./hw)
+if ((get-command "icl" -ErrorAction SilentlyContinue) -eq $null) {
+    write-output "icl not available"
+    exit 1
+} else {
+    write-output "icl found"
+    icl /QV
+}
+
+if ((get-command "icx" -ErrorAction SilentlyContinue) -eq $null) {
+    write-output "icx not available"
+    exit 1
+} else {
+    write-output "icx found"
+    icx /QV
+}
+
+ifort test/hw.f90 -o hw.exe
+$output=$(./hw.exe)
+if ($output -match "hello world") {
+    write-output "ifort compile succeeded"
+    write-output $output
+} else {
+    write-output "ifort unexpected output: $output"
+    exit 1
+}
+
+rm -Force hw.exe
+icl test/hw.cpp -o hw.exe
+$output=$(./hw.exe)
+if ($output -match "hello world") {
+    write-output "icl compile succeeded"
+    write-output $output
+} else {
+    write-output "icl unexpected output: $output"
+    exit 1
+}
+
+rm -Force hw.exe
+icx test/hw.cpp -o hw.exe
+$output=$(./hw.exe)
 if ($output -match "hello world") {
-    write-output "compile succeeded"
+    write-output "icx compile succeeded"
     write-output $output
 } else {
-    write-output "unexpected output: $output"
+    write-output "icx unexpected output: $output"
     exit 1
 }

test/test.sh

@@ -17,19 +17,76 @@ fi
 
 if command -v ifort &> /dev/null
 then
-  echo "ifort found"
+  echo "Fortran classic compiler found"
 else
-  echo "ifort not available"
+  echo "Fortran classic compiler not available"
   exit 1
 fi
 
+if [[ ( "$OSTYPE" == "cygwin" ) || ( "$OSTYPE" == "msys" ) || ( "$OSTYPE" == "win32" ) ]]; then
+  cmd=$(command -v icl)
+else
+  cmd=$(command -v icpc)
+fi
+if [ "$cmd" ]; then
+  echo "C/C++ classic compiler found"
+else
+  echo "C/C++ classic compiler not available"
+  exit 1
+fi
+
+# if [[ "$OSTYPE" == "darwin"* ]]; then
+#   echo "DPC++/C++ not supported on macOS, use classic compilers instead"
+# else
+#   if command -v icpx &> /dev/null
+#   then
+#     echo "icpx found"
+#   else
+#     echo "icpx not available"
+#     exit 1
+#   fi
+# fi
+
 ifort test/hw.f90 -o hw
 output=$(./hw '2>&1')
 if [[ "$output" == *"hello world"* ]]
 then
-  echo "compile succeeded"
+  echo "Fortran program compilation succeeded"
   echo "$output"
 else
-  echo "unexpected output: $output"
+  echo "Fortran program gave unexpected output: $output"
   exit 1
 fi
+
+sudo rm -rf hw
+if [[ ( "$OSTYPE" == "cygwin" ) || ( "$OSTYPE" == "msys" ) || ( "$OSTYPE" == "win32" ) ]]; then
+  icl test/hw.cpp -o hw.exe
+  output=$(./hw.exe '2>&1')
+else
+  icpc test/hw.cpp -o hw
+  output=$(./hw '2>&1')
+fi
+if [[ "$output" == *"hello world"* ]]
+then
+  echo "C++ program compilation succeeded"
+  echo "$output"
+else
+  echo "C++ program gave unexpected output: $output"
+  exit 1
+fi
+
+# if [[ "$OSTYPE" == "darwin"* ]]; then
+#   echo "DPC++/C++ not supported on macOS, use classic compilers instead"
+# else
+#   sudo rm -rf hw
+#   icpx test/hw.cpp -o hw
+#   output=$(./hw '2>&1')
+#   if [[ "$output" == *"hello world"* ]]
+#   then
+#     echo "icpx compile succeeded"
+#     echo "$output"
+#   else
+#     echo "icpx unexpected output: $output"
+#     exit 1
+#   fi
+# fi