volumen/.gitea/workflows/test.yml

# Test, Go. Push and pull request to development. Never on main.
#
# The gates are the ones the justfile's `gates` recipe runs, minus race: the shared
# runner box cannot afford the race detector on every push, so it lives in race.yml.
# The box is one core and 2 GB beside Gitea, so parallelism is bounded on purpose and
# everything runs in one job. Extra jobs would duplicate the checkout, the Go setup and
# the dependency download three times without buying any parallelism.
#
# Every step is one command, so the step that fails is the gate that failed, and no shell
# option has to be trusted for the run to stop. The scripted steps are Perl, not shell and
# not shell: Perl behaves the same on both runner images, there is no bashism to trip over
# on ash, and it is one language instead of two. The Perl uses builtins only, because
# Fedora packages the Perl modules separately and nothing beyond `perl` itself may be
# assumed present.
name: Test

on:
  push:
    branches: [development]
  pull_request:
    branches: [development]

# A superseded run of the same ref is cancelled instead of queueing behind a run that
# no longer matters.
concurrency:
  group: ${{ gitea.workflow }}-${{ gitea.ref }}
  cancel-in-progress: true

env:
  # interpres is fetched directly from the self-hosted Gitea, not via
  # proxy.golang.org, and skips the public checksum database.
  GOPRIVATE: sourcedock.dev
  # One core: parallelism buys no speed here and costs memory the box does not have.
  GOFLAGS: -p=1
  GOMAXPROCS: "2"

jobs:
  test:
    runs-on: fedora
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-go@v6
        with:
          # The module is the source of truth for the version, so it cannot drift.
          go-version-file: go.mod
          cache: true

      - name: Install Perl
        # The runner images are minimal and Perl is not guaranteed. The install is a
        # no-op where it is already present; drop this step once verified on the box.
        run: dnf install -y perl

      - name: Build
        run: go build ./...

      - name: Format
        run: |
          perl -e '
            open(my $g, q{-|}, q{gofmt}, q{-l}, q{.}) or die qq{gofmt: $!};
            my @bad = <$g>;
            close($g);
            print @bad;
            exit(@bad ? 1 : 0);
          '

      - name: Vet
        run: go vet ./...

      - name: Modernise
        # Exits non-zero when it has something to rewrite, so it needs no output capture.
        run: go fix -diff ./...

      - name: Tests
        # Scope the pattern to the packages that hold the logic when a thin cmd/ drags the
        # total under the floor, and keep it equal to `packages` in the project's justfile.
        # The inner timeout matches the job's, so a hanging test reports its own
        # goroutine dump rather than being killed by the job timeout.
        run: go test -count=1 -timeout 10m -coverprofile=coverage.out ./...

      - name: Coverage floor
        run: |
          perl -e '
            open(my $c, q{-|}, q{go}, q{tool}, q{cover}, q{-func=coverage.out}) or die qq{cover: $!};
            my $total;
            while (my $l = <$c>) { $total = $1 if $l =~ m{^total:\s+\S+\s+([0-9.]+)%} }
            close($c);
            die qq{no total line in coverage.out\n} unless defined $total;
            printf qq{Total coverage: %s%%\n}, $total;
            exit($total < 80 ? 1 : 0);
          '