Merge pull request #65 from HDFGroup/kimmy/coverall

Kimmy/coverall

.github/workflows/main.yml

@@ -1,4 +1,5 @@
 # This is a basic workflow to help you get started with Actions
+# CodeCoverage result can be found at https://coveralls.io/github/HDFGroup/hermes
 
 name: GitHub Actions
 
@@ -47,6 +48,7 @@ jobs:
           sudo apt-get install -y autoconf
           sudo apt-get install -y automake
           sudo apt-get install -y mpich
+          sudo apt-get install -y lcov
           sudo apt-get install -y zlib1g-dev 
           sudo apt-get install -y libsdl2-dev
           
@@ -55,4 +57,13 @@ jobs:
         run: ci/install_deps.sh
 
       - name: Build and Test
-        run: ci/install_hermes.sh
+        run: |
+          ci/install_hermes.sh
+          mkdir -p "${GITHUB_WORKSPACE}/coverage"
+          pushd build/src/CMakeFiles/hermes.dir
+          lcov -c -d . -o "${GITHUB_WORKSPACE}/coverage/lcov.info"
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

CMakeLists.txt

@@ -152,7 +152,7 @@ option(HERMES_MDM_STORAGE_STBDS
 option(HERMES_DEBUG_HEAP "Store Heap debug information for visualization." OFF)
 option(HERMES_BUILD_BENCHMARKS "Build the Hermes benchmark suite." OFF)
 option(HERMES_ENABLE_TIMING "Turn on timing of selected functions." OFF)
-option(HERMES_ENABLE_COVERAGE "Enable codecode  coverage." OFF)
+option(HERMES_ENABLE_COVERAGE "Enable code coverage." OFF)
 # Calculate code coverage with debug mode
 if(HERMES_ENABLE_COVERAGE)
   if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")

README.md

@@ -4,6 +4,8 @@ Hermes is a heterogeneous aware, multi-tiered, dynamic, and distributed I/O buff
 
 ![Build](https://github.com/HDFGroup/hermes/workflows/GitHub%20Actions/badge.svg)
 
+[![Coverage Status](https://coveralls.io/repos/github/HDFGroup/hermes/badge.svg?branch=master)](https://coveralls.io/github/HDFGroup/hermes?branch=master)
+
 ## Dependencies
 * A C++ compiler that supports C++ 17.
 * [Thallium](https://mochi.readthedocs.io/en/latest/installing.html) - RPC library for HPC. Use a version greater than `0.5` for RoCE support.

ci/install_hermes.sh

@@ -19,6 +19,7 @@ cmake                                                      \
     -DCMAKE_CXX_COMPILER=`which mpicxx`                    \
     -DCMAKE_C_COMPILER=`which mpicc`                       \
     -DBUILD_SHARED_LIBS=ON                                 \
+    -DHERMES_ENABLE_COVERAGE=ON                            \
     -DHERMES_INTERCEPT_IO=ON                               \
     -DHERMES_COMMUNICATION_MPI=ON                          \
     -DHERMES_BUILD_BUFFER_POOL_VISUALIZER=ON               \