run-tests-cpu.yml

# Copyright      2021  Fangjun Kuang (csukuangfj@gmail.com)

# See ../../LICENSE for clarification regarding multiple authors
#
# 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
#
#     http://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.

# refer to https://github.com/actions/starter-workflows/pull/47/files

name: run-tests-cpu

on:
  push:
    branches:
      - master
    paths:
      - '.github/workflows/run-tests-cpu.yml'
      - '.github/scripts/run-test.sh'
      - 'CMakeLists.txt'
      - 'cmake/**'
      - 'k2/csrc/**'
      - 'k2/python/**'
  pull_request:
    types: [labeled]
    paths:
      - '.github/workflows/run-tests-cpu.yml'
      - '.github/scripts/run-test.sh'
      - 'CMakeLists.txt'
      - 'cmake/**'
      - 'k2/csrc/**'
      - 'k2/python/**'
  workflow_dispatch:

concurrency:
  group: run-tests-cpu-${{ github.ref }}
  cancel-in-progress: true

jobs:
  run-tests-cpu:
    runs-on: ${{ matrix.os }}
    name: ${{ matrix.os }} ${{ matrix.torch }} ${{ matrix.python-version }} ${{ matrix.build_type }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest]
        torch: ["2.2.1"]
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
        build_type: ["Release", "Debug"]

    steps:
      # refer to https://github.com/actions/checkout
      - uses: actions/checkout@v2

      - name: Display GCC version
        run: |
          gcc --version

      - name: Display clang version
        if: startsWith(matrix.os, 'macos')
        run: |
          clang --version

      - name: Setup Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Display Python version
        run: python -c "import sys; print(sys.version)"

      - name: Install PyTorch ${{ matrix.torch }}
        if: startsWith(matrix.os, 'ubuntu')
        shell: bash
        run: |
          python3 -m pip install -qq --upgrade pip
          python3 -m pip install -qq wheel twine typing_extensions
          python3 -m pip install -qq torch==${{ matrix.torch }}+cpu -f https://download.pytorch.org/whl/torch_stable.html
          python3 -m pip install -qq dataclasses graphviz
          sudo apt-get -qq install graphviz

          python3 -c "import torch; print('torch version:', torch.__version__)"

          python3 -m torch.utils.collect_env

      - name: Install PyTorch ${{ matrix.torch }}
        if: startsWith(matrix.os, 'macos')
        shell: bash
        run: |
          python3 -m pip install -qq --upgrade pip
          python3 -m pip install -qq wheel twine numpy
          python3 -m pip install -qq torch==${{ matrix.torch }}
          python3 -m pip install -qq dataclasses graphviz
          brew install graphviz

          python3 -m torch.utils.collect_env

      - name: Configure CMake
        shell: bash
        env:
          torch: ${{ matrix.torch }}
        run: |
          pwd
          ./scripts/github_actions/fix_torch.sh
          mkdir build
          cd build
          cmake -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} -DK2_WITH_CUDA=OFF -DCMAKE_CXX_STANDARD=17 ..
          cat k2/csrc/version.h

      - name: ${{ matrix.build_type }} Build
        shell: bash
        run: |
          cd build
          make -j2 VERBOSE=1

      - name: Display Build Information
        shell: bash
        run: |
          export PYTHONPATH=$PWD/k2/python:$PWD/build/lib:$PYTHONPATH
          python3 -m k2.version

      - name: Run Tests
        shell: bash
        run: |
          cd build
          ctest --output-on-failure
          # default log level is INFO
          ./bin/cu_log_test --gtest_filter="Log.Cpu"
          K2_LOG_LEVEL=TRACE ./bin/cu_log_test --gtest_filter="Log.Cpu"
          K2_LOG_LEVEL=DEBUG ./bin/cu_log_test --gtest_filter="Log.Cpu"
          K2_LOG_LEVEL=INFO ./bin/cu_log_test --gtest_filter="Log.Cpu"
          K2_LOG_LEVEL=WARNING ./bin/cu_log_test --gtest_filter="Log.Cpu"
          K2_LOG_LEVEL=ERROR ./bin/cu_log_test --gtest_filter="Log.Cpu"
          K2_LOG_LEVEL=FATAL ./bin/cu_log_test --gtest_filter="Log.Cpu"

      - name: Run C++ API tests
        shell: bash
        run: |
          .github/scripts/run-test.sh