Add coverage report (#857)

* Add GitHub Actions workflow for code coverage reporting

This commit introduces a new workflow in the GitHub Actions configuration to automate code coverage reporting for pull requests. The workflow includes steps for setting up the JDK, caching dependencies, running tests with coverage, and conditionally adding coverage reports to pull requests based on coverage checks. It also allows for coverage overrides through PR comments, ensuring flexibility in coverage enforcement.

* Update GitHub Actions workflow to include permissions for pull requests and issues

This commit enhances the existing code coverage workflow by adding specific permissions for reading contents, and writing to pull requests and issues. These changes aim to improve the workflow's functionality and ensure proper access control during automated processes.

* Update coverage report workflow to use COVERAGE_TOKEN and set minimum coverage thresholds

This commit modifies the GitHub Actions workflow for code coverage reporting by replacing the GITHUB_TOKEN with COVERAGE_TOKEN for authentication. Additionally, it sets the minimum overall coverage requirement to 85% for both the main report and the skipped report, enhancing the enforcement of coverage standards.

* debug

* Refactor coverage report workflow to use GITHUB_TOKEN for authentication

This commit updates the GitHub Actions workflow for code coverage reporting by changing the authentication method from COVERAGE_TOKEN to GITHUB_TOKEN. Additionally, it modifies the event trigger from pull_request to pull_request_target, streamlining the workflow and enhancing security by utilizing the appropriate token for the context.

* add ref and repo

Author: madhav-db

.github/workflows/coverageReport.yml

@@ -0,0 +1,91 @@
+name: Code Coverage
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+
+on:
+  pull_request_target:
+
+jobs:
+  coverage:
+    runs-on:
+        group: databricks-protected-runner-group
+        labels: linux-ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Needed for coverage comparison
+        ref: ${{ github.event.pull_request.head.ref || github.ref_name }}
+        repository: ${{ github.event.pull_request.head.repo.full_name ||  github.repository }}
+        
+    - name: Set up JDK
+      uses: actions/setup-java@v4
+      with:
+        java-version: '21'
+        distribution: 'adopt'
+        
+    - name: Cache dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: |
+          ${{ runner.os }}-m2-
+        
+    - name: Run tests with coverage
+      run: mvn clean test jacoco:report
+      
+    - name: Check for coverage override
+      id: override
+      run: |
+        OVERRIDE_COMMENT=$(echo "${{ github.event.pull_request.body }}" | grep -E "SKIP_COVERAGE_CHECK\s*=" || echo "")
+        if [ -n "$OVERRIDE_COMMENT" ]; then
+          echo "override=true" >> $GITHUB_OUTPUT
+          REASON=$(echo "$OVERRIDE_COMMENT" | sed -E 's/.*SKIP_COVERAGE_CHECK\s*=\s*(.+)/\1/')
+          echo "reason=$REASON" >> $GITHUB_OUTPUT
+          echo "Coverage override found in PR description: $REASON"
+        else
+          echo "override=false" >> $GITHUB_OUTPUT
+          echo "No coverage override found"
+        fi
+      
+    - name: Add coverage to PR (with strict checks)
+      if: steps.override.outputs.override == 'false'
+      id: jacoco
+      uses: madrapps/[email protected]
+      with:
+        paths: |
+          ${{ github.workspace }}/target/site/jacoco/jacoco.xml
+        token: ${{ secrets.GITHUB_TOKEN }}
+        min-coverage-overall: 85
+        title: '📊 Code Coverage Report'
+        update-comment: true
+        pass-emoji: ':green_circle:'
+        fail-emoji: ':red_circle:'
+        
+    - name: Add coverage to PR (with override)
+      if: steps.override.outputs.override == 'true'
+      id: jacoco-override
+      uses: madrapps/[email protected]
+      with:
+        paths: |
+          ${{ github.workspace }}/target/site/jacoco/jacoco.xml
+        token: ${{ secrets.GITHUB_TOKEN }}
+        min-coverage-overall: 85
+        min-coverage-changed-files: 0
+        title: '📊 Code Coverage Report (SKIPPED: ${{ steps.override.outputs.reason }})'
+        update-comment: true
+        pass-emoji: ':green_circle:'
+        fail-emoji: ':red_circle:'
+        
+    - name: Coverage enforcement summary
+      run: |
+        if [ "${{ steps.override.outputs.override }}" == "true" ]; then
+          echo "⚠️ Coverage checks bypassed: ${{ steps.override.outputs.reason }}"
+          echo "Please ensure this override is justified and temporary"
+        else
+          echo "✅ Coverage checks enforced - minimum 85% required"
+        fi