__zstd-bundle-fallback.yml

# 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 - Zstandard bundle fallback
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  GO111MODULE: auto
on:
  push:
    branches:
      - main
      - releases/v*
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
      - ready_for_review
  schedule:
    - cron: '0 5 * * *'
  workflow_dispatch: {}
jobs:
  zstd-bundle-fallback:
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: macos-latest
            version: linked
          - os: windows-latest
            version: linked
          - os: ubuntu-latest
            version: linked
    name: Zstandard bundle fallback
    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: >-
          runner.os == 'macOS' && (

          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'
          setup-kotlin: 'true'
      - name: Remove CodeQL from toolcache
        uses: actions/github-script@v7
        with:
          script: |
            const fs = require('fs');
            const path = require('path');
            const codeqlPath = path.join(process.env['RUNNER_TOOL_CACHE'], 'CodeQL');
            fs.rmdirSync(codeqlPath, { recursive: true });
      - id: init
        uses: ./../action/init
        with:
          languages: javascript
          tools: ${{ steps.prepare-test.outputs.tools-url }}
      - uses: ./../action/analyze
        with:
          output: ${{ runner.temp }}/results
          upload-database: false
      - name: Upload SARIF
        uses: actions/upload-artifact@v3
        with:
          name: zstd-bundle.sarif
          path: ${{ runner.temp }}/results/javascript.sarif
          retention-days: 7
      - name: Check expected diagnostics
        uses: actions/github-script@v7
        env:
          SARIF_PATH: ${{ runner.temp }}/results/javascript.sarif
        with:
          script: |
            const fs = require('fs');

            const sarif = JSON.parse(fs.readFileSync(process.env['SARIF_PATH'], 'utf8'));
            const run = sarif.runs[0];

            const toolExecutionNotifications = run.invocations[0].toolExecutionNotifications;
            const downloadTelemetryNotifications = toolExecutionNotifications.filter(n =>
              n.descriptor.id === 'codeql-action/bundle-download-telemetry'
            );
            if (downloadTelemetryNotifications.length !== 1) {
              core.setFailed(
                'Expected exactly one reporting descriptor in the ' +
                  `'runs[].invocations[].toolExecutionNotifications[]' SARIF property, but found ` +
                  `${downloadTelemetryNotifications.length}. All notification reporting descriptors: ` +
                  `${JSON.stringify(toolExecutionNotifications)}.`
              );
            }

            const toolsUrl = downloadTelemetryNotifications[0].properties.attributes.toolsUrl;
            console.log(`Found tools URL: ${toolsUrl}`);

            if (!toolsUrl.endsWith('.tar.gz')) {
              core.setFailed(
                `Expected the tools URL to be a .tar.gz file, but found '${toolsUrl}'.`
              );
            }

            const zstdFailureReason = downloadTelemetryNotifications[0].properties.attributes.zstdFailureReason;
            console.log(`Found zstd failure reason: ${zstdFailureReason}`);

            const expectedZstdFailureReason = 'Failing since CODEQL_ACTION_FORCE_ZSTD_FAILURE is true.';
            if (zstdFailureReason !== expectedZstdFailureReason) {
              core.setFailed(
                `Expected the zstd failure reason to be '${expectedZstdFailureReason}', but found '${zstdFailureReason}'.`
              );
            }
    env:
      CODEQL_ACTION_ZSTD_BUNDLE: true
      CODEQL_ACTION_FORCE_ZSTD_FAILURE: true
      CODEQL_ACTION_TEST_MODE: true