refs #13614 - iwyu.yml: run include-what-you-use on macOS [skip ci] (danmar#7275)

Author: firewave

.github/workflows/iwyu.yml

@@ -15,16 +15,20 @@ jobs:
 
     strategy:
       matrix:
-        image: ["fedora:latest"] # "opensuse/tumbleweed:latest" / "fedora:latest" / "debian:unstable" / "archlinux:latest"
-        stdlib: [libstdc++, libc++]
+        # "opensuse/tumbleweed:latest" / "fedora:latest" / "debian:unstable" / "archlinux:latest"
         include:
-          - stdlib: libstdc++
-            use_libcxx: Off
-          - stdlib: libc++
-            use_libcxx: On
+          - os: ubuntu-22.04
+            image: "fedora:latest"
+            stdlib: libstdc++
+          - os: ubuntu-22.04
+            image: "fedora:latest"
+            stdlib: libc++
+          - os: macos-13
+            image: ""
+            stdlib: libc++  # no libstdc++ on macOS
       fail-fast: false
 
-    runs-on: ubuntu-22.04
+    runs-on: ${{ matrix.os }}
     if: ${{ github.repository_owner == 'danmar' }}
 
     container:
@@ -84,6 +88,13 @@ jobs:
           zypper install -y include-what-you-use-tools
           ln -s iwyu_tool.py /usr/bin/iwyu_tool
 
+      # coreutils contains "nproc"
+      - name: Install missing software on macOS
+        if: contains(matrix.os, 'macos')
+        run: |
+          brew install include-what-you-use pcre coreutils
+          ln -s iwyu_tool.py /usr/local/bin/iwyu_tool
+
       # Fails on OpenSUSE:
       # Warning: Failed to restore: Tar failed with error: Unable to locate executable file: tar. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.
       # Also the shell is broken afterwards:
@@ -99,7 +110,7 @@ jobs:
       - name: Prepare CMake
         run: |
           # TODO: why does it build dmake in the next step?
-          cmake -S . -B cmake.output -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DHAVE_RULES=On -DBUILD_TESTS=On -DBUILD_GUI=On -DUSE_QT6=On -DWITH_QCHART=On -DBUILD_TRIAGE=On -DENABLE_CHECK_INTERNAL=On -DCMAKE_GLOBAL_AUTOGEN_TARGET=On -DCMAKE_DISABLE_PRECOMPILE_HEADERS=On -DCPPCHK_GLIBCXX_DEBUG=Off -DUSE_MATCHCOMPILER=Off -DEXTERNALS_AS_SYSTEM=On -DUSE_LIBCXX=${{ matrix.use_libcxx }}
+          cmake -S . -B cmake.output -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DHAVE_RULES=On -DBUILD_TESTS=On -DBUILD_GUI=On -DUSE_QT6=On -DWITH_QCHART=On -DBUILD_TRIAGE=On -DENABLE_CHECK_INTERNAL=On -DCMAKE_GLOBAL_AUTOGEN_TARGET=On -DCMAKE_DISABLE_PRECOMPILE_HEADERS=On -DCPPCHK_GLIBCXX_DEBUG=Off -DUSE_MATCHCOMPILER=Off -DEXTERNALS_AS_SYSTEM=On -DUSE_LIBCXX=${{ matrix.stdlib == 'libc++' }}
         env:
           CC: clang
           CXX: clang++
@@ -121,21 +132,102 @@ jobs:
 
       - name: iwyu_tool
         run: |
-          PWD=$(pwd)
           # -isystem/usr/lib/clang/17/include
           # TODO: remove -stdlib= - it should have been taken from the compilation database
           iwyu_tool -p cmake.output -j $(nproc) -- -w -Xiwyu --max_line_length=1024 -Xiwyu --comment_style=long -Xiwyu --quoted_includes_first -Xiwyu --update_comments -stdlib=${{ matrix.stdlib }} > iwyu.log
 
       - uses: actions/upload-artifact@v4
         if: success() || failure()
         with:
