Merge release-8.1.0 into main

.circleci/config.yml

@@ -2,30 +2,30 @@ version: 2.1
 executorType: machine
 jobs:
   build:
-    docker:
-      - image: circleci/openjdk:14-jdk-buster-node-browsers-legacy
+    machine:
+      image: ubuntu-2004:202201-02
     steps:
       - checkout
       - restore_cache:
           key: kp-dependency-build-cache-{{ checksum "pom.xml" }}
       - run:
           name: Run build
           command: |
-            mvn clean install -DskipTests
+            mvn clean install -DskipTests -DCLOUD_STORE_GROUP_ID=$CLOUD_STORE_GROUP_ID -DCLOUD_STORE_ARTIFACT_ID=$CLOUD_STORE_ARTIFACT_ID -DCLOUD_STORE_VERSION=$CLOUD_STORE_VERSION
       - save_cache:
           paths:
             - ~/.m2
           key: kp-dependency-build-cache-{{ checksum "pom.xml" }}
 
   unit-tests:
-    docker:
-      - image: circleci/openjdk:14-jdk-buster-node-browsers-legacy
-      - image: circleci/redis:latest
+    machine:
+       image: ubuntu-2004:202201-02
     parallelism: 1
     steps:
       - checkout
       - restore_cache:
           key: kp-dependency-test-cache-{{ checksum "pom.xml" }}
+
       - run:
           name: Setup environment and run tests
           command: bash vmsetup.sh
@@ -45,8 +45,8 @@ jobs:
 workflows:
   version: 2.1
   build-then-test:
-      jobs:
-        - build
-        - unit-tests:
-            requires:
-              - build
+    jobs:
+      - build
+      - unit-tests:
+          requires:
+            - build

.github/actions/registry-login/action.yml

@@ -0,0 +1,44 @@
+name: "Container Registry Login"
+description: "Reusable action for logging in to container registries using workflow inputs"
+inputs:
+  registry_provider:
+    required: false
+  gcp_service_account_key:
+    required: false
+  registry_name:
+    required: false
+  registry_url:
+    required: false
+  registry_username:
+    required: false
+  registry_password:
+    required: false
+  github_token:
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        case "${{ inputs.registry_provider }}" in
+          "gcp")
+            echo "Using Google Container Registry"
+            echo "${{ inputs.gcp_service_account_key }}" | base64 --decode > $HOME/gcloud-key.json
+            gcloud auth activate-service-account --key-file=$HOME/gcloud-key.json
+            gcloud auth configure-docker ${{ inputs.registry_name }}
+            REGISTRY_URL=$(echo "${{ inputs.registry_url }}" | tr '[:upper:]' '[:lower:]')
+            ;;
+          "azure" | "dockerhub")
+            echo "Logging in to Container Registry"
+            echo "${{ inputs.registry_password }}" | docker login ${{ inputs.registry_name }} \
+              --username ${{ inputs.registry_username }} --password-stdin
+            REGISTRY_URL=$(echo "${{ inputs.registry_url }}" | tr '[:upper:]' '[:lower:]')
+            ;;
+          *)
+            echo "Using GitHub Container Registry (GHCR)"
+            REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
+            echo "${{ inputs.github_token }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+            REGISTRY_URL="ghcr.io/$REPO_NAME_LOWERCASE"
+            ;;
+        esac
+        echo "REGISTRY_URL=${REGISTRY_URL}" >> $GITHUB_ENV
+      shell: bash

.github/pull_request_template.md

@@ -17,7 +17,7 @@ Please describe the tests that you ran to verify your changes in the below check
 - [ ] Ran Test B
 
 **Test Configuration**:
-* Software versions: Java 11, scala-2.11, play-2.7.2
+* Software versions: Java 11, scala-2.12, play-2.7.2
 * Hardware versions: 2 CPU/ 4GB RAM
 
 ### Checklist:

.github/pull_request_template.md.yaml

@@ -17,7 +17,7 @@ Please describe the tests that you ran to verify your changes in the below check
 - [ ] Ran Test B
 
 **Test Configuration**:
-* Software versions: Java 11, scala-2.11, play-2.7.2
+* Software versions: Java 11, scala-2.12, play-2.7.2
 * Hardware versions:
 
 ### Checklist:

.github/workflows/Code-Quality-check.yml

