ci_build_library.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: build & test library and apps'
run-name: Build the library on different platforms and run tests

on:
  push:
    branches:
      - 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-in-progress: true
  group: ${{github.workflow}}-${{github.event.pull_request.number||github.ref}}

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

  run-tests:
    if: ${{needs.find-changes.outputs.code == 'true' || inputs.debug}}
    name: Run tests
    needs: find-changes
    runs-on: ${{matrix.conf.os}}
    continue-on-error: true
    timeout-minutes: 60
    strategy:
      fail-fast: false
      matrix:
        conf: [
          {os: ubuntu-24.04, pyarch: x64, py: 10},
          {os: ubuntu-24.04, pyarch: x64, py: 11},
          {os: ubuntu-24.04, pyarch: x64, py: 12},
          {os: ubuntu-24.04, pyarch: x64, py: 13},

          {os: macos-13, pyarch: x64, py: 10},
          {os: macos-13, pyarch: x64, py: 11},
          {os: macos-13, pyarch: x64, py: 12},
          {os: macos-13, pyarch: x64, py: 13},

          {os: macos-14, pyarch: arm64, py: 10},
          {os: macos-14, pyarch: arm64, py: 11},
          {os: macos-14, pyarch: arm64, py: 12},
          {os: macos-14, pyarch: arm64, py: 13},

          {os: macos-15, pyarch: arm64, py: 10},
          {os: macos-15, pyarch: arm64, py: 11},
          {os: macos-15, pyarch: arm64, py: 12},
          {os: macos-15, pyarch: arm64, py: 13},

          {os: windows-2025, pyarch: x64, py: 10},
          {os: windows-2025, pyarch: x64, py: 11},
          {os: windows-2025, pyarch: x64, py: 12},
          {os: windows-2025, pyarch: x64, py: 13},
        ]
    env:
      use-verbose: ${{inputs.debug}}
    steps:
      - if: >-
          ${{needs.find-changes.outputs.code == 'false'
            && github.event_name != 'workflow_dispatch'}}
        name: Exit early if there were no changes to code files
        run: exit 0

      - name: Check out a copy of the git repository
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
        with:
          fetch-depth: 1
          submodules: recursive

      - name: Set up Python with caching of pip dependencies
        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v5
        id: setup
        with:
          python-version: '3.${{matrix.conf.py}}'
          architecture: ${{matrix.conf.pyarch}}
          cache: pip
          cache-dependency-path: |
            requirements.txt
            dev-requirements.txt

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

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

      - if: matrix.conf.os != 'windows-2025'
        name: Run the build and test script (non-Windows case)
        env:
          # Add xtrace to SHELLOPTS for all Bash scripts when doing debug runs.
          SHELLOPTS: ${{inputs.debug && 'xtrace' || '' }}
        run: dev_tools/test_libs.sh ${{env.use-verbose && '--config=verbose'}}

      - if: matrix.conf.os == 'windows-2025'
        name: Run the build and test script (Windows case)
        # On GitHub Windows runners, Bazel ends up finding a different
        # "python3" binary than what's installed by setup-python unless we tell
        # Bazel what to use. Here we do that by setting PYTHON_BIN_PATH.
        env:
          pyroot: 'C:\\hostedtoolcache\\windows\\Python'
          pyexe: '${{steps.setup.outputs.python-version}}\\${{matrix.conf.pyarch}}\\python3.exe'
          SHELLOPTS: ${{env.use-verbose && 'xtrace' || '' }}
        shell: cmd
        run: bash -x dev_tools/test_libs.sh ${{env.use-verbose && '--config=verbose'}} --action_env PYTHON_BIN_PATH=${{env.pyroot}}\\${{env.pyexe}}

  report-results:
    if: always()
    name: ${{github.workflow}}
    needs: run-tests
    runs-on: ubuntu-24.04
    timeout-minutes: 2
    steps:
      - name: Exit with an appropriate status code
        run: |
          result="${{needs.run-tests.result}}"
          [[ "$result" == "success" || "$result" == "skipped" ]]