test.yaml

# Copyright 2025 LiveKit, Inc.
#
# 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.

name: Test

on:
  workflow_dispatch:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

      - name: Set up SoX resampler and Opus
        run: |
          sudo apt-get update
          sudo apt-get install -y libsoxr-dev libopus-dev libopusfile-dev opus-tools

      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: 1.26
          # setup-go's own cache restores on an exact key only, so any go.sum
          # change is a full cold build. Restored below instead.
          cache: false

      # The run_id suffix never pre-exists, so a push always writes a fresh
      # entry rather than one frozen at the go.sum that first created it.
      - name: Restore Go caches
        id: go-cache
        uses: actions/cache/restore@v4
        with:
          path: |
            ~/.cache/go-build
            ~/go/pkg/mod
          key: go-${{ runner.os }}-${{ hashFiles('go.sum') }}-${{ github.run_id }}
          restore-keys: |
            go-${{ runner.os }}-${{ hashFiles('go.sum') }}-
            go-${{ runner.os }}-

      - name: Set up gotestfmt
        run: go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest

      - name: Static Check
        uses: dominikh/staticcheck-action@master
        with:
          install-go: false

      - name: Replace mutexes
        run: |
          go get github.com/sasha-s/go-deadlock
          grep -rl sync.Mutex . | grep .go$ | xargs sed -i 's/sync\.Mutex/deadlock\.Mutex/g'
          grep -rl sync.RWMutex . | grep .go$ | xargs sed -i 's/sync\.RWMutex/deadlock\.RWMutex/g'
          go install golang.org/x/tools/cmd/goimports@latest
          grep -rl deadlock.Mutex . | grep .go$ | xargs goimports -w
          grep -rl deadlock.RWMutex . | grep .go$ | xargs goimports -w
          go mod tidy

      # Run tests with nice formatting. Save the original log in /tmp/gotest.log
      - name: Run tests
        run: |
          set -euo pipefail
          go test -json -v ./... 2>&1 | gotestfmt

      # Only main writes. Pull requests read main's entry, which keeps ~1 GB
      # per PR run out of the repo's 10 GB cache budget.
      - name: Save Go caches
        if: github.event_name == 'push'
        uses: actions/cache/save@v4
        with:
          path: |
            ~/.cache/go-build
            ~/go/pkg/mod
          key: ${{ steps.go-cache.outputs.cache-primary-key }}