test: add coverage percentages in pom.xml file, add ci steps for coverage badge, add tests information in readmes.md

Author: tennyros

.github/workflows/mvn-build-ci.yml

@@ -14,7 +14,7 @@ permissions:
   pull-requests: write
 
 jobs:
-  build:
+  test-coverage:
     runs-on: ubuntu-latest
 
     services:
@@ -49,6 +49,44 @@ jobs:
       - name: Build with Maven
         run: ./mvnw clean -B package --file pom.xml -Dspring.profiles.active=dev
 
+      - name: Switch to coverage-badge branch
+        run: |
+          git config --global user.name 'github-actions'
+          git config --global user.email 'github-actions@github.com'
+          git fetch origin coverage-badge || echo "Branch not found, creating a new one"
+          if git rev-parse --verify origin/coverage-badge; then
+            echo "Branch 'coverage-badge' exists, switching to it."
+            git checkout coverage-badge
+          else
+            echo "Branch 'coverage-badge' does not exist, creating and switching to it."
+            git checkout --orphan coverage-badge
+          fi
+
+      - name: Generate coverage badge
+        uses: cicirello/jacoco-badge-generator@v2
+        with:
+          jacoco-csv-file: target/jacoco-report/jacoco.csv
+          badges-directory: .github/badges
+
+      - name: Commit and push badge (only if changed)
+        run: |
+          git add .github/badges/jacoco.svg
+          git status
+          
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "Update test coverage badge"
+            git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/tennyros/subscription-service.git coverage-badge --force
+          fi
+
+      - name: Upload Jacoco coverage report
+        if: github.actor != 'nektos/act' # check for local GitHub act
+        uses: actions/upload-artifact@v4
+        with:
+          name: jacoco-report
+          path: target/jacoco-report/
+
       - name: Send Telegram notification
         if: always()
         env:

README.md

@@ -1,6 +1,7 @@
 # Subscription Service
 
 ![CI Status](https://github.com/tennyros/subscription-service/workflows/CI%20Pipeline%20with%20Maven/badge.svg)
+![Coverage](https://github.com/tennyros/subscription-service/raw/coverage-badge/.github/badges/jacoco.svg)
 ![Java 17](https://img.shields.io/badge/Java-17-blue)
 ![Spring Boot 3.4.5](https://img.shields.io/badge/Spring_Boot-3.4.5-brightgreen)
 
@@ -48,6 +49,13 @@ Source code structure (branch: dev):
 │       ├── application.yml               # Main configuration
 │       └── application-dev.yml           # Development configuration
 ├── test/                                 # Tests
+│   ├── java/
+│   │   └── com/github/tennyros/subscription_service/
+│   │       ├── controller/       # Controller layer unit/integration tests
+│   │       ├── mapper/           # Mapper unit tests
+│   │       └── service/          # Service layer unit tests
+│   └── resources/
+│       └── application-test.yml  # Test configuration
 pom.xml
 
 Built artifacts:

README_RUS.md

@@ -1,6 +1,7 @@
 # Subscription Service
 
 ![CI Status](https://github.com/tennyros/subscription-service/workflows/CI%20Pipeline%20with%20Maven/badge.svg)
+![Coverage](https://github.com/tennyros/subscription-service/raw/coverage-badge/.github/badges/jacoco.svg)
 ![Java 17](https://img.shields.io/badge/Java-17-blue)
 ![Spring Boot 3.4.5](https://img.shields.io/badge/Spring_Boot-3.4.5-brightgreen)
 
@@ -48,6 +49,13 @@
 │       ├── application.yml               # Основная конфигурация
 │       └── application-dev.yml           # Конфиг для разработки
 ├── test/                                 # Тесты
+│   ├── java/
+│   │   └── com/github/tennyros/subscription_service/
+│   │       ├── controller/       # Юнит/интеграционные тесты контроллер слоя
+│   │       ├── mapper/           # Юнит тесты мапперов
+│   │       └── service/          # Юнит тесты бизнес слоя
+│   └── resources/
+│       └── application-test.yml  # Конфигурация для тестирования
 pom.xml
 
 Собранные артефакты:

pom.xml

@@ -24,12 +24,9 @@
     <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version>
     <spring-cloud.version>2024.0.1</spring-cloud.version>
     <jacoco.plugin>0.8.13</jacoco.plugin>
-    <!--    target for instructions 0.8    -->
-    <jacoco.instructions.cov>0.0</jacoco.instructions.cov>
-    <!--    target for branches 0.7    -->
-    <jacoco.branch.cov>0.0</jacoco.branch.cov>
-    <!--    target for lines 0.75    -->
-    <jacoco.line.cov>0.0</jacoco.line.cov>
+    <jacoco.instructions.cov>0.75</jacoco.instructions.cov>
+    <jacoco.branch.cov>0.7</jacoco.branch.cov>
+    <jacoco.line.cov>0.75</jacoco.line.cov>
   </properties>
 
   <dependencies>