Initial coverage test in GitHub CI

This changelist adds an initial coverage test to GitHub Actions builds, uploading the generated HTML document as a new build artifact.
AcademySoftwareFoundation · Oct 2, 2023 · 7009c6d · 7009c6d
1 parent 6c48683
commit 7009c6d
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 17 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -39,6 +39,14 @@ jobs:
           python: 3.11
           upload_shaders: ON
 
+        - name: Linux_GCC_CoverageAnalysis
+          os: ubuntu-22.04
+          compiler: gcc
+          compiler_version: "None"
+          python: None
+          coverage_analysis: ON
+          cmake_config: -DMATERIALX_COVERAGE_ANALYSIS=ON -DMATERIALX_BUILD_RENDER=OFF -DMATERIALX_BUILD_PYTHON=OFF
+
         - name: Linux_Clang_10_Python37
           os: ubuntu-20.04
           compiler: clang
@@ -120,28 +128,32 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install xorg-dev mesa-utils
-        if [ "${{ matrix.compiler }}" = "gcc" ]; then
-          sudo apt-get install -y g++-${{ matrix.compiler_version }} g++-${{ matrix.compiler_version }}-multilib
-          echo "CC=gcc-${{ matrix.compiler_version }}" >> $GITHUB_ENV
-          echo "CXX=g++-${{ matrix.compiler_version }}" >> $GITHUB_ENV
-        else
-          sudo apt-get install -y clang-${{ matrix.compiler_version }} libc++-${{ matrix.compiler_version }}-dev libc++abi-${{ matrix.compiler_version }}-dev
-          echo "CC=clang-${{ matrix.compiler_version }}" >> $GITHUB_ENV
-          echo "CXX=clang++-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+        if [ "${{ matrix.compiler_version }}" != 'None' ]; then
+          if [ "${{ matrix.compiler }}" = "gcc" ]; then
+            sudo apt-get install -y g++-${{ matrix.compiler_version }} g++-${{ matrix.compiler_version }}-multilib
+            echo "CC=gcc-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+            echo "CXX=g++-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+          else
+            sudo apt-get install -y clang-${{ matrix.compiler_version }} libc++-${{ matrix.compiler_version }}-dev libc++abi-${{ matrix.compiler_version }}-dev
+            echo "CC=clang-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+            echo "CXX=clang++-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+          fi
         fi
 
     - name: Install Dependencies (MacOS)
       if: runner.os == 'macOS'
       run: |
-        if [ "${{ matrix.compiler }}" = "gcc" ]; then
-          brew install gcc@${{ matrix.compiler_version }}
-          echo "CC=gcc-${{ matrix.compiler_version }}" >> $GITHUB_ENV
-          echo "CXX=g++-${{ matrix.compiler_version }}" >> $GITHUB_ENV
-        else
-          ls -ls /Applications/
-          sudo xcode-select -switch /Applications/Xcode_${{ matrix.compiler_version }}.app
-          echo "CC=clang" >> $GITHUB_ENV
-          echo "CXX=clang++" >> $GITHUB_ENV
+        if [ "${{ matrix.compiler_version }}" != 'None' ]; then
+          if [ "${{ matrix.compiler }}" = "gcc" ]; then
+            brew install gcc@${{ matrix.compiler_version }}
+            echo "CC=gcc-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+            echo "CXX=g++-${{ matrix.compiler_version }}" >> $GITHUB_ENV
+          else
+            ls -ls /Applications/
+            sudo xcode-select -switch /Applications/Xcode_${{ matrix.compiler_version }}.app
+            echo "CC=clang" >> $GITHUB_ENV
+            echo "CXX=clang++" >> $GITHUB_ENV
+          fi
         fi
 
     - name: Install Dependencies (Windows)
@@ -222,6 +234,14 @@ jobs:
       run: |
         python python/Scripts/generateshader.py resources/Materials/Examples/StandardSurface --target msl --validator "xcrun metal --language=metal" --validatorArgs="-w"
 
+    - name: Coverage Analysis Tests
+      if: matrix.coverage_analysis == 'ON'
+      run: |
+        sudo apt-get install gcovr
+        mkdir coverage
+        gcovr --html --html-details --output coverage/index.html --exclude .*\/External\/.* --root .. .
+      working-directory: build
+
     - name: Static Analysis Tests
       if: matrix.static_analysis == 'ON' && runner.os == 'Linux'
       run: |
@@ -279,6 +299,13 @@ jobs:
         name: Renders_${{ matrix.name }}
         path: build/render/*.png
 
+    - name: Upload Coverage Report
+      uses: actions/upload-artifact@v3
+      if: matrix.coverage_analysis == 'ON'
+      with:
+        name: MaterialX_Coverage
+        path: build/coverage
+
     - name: JavaScript CMake Generate
       if: matrix.build_javascript == 'ON'
       run: |

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -52,6 +52,7 @@ option(MATERIALX_INSTALL_PYTHON "Install the MaterialX Python package as a third
 option(MATERIALX_INSTALL_RESOURCES "Install the resources folder when building render modules." ON)
 option(MATERIALX_TEST_RENDER "Run rendering tests for MaterialX Render module. GPU required for graphics validation." ON)
 option(MATERIALX_WARNINGS_AS_ERRORS "Interpret all compiler warnings as errors." OFF)
+option(MATERIALX_COVERAGE_ANALYSIS "Build MaterialX libraries with coverage analysis on supporting platforms." OFF)
 option(MATERIALX_DYNAMIC_ANALYSIS "Build MaterialX libraries with dynamic analysis on supporting platforms." OFF)
 option(MATERIALX_OSL_LEGACY_CLOSURES "Build OSL shader generation supporting the legacy OSL closures." ON)
 
@@ -138,6 +139,7 @@ mark_as_advanced(MATERIALX_INSTALL_PYTHON)
 mark_as_advanced(MATERIALX_INSTALL_RESOURCES)
 mark_as_advanced(MATERIALX_TEST_RENDER)
 mark_as_advanced(MATERIALX_WARNINGS_AS_ERRORS)
+mark_as_advanced(MATERIALX_COVERAGE_ANALYSIS)
 mark_as_advanced(MATERIALX_DYNAMIC_ANALYSIS)
 mark_as_advanced(MATERIALX_PYTHON_VERSION)
 mark_as_advanced(MATERIALX_PYTHON_EXECUTABLE)
@@ -228,6 +230,10 @@ else()
     if(MATERIALX_WARNINGS_AS_ERRORS)
         add_compile_options(-Werror)
     endif()
+    if(MATERIALX_COVERAGE_ANALYSIS)
+        add_compile_options(--coverage -O0)
+        add_link_options(--coverage)
+    endif()
     if(MATERIALX_DYNAMIC_ANALYSIS)
         set(DYNAMIC_ANALYSIS_OPTIONS -fsanitize=address -fsanitize=leak -fsanitize=undefined -fno-sanitize-recover=all)
         add_compile_options(${DYNAMIC_ANALYSIS_OPTIONS})