test.yaml

# SPDX-FileCopyrightText: 2024 Tobias Böhm <code@aibor.de>
#
# SPDX-License-Identifier: GPL-3.0-or-later

name: Test

on:
  push:
    branches:
      - "main"
      - "dev/*"
  pull_request:
    branches:
      - "main"

permissions:
  contents: read

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

jobs:
  go-setup:
    name: Go setup
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version-file: go.mod

      - name: Go mod tidy
        run: go mod tidy && git diff --exit-code

      - name: Go mod verify
        run: go mod verify

  go-vuln-check:
    name: Go vulnerability check
    runs-on: ubuntu-latest
    needs:
      - go-setup
    steps:
      - name: Go vulnerability check
        uses: golang/govulncheck-action@v1
        with:
          go-version-file: go.mod
          go-package: -test ./...

  go-gen-check:
    name: Go generate check
    runs-on: ubuntu-latest
    needs:
      - go-setup
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version-file: go.mod

      - name: Go generate
        run: go generate ./... && git diff --exit-code

  go-lint:
    name: Go lint
    runs-on: ubuntu-latest
    needs:
      - go-setup
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version-file: go.mod

      - name: Run vet with all constraints
        run: go vet -tags integration,integration_sysinit ./...

      - name: Run golangci-lint
        uses: golangci/golangci-lint-action@v9
        with:
          version: "v2.12"
          args: "--build-tags integration,integration_sysinit ./..."

  reuse-lint:
    name: FSFE REUSE Compliance Check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: REUSE Compliance Check
        uses: fsfe/reuse-action@v6

      - name: Checkout
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

  goreleaser-lint:
    name: Goreleaser check
    runs-on: ubuntu-latest
    needs:
      - go-setup
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version-file: go.mod

      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v7
        with:
          version: latest
          args: check

  integration-tests:
    name: Run integration tests
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/aibor/virtrun-test:${{ matrix.arch }}
    strategy:
      matrix:
        arch:
          - amd64
          - arm64
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version-file: go.mod

      - name: Run go generate testdata
        run: go generate -tags testdata ./internal/sys/gen_test.go

      - name: Run go generate integration tests
        env:
          GOARCH: ${{ matrix.arch }}
        run: go generate -tags integration ./internal/cmd/run_integration_test.go

      - name: Run tests
        env:
          SKIP: ${{ matrix.arch != 'amd64' && 'TestIntegration/linked' || '' }}
          VIRTRUN_ARGS: "-kernel /kernel/vmlinuz-virt \
                         -transport pci \
                         -memory 128 \
                         -verbose \
                         -debug"
        run: |
          go test -v \
            -tags integration \
            -skip "${{ env.SKIP }}" \
            -race \
            -covermode atomic \
            -coverprofile coverage.txt \
            -coverpkg $(go list ./internal/... | tr '\n' ,) \
            ./internal/... \
            | go-junit-report -set-exit-code -iocopy -out junit-report.xml

      - name: Run go-cobertura
        run: gocover-cobertura -by-files < coverage.txt > coverage.xml

      - name: Upload test output
        uses: actions/upload-artifact@v7
        if: always()
        with:
          name: test-results-integration-${{ matrix.arch }}
          path: junit-report.xml
          retention-days: 2

      - name: Upload coverage data
        uses: actions/upload-artifact@v7
        if: ${{ matrix.arch == 'amd64' }}
        with:
          name: go-coverage
          path: coverage*

  integration-tests-sysinit:
    name: Run integration tests of sysinit package and binaries
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/aibor/virtrun-test:${{ matrix.arch }}
    strategy:
      matrix:
        arch:
          - amd64
          - arm64
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version-file: go.mod

      - name: Build virtrun
        run: go build -buildvcs=false -o /virtrun .

      - name: Run sysinit test
        env:
          GOARCH: "${{ matrix.arch }}"
          RACE: ${{ matrix.arch == 'amd64' && '-race' || '' }}
          VIRTRUN_ARGS: "-kernel /kernel/vmlinuz-virt \
                         -addModule /kernel/tun.ko.gz \
                         -addModule /kernel/veth.ko.gz \
                         -transport pci \
                         -standalone \
                         -verbose \
                         -debug"
        run: |
          go test -v \
            -tags integration_sysinit \
            -exec /virtrun \
            ${{ env.RACE }} \
            -covermode atomic \
            -coverprofile coverage.txt \
            -coverpkg ./sysinit \
            ./sysinit \
            ./internal/pidone/cmd \
            -testModules tun,veth \
            | go-junit-report -set-exit-code -iocopy -out junit-report-sysinit.xml

      - name: Run go-cobertura
        run: gocover-cobertura -by-files < coverage.txt > coverage.xml

      - name: Upload test output
        uses: actions/upload-artifact@v7
        if: always()
        with:
          name: test-results-integration-sysinit-${{ matrix.arch }}
          path: junit-report*.xml
          retention-days: 2

      - name: Upload coverage data
        uses: actions/upload-artifact@v7
        if: ${{ matrix.arch == 'amd64' }}
        with:
          name: go-coverage-sysinit
          path: coverage*

  results:
    if: always()
    runs-on: ubuntu-latest
    name: Test Results
    needs:
      - go-vuln-check
      - go-gen-check
      - go-lint
      - integration-tests
      - integration-tests-sysinit
      - reuse-lint
      - goreleaser-lint
    steps:
    - run: exit 1
      if: |
        contains(needs.*.result, 'failure') ||
          contains(needs.*.result, 'cancelled')