Release 8.1.0

.github/BUILD.md

@@ -0,0 +1,78 @@
+# GitHub Action: Build and Deploy
+
+## Overview
+This GitHub Action automates the build and deployment process for the Groups service. It builds the project, runs tests, packages the application, and pushes a Docker image to GitHub Container Registry (GHCR).
+
+## Usage
+The action will automatically build and deploy your service whenever a new tag is pushed.
+
+## Steps
+
+1. **Set up JDK 11**
+   - Configures the environment with JDK 11 using the `actions/setup-java` action with Temurin distribution.
+
+2. **Checkout code**
+   - Checks out the repository code with full commit history.
+
+3. **Cache Maven packages**
+   - Caches Maven dependencies to speed up subsequent builds.
+
+4. **Build and run test cases**
+   ```bash
+   mvn clean install -DskipTests
+   cd service
+   mvn clean verify surefire-report:report
+   ```
+   - Generates test reports for the test results.
+
+5. **Package build artifact**
+   - Packages the application using Play Framework's `dist` goal.
+   ```bash
+   mvn -f service/pom.xml play2:dist
+   ```
+
+6. **Upload artifact**
+   - Uploads the packaged application as a GitHub Actions artifact named `groups-service-dist`.
+
+7. **Extract image tag details**
+   - Prepares Docker image name and tags based on the repository name and reference.
+
+8. **Log in to GitHub Container Registry**
+   - Authenticates to GHCR using the provided GitHub token.
+
+9. **Build and push Docker image**
+   - Builds the Docker image using the provided Dockerfile and pushes it to GHCR with the appropriate tags.
+
+## Environment Variables
+- `REGISTRY`: The GitHub Container Registry URL (ghcr.io)
+- `IMAGE_NAME`: Auto-generated based on the repository name (e.g., ghcr.io/username/repo)
+- `IMAGE_TAG`: Auto-generated based on the git reference (branch name or tag)
+
+## Permissions
+This workflow requires the following permissions:
+- `contents: read` - To read the repository contents
+- `packages: write` - To push Docker images to GitHub Container Registry
+
+## How to Use the Docker Image
+
+1. **Pull the Docker Image**:
+   ```bash
+   docker pull ghcr.io/<repository-name>:<tag>
+   ```
+   Replace `<repository-name>` and `<tag>` with the appropriate values.
+
+2. **Run the Docker Container**:
+   ```bash
+   docker run -d -p <host-port>:9000 ghcr.io/<repository-name>:<tag>
+   ```
+   Replace `<host-port>` with your desired port number.
+
+3. **Access the Application**:
+   Once the container is running, you can access the application at `http://localhost:<host-port>`.
+
+## Notes
+- The workflow uses Ubuntu latest runner.
+- Maven dependencies are cached to improve build performance.
+- The Docker image is built using the Dockerfile in the repository root.
+- The workflow automatically handles repository name and tag generation for Docker images.
+- Test reports are generated and made available in the GitHub Actions UI.

.github/COVERAGE.md

@@ -0,0 +1,55 @@
+# 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 on every pull request to any branch in the repository. It ensures comprehensive testing and quality checks for all code changes.
+
+## Prerequisites
+- Maven
+- JDK 11 (for building and testing)
+- JDK 17 (for SonarQube analysis)
+- SonarCloud account and token
+
+## 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. The workflow uses the `temurin` distribution and caches Maven dependencies for faster builds.
+
+3. **Build the Project and Generate Reports**
+   - Execute the following commands to build the project and generate test coverage reports:
+     ```bash
+     mvn clean install -DskipTests
+     cd service
+     mvn clean verify jacoco:report surefire-report:report
+     ```
+
+4. **Generate Test Summary**
+   - The workflow generates an interactive test summary showing all test results, including passed and failed tests, grouped by test class.
+
+5. **Set Up JDK 17**
+   - After generating the coverage report, set up JDK 17 for SonarQube analysis.
+
+6. **Run SonarQube Analysis**
+   - Execute the SonarQube analysis to check the quality of the code and coverage. The analysis includes:
+     - Code quality metrics
+     - Code coverage analysis
+     - Security vulnerabilities
+   ```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
+    ```
+## Generated Reports
+- **Test Reports**: `service/target/surefire-reports/`
+- **Code Coverage**: `service/target/site/jacoco/`
+
+## Notes
+- Ensure the `SONAR_TOKEN` secret is configured in your GitHub repository settings for SonarQube analysis to work
+- The test summary is available directly in the GitHub Actions UI
+- The workflow automatically runs on every pull request to any branch

