tests.yml

name: Tests

on:
  push:
    branches: [main]
  pull_request:
  # So a run can be asked for without pushing something to ask for it.
  workflow_dispatch:

jobs:
  tests:
    name: PHP ${{ matrix.php }}
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        php: ['8.1', '8.2', '8.3', '8.4']
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
        with:
          php-version: ${{ matrix.php }}
          coverage: none

      - uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # 4.0.0

      - name: Unit tests
        run: vendor/bin/unit-tests

  coverage:
    name: Coverage
    runs-on: ubuntu-latest
    env:
      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
        with:
          php-version: '8.3'
          coverage: none

      - uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # 4.0.0

      - name: Unit tests with coverage
        run: phpdbg -qrr vendor/bin/unit-tests

      # Only where the token is there, so a fork or a repository without it still passes.
      - name: SonarCloud
        if: env.SONAR_TOKEN != ''
        # Reporting, not a gate: a token which has expired should not turn a green suite red.
        continue-on-error: true
        uses: SonarSource/sonarqube-scan-action@22918119ff8e1ca75a623e15c8296b6ea4fbe28f # v8.2.1
        env:
          SONAR_HOST_URL: https://sonarcloud.io

  benchmark:
    name: Benchmark
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
        with:
          php-version: '8.4'
          coverage: none

      - uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # 4.0.0

      - name: Build a small application to measure
        run: |
          mkdir -p .benchmark/public
          cat > .benchmark/public/index.php <<'PHP'
          <?php

          require __DIR__ . '/../../vendor/autoload.php';
          require __DIR__ . '/../App.php';

          use Quillstack\Framework\App;
          use Quillstack\Framework\Interfaces\RouteProviderInterface;

          echo json_encode((new App('', [
              RouteProviderInterface::class => Benchmark\Routes::class,
          ]))->run());
          PHP
          cat > .benchmark/App.php <<'PHP'
          <?php

          namespace Benchmark;

          use Psr\Http\Message\ServerRequestInterface;
          use Quillstack\Framework\Interfaces\ControllerInterface;
          use Quillstack\Framework\Interfaces\RouteProviderInterface;
          use Quillstack\Response\Response;
          use Quillstack\Router\Router;

          final class HelloResponse extends Response
          {
              public function send(): array
              {
                  return ['hello' => 'world'];
              }
          }

          final class HelloController implements ControllerInterface
          {
              public function __construct(private readonly HelloResponse $response)
              {
              }

              public function handle(ServerRequestInterface $request): HelloResponse
              {
                  return $this->response;
              }
          }

          final class Routes implements RouteProviderInterface
          {
              public function setRoutes(Router $router): void
              {
                  $router->get('/', HelloController::class)->name('home');
                  $router->get('/users/:id', HelloController::class)->name('users.show');
              }
          }
          PHP

      - name: Measure
        run: |
          php -S 127.0.0.1:8088 -t .benchmark/public >/dev/null 2>&1 &
          for i in $(seq 1 40); do curl -sf -o /dev/null http://127.0.0.1:8088/ && break; sleep 0.25; done

          curl -sf -o /dev/null http://127.0.0.1:8088/ || { echo "The application did not answer"; exit 1; }

          result=$(vendor/bin/benchmark benchmark:http:get http://127.0.0.1:8088/users/42 200 10)
          echo "$result"

          # A number, or the measurement did not happen — an empty one reads like a fast one.
          echo "$result" | grep -qE '[0-9]+\.[0-9]+ requests per second' \
            || { echo "Nothing was measured"; exit 1; }

          {
            echo '### Benchmark'
            echo
            echo '```text'
            echo "$result"
            echo '```'
            echo
            echo '_Shared CI runners are noisy, so this is a number to read rather than a gate.'
            echo 'Compare runs on the same machine before believing a change._'
          } >> "$GITHUB_STEP_SUMMARY"

  static-analysis:
    name: Static analysis
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2
        with:
          php-version: '8.3'
          coverage: none

      - uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # 4.0.0

      - name: PHPStan
        run: vendor/bin/phpstan analyse --no-progress