run-codeql-unit-tests-javascript.yml

name: ⚙️ CodeQL - Run Unit Tests (javascript)


on:
  push:
    branches:
      - 'main'
  pull_request:
    branches:
      - 'main'
  workflow_dispatch:

jobs:
  create-unit-test-matrix:
    name: Create CodeQL Unit Test Matrix
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.export-unit-test-matrix.outputs.matrix }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install QLT
        id: install-qlt
        uses: advanced-security/codeql-development-toolkit/.github/actions/install-qlt@main
        with:
          qlt-version: 'latest'
          add-to-path: true

      - name: Export unit test matrix
        id: export-unit-test-matrix
        run: |
          qlt test run get-matrix --os-version ubuntu-latest

  run-test-suites:
    name: Run Unit Tests
    needs: create-unit-test-matrix

    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix: ${{ fromJSON(needs.create-unit-test-matrix.outputs.matrix) }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install QLT
        id: install-qlt
        uses: advanced-security/codeql-development-toolkit/.github/actions/install-qlt@main
        with:
          qlt-version: 'latest'
          add-to-path: true

      - name: Install CodeQL
        id: install-codeql
        shell: bash
        run: |
          echo "Installing CodeQL"
          qlt codeql run install
          echo "-----------------------------"
          echo "CodeQL Home: $QLT_CODEQL_HOME"
          echo "CodeQL Binary: $QLT_CODEQL_PATH"

      - name: Verify Versions of Tooling
        shell: bash
        run: |
          echo -e "Checking CodeQL Version:"
          $QLT_CODEQL_PATH --version

          echo -e "Checking QLT Version:"
          echo "QLT Home: ${{ steps.install-qlt.outputs.qlt-home }}"
          qlt version

      - name: Install QL Packs
        shell: bash
        run: |
          qlt query run install-packs

      - name: Ensure presence of cds shell command
        run: |
          if ! command -v cds &> /dev/null
          then
            ## Workaround for https://github.tools.sap/cap/issues/issues/17840
            npm install -g @sap/cds-dk@8.6.1
          fi

      # Compile .cds files to .cds.json files.
      - name: Compile CAP CDS files
        run: |
          for test_dir in $(find . -type f -name '*.expected' -exec dirname {} \;);
          do
            # The CDS compiler produces locations relative to the working directory
            # so we switch to the test directory before running the compiler.
            pushd $test_dir
            for cds_file in $(find . -type f \( -iname '*.cds' \) -print)
            do
              echo "I am compiling $cds_file"
              _out_path="${cds_file}.json"
              cds compile $cds_file \
                --locations \
                --to json \
                --dest "$_out_path" \
                2> "$cds_file.err"
              # Check if the output is a regular file or a (sub)directory, where
              # files generated in an output directory will need to have the file
              # extension changed from '.json' to '.cds.json', but we don't need
              # to rename anything if the cds compiler just generated a single
              # '.cds.json' file.
              if [ -d "$_out_path" ]
              then
                for json_file in $(find "$_out_path" -type f \( -iname '*.json' \) -print)
                do
                  _new_path="${json_file%.json}.cds.json"
                  echo "Renaming CDS compiler generated JSON file $json_file to $_new_path"
                  mv "$json_file" "$_new_path"
                done
              fi
            done
            popd
          done

      - name: Run test suites
        id: run-test-suites
        env:
          RUNNER_OS: ${{ runner.os }}
          CODEQL_CLI: ${{ matrix.codeql_cli }}
          CODEQL_STDLIB: ${{ matrix.codeql_standard_library }}
          CODEQL_STDLIB_IDENT: ${{matrix.codeql_standard_library_ident}}
          RUNNER_TMP: ${{ runner.temp }}
          LGTM_INDEX_XML_MODE: all
          LGTM_INDEX_FILETYPES: ".json:JSON\n.cds:JSON"

        shell: bash
        run: >
          qlt test run execute-unit-tests
          --codeql-args "--threads=0 --strict-test-discovery"
          --num-threads 2
          --language javascript
          --runner-os $RUNNER_OS
          --work-dir $RUNNER_TMP

      - name: Upload test results
        uses: actions/upload-artifact@v4
        with:
          name: test-results-${{ runner.os }}-${{ matrix.codeql_cli }}-${{ matrix.codeql_standard_library_ident }}
          path: |
            ${{ runner.temp }}/test_report_${{ runner.os }}_${{ matrix.codeql_cli }}_${{ matrix.codeql_standard_library_ident }}_slice_*.json
          if-no-files-found: error

  validate-test-results:
    name: Validate test results
    needs: [run-test-suites]
    runs-on: ubuntu-latest
    steps:

      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install QLT
        id: install-qlt
        uses: advanced-security/codeql-development-toolkit/.github/actions/install-qlt@main
        with:
          qlt-version: 'latest'
          add-to-path: true


      - name: Collect test results
        uses: actions/download-artifact@v4

      - name: Validate test results
        run: |
          qlt test run validate-unit-tests --pretty-print --results-directory . >> $GITHUB_STEP_SUMMARY
          qlt test run validate-unit-tests --results-directory .