ci: support coverage report (#1)

.github/workflows/build.yml

@@ -49,7 +49,7 @@ jobs:
         sudo apt-get update
         sudo apt-get install -qq libgflags-dev \
             libprotobuf-dev libprotoc-dev protobuf-compiler \
-            libleveldb-dev libgoogle-perftools-dev
+            libleveldb-dev libgoogle-perftools-dev lcov
         sudo apt-get install libgtest-dev && cd /usr/src/gtest && sudo env "PATH=$PATH" cmake . && sudo make && sudo mv ./lib/libgtest* /usr/lib/
     - name: Install bazel
       if: ${{ matrix.build_tool == 'bazel' }}
@@ -62,20 +62,43 @@ jobs:
     - name: Build with cmake
       if: ${{ matrix.build_tool == 'cmake' }}
       run: |
-        cmake -S "${{ github.workspace }}" -B "${{ env.CMAKE_BUILD_DIR }}" -DWITH_TESTS=ON
+        cmake -S "${{ github.workspace }}" -B "${{ env.CMAKE_BUILD_DIR }}" -DWITH_TESTS=ON -DWITH_COVERAGE=ON
         cmake --build bld  --parallel 16 -- brpc-static
         cmake --build "${{ env.CMAKE_BUILD_DIR }}" --parallel 16
+
     - name: Build with bazel
       if: ${{ matrix.build_tool == 'bazel' }}
       run: |
         ~/.bazel/bin/bazel build -c opt --copt -DHAVE_ZLIB=1 //...
+
     - name: Run Tests
       if: ${{ matrix.with_test }}
       id: test-braft
       working-directory: ${{ github.workspace }}/bld/test
       run: |
         ulimit -c unlimited -S
         sh ../../test/run_tests.sh
+
+    - name: Coverage
+      if: ${{ matrix.with_test   && matrix.compiler == 'gcc' }}
+      working-directory: ${{ github.workspace }}
+      run: |
+        # generate coverage report
+        lcov --capture --directory .  --output-file coverage.info --no-external
+        # only keep braft/src files
+        lcov --extract coverage.info '*/src/braft/*' --output-file coverage.info
+        # report
+        lcov --list coverage.info
+
+    - uses: codecov/codecov-action@v4
+      if: ${{ matrix.with_test   && matrix.compiler == 'gcc' }}
+      with:
+        fail_ci_if_error: true # optional (default = false)
+        files: ./coverage.info # optional
+        name: codecov-umbrella # optional
+        token: ${{ secrets.CODECOV_TOKEN }} # required
+        verbose: true # optional (default = false)
+
     - name: Collect failure info
       if: ${{ steps.test-braft.conclusion == 'failure'}}
       run: |

CMakeLists.txt

@@ -13,6 +13,7 @@ option(WITH_DEBUG_SYMBOLS "With debug symbols" ON)
 # suppress this  CMP0058 warning
 cmake_policy(SET CMP0058 OLD)
 option(WITH_TESTS "Whether to build unit tests" OFF)
+option(WITH_COVERAGE "Whether build with coverage report" OFF)
 
 set(WITH_GLOG_VAL "0")
 if(BRPC_WITH_GLOG)
@@ -232,7 +233,7 @@ add_subdirectory(src)
 if(WITH_TESTS)
     add_subdirectory(test)
 endif()
-add_subdirectory(tools)
+# add_subdirectory(tools)
 
 file(COPY ${CMAKE_CURRENT_BINARY_DIR}/braft/
         DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/output/include/braft/

README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/baidu/braft.svg?branch=master)](https://travis-ci.org/baidu/braft)
+![build status](https://github.com/ehds/mbraft/actions/workflows/build.yml/badge.svg\?branch=main)
+[![codecov](https://codecov.io/gh/ehds/mbraft/graph/badge.svg?token=TCS003M7RA)](https://codecov.io/gh/ehds/mbraft)
 
 ---
 
@@ -47,7 +48,3 @@ It's widely used inside Baidu to build highly-available systems, such as:
   * [Paxos](./docs/cn/paxos_protocol.md)
   * [ZAB](./docs/cn/zab_protocol.md)
   * [QJM](./docs/cn/qjm.md)
-
-# Discussion
-
-* Add Weixin id ***zhengpf__87*** or ***xiongk_2049*** with a verification message '**braft**', then you will be invited into the discussion group. 

src/CMakeLists.txt

@@ -12,6 +12,11 @@ include_directories(${CMAKE_SOURCE_DIR}/src)
 add_library(OBJ_LIB OBJECT ${SOURCES})
 
 set_property(TARGET ${OBJ_LIB} PROPERTY POSITION_INDEPENDENT_CODE 1)
+
+if(WITH_TESTS AND WITH_COVERAGE)
+    target_compile_options(OBJ_LIB PRIVATE -g -O0 --coverage -fprofile-arcs -ftest-coverage)
+endif()
+
 add_library(braft-shared SHARED $<TARGET_OBJECTS:OBJ_LIB>)
 add_library(braft-static STATIC $<TARGET_OBJECTS:OBJ_LIB>)
 target_link_libraries(braft-shared ${DYNAMIC_LIB})

test/CMakeLists.txt

@@ -8,26 +8,42 @@ include_directories(${CMAKE_SOURCE_DIR}/test)
 set(CMAKE_CPP_FLAGS "-DGFLAGS_NS=${GFLAGS_NS}")
 set(CMAKE_CPP_FLAGS "${CMAKE_CPP_FLAGS} -D__const__=__unused__ -D_GNU_SOURCE -DUSE_SYMBOLIZE -DNO_TCMALLOC -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -D__STDC_CONSTANT_MACROS -DUNIT_TEST -g -Dprivate=public -Dprotected=public -D__STRICT_ANSI__ -include sstream_workaround.h")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CPP_FLAGS} -O2 -pipe -Wall -W -fPIC -fstrict-aliasing -Wno-invalid-offsetof -Wno-unused-parameter -fno-omit-frame-pointer -Wno-unused-result")
-use_cxx11()
+
+if (WITH_COVERAGE)
+    if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
+        link_libraries(gcov)
+    else()
+        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+    endif()
+
+endif()
 
 # bthread_* functions are used in logging.cc, and they need to be marked as
 # weak symbols explicitly in Darwin system.
 if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
     set(DYNAMIC_LIB ${DYNAMIC_LIB}
-        "-Wl,-U,_bthread_getspecific"
-        "-Wl,-U,_bthread_setspecific"
-        "-Wl,-U,_bthread_key_create")
+        pthread
+        "-framework CoreFoundation"
+        "-framework CoreGraphics"
+        "-framework CoreData"
+        "-framework CoreText"
+        "-framework Security"
+        "-framework Foundation"
+        "-Wl,-U,_MallocExtension_ReleaseFreeMemory"
+        "-Wl,-U,_ProfilerStart"
+        "-Wl,-U,_ProfilerStop"
+        "-Wl,-U,__Z13GetStackTracePPvii")
 endif()
 
 file(GLOB TEST_BRAFT_SRCS "test_*.cpp")
 foreach(BRAFT_UT ${TEST_BRAFT_SRCS})
     get_filename_component(BRAFT_UT_WE ${BRAFT_UT} NAME_WE)
-    add_executable(${BRAFT_UT_WE} ${BRAFT_UT} 
-                   $<TARGET_OBJECTS:OBJ_LIB>)
+    add_executable(${BRAFT_UT_WE} ${BRAFT_UT})
     target_link_libraries(${BRAFT_UT_WE}
                           ${GTEST_MAIN_LIB}
                           ${GTEST_LIB}
                           ${GPERFTOOLS_LIBRARY}
                           ${DYNAMIC_LIB}
+                          $<TARGET_OBJECTS:OBJ_LIB>
                           )
 endforeach()