Merge remote-tracking branch 'origin/releases/v3' into backport-v2.24.1-e675ced7a

.github/workflows/__build-mode-autobuild.yml

@@ -0,0 +1,88 @@
+# Warning: This file is generated automatically, and should not be modified.
+# Instead, please modify the template in the pr-checks directory and run:
+#     (cd pr-checks; pip install ruamel.yaml@0.17.31 && python3 sync.py)
+# to regenerate this file.
+
+name: PR Check - Build mode autobuild
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  GO111MODULE: auto
+  CODEQL_EXTRACTOR_JAVA_AGENT_DISABLE_KOTLIN: 'true'
+on:
+  push:
+    branches:
+    - main
+    - releases/v*
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+    - ready_for_review
+  workflow_dispatch: {}
+jobs:
+  build-mode-autobuild:
+    strategy:
+      matrix:
+        include:
+        - os: ubuntu-latest
+          version: nightly-latest
+    name: Build mode autobuild
+    permissions:
+      contents: read
+      security-events: write
+    timeout-minutes: 45
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Setup Python on MacOS
+      uses: actions/setup-python@v5
+      if: >-
+        matrix.os == 'macos-latest' && (
+
+        matrix.version == 'stable-20221211' ||
+
+        matrix.version == 'stable-20230418' ||
+
+        matrix.version == 'stable-v2.13.5' ||
+
+        matrix.version == 'stable-v2.14.6')
+      with:
+        python-version: '3.11'
+    - name: Check out repository
+      uses: actions/checkout@v4
+    - name: Prepare test
+      id: prepare-test
+      uses: ./.github/actions/prepare-test
+      with:
+        version: ${{ matrix.version }}
+        use-all-platform-bundle: 'false'
+    - name: Set environment variable for Swift enablement
+      if: runner.os != 'Windows' && matrix.version == '20221211'
+      shell: bash
+      run: echo "CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT=true" >> $GITHUB_ENV
+    - name: Set up Java test repo configuration
+      run: |
+        mv * .github ../action/tests/multi-language-repo/
+        mv ../action/tests/multi-language-repo/.github/workflows .github
+        mv ../action/tests/java-repo/* .
+
+    - uses: ./../action/init
+      id: init
+      with:
+        build-mode: autobuild
+        db-location: ${{ runner.temp }}/customDbLocation
+        languages: java
+        tools: ${{ steps.prepare-test.outputs.tools-url }}
+
+    - name: Validate database build mode
+      run: |
+        metadata_path="$RUNNER_TEMP/customDbLocation/java/codeql-database.yml"
+        build_mode=$(yq eval '.buildMode' "$metadata_path")
+        if [[ "$build_mode" != "autobuild" ]]; then
+          echo "Expected build mode to be 'autobuild' but was $build_mode"
+          exit 1
+        fi
+
+    - uses: ./../action/analyze
+    env:
+      CODEQL_ACTION_TEST_MODE: true

.github/workflows/__build-mode-manual.yml

@@ -0,0 +1,90 @@
+# Warning: This file is generated automatically, and should not be modified.
+# Instead, please modify the template in the pr-checks directory and run:
+#     (cd pr-checks; pip install ruamel.yaml@0.17.31 && python3 sync.py)
+# to regenerate this file.
+
+name: PR Check - Build mode manual
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  GO111MODULE: auto
+  CODEQL_EXTRACTOR_JAVA_AGENT_DISABLE_KOTLIN: 'true'
+on:
+  push:
+    branches:
+    - main
+    - releases/v*
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+    - ready_for_review
+  workflow_dispatch: {}
+jobs:
+  build-mode-manual:
+    strategy:
+      matrix:
+        include:
+        - os: ubuntu-latest
+          version: nightly-latest
+    name: Build mode manual
+    permissions:
+      contents: read
+      security-events: write
+    timeout-minutes: 45
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Setup Python on MacOS
+      uses: actions/setup-python@v5
+      if: >-
+        matrix.os == 'macos-latest' && (
+
+        matrix.version == 'stable-20221211' ||
+
+        matrix.version == 'stable-20230418' ||
+
+        matrix.version == 'stable-v2.13.5' ||
+
+        matrix.version == 'stable-v2.14.6')
+      with:
+        python-version: '3.11'
+    - name: Check out repository
+      uses: actions/checkout@v4
+    - name: Prepare test
+      id: prepare-test
+      uses: ./.github/actions/prepare-test
+      with:
+        version: ${{ matrix.version }}
+        use-all-platform-bundle: 'false'
+    - name: Set environment variable for Swift enablement
+      if: runner.os != 'Windows' && matrix.version == '20221211'
+      shell: bash
+      run: echo "CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT=true" >> $GITHUB_ENV
+    - uses: ./../action/init
+      id: init
+      with:
+        build-mode: manual
+        db-location: ${{ runner.temp }}/customDbLocation
+        languages: java
+        tools: ${{ steps.prepare-test.outputs.tools-url }}
+
+    - name: Validate database build mode
+      run: |
+        metadata_path="$RUNNER_TEMP/customDbLocation/java/codeql-database.yml"
+        build_mode=$(yq eval '.buildMode' "$metadata_path")
+        if [[ "$build_mode" != "manual" ]]; then
+          echo "Expected build mode to be 'manual' but was $build_mode"
+          exit 1
+        fi
+
+    - uses: ./../action/.github/actions/setup-swift
+      with:
+        codeql-path: ${{ steps.init.outputs.codeql-path }}
+
+    - name: Build code
+      shell: bash
+      run: ./build.sh
+
+    - uses: ./../action/analyze
+    env:
+      CODEQL_ACTION_TEST_MODE: true

.github/workflows/__build-mode-none.yml

@@ -79,7 +79,10 @@ jobs:
           exit 1
         fi
 
+  # The latest nightly supports omitting the autobuild Action when the build mode is specified.
     - uses: ./../action/autobuild
+      if: matrix.version != 'nightly-latest'
+
     - uses: ./../action/analyze
     env:
       CODEQL_ACTION_TEST_MODE: true

.github/workflows/__config-export.yml

@@ -101,13 +101,13 @@ jobs:
             core.setFailed('`codeqlConfigSummary` property not found in the SARIF run property bag.');
           }
           if (configSummary.disableDefaultQueries !== false) {
-            core.setFailed('`disableDefaultQueries` property incorrect: expected false, got ' + 
+            core.setFailed('`disableDefaultQueries` property incorrect: expected false, got ' +
               `${JSON.stringify(configSummary.disableDefaultQueries)}.`);
           }
           const expectedQueries = [{ type: 'builtinSuite', uses: 'security-extended' }];
           // Use JSON.stringify to deep-equal the arrays.
           if (JSON.stringify(configSummary.queries) !== JSON.stringify(expectedQueries)) {
-            core.setFailed(`\`queries\` property incorrect: expected ${JSON.stringify(expectedQueries)}, got ` + 
+            core.setFailed(`\`queries\` property incorrect: expected ${JSON.stringify(expectedQueries)}, got ` +
               `${JSON.stringify(configSummary.queries)}.`);
           }
           core.info('Finished config export tests.');

.github/workflows/__diagnostics-export.yml

@@ -136,7 +136,7 @@ jobs:
             core.setFailed(
               'Expected exactly one status page reporting descriptor for this diagnostic in the ' +
                 `'runs[].invocations[].toolExecutionNotifications[]' SARIF property, but found ` +
-                `${statusPageNotifications.length}. All notification reporting descriptors: ` + 
+                `${statusPageNotifications.length}. All notification reporting descriptors: ` +
                 `${JSON.stringify(toolExecutionNotifications)}.`
             );
           }

.github/workflows/__multi-language-autodetect.yml

@@ -146,7 +146,7 @@ jobs:
 
     - name: Check language autodetect for Swift
       if: >-
-        env.CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT == 'true' || 
+        env.CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT == 'true' ||
             (runner.os != 'Windows' && matrix.version == 'nightly-latest')
       shell: bash
       run: |

.github/workflows/__with-checkout-path.yml

@@ -25,48 +25,12 @@ jobs:
     strategy:
       matrix:
         include:
-        - os: ubuntu-latest
-          version: stable-20221211
-        - os: macos-latest
-          version: stable-20221211
-        - os: windows-latest
-          version: stable-20221211
-        - os: ubuntu-latest
-          version: stable-20230418
-        - os: macos-latest
-          version: stable-20230418
-        - os: windows-latest
-          version: stable-20230418
-        - os: ubuntu-latest
-          version: stable-v2.13.5
-        - os: macos-latest
-          version: stable-v2.13.5
-        - os: windows-latest
-          version: stable-v2.13.5
-        - os: ubuntu-latest
-          version: stable-v2.14.6
-        - os: macos-latest
-          version: stable-v2.14.6
-        - os: windows-latest
-          version: stable-v2.14.6
-        - os: ubuntu-latest
-          version: default
-        - os: macos-latest
-          version: default
-        - os: windows-latest
-          version: default
         - os: ubuntu-latest
           version: latest
         - os: macos-latest
           version: latest
         - os: windows-latest
           version: latest
-        - os: ubuntu-latest
-          version: nightly-latest
-        - os: macos-latest
-          version: nightly-latest
-        - os: windows-latest
-          version: nightly-latest
     name: Use a custom `checkout_path`
     permissions:
       contents: read
@@ -120,7 +84,6 @@ jobs:
       # it's enough to test one compiled language and one interpreted language
         languages: csharp,javascript
         source-root: x/y/z/some-path/tests/multi-language-repo
-        debug: true
 
     - name: Build code
       shell: bash

.github/workflows/debug-artifacts-failure.yml

@@ -20,15 +20,12 @@ on:
   workflow_dispatch: {}
 jobs:
   upload-artifacts:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
     name: Upload debug artifacts after failure in analyze
     continue-on-error: true
     env:
       CODEQL_ACTION_TEST_MODE: true
     timeout-minutes: 45
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - name: Dump GitHub event
         run: cat "${GITHUB_EVENT_PATH}"
@@ -67,27 +64,24 @@ jobs:
       - name: Check expected artifacts exist
         shell: bash
         run: |
-          OPERATING_SYSTEMS="ubuntu-latest macos-latest"
           LANGUAGES="cpp csharp go java javascript python"
-          for os in $OPERATING_SYSTEMS; do
-            pushd "./my-debug-artifacts-$os"
-            echo "Artifacts from run on $os:"
-            for language in $LANGUAGES; do
-              echo "- Checking $language"
-              if [[ ! -f "my-db-$language-partial.zip" ]] ; then
-                echo "Missing a partial database bundle for $language"
-                exit 1
-              fi
-              if [[ ! -d "log" ]] ; then
-                echo "Missing database initialization logs"
-                exit 1
-              fi
-              if [[ ! "$language" == "go" ]] && [[ ! -d "$language/log" ]] ; then
-                echo "Missing logs for $language"
-                exit 1
-              fi
-            done
-            popd
+          pushd "./my-debug-artifacts"
+          echo "Artifacts from run:"
+          for language in $LANGUAGES; do
+            echo "- Checking $language"
+            if [[ ! -f "my-db-$language-partial.zip" ]] ; then
+              echo "Missing a partial database bundle for $language"
+              exit 1
+            fi
+            if [[ ! -d "log" ]] ; then
+              echo "Missing database initialization logs"
+              exit 1
+            fi
+            if [[ ! "$language" == "go" ]] && [[ ! -d "$language/log" ]] ; then
+              echo "Missing logs for $language"
+              exit 1
+            fi
           done
+          popd
         env:
           GO111MODULE: auto

.github/workflows/debug-artifacts.yml

@@ -21,9 +21,6 @@ jobs:
   upload-artifacts:
     strategy:
       matrix:
-        os:
-        - ubuntu-latest
-        - macos-latest
         version:
         - stable-20221211
         - stable-20230418
@@ -36,7 +33,7 @@ jobs:
     env:
       CODEQL_ACTION_TEST_MODE: true
     timeout-minutes: 45
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - name: Check out repository
         uses: actions/checkout@v4
@@ -48,16 +45,6 @@ jobs:
       - uses: actions/setup-go@v5
         with:
           go-version: ^1.13.1
-      - name: Setup Python on MacOS
-        uses: actions/setup-python@v5
-        if: |
-          matrix.os == 'macos-latest' && (
-          matrix.version == 'stable-20221211' ||
-          matrix.version == 'stable-20230418' ||
-          matrix.version == 'stable-v2.13.5' ||
-          matrix.version == 'stable-v2.14.6')
-        with:
-          python-version: '3.11'
       - uses: ./../action/init
         id: init
         with:
@@ -87,26 +74,24 @@ jobs:
           VERSIONS="stable-20221211 stable-20230418 stable-v2.13.5 stable-v2.14.6 default latest nightly-latest"
           LANGUAGES="cpp csharp go java javascript python"
           for version in $VERSIONS; do
-            for os in ubuntu-latest macos-latest; do
-              pushd "./my-debug-artifacts-$os-${version//./}"
-              echo "Artifacts from version $version on $os:"
-              for language in $LANGUAGES; do
-                echo "- Checking $language"
-                if [[ ! -f "$language.sarif" ]] ; then
-                  echo "Missing a SARIF file for $language"
-                  exit 1
-                fi
-                if [[ ! -f "my-db-$language.zip" ]] ; then
-                  echo "Missing a database bundle for $language"
-                  exit 1
-                fi
-                if [[ ! -d "$language/log" ]] ; then
-                  echo "Missing logs for $language"
-                  exit 1
-                fi
-              done
-              popd
+            pushd "./my-debug-artifacts-${version//./}"
+            echo "Artifacts from version $version:"
+            for language in $LANGUAGES; do
+              echo "- Checking $language"
+              if [[ ! -f "$language.sarif" ]] ; then
+                echo "Missing a SARIF file for $language"
+                exit 1
+              fi
+              if [[ ! -f "my-db-$language.zip" ]] ; then
+                echo "Missing a database bundle for $language"
+                exit 1
+              fi
+              if [[ ! -d "$language/log" ]] ; then
+                echo "Missing logs for $language"
+                exit 1
+              fi
             done
+            popd
           done
         env:
           GO111MODULE: auto