regression-test.yml

name: Regression Tests

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

permissions:
  pull-requests: write

jobs:
  regression:
    strategy:
      fail-fast: false
      matrix:
        config:
          - os: ubuntu-latest
            cc: gcc
            cxx: g++
            core: virtualjaguar_libretro.so
            platform: linux-x64

          - os: ubuntu-24.04-arm
            cc: gcc
            cxx: g++
            core: virtualjaguar_libretro.so
            platform: linux-arm64

          - os: macos-latest
            cc: clang
            cxx: clang++
            core: virtualjaguar_libretro.dylib
            platform: macos-arm64

    name: regression-${{ matrix.config.platform }}
    runs-on: ${{ matrix.config.os }}

    steps:
    - uses: actions/checkout@v4

    - name: Install ImageMagick
      run: |
        if [ "$(uname -s)" = "Darwin" ]; then
          brew install imagemagick
        else
          sudo apt-get update -qq && sudo apt-get install -y -qq imagemagick
        fi

    - name: Cache miniretro
      id: cache-miniretro
      uses: actions/cache@v4
      with:
        path: miniretro-bin
        key: miniretro-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('.github/workflows/regression-test.yml') }}

    - name: Build miniretro
      if: steps.cache-miniretro.outputs.cache-hit != 'true'
      run: |
        git clone --depth 1 https://github.com/davidgfnet/miniretro.git /tmp/miniretro-src
        LDFLAGS="-ldl"
        if [ "$(uname -s)" = "Darwin" ]; then LDFLAGS=""; fi
        ${{ matrix.config.cxx }} -O2 -Wall -Wno-deprecated-declarations -Wno-unused-result \
          -o miniretro-bin \
          /tmp/miniretro-src/miniretro.cc \
          /tmp/miniretro-src/util.cc \
          /tmp/miniretro-src/loader.cc \
          $LDFLAGS

    - name: Build core
      run: make -j4 CC=${{ matrix.config.cc }} CXX=${{ matrix.config.cxx }}

    - name: Run regression tests
      run: |
        export MINIRETRO_BIN="$(pwd)/miniretro-bin"
        export DIFF_DIR="$(pwd)/regression-diffs"
        chmod +x "${MINIRETRO_BIN}"
        ./test/regression_test.sh ./${{ matrix.config.core }}

    - name: Run SRAM interface tests
      run: ./test/sram_test.sh ./${{ matrix.config.core }}

    - name: Upload diff artifacts
      if: failure()
      uses: actions/upload-artifact@v4
      with:
        name: regression-diffs-${{ matrix.config.platform }}
        path: regression-diffs/
        if-no-files-found: ignore

    - name: Comment on PR with results
      if: always() && github.event_name == 'pull_request'
      continue-on-error: true
      uses: actions/github-script@v7
      with:
        script: |
          const fs = require('fs');
          const path = 'regression-diffs/summary.md';
          if (!fs.existsSync(path)) return;

          const summary = fs.readFileSync(path, 'utf8');
          const platform = '${{ matrix.config.platform }}';

          // Paginate to find existing comment even on busy PRs
          const comments = await github.paginate(
            github.rest.issues.listComments,
            {
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
              per_page: 100,
            }
          );
          const marker = `<!-- regression-${platform} -->`;
          const existing = comments.find(c => c.body.includes(marker));

          const hasDiffs = fs.readdirSync('regression-diffs').some(f => f.endsWith('_diff.png'));
          const body = `${marker}\n### Regression: \`${platform}\`\n\n${summary}\n\n` +
            (hasDiffs
              ? `> :warning: Visual diffs uploaded as artifacts — download \`regression-diffs-${platform}\` to inspect.\n`
              : '') +
            `\n<sub>Updated by CI at ${new Date().toISOString()}</sub>`;

          if (existing) {
            await github.rest.issues.updateComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              comment_id: existing.id,
              body,
            });
          } else {
            await github.rest.issues.createComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
              body,
            });
          }