.github/workflows/build.yml

@@ -0,0 +1,106 @@
+name: Build and Deploy
+
+on:
+  push:
+    tags:
+      - '*'  # Trigger this workflow on any git tag push
+
+jobs:
+  ghcr-build-and-deploy:
+    runs-on: ubuntu-latest  # Use the latest available Ubuntu runner
+
+    permissions:
+      contents: read         # Allows reading repository contents
+      packages: write        # Allows writing to GitHub Packages (GHCR)
+
+    env:
+      REGISTRY: ghcr.io      # Define GitHub Container Registry as the target registry
+
+    steps:
+      # Set up Java Development Kit (JDK) 11
+      - name: Set up JDK 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'temurin'  # Use the Temurin distribution of OpenJDK
+          java-version: '11'       # Set Java version to 11
+
+      # Check out the repository code
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Ensure full history is fetched, needed for tags
+
+      # Cache local 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 test reports (without skipping tests)
+      - name: Build and run test cases
+        run: | 
+          mvn clean install -DskipTests  # Initial install, skipping tests
+          cd service
+          mvn clean verify surefire-report:report  # Run tests and generate reports
+
+      # Generate and display a detailed test report in the GitHub Actions UI
+      - name: Test Summary
+        uses: dorny/test-reporter@v2.1.0
+        if: always()  # Ensure this runs even if previous steps fail
+        with:
+          name: Test Results
+          path: '**/surefire-reports/*.xml'  # Look for JUnit XML test reports
+          reporter: java-junit
+          fail-on-error: false
+          only-summary: false
+          list-tests: 'all'  # Include full list of tests in the summary
+
+      # Package the application using Play Framework's dist goal
+      - name: Package build artifact (Play dist)
+        run: mvn -f service/pom.xml play2:dist
+
+      # Move the packaged artifact to the root directory for easier access
+      - name: Moving the artifact to the root directory
+        run: |
+          mv service/target/group-service-1.0.0-dist.zip .
+
+      # Upload the packaged artifact to GitHub as a workflow artifact
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4.3.1
+        with:
+          name: groups-service-dist
+          path: |
+            service/target/group-service-*-dist.zip
+
+      # Extract Docker image name and tag from GitHub variables
+      - name: Extract image tag details
+        id: image_vars
+        run: |
+          REPO_LOWER=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
+          SHORT_SHA=$(git rev-parse HEAD | cut -c1-7)
+          TAG_LOWER=$(echo "${GITHUB_REF_NAME}" | tr '[:upper:]' '[:lower:]')
+          IMAGE_NAME=${{ env.REGISTRY }}/${REPO_LOWER}
+          IMAGE_TAG=${TAG_LOWER}_${SHORT_SHA}_${GITHUB_RUN_NUMBER}
+          echo "IMAGE_NAME=${IMAGE_NAME}" >> $GITHUB_ENV
+          echo "IMAGE_TAG=${IMAGE_TAG}" >> $GITHUB_ENV
+
+      # Authenticate Docker to GitHub Container Registry (GHCR)
+      - name: Log in to GitHub Container Registry (GHCR)
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Build the Docker image and push it to GHCR
+      - name: Build and push Docker image to GHCR
+        uses: docker/build-push-action@v4
+        with:
+          context: .              # Docker context (root of the repository)
+          file: ./Dockerfile      # Path to Dockerfile
+          push: true              # Push the image to the registry
+          tags: ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}  # Full image tag

.github/workflows/pr-actions.yml

