zz-jason · zz-jason · Dec 23, 2023 · Dec 22, 2023 · Dec 22, 2023 · Dec 22, 2023
diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml
@@ -1,4 +1,4 @@
-name: C/C++ CI
+name: CI
 
 on:
   push:
@@ -9,28 +9,42 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    name: Debug Test
     steps:
-    - name: Set up GCC
-      uses: egor-tensin/setup-gcc@v1
-      with:
-        version: 12
-        platform: x64
 
     - name: Check out repository
       uses: actions/checkout@v3
 
+    - name: Setup GCC
+      uses: Dup4/actions-setup-gcc@v1
+      with:
+        version: 12
+
     - name: Install dependencies
-      run: sudo apt install -y libaio-dev
+      run: sudo apt install -y libaio-dev gcovr
 
     - name: Config project
-      run: cmake -B build -S .
+      run: cmake -B build/debug -S . -DCMAKE_BUILD_TYPE=Debug -DBUILD_WITH_COVERAGE=ON
 
     - name: Build project
-      run: cmake --build build -j `nproc`
+      run: cmake --build build/debug -j `nproc`
+
+    - name: Test
+      run: ctest --test-dir build/debug
 
-    - name: Test test
-      run: ctest --test-dir build --output-on-failure
+    - name: Generate coverage file
+      run: gcovr -v -r . --json-pretty --json=coverage.json --xml-pretty --xml=coverage.xml --exclude 'build/*' --exclude 'tests/*'
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v3
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      with:
+        files: coverage.xml
+        verbose: true
 
     - name: Setup tmate session
-      if: ${{ failure() }}
       uses: mxschmitt/action-tmate@v3
+      if: ${{ failure() }}
+      with:
+        limit-access-to-actor: true
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -9,12 +9,25 @@ if (NOT UNIX)
     message(SEND_ERROR "unsupported platform")
 endif ()
 
+# Define custom build options
+option(BUILD_WITH_COVERAGE "Build the library with code coverage" OFF)
+
+option(THIRD_PARTY_SRC_DIR "The directory to store downloaded third-party sources" "${CMAKE_CURRENT_BINARY_DIR}/third-party-src")
+if(NOT THIRD_PARTY_SRC_DIR)
+  set(THIRD_PARTY_SRC_DIR ${CMAKE_CURRENT_BINARY_DIR}/third-party-src)
+endif()
+message(STATUS "THIRD_PARTY_SRC_DIR: ${THIRD_PARTY_SRC_DIR}")
+
+
 enable_language(ASM)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread -rdynamic -fno-omit-frame-pointer -g3 -static-libstdc++")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wunused -Wunreachable-code")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
+if(BUILD_WITH_COVERAGE)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --coverage -g -O0")
+endif()
+
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 if (CMAKE_SYSTEM_PROCESSOR MATCHES "(x86)|(X86)|(amd64)|(AMD64)")

diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
+[![CI](https://github.com/zz-jason/leanstore/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/zz-jason/leanstore/actions/workflows/c-cpp.yml)
+[![codecov](https://codecov.io/github/zz-jason/leanstore/graph/badge.svg?token=MBS1H361JJ)](https://codecov.io/github/zz-jason/leanstore)
+
 # LeanStore
 
 [LeanStore](https://db.in.tum.de/~leis/papers/leanstore.pdf) is a
@@ -17,8 +20,8 @@ hope to make it usable in production in the future.
 
 ```sh
 # install dependencies
-sudo apt-get update
-sudo apt-get install -y libaio-dev
+sudo apt update
+sudo apt install -y libaio-dev gcovr lcov
 
 # build
 cmake -DCMAKE_BUILD_TYPE=Debug -B build -S .

diff --git a/cmake/Modules/LeanStoreAddExternalHeaderOnlyLib.cmake b/cmake/Modules/LeanStoreAddExternalHeaderOnlyLib.cmake
@@ -6,6 +6,7 @@ function(leanstore_add_ext_header_only_lib TARGET_NAME GIT_REPO GIT_TAG)
     set(LIB_INCLUDE_DIR ${CMAKE_CURRENT_BINARY_DIR}/third-party)
     set(TARGET_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME}-src)
     ExternalProject_Add(${TARGET_NAME}_internal
+        SOURCE_DIR ${THIRD_PARTY_SRC_DIR}/${TARGET_NAME}_src
         PREFIX ${TARGET_PREFIX}
         GIT_REPOSITORY ${GIT_REPO}
         GIT_TAG ${GIT_TAG}

diff --git a/cmake/Modules/LeanStoreAddExternalLib.cmake b/cmake/Modules/LeanStoreAddExternalLib.cmake
@@ -6,6 +6,7 @@ function(leanstore_add_ext_lib TARGET_NAME LIB_NAME GIT_REPO GIT_TAG)
     set(TARGET_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME}-src)
     set(TARGET_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME})
     ExternalProject_Add(${TARGET_NAME}_internal
+        SOURCE_DIR ${THIRD_PARTY_SRC_DIR}/${TARGET_NAME}_src
         PREFIX ${TARGET_PREFIX}
         GIT_REPOSITORY ${GIT_REPO}
         GIT_TAG ${GIT_TAG}

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,6 +1,8 @@
 include(GoogleTest)
 enable_testing()
 
+set(TEST_EXECUTABLES "")
+
 # Define a cmake function to add a test file linked with Google Test
 function(leanstore_add_test TARGET_NAME)
   add_executable(
@@ -13,8 +15,9 @@ function(leanstore_add_test TARGET_NAME)
     gtest
     leanstore
   )
-  target_compile_options(${TARGET_NAME} PRIVATE -fprofile-arcs -ftest-coverage)
   gtest_discover_tests(${TARGET_NAME})
+  list(APPEND TEST_EXECUTABLES ${TARGET_NAME})
+
 endfunction(leanstore_add_test)
 
 function(leanstore_add_test_without_gtest_main TARGET_NAME)
@@ -27,8 +30,8 @@ function(leanstore_add_test_without_gtest_main TARGET_NAME)
     gtest
     leanstore
   )
-  target_compile_options(${TARGET_NAME} PRIVATE -fprofile-arcs -ftest-coverage)
   gtest_discover_tests(${TARGET_NAME})
+  list(APPEND TEST_EXECUTABLES ${TARGET_NAME})
 endfunction(leanstore_add_test_without_gtest_main)
 
 
@@ -37,4 +40,13 @@ leanstore_add_test(BTreeLLTest)
 leanstore_add_test(BTreeVILoggingAndRecoveryTest)
 leanstore_add_test(BufferFrameTest)
 
-leanstore_add_test_without_gtest_main(BTreeVITest)
+leanstore_add_test_without_gtest_main(BTreeVITest)
+
+# # for code coverages
+# if(BUILD_WITH_COVERAGE)
+#   add_custom_target(coverage
+#       COMMAND gcovr -r . --json-pretty -json coverage.json --xml-pretty -xml coverage.xml --exclude 'build/*' --exclude 'tests/*'
+#       COMMENT "Generating code coverage reports"
+#       DEPENDS ${TEST_EXECUTABLES}
+#   )
+# endif()
diff --git a/third-party/gbench.cmake b/third-party/gbench.cmake
@@ -5,6 +5,7 @@ set(GIT_TAG v1.8.3)
 set(TARGET_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME}-src)
 set(TARGET_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME})
 ExternalProject_Add(${TARGET_NAME}_internal
+    SOURCE_DIR ${THIRD_PARTY_SRC_DIR}/${TARGET_NAME}_src
     PREFIX ${TARGET_PREFIX}
     GIT_REPOSITORY ${GIT_REPO}
     GIT_TAG ${GIT_TAG}

diff --git a/third-party/gtest.cmake b/third-party/gtest.cmake
@@ -5,6 +5,7 @@ set(GIT_TAG v1.14.0)
 set(TARGET_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME}-src)
 set(TARGET_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME})
 ExternalProject_Add(${TARGET_NAME}_internal
+    SOURCE_DIR ${THIRD_PARTY_SRC_DIR}/${TARGET_NAME}_src
     PREFIX ${TARGET_PREFIX}
     GIT_REPOSITORY ${GIT_REPO}
     GIT_TAG ${GIT_TAG}

diff --git a/third-party/onetbb.cmake b/third-party/onetbb.cmake
@@ -10,6 +10,7 @@ set(GIT_TAG v2021.11.0)
 set(TARGET_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME}-src)
 set(TARGET_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME})
 ExternalProject_Add(${TARGET_NAME}_internal
+    SOURCE_DIR ${THIRD_PARTY_SRC_DIR}/${TARGET_NAME}_src
     PREFIX ${TARGET_PREFIX}
     GIT_REPOSITORY ${GIT_REPO}
     GIT_TAG ${GIT_TAG}

diff --git a/third-party/prometheus-cpp.cmake b/third-party/prometheus-cpp.cmake
@@ -9,6 +9,7 @@ set(GIT_TAG v1.1.0)
 set(TARGET_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME}-src)
 set(TARGET_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/third-party/${TARGET_NAME})
 ExternalProject_Add(${TARGET_NAME}_internal
+    SOURCE_DIR ${THIRD_PARTY_SRC_DIR}/${TARGET_NAME}_src
     PREFIX ${TARGET_PREFIX}
     GIT_REPOSITORY ${GIT_REPO}
     GIT_TAG ${GIT_TAG}