ci(homebrew): enable test coverage

Author: ReenigneArcher

.github/workflows/ci-homebrew.yml

@@ -49,26 +49,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v5
 
-      - name: Fix homebrew python
-        if: matrix.os_name == 'macos' && matrix.os_version == '13'
+      - name: Fix homebrew cmake  # # see https://github.com/actions/runner-images/issues/12912
+        if: matrix.os_name == 'macos'
         run: |
-          rm '/usr/local/bin/2to3'
-          rm '/usr/local/bin/2to3-3.12'
-          rm '/usr/local/bin/idle3'
-          rm '/usr/local/bin/idle3.12'
-          rm '/usr/local/bin/idle3.13'
-          rm '/usr/local/bin/pip3.12'
-          rm '/usr/local/bin/pip3.13'
-          rm '/usr/local/bin/pydoc3'
-          rm '/usr/local/bin/pydoc3.12'
-          rm '/usr/local/bin/pydoc3.13'
-          rm '/usr/local/bin/python3'
-          rm '/usr/local/bin/python3.12'
-          rm '/usr/local/bin/python3.13'
-          rm '/usr/local/bin/python3-config'
-          rm '/usr/local/bin/python3.12-config'
-          rm '/usr/local/bin/python3.13-config'
-          brew install python3
+          brew uninstall cmake
+          brew untap local/pinned
+          brew install cmake
 
       - name: Configure formula
         env:
@@ -161,36 +147,28 @@ jobs:
           validate: true
       - run: echo "::remove-matcher owner=gcc-strip3::"
 
-      - name: Setup python
-        id: python
-        if: false
-        uses: actions/setup-python@v5
+      # TODO: remove this step
+      - name: Debug upload gcda artifact
+        if: always() && matrix.release != true
+        uses: actions/upload-artifact@v4
         with:
-          python-version: '3.11'
-
-      - name: Generate gcov report
-        id: test_report
-        # any except canceled or skipped
-        # TODO: fix coverage, no .gcno files are being created
-        # TODO: .gcno files are supposed to be created next to .o files
-        if: false
-        # if: >-
-        #   always() &&
-        #   matrix.release != true &&
-        #   (steps.test.outcome == 'success' || steps.test.outcome == 'failure')
+          name: homebrew-gcda-${{ matrix.os_name }}-${{ matrix.os_version }}
+          path: ${{ steps.test.outputs.buildpath }}/build/tests/CMakeFiles/test_sunshine.dir/__/src/audio.cpp.gcda
+
+      # TODO: remove this step
+      - name: Debug homebrew buildpath
+        if: always() && matrix.release != true
         run: |
-          cp -rf ${{ steps.test.outputs.buildpath }}/build/ ./build/
-          cd build
-          ls -Ra
-
-          ${{ steps.python.outputs.python-path }} -m pip install gcovr
-          ${{ steps.python.outputs.python-path }} -m gcovr . -r ../src \
-            --exclude-noncode-lines \
-            --exclude-throw-branches \
-            --exclude-unreachable-branches \
-            --verbose \
-            --xml-pretty \
-            -o coverage.xml
+          # print the build path
+          echo "Build path: ${{ steps.test.outputs.buildpath }}"
+          echo "contents:"
+          ls -Ra ${{ steps.test.outputs.buildpath }}
+
+          # print the test path
+          echo "----"
+          echo "Test path: ${{ steps.test.outputs.testpath }}"
+          echo "contents:"
+          ls -Ra ${{ steps.test.outputs.testpath }}
 
       - name: Upload coverage artifact
         if: >-
@@ -202,8 +180,8 @@ jobs:
         with:
           name: coverage-Homebrew-${{ matrix.os_name }}-${{ matrix.os_version }}
           path: |
-            build/coverage.xml
-            ${{ steps.test.outputs.testpath }}/test_results.xml
+            ${{ steps.test.outputs.testpath }}/coverage.xml
+            ${{ steps.test.outputs.testpath }}/tests/test_results.xml
           if-no-files-found: error
 
       - name: Patch homebrew formula

.github/workflows/ci.yml

@@ -135,15 +135,10 @@ jobs:
       matrix:
         include:
           - name: Linux-AppImage
-            coverage: true
           - name: Homebrew-macos-14
-            coverage: false
           - name: Homebrew-macos-15
-            coverage: false
           - name: Homebrew-ubuntu-latest
-            coverage: false
           - name: Windows-AMD64
-            coverage: true
     steps:
       - name: Checkout
         uses: actions/checkout@v5
@@ -166,7 +161,6 @@ jobs:
 
       - name: Upload coverage
         uses: codecov/codecov-action@v5
-        if: matrix.coverage != false
         with:
           disable_search: true
           fail_ci_if_error: true

packaging/sunshine.rb

@@ -31,17 +31,20 @@ class @PROJECT_NAME@ < Formula
   depends_on "graphviz" => :build
   depends_on "node" => :build
   depends_on "pkgconf" => :build
+  depends_on "gcovr" => :test
   depends_on "curl"
   depends_on "miniupnpc"
   depends_on "openssl"
   depends_on "opus"
   depends_on "icu4c" => :recommended
 
   on_macos do
+    depends_on "llvm" => [:build, :test]
     depends_on xcode: ["15.3", :build]
   end
 
   on_linux do
+    depends_on "gcc@14" => [:build, :test]
     depends_on "avahi"
     depends_on "libayatana-appindicator"
     depends_on "libcap"
@@ -78,6 +81,13 @@ def install
     ENV["BUILD_VERSION"] = "@BUILD_VERSION@"
     ENV["COMMIT"] = "@GITHUB_COMMIT@"
 
+    # Ensure we use GCC 14 consistently on Linux
+    if OS.linux?
+      gcc14 = Formula["gcc@14"]
+      ENV["CC"] = "#{gcc14.opt_bin}/gcc-14"
+      ENV["CXX"] = "#{gcc14.opt_bin}/g++-14"
+    end
+
     args = %W[
       -DBUILD_WERROR=ON
       -DCMAKE_CXX_STANDARD=23
@@ -171,7 +181,35 @@ def caveats
     system bin/"sunshine", "--version"
 
     # run the test suite
-    system bin/"test_sunshine", "--gtest_color=yes", "--gtest_output=xml:test_results.xml"
-    assert_path_exists testpath/"test_results.xml"
+    system bin/"test_sunshine", "--gtest_color=yes", "--gtest_output=xml:tests/test_results.xml"
+    assert_path_exists File.join(testpath, "tests", "test_results.xml")
+
+    # create gcovr report
+    if ENV["HOMEBREW_BUILDPATH"]
+      buildpath = ENV["HOMEBREW_BUILDPATH"]
+
+      # Change to the source directory for gcovr to work properly
+      cd "#{buildpath}/build" do
+        # Use the same GCC version that was used for compilation
+        gcov_executable = "#{Formula["llvm"].opt_bin}/llvm-cov gcov"
+
+        if OS.linux?
+          # Use GCC 14 to match what was used during compilation
+          gcc14 = Formula["gcc@14"]
+          gcov_executable = "#{gcc14.opt_bin}/gcov-14"
+        end
+
+        system "gcovr", ".",
+          "-r", "../src",
+          "--gcov-executable", gcov_executable,
+          "--exclude-noncode-lines",
+          "--exclude-throw-branches",
+          "--exclude-unreachable-branches",
+          "--verbose",  # TODO: remove verbose once working
+          "--xml-pretty",
+          "-o=#{testpath}/coverage.xml"
+      end
+      assert_path_exists File.join(testpath, "coverage.xml")
+    end
   end
 end