ci_hardware_options.yaml

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: 'CI: hardware options tests'
run-name: Test with instruction set extensions and parallelism

on:
  push:
    branches:
      - master
      - main

  pull_request:
    types: [opened, synchronize]

  merge_group:
    types:
      - checks_requested

  workflow_dispatch:
    inputs:
      debug:
        description: 'Run with debugging options'
        type: boolean
        default: true

permissions: read-all

concurrency:
  # Cancel any previously-started but still active runs on the same branch.
  cancel-in-progress: true
  group: ${{github.workflow}}-${{github.event.pull_request.number||github.ref}}

jobs:
  find-changes:
    name: Find changed files
    uses: ./.github/workflows/reusable_find_changes.yaml
    secrets: inherit

  test-options:
    # For efficiency, skip this workflow if there were no code file changes.
    if: needs.find-changes.outputs.code || github.event_name == 'workflow_dispatch'
    name: Test ${{matrix.hardware_opt}} + ${{matrix.parallel_opt}}
    needs: find-changes
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    strategy:
      matrix:
        # Hardware optimizers.
        hardware_opt: [avx, sse, basic]
        # Optimizers for parallelism.
        parallel_opt: [openmp, nopenmp]
    env:
      # Must use explicit test for true so it works when inputs.debug is null.
      use-verbose: ${{github.event.inputs.debug == true}}
    steps:
      - name: Check out a copy of the git repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
        with:
          fetch-depth: 1
          submodules: recursive

      - name: Set up Bazel with caching
        uses: bazel-contrib/setup-bazel@8d2cb86a3680a820c3e219597279ce3f80d17a47 # 0.15.0
        with:
          disk-cache: ${{github.workflow}}
          bazelisk-cache: true
          external-cache: true
          repository-cache: true

      - name: Set up Python with caching of pip dependencies
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: '3.12'
          cache: pip
          cache-dependency-path: |
            requirements.txt
            dev-requirements.txt

      - name: Install qsim development dependencies
        run: |
          pip install -r requirements.txt
          pip install -r dev-requirements.txt

      - name: Run C++ tests
        run: |
          bazel test \
              --config=${{matrix.hardware_opt}} \
              --config=${{matrix.parallel_opt}} \
              ${{env.use-verbose && '--config=verbose'}} \
              tests:all

      - name: Run sample simulation
        run: |
          bazel run \
              --config=${{matrix.hardware_opt}} \
              --config=${{matrix.parallel_opt}} \
              ${{env.use-verbose && '--config=verbose'}} \
              apps:qsim_base -- -c circuits/circuit_q24