pr-checks.yaml

name: pr-checks

on:
  pull_request:

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod

      - name: Install all tools
        uses: ./.github/tools-cache
      - name: make docs
        run: |
          make docs
          git diff --exit-code

  fmt:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod
      - name: Install all tools
        uses: ./.github/tools-cache
      - name: make fmt
        run:  make fmt && git diff --exit-code

  escapes_detect:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod

      - name: Install all tools
        uses: ./.github/tools-cache

      - name: run escapes detect
        run: make escapes_detect

  golangci:
    permissions:
      contents: read
      # NOTE: allow read access to pull request. Use with `only-new-issues` option.
      pull-requests: read

    runs-on: ubuntu-latest
    steps:
      - name: code checkout
        uses: actions/checkout@v3
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod
          cache: false

      - name: golangci-lint
        uses: golangci/golangci-lint-action@v3
        with:
          version: v1.53
          args: --timeout=3m --issues-exit-code=0 ./...
          only-new-issues: true

  vulnerability_detect:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod

      - name: Install all tools
        uses: ./.github/tools-cache

      - name: run vulnerability detect
        run: make check-govuln

  bundle:
    needs: [docs, golangci, fmt, vulnerability_detect, escapes_detect]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod
      - name: Install all tools
        uses: ./.github/tools-cache

      - name: bundle
        run: |
          make generate manifests bundle
          git diff --exit-code

  build-images:
    needs: [docs, golangci, fmt, vulnerability_detect, escapes_detect]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-go@main
        with:
          go-version-file: go.mod

      - uses: ./.github/compute-version
        id: version

      - name: additional image tags
        id: additional_tags
        shell: bash
        run: |
          echo "result=$(git rev-parse --short HEAD),v1alpha1" >> $GITHUB_OUTPUT

      - name: Install all tools
        uses: ./.github/tools-cache

      - name: build images for PR checks
        uses: ./.github/publish-images
        with:
          image_registry: "localhost:5001"
          version: ${{ steps.version.outputs.version }}
          additional_tags: ${{ steps.additional_tags.outputs.result }}

  e2e:
    needs: [docs, golangci, fmt, vulnerability_detect, escapes_detect]
    env:
      KIND_VERSION: "0.15.0"
      GO111MODULE: "on"
      OPERATOR_IMAGE: "quay.io/sustainable_computing_io/kepler-operator"
      KUBECONFIG: /tmp/.kube/config
      KIND_WORKER_NODES: 2
    name: e2e
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v3

      - name: Install Go
        uses: actions/setup-go@main
        with:
          go-version-file: go.mod

      - name: Install all tools
        uses: ./.github/tools-cache

      - name: use kepler action for kind cluster build
        uses: sustainable-computing-io/kepler-action@v0.0.5
        with:
          ebpfprovider: libbpf
          cluster_provider: kind
        env:
          PROMETHEUS_ENABLE: "false"

      - name: Ensure cluster is able to run OLM bundles
        run: make cluster-prereqs

      - uses: ./.github/compute-version
        id: version

      - name: reclaim space before running tests
        run: |
          sudo apt-get clean
          sudo rm -rf /var/lib/apt/lists/*
          sudo rm -rf /tmp/*
          sudo rm -rf /opt/hostedtoolcache/CodeQL
          sudo rm -rf /opt/hostedtoolcache/Python
          df -kh

      - name: Run e2e tests
        run: |
          ./tests/run-e2e.sh --ci
        env:
          VERSION: ${{ steps.version.outputs.version }}

      - name: Capture cluster state
        if: always()
        shell: bash
        run: |
          # Capture apiserver state
          # TODO: enable this when we have oc installed as part of `make tools`
          # oc adm inspect node --dest-dir cluster-state || true
          # oc adm inspect -A statefulset --dest-dir cluster-state || true
          # oc adm inspect -A deployment --dest-dir cluster-state || true
          # oc adm inspect -A ns --dest-dir cluster-state || true
          cp -r tmp/e2e cluster-state/ || true

      - name: Archive production artifacts
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: cluster-state
          path: cluster-state