fixup! ci: Run static code analysis

Author: ltoenning

.github/workflows/build.yml

@@ -33,6 +33,7 @@ jobs:
     if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository }}
     outputs:
       version: ${{ steps.version.outputs.value }}
+      should_run: ${{ steps.check_static_analysis.outputs.should_run }}
 
     steps:
       - name: Checkout repository
@@ -43,6 +44,15 @@ jobs:
         id: version
         run: |
           echo "value=$(python3 -u scripts/utils.py --version)" >>$GITHUB_OUTPUT
+      - name: Check if static analysis is required
+        id: check_static_analysis
+        run: |
+          python3 -u scripts/run_static_analysis.py --check-changed-files
+          if [ $? -eq 0 ]; then
+            echo "should_run=true" >> $GITHUB_OUTPUT
+          else
+            echo "should_run=false" >> $GITHUB_OUTPUT
+          fi
       - name: Remove artifacts
         uses: swift-project/delete-artifact@swift
         with:
@@ -106,9 +116,58 @@ jobs:
         with:
           path: docs/html/
 
+  staticAnalysis:
+    runs-on: ubuntu-22.04
+    needs: [ preBuild, checks ]
+    if: ${{ needs.preBuild.outputs.should_run == 'true' }}
+    steps:
+      - name: Install Qt
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: ${{ env.qt_version }}
+          modules: 'qtmultimedia'
+          cache: true
+      - name: Install dependencies
+        run: |
+          sudo apt-get -y install dbus-x11 libglu1-mesa-dev libpulse-dev libdbus-1-dev ninja-build
+          pip3 install requests conan
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0
+      - name: Checkout externals
+        if: ${{ env.use_externals == 'true' }}
+        uses: actions/checkout@v4
+        env:
+          EXTERNALS_PAT: ${{ secrets.EXTERNALS_PAT }}
+        with:
+          repository: ${{ env.externals }}
+          ref: ${{ env.externals_sha }}
+          token: ${{ env.EXTERNALS_PAT }}
+          path: 'third_party/externals'
+      - name: Install conan dependencies
+        shell: bash
+        env:
+          ARTIFACTORY_USER: ${{ secrets.ARTIFACTORY_USER }}
+          ARTIFACTORY_TOKEN: ${{ secrets.ARTIFACTORY_TOKEN }}
+        run: |
+          conan profile detect
+          conan remote disable conancenter
+          conan remote add swift https://artifactory.swift-project.org/artifactory/api/conan/conan-local
+          conan remote login swift "$ARTIFACTORY_USER" --password "$ARTIFACTORY_TOKEN"
+          conan install . --output-folder=build_conan --deployer=full_deploy -pr=ci/profile_linux
+      - name: Install conan dependencies
+        shell: bash
+        run: |
+          mkdir build && pushd build
+          cmake .. --preset ci-build-linux-no-pch
+          popd ..
+          python3 scripts/run_static_analysis.py --clang-tidy --build-path build --changed-files-ci
+
   buildLinux:
     runs-on: ubuntu-22.04
-    needs: [preBuild, checks]
+    needs: [preBuild, checks, staticAnalysis]
     env:
       BACKTRACE_SYMBOL_TOKEN: ${{ secrets.BACKTRACE_SYMBOL_TOKEN }}
       BACKTRACE_MINIDUMP_TOKEN: ${{ secrets.BACKTRACE_MINIDUMP_TOKEN }}
@@ -218,7 +277,7 @@ jobs:
 
   buildWin64:
     runs-on: windows-2022
-    needs: [preBuild, checks]
+    needs: [preBuild, checks, staticAnalysis]
     env:
       BACKTRACE_SYMBOL_TOKEN: ${{ secrets.BACKTRACE_SYMBOL_TOKEN }}
       BACKTRACE_MINIDUMP_TOKEN: ${{ secrets.BACKTRACE_MINIDUMP_TOKEN }}
@@ -329,7 +388,7 @@ jobs:
 
   buildMacOS:
     runs-on: macos-13
-    needs: [preBuild, checks]
+    needs: [preBuild, checks, staticAnalysis]
     env:
       BACKTRACE_SYMBOL_TOKEN: ${{ secrets.BACKTRACE_SYMBOL_TOKEN }}
       BACKTRACE_MINIDUMP_TOKEN: ${{ secrets.BACKTRACE_MINIDUMP_TOKEN }}
