Merge pull request #1264 from Sunbird-Lern/gh-actions

SBCOSS-465: Userorg-service  - add the GitHub actions to run test cases and code quality checks when a PR raised

Author: pallakartheekreddy

.github/COVERAGE.md

@@ -0,0 +1,39 @@
+# PR Code Coverage
+
+This document outlines the steps for the Pull Request Code Coverage process.
+
+## Triggering the Workflow
+This GitHub Actions workflow is triggered automatically whenever a pull request (PR) is raised against any branch in the repository. It ensures that every proposed change is checked for code quality and coverage before being merged into the main codebase.
+
+## Steps
+
+1. **Checkout the Repository**
+   - The first step is to checkout the repository to ensure you have the latest code.
+
+2. **Set Up JDK 11**
+   - JDK 11 is used for building the project. Ensure to use the `temurin` distribution and cache Maven dependencies.
+
+3. **Build the Project and Generate Coverage Report**
+   - Execute the following commands to build and generate coverage report:
+     ```bash
+     mvn clean verify jacoco:report
+     ```
+
+4. **Set Up JDK 17**
+   - After generating the coverage report, set up JDK 17 for SonarQube analysis.
+
+5. **Run SonarQube Analysis**
+   - Execute the SonarQube analysis to check code quality and coverage:
+     ```bash
+     mvn sonar:sonar \
+       -Dsonar.projectKey=sunbird-lern \
+       -Dsonar.organization=sunbird-lern \
+       -Dsonar.host.url=https://sonarcloud.io \
+       -Dsonar.coverage.jacoco.xmlReportPaths=service/target/site/jacoco/jacoco.xml
+     ```
+
+## Notes
+- Ensure that the `SONAR_TOKEN` secret is set in your GitHub repository for the SonarQube analysis to work.
+- The coverage report can be found at `controller/target/site/jacoco/jacoco.xml`.
+- The workflow uses Ubuntu latest runner.
+- Maven dependencies are cached to improve build performance.

.github/workflows/pr-actions.yml

@@ -0,0 +1,54 @@
+name: PR Code Coverage and SonarQube Analysis
+
+on:
+  pull_request:
+    # Trigger this workflow on pull requests to any branch
+    branches: ['**']
+
+jobs:
+  pr-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the code from the pull request
+      - uses: actions/checkout@v3
+
+      # Set up JDK 11 for running tests and generating code coverage
+      - name: Set up JDK11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      # Cache Maven dependencies to speed up builds
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      # Build the project and generate the JaCoCo coverage report
+      - name: Build and Generate Coverage Report
+        run: |
+          mvn clean verify jacoco:report
+
+      # Set up JDK 17 for running SonarQube analysis (if required by plugins)
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      # Run SonarQube analysis using the generated JaCoCo coverage report
+      - name: Run SonarQube Analysis
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          mvn sonar:sonar \
+            -Dsonar.projectKey=sunbird-lern \
+            -Dsonar.organization=sunbird-lern \
+            -Dsonar.host.url=https://sonarcloud.io \
+            -Dsonar.coverage.jacoco.xmlReportPaths=controller/target/site/jacoco/jacoco.xml