ci.yml

name: ci

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  DESTDIR: ./bin

on:
  schedule:
    - cron: '0 8 */6 * *' # every 6 days
  push:
    branches:
      - master
  pull_request:

jobs:
  validate:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        target:
          - lint
          - validate-gomod
          - validate-shfmt
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
      -
        name: Run
        uses: docker/bake-action@v3
        with:
          targets: ${{ matrix.target }}

  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        target:
          - build
          - cross
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
      -
        name: Run
        uses: docker/bake-action@v3
        with:
          targets: ${{ matrix.target }}

  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        go:
          - "1.19"
          - "1.20"
        mode:
          - "root"
          - "noroot"
    env:
      GO_VERSION: ${{ matrix.go }}
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
      -
        name: Test
        uses: docker/bake-action@v3
        with:
          targets: test-${{ matrix.mode }}
      -
        name: Upload coverage
        uses: codecov/codecov-action@v4
        with:
          directory: ${{ env.DESTDIR }}/coverage
          flags: unit,${{ matrix.mode }},go-${{ matrix.go }}

  test-os:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os:
          - macos-latest
          - windows-latest
        go:
          - "1.19"
          - "1.20"
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: ${{ matrix.go }}
      -
        name: Test
        run: |
          go test -coverprofile="coverage.txt" -covermode="atomic" ./...
          go tool cover -func="coverage.txt"
      -
        name: Upload coverage
        if: always()
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.txt
          env_vars: RUNNER_OS
          flags: unit,go-${{ matrix.go }}

  test-freebsd-amd64:
    runs-on: macos-13
    env:
      VAGRANT_VAGRANTFILE: hack/Vagrantfile.freebsd13
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Cache Vagrant boxes
        uses: actions/cache@v3
        with:
          path: ~/.vagrant.d/boxes
          key: ${{ runner.os }}-vagrant-${{ hashFiles('hack/Vagrantfile.freebsd13') }}
          restore-keys: |
            ${{ runner.os }}-vagrant-
      -
        name: Install Vagrant and VirtualBox
        run: |
          set -x
          brew tap hashicorp/tap
          brew install hashicorp/tap/hashicorp-vagrant
          brew install --cask virtualbox
        env:
          HOMEBREW_NO_AUTO_UPDATE: 1
          HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
      -
        name: Check versions
        run: |
          set -x
          vagrant --version
          VBoxManage -v
      -
        name: Set up vagrant
        run: |
          vagrant up --no-tty
      -
        name: Test
        uses: nick-fields/retry@14672906e672a08bd6eeb15720e9ed3ce869cdd4  # v2.9.0
        with:
          timeout_minutes: 20
          max_attempts: 5
          command: |
            vagrant ssh -- "cd /vagrant; go test -buildvcs=false -coverprofile=coverage.txt -covermode=atomic ./..."
            vagrant ssh -c "sudo cat /vagrant/coverage.txt" > coverage.txt
      -
        name: Upload coverage
        if: always()
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.txt
          flags: unit,freebsd

  bench:
    runs-on: ubuntu-latest
    permissions:
      deployments: write  # deployments permission to deploy GitHub pages website
      contents: write  # contents permission to update benchmark contents in bench-gh-pages branch
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: "1.20"
          cache-dependency-path: |
            go.sum
            bench/go.sum
      -
        name: Test
        run: |
          set -ex
          mkdir ./bin
          go mod download
          go test -bench=. . | tee ./bin/temp_bench.txt
          head -n -2 ./bin/temp_bench.txt > ./bin/bench.txt
          cd ./bench
          go mod download
          BENCH_FILE_SIZE=10000 go test -bench=. . | tee ../bin/temp_bench.txt
          awk 'NR > 4 {print buf[NR%3]} {buf[NR%3] = $0}' ../bin/temp_bench.txt >> ../bin/bench.txt
      -
        name: Result
        run: |
          cat ./bin/bench.txt
      -
        name: Store benchmark result
        uses: benchmark-action/github-action-benchmark@cc9ac13ce81036c9b67fcfe2cb95ca366684b9ea  # v1.19.3
        with:
          tool: go
          output-file-path: ./bin/bench.txt
          summary-always: true
          gh-pages-branch: bench-gh-pages
          github-token: ${{ secrets.GITHUB_TOKEN }}