ci.yaml

name: CI

env:
  # Database to connect to that can create other databases with `CREATE DATABASE`.
  ADMIN_DATABASE_URL: postgres://postgres:postgres@localhost:5432

  # A suitable URL for non-test database.
  DATABASE_URL: postgres://postgres:postgres@127.0.0.1:5432/river_dev?sslmode=disable

  # Test database.
  TEST_DATABASE_URL: postgres://postgres:postgres@127.0.0.1:5432/river_test?sslmode=disable

on:
  push:
    branches:
      - master
  pull_request:

jobs:
  build_and_test:
    env:
      # The special value "local" tells Go to use the bundled Go version rather
      # than trying to fetch one according to a `toolchain` value in `go.mod`.
      # This ensures that we're really running the Go version in the CI matrix
      # rather than one that the Go command has upgraded to automatically.
      GOTOOLCHAIN: local
    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version:
          - "1.21"
          - "1.22"
          - "1.23"
        postgres-version: [14, 15, 16]
      fail-fast: false
    timeout-minutes: 5

    services:
      postgres:
        image: postgres:${{ matrix.postgres-version }}
        env:
          POSTGRES_PASSWORD: postgres
        options: >-
          --health-cmd pg_isready
          --health-interval 2s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432

    steps:
      - uses: actions/checkout@v4

      - name: Setup Go ${{ matrix.go-version }}
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}

      - name: Display Go version
        run: go version

      - name: Set up test DBs
        run: go run ./internal/cmd/testdbman create
        env:
          PGHOST: 127.0.0.1
          PGPORT: 5432
          PGUSER: postgres
          PGPASSWORD: postgres
          PGSSLMODE: disable

      - name: Test
        working-directory: .
        run: go test -p 1 -race ./... -timeout 2m

      - name: Test cmd/river
        working-directory: ./cmd/river
        run: go test -race ./... -timeout 2m

      - name: Test riverdriver
        working-directory: ./riverdriver
        run: go test -race ./... -timeout 2m

      - name: Test riverdriver/riverdatabasesql
        working-directory: ./riverdriver/riverdatabasesql
        run: go test -race ./... -timeout 2m

      - name: Test riverdriver/riverpgxv5
        working-directory: ./riverdriver/riverpgxv5
        run: go test -race ./... -timeout 2m

      - name: Test rivershared
        working-directory: ./rivershared
        run: go test -race ./... -timeout 2m

      - name: Test rivertype
        working-directory: ./rivertype
        run: go test -race ./... -timeout 2m

  cli:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]

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

    steps:
      - uses: ikalnytskyi/action-setup-postgres@v6
        with:
          database: river_dev
          password: postgres

      - uses: actions/setup-go@v5
        with:
          go-version: "stable"
          check-latest: true

      - name: Setup GOBIN (Linux)
        if: runner.os == 'Linux'
        run: |
          echo "GOBIN=$(go env GOPATH)/bin" >> $GITHUB_ENV
          echo "PATH=$(go env GOPATH)/bin:$PATH" >> $GITHUB_ENV
        shell: bash

      - name: Setup GOBIN (Windows)
        if: runner.os == 'Windows'
        run: |
          $gobin = "$(go env GOPATH)\bin"
          echo "GOBIN=$gobin" >> $env:GITHUB_ENV
          echo $gobin | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
        shell: pwsh

      - name: Checkout
        uses: actions/checkout@v4

      - name: export RIVER_CMD_DIR
        run: |
          if [ "$RUNNER_OS" == "Linux" ]; then
            echo "RIVER_CMD_DIR=./cmd/river" >> $GITHUB_ENV
          elif [ "$RUNNER_OS" == "Windows" ]; then
            echo "RIVER_CMD_DIR=.\cmd\river" >> $GITHUB_ENV
          fi
        shell: bash

      - name: Build and install CLI
        run: go install .
        working-directory: ${{ env.RIVER_CMD_DIR }}

      - run: river migrate-get --down --version 3

      - run: river migrate-get --up --version 3

      - run: river migrate-get --all --exclude-version 1 --down

      - run: river migrate-get --all --exclude-version 1 --up

      - name: river migrate-up
        run: river migrate-up --database-url $DATABASE_URL
        shell: bash

      - name: river migrate-list
        run: river migrate-list --database-url $DATABASE_URL
        shell: bash

      - name: river validate
        run: river validate --database-url $DATABASE_URL
        shell: bash

      - name: river version
        run: river version
        shell: bash

      - name: river bench
        run: |
          if [ "$RUNNER_OS" == "Linux" ]; then
            ( sleep 10 && killall -SIGTERM river ) &
            river bench --database-url $DATABASE_URL
          elif [ "$RUNNER_OS" == "Windows" ]; then
            (sleep 10 && taskkill //F //IM river.exe //T ) &
            river bench --database-url $DATABASE_URL || exit 0
          fi
        shell: bash

      # Bench again in fixed number of jobs mode.
      - name: river bench
        run: |
          if [ "$RUNNER_OS" == "Linux" ]; then
            ( sleep 10 && killall -SIGTERM river ) &
            river bench --database-url $DATABASE_URL --num-total-jobs 1_234
          elif [ "$RUNNER_OS" == "Windows" ]; then
            (sleep 10 && taskkill //F //IM river.exe //T ) &
            river bench --database-url $DATABASE_URL --num-total-jobs 1_234 || exit 0
          fi
        shell: bash

      - name: river migrate-down
        run: river migrate-down --database-url $DATABASE_URL --max-steps 100
        shell: bash

      - name: river validate (expect failure)
        run: |
          if river validate --database-url $DATABASE_URL; then
            echo "expected non-zero exit code" && exit 1
          fi
        shell: bash

      - name: river unknown command (expect failure)
        run: |
          if river not-a-command; then
            echo "expected non-zero exit code" && exit 1
          fi
        shell: bash

  golangci:
    name: lint
    runs-on: ubuntu-latest
    env:
      GOLANGCI_LINT_VERSION: v1.61.0
    permissions:
      contents: read
      # allow read access to pull request. Use with `only-new-issues` option.
      pull-requests: read

    steps:
      - uses: actions/setup-go@v5
        with:
          go-version: "stable"
          check-latest: true

      - name: Checkout
        uses: actions/checkout@v4

      - name: Lint
        uses: golangci/golangci-lint-action@v4
        with:
          # golangci-lint needs to be run separately for every Go module, and
          # its GitHub Action doesn't provide any way to do that. Have it fetch
          # the golangci-lint binary, trick it into not running by sending only
          # `--help`, then run the full set of lints below. DO NOT run separate
          # modules as separate golangci-lint-action steps. Its post run caching
          # can be extremely slow, and that's amplified in a very painful way if
          # it needs to be run multiple times.
          args: --help
          version: ${{ env.GOLANGCI_LINT_VERSION }}

      - name: Run lint
        run: make lint

  migration_and_sqlc_verify:
    runs-on: ubuntu-latest
    timeout-minutes: 2

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup sqlc
        uses: sqlc-dev/setup-sqlc@v4
        with:
          sqlc-version: "1.27.0"

      - name: Verify migrations match
        run: |
          echo "Make sure migration directories are the same"
          make verify/migrations

      - name: Verify sqlc generated code
        run: |
          echo "Make sure that all sqlc changes are checked in"
          make verify/sqlc

  submodule_check:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/setup-go@v5
        with:
          go-version: "stable"
          check-latest: true

      - name: Checkout
        uses: actions/checkout@v4

      - name: Check all go/toolchain directives match
        run: CHECK=true make update-mod-go