@@ -0,0 +1,69 @@
+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 Jacoco reports and Surefire reports
+        run: |
+          mvn clean install -DskipTests
+          cd service
+          mvn clean verify jacoco:report surefire-report:report
+
+      # Generate and display a detailed test report in the GitHub Actions UI
+      # This step uses dorny/test-reporter to parse XML reports and create an interactive test summary
+      - name: Test Summary
+        uses: dorny/test-reporter@v2.1.0
+        if: always()
+        with:
+          name: Test Results
+          path: '**/surefire-reports/*.xml'
+          reporter: java-junit
+          fail-on-error: false
+          only-summary: false
+          list-tests: 'all'
+
+      # Set up JDK 17 for running SonarQube analysis (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=service/target/site/jacoco/jacoco.xml

UPGRADE_README.md

@@ -0,0 +1,85 @@
+# Play Framework 3.0.5 and Apache Pekko 1.0.3 Upgrade
+
+## Overview
+
+This document describes the upgrade of groups-service from Play Framework 2.7.2 with Akka 2.5.22 to Play Framework 3.0.5 with Apache Pekko 1.0.3.
+
+## Why This Upgrade
+
+1. License Compliance: Akka changed from Apache 2.0 to Business Source License 1.1, requiring commercial licenses for production use. Apache Pekko maintains Apache 2.0 license.
+2. Security: Play 2.7.2 and Akka 2.5.22 no longer receive security updates.
+3. Modernization: Access to latest features and performance improvements.
+
+## Technology Stack Changes
+
+- Play Framework: 2.7.2 to 3.0.5
+- Actor Framework: Akka 2.5.22 to Apache Pekko 1.0.3
+- Scala: 2.12.11 to 2.13.12
+- SLF4J: 1.6.1 to 2.0.9
+- Logback: 1.0.7 to 1.4.14
+- Jackson: 2.13.5 to 2.14.3
+- Netty: 4.1.44 to 4.1.93
+
+## Key Changes
+
+### Dependencies
+
+All Maven POM files updated with new versions. Play Framework groupId changed from com.typesafe.play to org.playframework. Scala library exclusions added to prevent version conflicts between Scala 2.12 and 2.13.
+
+### Source Code
+
+All Akka imports migrated to Pekko across Java files:
+- akka.actor.* to org.apache.pekko.actor.*
+- akka.event.* to org.apache.pekko.event.*
+- akka.pattern.* to org.apache.pekko.pattern.*
+- akka.routing.* to org.apache.pekko.routing.*
+- akka.util.* to org.apache.pekko.util.*
+- akka.testkit.* to org.apache.pekko.testkit.*
+- akka.stream.* to org.apache.pekko.stream.*
+
+### Configuration
+
+application.conf files updated with Pekko namespaces:
+- akka configuration blocks changed to pekko
+- Actor system configurations migrated
+- Serialization bindings updated
+- Dispatcher references changed
+- Logger references updated to Pekko
+
+### Scala API Updates
+
+- scala.compat.java8.FutureConverters updated to scala.jdk.javaapi.FutureConverters
+- FutureConverters.toJava() changed to FutureConverters.asJava()
+
+## Build Instructions
+
+Build all modules:
+```
+mvn clean install -DskipTests
+```
+
+Create distribution package:
+```
+cd service
+mvn play2:dist
+```
+
+## Migration Impact
+
+Business Logic: No changes to business logic or functionality
+API Compatibility: Maintained, as Pekko is API-compatible with Akka 2.6
+Code Changes: Primarily package name updates from akka to pekko
+License: Now compliant with Apache 2.0 throughout the stack
+
+
+## Files Modified
+
+- POM files (dependency management)
+- Java source files (import migrations)
+- Configuration files (namespace updates)
+
+## Known Issues
+
+Test Failures: Some unit tests fail due to PowerMock compatibility with Java 11 module system. This is a known PowerMock issue unrelated to the Pekko migration. The compilation and build are fully successful.
+
+Scala Version Conflicts: If you encounter NoClassDefFoundError for scala.collection.GenMap, verify dependency tree to ensure no Scala 2.12 artifacts are present. Run mvn dependency:tree and add exclusions for any scala-library or scala-reflect with version 2.12.