Merge pull request #262 from ursfassler/coverage

Coverage

Author: ursfassler

.github/workflows/run-all.yml

@@ -4,6 +4,9 @@ on:
   pull_request:
     branches: [ main ]
   workflow_dispatch:
+  push:
+    branches:
+      - main
 
 jobs:
   build:
@@ -17,6 +20,7 @@ jobs:
         sudo apt-get install --no-install-recommends \
         cmake \
         g++ \
+        gcovr \
         git \
         libboost-date-time-dev \
         libboost-filesystem-dev \
@@ -52,3 +56,17 @@ jobs:
         export DISPLAY=:99
         ./run-all.sh
 
+    - name: code coverage summary report
+      uses: irongut/[email protected]
+      with:
+        filename: coverage/cobertura.xml
+        indicators: false
+        hide_complexity: true
+        format: markdown
+        output: file
+
+    - name: publish code coverage summary
+      run: |
+        echo '# Code Coverage Report' >> $GITHUB_STEP_SUMMARY
+        cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY
+

.gitignore

@@ -7,6 +7,8 @@
 
 # Build artifacts
 /build/
+/coverage/
+/.local/
 
 # vim swap files
 *.swp

CMakeLists.txt

@@ -22,6 +22,7 @@ option(CUKE_ENABLE_GTEST        "Enable Google Test framework" ON)
 option(CUKE_ENABLE_QT           "Enable Qt framework" ON)
 option(CUKE_TESTS_E2E           "Enable end-to-end tests" ON)
 option(CUKE_TESTS_UNIT          "Enable unit tests" ON)
+option(CUKE_CODE_COVERAGE       "Enable instrumentation for code coverage" OFF)
 set(CUKE_ENABLE_SANITIZER       "OFF" CACHE STRING "Sanitizer to use for checking")
 set_property(CACHE CUKE_ENABLE_SANITIZER PROPERTY STRINGS OFF "address" "thread" "undefined")
 option(CUKE_TESTS_VALGRIND      "Enable tests within Valgrind" OFF)
@@ -36,6 +37,10 @@ elseif(CMAKE_CXX_STANDARD LESS 14)
     message(FATAL_ERROR "C++14 (above) is required")
 endif()
 
+if(CUKE_CODE_COVERAGE)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --coverage")
+endif()
+
 set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/modules)
 
 #

README.md

@@ -2,7 +2,6 @@
 
 [![Join the chat at https://gitter.im/cucumber/cucumber-cpp](https://badges.gitter.im/cucumber/cucumber-cpp.svg)](https://gitter.im/cucumber/cucumber-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Windows build status](https://ci.appveyor.com/api/projects/status/5jeap3a4si9w8kka?svg=true)](https://ci.appveyor.com/project/paoloambrosio/cucumber-cpp-qqrt7)
-[![Coverage Status](https://coveralls.io/repos/github/cucumber/cucumber-cpp/badge.svg)](https://coveralls.io/github/cucumber/cucumber-cpp)
 
 Cucumber-Cpp allows Cucumber to support step definitions written in C++.
 

run-all.sh

@@ -22,6 +22,7 @@ cmake -E make_directory build
 cmake -E chdir build cmake \
     -G Ninja \
     -DCUKE_ENABLE_EXAMPLES=on \
+    -DCUKE_CODE_COVERAGE=on \
     -DBUILD_SHARED_LIBS="${BUILD_SHARED_LIBS:-OFF}" \
     -DCMAKE_INSTALL_PREFIX=${HOME}/.local \
     ${CMAKE_PREFIX_PATH:+"-DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}"} \
@@ -83,4 +84,7 @@ echo "unix: ${SOCK}" > examples/FeatureShowcase/features/step_definitions/cucumb
 (cd examples/FeatureShowcase; cucumber)
 wait %
 
+mkdir -p coverage
+gcovr build/ --html-details --output coverage/index.html --xml coverage/cobertura.xml
+
 cmake --build build --target install