[cmake][ci] Enable codecov.

Fixes #27.

Author: vgvassilev

.github/workflows/main.yml

@@ -21,7 +21,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        include:
+          - name: ubu
+            os: ubuntu-latest
+          - name: ubu-analyzers
+            os: ubuntu-latest
+            coverage: true
+            extra_cmake_flags: -DCMAKE_BUILD_TYPE=Debug
+          - name: osx
+            os: macos-latest
 
     steps:
       - uses: actions/checkout@v2
@@ -40,28 +48,30 @@ jobs:
       - name: cmake configure
         shell: bash -l {0}
         run: |
-          mkdir -p bld
-          cd bld
+          mkdir -p build
+          cd build
           cmake .. \
            -DCMAKE_PREFIX_PATH=$CONDA_PREFIX \
-           -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX 
+           -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX \
+           -DXEUS_CPP_ENABLE_CODE_COVERAGE=${{ matrix.coverage }} \
+           ${{ matrix.extra_cmake_flags }}
 
       - name: build
         shell: bash -l {0}
         run: |
-          cd bld
+          cd build
           make -j8
 
       - name: install
         shell: bash -l {0}
         run: |
-          cd bld
+          cd build
           make install
 
       - name: Test xeus-cpp C++
         shell: bash -l {0}
         run: |
-          cd bld/test
+          cd build/test
           ./test_xeus_cpp
         timeout-minutes: 4
 
@@ -71,6 +81,27 @@ jobs:
           cd test
           pytest .  --reruns 5
 
+      - name: Prepare code coverage report
+        if: ${{ success() && (matrix.coverage == true) }}
+        shell: bash -l {0}
+        run: |
+          # Create lcov report
+          # Find the current compiler version.
+          CC=$(realpath `which c++`)
+          vers="${CC##*-}"
+          sudo apt install lcov
+          # capture coverage info
+          lcov --directory build/ --capture --output-file coverage.info --gcov-tool $CONDA_PREFIX/bin/gcov
+          lcov --remove coverage.info '/usr/*' "${HOME}"'/.cache/*' ${{ github.workspace }}'/llvm-project/*' ${{ github.workspace }}'/test/*' --output-file coverage.info
+          # output coverage data for debugging (optional)
+          lcov --list coverage.info
+
+      - name: Upload to codecov.io
+        if: ${{ success() && (matrix.coverage == true) }}
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.info
+
   win:
 
     runs-on: ${{ matrix.os }}
@@ -98,15 +129,15 @@ jobs:
         shell: cmd
         run: |
           call C:\Users\runneradmin\micromamba-root\condabin\micromamba.bat activate xeus-cpp
-          mkdir -p bld
-          cd bld
+          mkdir -p build
+          cd build
           cmake .. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release -DXEUS_BUILD_TESTS=ON -DDEPENDENCY_SEARCH_PREFIX="%CONDA_PREFIX%\Library" -DCMAKE_PREFIX_PATH="%CONDA_PREFIX%\Library" -DCMAKE_INSTALL_PREFIX="%CONDA_PREFIX%"
 
       - name: build
         shell: cmd
         run: |
           call C:\Users\runneradmin\micromamba-root\condabin\micromamba.bat activate xeus-cpp
-          cd bld
+          cd build
           set CL=/MP
           nmake install
 

CMakeLists.txt

@@ -52,6 +52,19 @@ OPTION(XEUS_CPP_USE_SHARED_XEUS_CPP "Link xcpp  with the xeus shared library (in
 
 # Test options
 OPTION(XEUS_CPP_BUILD_TESTS "xeus-cpp test suite" ON)
+OPTION(XEUS_CPP_ENABLE_CODE_COVERAGE "xeus-cpp test suite" OFF)
+if(XEUS_CPP_ENABLE_CODE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+  string(TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE)
+  if(NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG")
+    message(FATAL_ERROR "CodeCov enabled on non-debug build!")
+  endif()
+  set(GCC_COVERAGE_COMPILE_FLAGS "-fprofile-arcs -ftest-coverage")
+  set(GCC_COVERAGE_LINK_FLAGS    "--coverage")
+  set(CMAKE_CXX_FLAGS            "${CMAKE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
+  set(CMAKE_EXE_LINKER_FLAGS     "${CMAKE_EXE_LINKER_FLAGS} ${GCC_COVERAGE_LINK_FLAGS}")
+  set(CMAKE_SHARED_LINKER_FLAGS  "${CMAKE_SHAREDLINKER_FLAGS} ${GCC_COVERAGE_LINK_FLAGS}")
+  set(CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS "${CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
+endif()
 
 if(EMSCRIPTEN)
     add_compile_definitions(XEUS_CPP_EMSCRIPTEN_WASM_BUILD)
@@ -418,4 +431,4 @@ endif ()
 
 if(XEUS_CPP_INCLUDE_DOCS)
     add_subdirectory(docs)
-endif()
+endif()

README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://github.com/compiler-research/xeus-cpp/actions/workflows/main.yml/badge.svg)](https://github.com/compiler-research/xeus-cpp/actions/workflows/main.yml)
 [![Documentation Status](http://readthedocs.org/projects/xeus-cpp/badge/?version=latest)](https://xeus-cppreadthedocs.io/en/latest/?badge=latest)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/compiler-research/xeus-cpp/main?urlpath=/lab/tree/notebooks/xeus-cpp.ipynb)
+[![codecov]( https://codecov.io/gh/compiler-research/xeus-cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/compiler-research/xeus-cpp)
 
 `xeus-cpp` is a Jupyter kernel for cpp based on the native implementation of the
 Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).