@@ -0,0 +1,267 @@
+name: Pull Request Checks
+
+on:
+  pull_request:
+    branches:
+      - '*'
+permissions:
+  pull-requests: write
+  contents: read
+  issues: write
+  checks: write
+  statuses: write
+
+env:
+  CLOUD_STORE_GROUP_ID: ${{ vars.CLOUD_STORE_GROUP_ID }}
+  CLOUD_STORE_ARTIFACT_ID: ${{ vars.CLOUD_STORE_ARTIFACT_ID }}
+  CLOUD_STORE_VERSION: ${{ vars.CLOUD_STORE_VERSION }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      maven_cache_key: ${{ runner.os }}-maven-${{ steps.cache.outputs.cache-hit }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Build Knowledge Platform
+        run: |
+          mvn clean install -DskipTests=true \
+          -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+          -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID}  \
+          -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION}
+
+  test-content:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Run Content Service Tests
+        working-directory: content-api/content-service/
+        run: |
+          mvn clean org.jacoco:jacoco-maven-plugin:0.8.8:prepare-agent test org.jacoco:jacoco-maven-plugin:0.8.8:report \
+          -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+          -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID}  \
+          -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION}
+
+      - name: Upload Content Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: content-test-results
+          path: 'content-api/content-service/target/surefire-reports/*.xml'
+
+      - name: Publish Content Test Results
+        if: always()
+        uses: dorny/test-reporter@v1
+        with:
+          name: Content Test Results
+          path: content-api/content-service/target/surefire-reports/*.xml
+          reporter: java-junit
+          fail-on-error: true
+
+  test-taxonomy:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Run Taxonomy Tests
+        working-directory: taxonomy-api/taxonomy-service/
+        run: |
+          mvn clean org.jacoco:jacoco-maven-plugin:0.8.8:prepare-agent test org.jacoco:jacoco-maven-plugin:0.8.8:report \
+          -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+          -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID}  \
+          -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION}
+
+      - name: Upload Taxonomy Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: taxonomy-test-results
+          path: 'taxonomy-api/taxonomy-service/target/surefire-reports/*.xml'
+
+      - name: Publish Taxonomy Test Results
+        if: always()
+        uses: dorny/test-reporter@v1
+        with:
+          name: Taxonomy Test Results
+          path: taxonomy-api/taxonomy-service/target/surefire-reports/*.xml
+          reporter: java-junit
+          fail-on-error: true
+
+  test-search:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Run Search Tests
+        working-directory: search-api/search-service
+        run: |
+          mvn clean org.jacoco:jacoco-maven-plugin:0.8.8:prepare-agent test org.jacoco:jacoco-maven-plugin:0.8.8:report \
+          -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+          -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID}  \
+          -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION}
+
+      - name: Upload Search Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: search-test-results
+          path: 'search-api/search-service/target/surefire-reports/*.xml'
+
+      - name: Publish Search Test Results
+        if: always()
+        uses: dorny/test-reporter@v1
+        with:
+          name: Search Test Results
+          path: search-api/search-service/target/surefire-reports/*.xml
+          reporter: java-junit
+          fail-on-error: true
+
+  sonar-analysis-content:
+    needs: test-content
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Run SonarCloud Analysis for Content
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        working-directory: content-api/content-service
+        run: |
+          mvn sonar:sonar \
+          -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+          -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID} \
+          -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION} \
+          -Dsonar.projectKey=Sunbird-Knowlg_knowledge-platform \
+          -Dsonar.organization=sunbird-knowlg-1 \
+          -Dsonar.host.url=https://sonarcloud.io \
+          -Dsonar.coverage.jacoco.xmlReportPaths=content-api/content-service/target/site/jacoco/jacoco.xml
+
+  sonar-analysis-taxonomy:
+    needs: test-taxonomy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Run SonarCloud Analysis for Taxonomy
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        working-directory: taxonomy-api/taxonomy-service
+        run: |
+          mvn sonar:sonar \
+          -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+          -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID} \
+          -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION} \
+          -Dsonar.projectKey=Sunbird-Knowlg_knowledge-platform \
+          -Dsonar.organization=sunbird-knowlg-1 \
+          -Dsonar.host.url=https://sonarcloud.io \
+          -Dsonar.coverage.jacoco.xmlReportPaths=taxonomy-api/taxonomy-service/target/site/jacoco/jacoco.xml
+
+  sonar-analysis-search:
+    needs: test-search
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Run SonarCloud Analysis for Search
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        working-directory: search-api/search-service
+        run: |
+          mvn clean compile \
+            -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+            -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID} \
+            -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION}
+
+          mvn sonar:sonar \
+            -DCLOUD_STORE_GROUP_ID=${CLOUD_STORE_GROUP_ID} \
+            -DCLOUD_STORE_ARTIFACT_ID=${CLOUD_STORE_ARTIFACT_ID} \
+            -DCLOUD_STORE_VERSION=${CLOUD_STORE_VERSION} \
+            -Dsonar.projectKey=Sunbird-Knowlg_knowledge-platform \
+            -Dsonar.organization=sunbird-knowlg-1 \
+            -Dsonar.host.url=https://sonarcloud.io \
+            -Dsonar.java.binaries=target/classes \
+            -Dsonar.java.test.binaries=target/test-classes \
+            -Dsonar.coverage.jacoco.xmlReportPaths=search-api/search-service/target/site/jacoco/jacoco.xml
+
+  comment-pr:
+    needs: [sonar-analysis-content, sonar-analysis-taxonomy, sonar-analysis-search]
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment PR with SonarQube Results
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const message = `### SonarCloud Analysis Results 🔍
+
+            #### Quality Gate Results for Services:
+            - [Content Service Analysis](https://sonarcloud.io/dashboard?id=Sunbird-Knowlg_knowledge-platform_content)
+            - [Taxonomy Service Analysis](https://sonarcloud.io/dashboard?id=Sunbird-Knowlg_knowledge-platform_taxonomy)
+            - [Search Service Analysis](https://sonarcloud.io/dashboard?id=Sunbird-Knowlg_knowledge-platform_search)
+
+            Please review the analysis results for each service. Ensure all quality gates are passing before merging.`;
+
+            github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              body: message
+            });