-          name: Compilation Database (include-what-you-use - ${{ matrix.stdlib }})
+          name: Compilation Database (include-what-you-use - ${{ matrix.os }} ${{ matrix.stdlib }})
+          path: ./cmake.output/compile_commands.json
+
+      - uses: actions/upload-artifact@v4
+        if: success() || failure()
+        with:
+          name: Logs (include-what-you-use - ${{ matrix.os }} ${{ matrix.stdlib }})
+          path: ./*.log
+
+  clang-include-cleaner:
+
+    strategy:
+      matrix:
+        stdlib: [libstdc++, libc++]
+      fail-fast: false
+
+    runs-on: ubuntu-22.04
+    if: ${{ github.repository_owner == 'danmar' }}
+
+    env:
+      QT_VERSION: 6.8.1
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install missing software
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake make libpcre3-dev
+          sudo apt-get install -y libgl-dev  # missing dependency for using Qt in CMake
+
+      - name: Install clang
+        run: |
+          sudo apt-get purge --auto-remove llvm python3-lldb-14 llvm-14
+          wget https://apt.llvm.org/llvm.sh
+          chmod +x llvm.sh
+          sudo ./llvm.sh 19
+          sudo apt-get install -y clang-tools-19
+
+      - name: Install libc++
+        if: matrix.stdlib == 'libc++'
+        run: |
+          sudo apt-get install -y libc++-19-dev
+
+      - name: Install Qt ${{ env.QT_VERSION }}
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: ${{ env.QT_VERSION }}
+          modules: 'qtcharts'
+          install-deps: false
+          cache: true
+
+      - name: Prepare CMake
+        run: |
+          # TODO: why does it build dmake in the next step?
+          cmake -S . -B cmake.output -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DHAVE_RULES=On -DBUILD_TESTS=On -DBUILD_GUI=On -DUSE_QT6=On -DWITH_QCHART=On -DENABLE_CHECK_INTERNAL=On -DCMAKE_GLOBAL_AUTOGEN_TARGET=On -DCMAKE_DISABLE_PRECOMPILE_HEADERS=On -DCPPCHK_GLIBCXX_DEBUG=Off -DUSE_MATCHCOMPILER=Off -DEXTERNALS_AS_SYSTEM=On -DUSE_LIBCXX=${{ matrix.stdlib == 'libc++' }}
+        env:
+          CC: clang-19
+          CXX: clang++-19
+
+      - name: Prepare CMake dependencies
+        run: |
+          # make sure the auto-generated GUI sources exist
+          make -C cmake.output autogen
+          # make sure the precompiled headers exist
+          #make -C cmake.output/cli cmake_pch.hxx.pch
+          #make -C cmake.output/gui cmake_pch.hxx.pch
+          #make -C cmake.output/lib cmake_pch.hxx.pch
+          #make -C cmake.output/test cmake_pch.hxx.pch
+          # make sure the auto-generated GUI dependencies exist
+          make -C cmake.output gui-build-deps
+
+      - name: clang-include-cleaner
+        run: |
+          # TODO: run multi-threaded
+          find $PWD/cli $PWD/lib $PWD/test $PWD/gui -maxdepth 1 -name "*.cpp" | xargs -t -n 1 clang-include-cleaner-19 --print=changes --extra-arg=-w --extra-arg=-stdlib=${{ matrix.stdlib }} -p cmake.output > clang-include-cleaner.log 2>&1
+
+      - uses: actions/upload-artifact@v4
+        if: success() || failure()
+        with:
+          name: Compilation Database (clang-include-cleaner - ${{ matrix.stdlib }})
           path: ./cmake.output/compile_commands.json
 
       - uses: actions/upload-artifact@v4
         if: success() || failure()
         with:
-          name: Logs (include-what-you-use - ${{ matrix.stdlib }})
+          name: Logs (clang-include-cleaner - ${{ matrix.stdlib }})
           path: ./*.log
 
   clang-include-cleaner: