test.yml

name: Test

on:
  push:
    branches:
      - renovate/** # branches generated by https://github.com/apps/renovate
  pull_request:
    branches:
      - main
      - beta
      - '+([0-9])?(.{+([0-9]),x}).x'
  workflow_call:

permissions:
  contents: read

jobs:
  # prevent duplicate checks on Renovate PRs
  prevent-duplicate-checks:
    runs-on: ubuntu-latest
    steps:
      - uses: insurgent-lab/is-in-pr-action@129df59687402c4a9c81a9a9e88d7448cdbba541 # v0.2.0
        id: isInPR
    outputs:
      should-run: ${{ !(steps.isInPR.outputs.result == 'true' && startsWith(github.ref, 'refs/heads/renovate/')) }}

  test_matrix:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        node: [16, 18, 20]

    runs-on: ${{ matrix.os }}
    timeout-minutes: 5

    needs: prevent-duplicate-checks
    if: ${{ needs.prevent-duplicate-checks.outputs.should-run == 'true' }}

    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
        with:
          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

      - name: Checkout project
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

      - name: Use Node.js ${{ matrix.node }}
        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
        with:
          node-version: ${{ matrix.node }}
          cache: 'npm'

      - name: Install packages
        run: npm ci

      - name: Audit npm signatures
        run: npm audit signatures

      - name: Check codestyle compliance
        run: npm run lint

      - name: Build project
        run: npm run build

      - name: Run tests
        run: npm run test

      - name: Run fuzz tests
        run: npm run test:fuzz

  # separate job to set as required status check in branch protection
  required_check:
    runs-on: ubuntu-latest
    needs:
      - prevent-duplicate-checks
      - test_matrix

    if: ${{ !cancelled() && needs.prevent-duplicate-checks.outputs.should-run == 'true' }}
    steps:
      - name: All required jobs and matrix versions passed
        if: ${{ !(contains(needs.*.result, 'failure')) }}
        run: exit 0
      - name: Some required jobs or matrix versions failed
        if: ${{ contains(needs.*.result, 'failure') }}
        run: exit 1