add test ci

Author: sourcehawk

.github/workflows/test.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake build-essential libgtest-dev lcov
+
+      - name: Configure & build (with coverage)
+        run: cmake -S . -B build \
+          -DENABLE_COVERAGE=ON \
+          -DBUILD_TESTING=ON \
+          -DCMAKE_BUILD_TYPE=Debug
+
+      - name: Build
+        run: cmake --build build --parallel
+
+      - name: Zero coverage counters
+        run: lcov --directory build --zerocounters
+
+      - name: Run tests
+        run: ctest --test-dir build --output-on-failure
+
+      - name: Capture coverage
+        run: lcov \
+          --directory build \
+          --capture \
+          --output-file coverage.info
+
+      - name: Filter coverage
+        run: lcov \
+          --remove coverage.info \
+          '/usr/*' '*/test/*' \
+          --output-file coverage.filtered.info
+
+      - name: Generate HTML report
+        run: genhtml coverage.filtered.info --output-directory coverage-report
+
+      - name: Upload coverage-report
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-report
+          path: coverage-report
+
+      # Optional: push to Codecov (requires you set CODECOV_TOKEN in secrets)
+      # - name: Upload to Codecov
+      #   uses: codecov/codecov-action@v3
+      #   with:
+      #     files: coverage.filtered.info
+      #     fail_ci_if_error: true

.gitignore

@@ -1 +1,4 @@
-build
+build
+coverage.filtered.info
+coverage.info
+coverage-report

CMakeLists.txt

@@ -82,6 +82,17 @@ install(
   DESTINATION ${config_package_location}
 )
 
+option(ENABLE_COVERAGE "Enable coverage reporting" OFF)
+if(ENABLE_COVERAGE)
+  message(STATUS "Building with coverage support")
+  # GCC/Clang coverage instrumentation
+  set(CMAKE_CXX_FLAGS        "${CMAKE_CXX_FLAGS}        --coverage -O0 -g")
+  set(CMAKE_C_FLAGS          "${CMAKE_C_FLAGS}          --coverage -O0 -g")
+  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+  set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage")
+endif()
+
+
 option(BUILD_TESTING "Enable unit tests" ON)
 if(BUILD_TESTING)
   enable_testing()

README.md

@@ -30,10 +30,12 @@ To ensure your control unit is supported, please refer to the [Micro Epsilon man
 3. Build the project:
 
    ```bash
-   mkdir build
+   cmake -S . -B build \
+    -DENABLE_COVERAGE=OFF \
+    -DBUILD_TESTING=OFF \
+    -DCMAKE_BUILD_TYPE=Debug
+
    cd build
-   # use flag -DBUILD_TESTING=ON to build the tests
-   cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local
    make
    ```
 
@@ -184,13 +186,22 @@ Where:
 
 ## Development
 
-Install GTest for testing. On ubuntu you can do this with:
+Install GTest and lcov for testing. On ubuntu you can do this with:
 
 ```bash
-sudo apt-get install libgtest-dev
+sudo apt-get install libgtest-dev lcov
 ```
 
-Follow the installation instructions above to set up the project. The library uses CMake for building and testing. To run the tests, ensure you have the `BUILD_TESTING` option enabled in your CMake configuration.
+Build the project:
+
+```bash
+cmake -S . -B build \
+  -DENABLE_COVERAGE=OFF \
+  -DBUILD_TESTING=OFF \
+  -DCMAKE_BUILD_TYPE=Debug
+
+cmake --build build --parallel
+```
 
 Testing:
 

test/test_proximity_sensor_message.cpp

@@ -1,5 +1,4 @@
 #include <gtest/gtest.h>
-// #include <endian.h>
 #include <memory>
 #include "capancdt/proximity_sensor_message.h"