@@ -438,7 +497,7 @@ jobs:
 
   postBuild:
     runs-on: ubuntu-22.04
-    needs: [preBuild, checks, buildLinux, buildWin64, buildMacOS]
+    needs: [preBuild, checks, staticAnalysis, buildLinux, buildWin64, buildMacOS]
 
     steps:
       - name: Download xswiftbus-thin

scripts/run_static_analysis.py

@@ -14,6 +14,13 @@
 import os
 import subprocess
 
+# Currently we are not checking all directories as they might need to run compilation first for Qt UIC
+CHECK_DIRECTORIES = [
+    "src/core",
+    "src/misc",
+    "src/input"
+]
+
 
 def _get_all_files(build_path: str) -> list[str]:
     src_path = utils.get_swift_source_path()
@@ -23,11 +30,21 @@ def _get_all_files(build_path: str) -> list[str]:
         commands = json.load(f)
     commands = set([os.path.relpath(entry["file"], utils.get_swift_source_path()) for entry in commands])
 
-    commands = [command for command in commands if not command.startswith("third_party") and not command.startswith(build_path)]
+    commands = [command for command in commands if not command.startswith("third_party") and not command.startswith(build_path) and command.startswith("src/misc/network/role.cpp")]
     return commands
 
+def _get_all_files_ci(build_path: str) -> list[str]:
+    src_path = utils.get_swift_source_path()
+    os.chdir(src_path)
 
-def _get_changed_files(build_path: str) -> set[str]:
+    with open(os.path.join(build_path, "compile_commands.json"), 'r') as f:
+        commands = json.load(f)
+    commands = set([os.path.relpath(entry["file"], utils.get_swift_source_path()) for entry in commands])
+
+    commands = [command for command in commands if command.startswith(tuple(CHECK_DIRECTORIES))]
+    return commands
+
+def _get_changed_files_ci(build_path: str) -> set[str]:
     src_path = utils.get_swift_source_path()
     os.chdir(src_path)
 
@@ -42,14 +59,13 @@ def _get_changed_files(build_path: str) -> set[str]:
     commands = set([os.path.relpath(entry["file"], utils.get_swift_source_path()) for entry in commands])
 
     files = set([line for line in result.stdout.splitlines() if
-                 (line.endswith('.cpp') or line.endswith('.h')) and not line.startswith(
-                     'tests') and not line.startswith('samples') and not line.startswith("third_party") and not line.startswith(build_path)])
+                 (line.endswith('.cpp') or line.endswith('.h')) and line.startswith(tuple(CHECK_DIRECTORIES))])
     return files & commands
 
 
 def run_clang_tidy(build_path: str, changed_source_files: set[str]):
     print(f"Run clang-tidy on files: {changed_source_files}")
-    nproc = os.cpu_count()
+    nproc = 10
     try:
         subprocess.run([
             'xargs',
@@ -60,6 +76,7 @@ def run_clang_tidy(build_path: str, changed_source_files: set[str]):
             '-p', build_path,
             '--warnings-as-errors', '*',
             '--quiet',
+            #'--header-filter', '*',
             '--header-filter', f'{utils.get_swift_source_path()}/src/',
         ], input='\n'.join(changed_source_files), text=True, check=True)
     except CalledProcessError:
@@ -89,6 +106,8 @@ def main():
     parser.add_argument("--build-path", required=True, help='Path to build folder')
     parser.add_argument("--all-files", action="store_true",
                         help="Run check on all files in build database")
+    parser.add_argument("--files-ci", action="store_true",
+                        help="Run check on specific files in build database which are also used in CI")
 
     parser.add_argument("--clang-tidy", action="store_true",
                         help="Run clang-tidy checks")
@@ -98,8 +117,11 @@ def main():
 
     if args.all_files:
         source_files = _get_all_files(args.build_path)
+    elif args.files_ci:
+        source_files = _get_all_files_ci(args.build_path)
     else:
-        source_files = _get_changed_files(args.build_path)
+        source_files = _get_changed_files_ci(args.build_path)
+
     if args.clang_tidy:
         run_clang_tidy(args.build_path, source_files)
     elif args.clazy: