chore: add pr coverage report (#154)

Co-authored-by: Johan Jatko <[email protected]>

Author: enoodle

.github/workflows/on-pr.yaml

@@ -4,6 +4,7 @@
 name: KAI Scheduler - Pull Request
 on:
   pull_request:
+    types: [opened, reopened, synchronize]
 
 concurrency:
   group: ${{ github.head_ref || github.ref || github.run_id }}
@@ -28,6 +29,29 @@ jobs:
       - name: Run tests
         run: make test
 
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage
+          path: coverage/coverage.out
+
+  code-coverage-report:
+    name: Code Coverage Report
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    needs: validate-and-test
+    permissions:
+      contents: read
+      actions: read
+      pull-requests: write
+    steps:
+      - uses: fgrosse/go-coverage-report@8c1d1a09864211d258937b1b1a5b849f7e4f2682
+        with:
+          coverage-artifact-name: "code-coverage"
+          coverage-file-name: "coverage.out"
+          root-package: "github.com/NVIDIA/KAI-Scheduler"
+          github-baseline-workflow-ref: update-coverage-badge.yaml
+
   build:
     name: Build
     runs-on: ubuntu-latest

.github/workflows/update-coverage-badge.yaml

@@ -0,0 +1,82 @@
+# Copyright 2025 NVIDIA CORPORATION
+# SPDX-License-Identifier: Apache-2.0
+
+name: Update Coverage Badge
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    paths:
+      - .github/workflows/update-coverage-badge.yaml
+  workflow_dispatch:
+
+jobs:
+  update-coverage:
+    name: Update Coverage Badge
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23.4'
+
+      - name: Run tests with coverage
+        run: make test
+
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage
+          path: coverage/coverage.out
+
+      - name: Calculate coverage percentage
+        id: coverage
+        run: |
+          COVERAGE=$(go tool cover -func=coverage/coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+')
+          echo "percentage=$COVERAGE" >> $GITHUB_OUTPUT
+          ROUNDED_COVERAGE=$(printf "%.0f" $COVERAGE)
+          echo "rounded=$ROUNDED_COVERAGE" >> $GITHUB_OUTPUT
+          echo "Total coverage: $COVERAGE%"
+          
+          # Determine badge color based on coverage percentage
+          if (( $(echo "$COVERAGE >= 80" | bc -l) )); then
+            echo "color=brightgreen" >> $GITHUB_OUTPUT
+          elif (( $(echo "$COVERAGE >= 70" | bc -l) )); then
+            echo "color=green" >> $GITHUB_OUTPUT
+          elif (( $(echo "$COVERAGE >= 60" | bc -l) )); then
+            echo "color=yellowgreen" >> $GITHUB_OUTPUT
+          elif (( $(echo "$COVERAGE >= 50" | bc -l) )); then
+            echo "color=yellow" >> $GITHUB_OUTPUT
+          elif (( $(echo "$COVERAGE >= 40" | bc -l) )); then
+            echo "color=orange" >> $GITHUB_OUTPUT
+          else
+            echo "color=red" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Update README.md with Coverage Badge
+        if: github.event_name != 'pull_request'
+        run: |
+          # Create the shields.io URL with the coverage data
+          BADGE_URL="https://img.shields.io/badge/coverage-${{ steps.coverage.outputs.percentage }}%25-${{ steps.coverage.outputs.color }}"
+          
+          # Update the README.md file
+          sed -i -E "s|(\!\[License\]\([^)]+\))|\1 \![Coverage]($BADGE_URL)|" README.md
+          
+          # Check if the README has been modified
+          if git diff --exit-code README.md; then
+            echo "No changes to README.md"
+          else
+            git config --local user.email "[email protected]"
+            git config --local user.name "Update Coverage Badge Action"
+            git add README.md
+            git commit -m "docs: update test coverage badge [skip ci]"
+            git push
+          fi 

.gitignore

@@ -3,3 +3,4 @@ bin/
 charts/
 cover.out
 .DS_Store
+coverage/

build/makefile/testenv.mk

@@ -1,4 +1,3 @@
-
 ENVTEST_K8S_VERSION = 1.32.0
 ENVTEST_VERSION=release-0.20
 
@@ -12,8 +11,9 @@ envtest-docker-go: builder gocache
 
 envtest-go: envtest
 	@ ${ECHO_COMMAND} ${GREEN_CONSOLE} "${CONSOLE_PREFIX} Running unit-tests" ${BASE_CONSOLE}
+	mkdir -p coverage
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path --bin-dir $(LOCALBIN))" \
-    go test ${TEST_TARGETS} -timeout 30m || ${FAILURE_MESSAGE_HANDLER}
+    go test ${TEST_TARGETS} -timeout 30m -coverprofile=coverage/coverage.out || ${FAILURE_MESSAGE_HANDLER}
 	${SUCCESS_MESSAGE_HANDLER}
 
 ENVTEST = $(LOCALBIN)/setup-envtest