Add code-coverage GitHub action

eclipse-openbsw · Nov 18, 2024 · cd34715 · cd34715
1 parent ee26225
commit cd34715
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 20 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -27,4 +27,4 @@ jobs:
       run: |
           cmake -B cmake-build-unit-tests -S executables/unitTest -DBUILD_UNIT_TESTS=ON
           cmake --build cmake-build-unit-tests -j4
-          ctest --test-dir cmake-build-unit-tests -j4
+          ctest --test-dir cmake-build-unit-tests -j4
diff --git a/.github/workflows/code-coverage.yml b/.github/workflows/code-coverage.yml
@@ -1,6 +1,6 @@
 name: Code Coverage Report
 
-on: [push, pull_request]
+on: [workflow_call,push, pull_request]
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
@@ -14,23 +14,23 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    # - name: Update package list
-    #   run: sudo apt update
+
     - name: Setup cmake
       uses: jwlawson/actions-setup-cmake@v2
       with:
         cmake-version: '3.22.x'
+
     - name: Test
       # Execute tests defined by the CMake configuration.
       run: |
-          cmake -B cmake-build-unit-tests -S executables/unitTest -DBUILD_UNIT_TESTS=ON
+          cmake -B cmake-build-unit-tests -S executables/unitTest -DBUILD_UNIT_TESTS=ON -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
           cmake --build cmake-build-unit-tests -j4
           ctest --test-dir cmake-build-unit-tests -j4
     
-    #Code coverage 
     - name: Install lcov
       run: sudo apt install lcov
 
+    # no-external command excludes the system libraries in the root directory 
     - name: Capture code coverage
       run: |
         echo "Capturing code coverage..."
@@ -53,13 +53,15 @@ jobs:
         echo "Generating HTML coverage report..."
         genhtml cmake-build-unit-tests/coverage.info \
                  --output-directory cmake-build-unit-tests/coverage
+    
+
+    - name: Zip the coverage report
+      run: |
+        mv  cmake-build-unit-tests/coverage code_coverage
+        zip -r code_coverage.zip code_coverage
 
-    - name: Deploy to GitHub Pages
-      uses: peaceiris/actions-gh-pages@v4
+    - name: Upload code coverage artifact
+      uses: actions/upload-artifact@v4
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: cmake-build-unit-tests/coverage
-        destination_dir: code-coverage
-        force_orphan: false    
-
-
+        name: code_coverage
+        path: code_coverage.zip
diff --git a/.github/workflows/doc-publish.yml b/.github/workflows/doc-publish.yml
@@ -12,9 +12,12 @@ jobs:
   build-sphinx-docs:
     uses: ./.github/workflows/sphinx-doc-build.yml
 
+  build-code-coverage:
+    uses: ./.github/workflows/code-coverage.yml
+
   publish-docs:
     runs-on: ubuntu-latest
-    needs: build-sphinx-docs
+    needs: [build-sphinx-docs, build-code-coverage]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -31,6 +34,18 @@ jobs:
           unzip sphinx_docs.zip
           rm sphinx_docs.zip
 
+      - name: Download Code coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: code_coverage
+          path: ./doc/github_pages
+
+      - name: Unzip Code coverage report
+        working-directory: ./doc/github_pages
+        run: |
+          unzip code_coverage.zip
+          rm code_coverage.zip
+
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
         with:

diff --git a/README.md b/README.md
@@ -54,10 +54,6 @@ allowing developers to get up and running quickly.
 The [documentation](https://eclipse-openbsw.github.io/openbsw)
 describes Eclipse OpenBSW in detail and provides simple setup guides to build and use it.
 
-## Code coverage
-
-Code coverage report [here](https://esrlabs.github.io/openbsw/coverage/index.html)
-
 ## Contributing
 
 It is expected that this respository will be used as a starting point for many custom developments.

diff --git a/doc/github_pages/index.html b/doc/github_pages/index.html
@@ -10,7 +10,7 @@ <h2><a href="sphinx_docs/doc/index.html">Welcome to Eclipse OpenBSW</a></h2>
     <h3><a href="doxygenOut/html/index.html">Doxygen-generated API docs</a></h3>
     <h3>Coverage reports</h3>
     <ul>
-        <li><a href="code_coverage_url">Code coverage report</a></li>
+        <li><a href="code-coverage/index.html">Code coverage report</a></li>
         <li><a href="api_doc_coverage_url">API doc coverage report</a></li>
     </ul>
   </body>