.github/workflows/twister.yaml

name: Run tests with twister

on:
  push:
    branches:
      - main
      - v*-branch
      - collab-*
  pull_request:
    branches:
      - main
      - v*-branch
      - collab-*
  schedule:
    # Run at 02:00 UTC on every Sunday
    - cron: '0 2 * * 0'

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

jobs:
  twister-build-prep:
    if: github.repository_owner == 'zephyrproject-rtos'
    runs-on:
      group: zephyr-runner-v2-linux-x64-4xlarge
    timeout-minutes: 60
    container:
      image: ghcr.io/zephyrproject-rtos/ci-repo-cache:v0.29.2.20260422
      options: '--entrypoint /bin/bash'
    outputs:
      subset: ${{ steps.output-services.outputs.subset }}
      size: ${{ steps.output-services.outputs.size }}
      fullrun: ${{ steps.output-services.outputs.fullrun }}
      testplan: ${{ steps.test-plan.outputs.has_testplan }}
    env:
      MATRIX_SIZE: 10
      PUSH_MATRIX_SIZE: 30
      WEEKLY_MATRIX_SIZE: 200
      TESTS_PER_BUILDER: 900
      BASE_REF: ${{ github.base_ref }}
    steps:
      - name: Print cloud service information
        run: |
          echo "ZEPHYR_RUNNER_CLOUD_PROVIDER = ${ZEPHYR_RUNNER_CLOUD_PROVIDER}"
          echo "ZEPHYR_RUNNER_CLOUD_NODE = ${ZEPHYR_RUNNER_CLOUD_NODE}"
          echo "ZEPHYR_RUNNER_CLOUD_POD = ${ZEPHYR_RUNNER_CLOUD_POD}"

      - name: Apply container owner mismatch workaround
        run: |
          # FIXME: The owner UID of the GITHUB_WORKSPACE directory may not
          #        match the container user UID because of the way GitHub
          #        Actions runner is implemented. Remove this workaround when
          #        GitHub comes up with a fundamental fix for this problem.
          git config --global --add safe.directory ${GITHUB_WORKSPACE}

      - name: Clone cached Zephyr repository
        continue-on-error: true
        run: |
          git clone --shared /repo-cache/zephyrproject/zephyr .
          git remote set-url origin ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}

      - name: Checkout
        if: github.event_name == 'pull_request'
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0
          persist-credentials: false

      # Only needed on pull requests, where the test plan is generated below.
      # On push/schedule the matrix size is fixed and needs no west workspace.
      # Runs before the Python setup so requirements are installed from the
      # rebased tree.
      - name: Set up Zephyr environment
        if: github.event_name == 'pull_request'
        uses: ./.github/actions/zephyr-ci-env
        with:
          group-filter: '+ci,'
          base-ref: ${{ github.base_ref }}
          run-checks: 'true'

      - name: Set up Python
        if: github.event_name == 'pull_request'
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: 3.12
          cache: pip
          cache-dependency-path: scripts/requirements-actions.txt

      - name: install-packages
        if: github.event_name == 'pull_request'
        run: |
          pip install -r scripts/requirements-actions.txt --require-hashes

      - name: Generate Test Plan with Twister
        if: github.event_name == 'pull_request'
        id: test-plan
        run: |
          export ZEPHYR_BASE=${PWD}
          export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
          python3 scripts/ci/test_plan_v2.py -c origin/${BASE_REF}.. \
            --tests-per-builder $TESTS_PER_BUILDER \
            --disable-strategy  BoilerplateFilter
          if [ -s .testplan ]; then
            cat .testplan >> $GITHUB_ENV
          else
            echo "TWISTER_NODES=${MATRIX_SIZE}" >> $GITHUB_ENV
          fi
          if [ -f testplan.json ]; then
            echo "has_testplan=true" >> $GITHUB_OUTPUT
          else
            echo "has_testplan=false" >> $GITHUB_OUTPUT
          fi
          rm -f .testplan

      - name: Upload Test Plan
        if: github.event_name == 'pull_request' && steps.test-plan.outputs.has_testplan == 'true'
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: testplan
          if-no-files-found: error
          path: testplan.json

      - name: Determine matrix size
        id: output-services
        run: |
          if [ "${{github.event_name}}" = "push" ]; then
            subset="[$(seq -s',' 1 ${PUSH_MATRIX_SIZE})]"
            size=${MATRIX_SIZE}
          elif [ "${{github.event_name}}" = "pull_request" ]; then
            if [ -n "${TWISTER_NODES}" ]; then
              subset="[$(seq -s',' 1 ${TWISTER_NODES})]"
            else
              subset="[$(seq -s',' 1 ${MATRIX_SIZE})]"
            fi
            size=${TWISTER_NODES}
          elif [ "${{github.event_name}}" = "schedule" -a "${{github.repository}}" = "zephyrproject-rtos/zephyr" ]; then
            subset="[$(seq -s',' 1 ${WEEKLY_MATRIX_SIZE})]"
            size=${WEEKLY_MATRIX_SIZE}
          else
            subset='[]'
            size=0
          fi

          echo "subset=${subset}" >> $GITHUB_OUTPUT
          echo "size=${size}" >> $GITHUB_OUTPUT
          echo "fullrun=${TWISTER_FULL}" >> $GITHUB_OUTPUT

  twister-build:
    runs-on:
      group: zephyr-runner-v2-linux-x64-4xlarge
    needs: twister-build-prep
    if: needs.twister-build-prep.outputs.size != 0
    container:
      image: ghcr.io/zephyrproject-rtos/ci-repo-cache:v0.29.2.20260422
      options: '--entrypoint /bin/bash'
    strategy:
      fail-fast: false
      matrix:
        subset: ${{fromJSON(needs.twister-build-prep.outputs.subset)}}
    timeout-minutes: ${{ github.event_name == 'schedule' && 1440 || 120 }}
    env:
      CCACHE_DIR: /node-cache/ccache-zephyr
      CCACHE_REMOTE_STORAGE: "redis://cache-*.keydb-cache.svc.cluster.local|shards=1,2,3"
      CCACHE_REMOTE_ONLY: "true"
      # `--specs` is ignored because ccache is unable to resolve the toolchain specs file path.
      CCACHE_IGNOREOPTIONS: '-specs=* --specs=*'
      BSIM_OUT_PATH: /opt/bsim/
      BSIM_COMPONENTS_PATH: /opt/bsim/components
      TWISTER_COMMON: ' --test-config tests/test_config_ci.yaml --force-color --inline-logs -v -N -M --retry-failed 3 --timeout-multiplier 2 --post-build-checks '
      WEEKLY_OPTIONS: ' -M --build-only --all --show-footprint --report-filtered -j 32'
      PR_OPTIONS: ' --clobber-output --integration -j 16'
      PUSH_OPTIONS: ' --clobber-output -M --show-footprint --report-filtered -j 16'
      LLVM_TOOLCHAIN_PATH: /usr/lib/llvm-20
    steps:
      - name: Print cloud service information
        run: |
          echo "ZEPHYR_RUNNER_CLOUD_PROVIDER = ${ZEPHYR_RUNNER_CLOUD_PROVIDER}"
          echo "ZEPHYR_RUNNER_CLOUD_NODE = ${ZEPHYR_RUNNER_CLOUD_NODE}"
          echo "ZEPHYR_RUNNER_CLOUD_POD = ${ZEPHYR_RUNNER_CLOUD_POD}"

      - name: Apply container owner mismatch workaround
        run: |
          # FIXME: The owner UID of the GITHUB_WORKSPACE directory may not
          #        match the container user UID because of the way GitHub
          #        Actions runner is implemented. Remove this workaround when
          #        GitHub comes up with a fundamental fix for this problem.
          git config --global --add safe.directory ${GITHUB_WORKSPACE}

      - name: Clone cached Zephyr repository
        continue-on-error: true
        run: |
          git clone --shared /repo-cache/zephyrproject/zephyr .
          git remote set-url origin ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}

      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0
          persist-credentials: false

      - name: Set up Zephyr environment
        uses: ./.github/actions/zephyr-ci-env
        with:
          group-filter: '+ci,+optional,+testing'
          base-ref: ${{ github.base_ref }}
          run-checks: 'true'

      - name: Install Python packages
        run: |
          pip install -r scripts/requirements-actions.txt --require-hashes
          west packages pip --install

      - name: Set up ccache
        run: |
          mkdir -p ${CCACHE_DIR}
          ccache -M 10G
          ccache -p
          ccache -z -s -vv

      - name: Update BabbleSim to manifest revision
        run: |
          export BSIM_VERSION=$( west list bsim -f {revision} )
          echo "Manifest points to bsim sha $BSIM_VERSION"
          cd /opt/bsim_west/bsim
          git fetch -n origin ${BSIM_VERSION}
          git -c advice.detachedHead=false checkout ${BSIM_VERSION}
          west update
          make everything -s -j 8

      - name: Download Test Plan
        if: github.event_name == 'pull_request' && needs.twister-build-prep.outputs.testplan == 'true'
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: testplan
          path: .

      - name: Run Tests with Twister
        id: run_twister
        run: |
          export ZEPHYR_BASE=${PWD}
          export ZEPHYR_TOOLCHAIN_VARIANT=zephyr

          # Select the per-event twister options and, for pull requests, load
          # the pre-computed test plan.
          LOAD_TESTS=""
          case "${{ github.event_name }}" in
            push)
              OPTIONS="${PUSH_OPTIONS}"
              ;;
            schedule)
              OPTIONS="${WEEKLY_OPTIONS}"
              ;;
            pull_request)
              OPTIONS="${PR_OPTIONS}"
              # testplan.json is only present when targeted tests were
              # selected; without it there is nothing to run.
              if [ ! -f testplan.json ]; then
                echo "No testplan.json - nothing to run."
                exit 0
              fi
              LOAD_TESTS="--load-tests testplan.json"
              ;;
          esac

          ./scripts/twister --subset ${{matrix.subset}}/${{ strategy.job-total }} ${LOAD_TESTS} ${TWISTER_COMMON} ${OPTIONS}

          # Module tests run once, on the first subset. On pull requests they
          # only run for a full run.
          if [ "${{matrix.subset}}" = "1" ]; then
            run_modules=true
            if [ "${{ github.event_name }}" = "pull_request" ] && \
               [ "${{ needs.twister-build-prep.outputs.fullrun }}" != "True" ]; then
              run_modules=false
            fi
            if [ "${run_modules}" = "true" ]; then
              ./scripts/zephyr_module.py --twister-out module_tests.args
              if [ -s module_tests.args ]; then
                ./scripts/twister +module_tests.args --outdir module_tests ${TWISTER_COMMON} ${OPTIONS}
              fi
            fi
          fi

      - name: Print ccache stats
        if: always()
        run: |
          ccache -s -vv

      - name: Upload Unit Test Results
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: Unit Test Results (Subset ${{ matrix.subset }})
          if-no-files-found: ignore
          path: |
            twister-out/twister.xml
            twister-out/twister.json
            module_tests/twister.xml
            testplan.json

  twister-test-results:
    name: "Publish Unit Tests Results"
    needs:
      - twister-build
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    permissions:
      checks: write # to create the check run entry with Twister test results
    # the build-and-test job might be skipped, we don't need to run this job then
    if: success() || failure()

    steps:
      - name: Check out source code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: 3.12
          cache: pip
          cache-dependency-path: scripts/requirements-actions.txt

      - name: Install Python packages
        run: |
          pip install -r scripts/requirements-actions.txt --require-hashes

      - name: Download Artifacts
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          path: artifacts

      - name: Merge Test Results
        run: |
          python ./scripts/ci/merge_junit.py junit.xml 'artifacts/*/twister.xml' 'artifacts/*/*/twister.xml'
          junit2html junit.xml junit.html

      - name: Upload Unit Test Results
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: Unit Test Results
          if-no-files-found: ignore
          path: |
            junit.html
            junit.xml

      - name: Upload test results to Codecov
        if: ${{ !cancelled() && (github.event_name == 'push') }}
        uses: codecov/test-results-action@0fa95f0e1eeaafde2c782583b36b28ad0d8c77d3 # v1.2.1
        with:
          token: ${{ secrets.CODECOV_TOKEN }}

      - name: Publish Unit Test Results
        uses: EnricoMi/publish-unit-test-result-action@d0a4676d0e0b938bc201470d88276b7c74c712b3 # v2.24.0
        with:
          check_name: Unit Test Results
          files: "**/twister.xml"
          comment_mode: off

      - name: Analyze Twister Reports
        if: needs.twister-build.result == 'failure'
        run: |
          ./scripts/ci/twister_report_analyzer.py artifacts/*/*/twister.json --long-summary --platforms --output-md errors.md
          if [[ -s "errors.md" ]]; then
            echo '### Error Summary! 🚀' >> $GITHUB_STEP_SUMMARY
            cat errors.md  >> $GITHUB_STEP_SUMMARY
          fi

      - name: Upload Twister Analysis Results
        if: needs.twister-build.result == 'failure'
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: Twister Analysis Results
          if-no-files-found: ignore
          path: |
            twister_report_summary.json

  twister-status-check:
    if: always()
    name: "Check Twister Status"
    needs:
      - twister-build-prep
      - twister-build
    uses: ./.github/workflows/ready-to-merge.yml
    with:
      needs_context: ${{ toJson(needs) }}