test: add e2e test scenarios

.github/workflows/aam-backend-service-analyse.yml

@@ -0,0 +1,49 @@
+name: aam-backend-service-analyse
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/aam-backend-service-analyse.yml'
+      - 'application/aam-backend-service/**'
+  pull_request:
+    types: [ opened, synchronize, reopened, ready_for_review ]
+
+jobs:
+  test_coverage:
+    name: Run tests and coverage calculation
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: application/aam-backend-service
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'corretto'
+          java-version: 17
+          cache: 'gradle'
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Test and analyse test coverage
+        run: ./gradlew jacocoTestReport --no-daemon
+
+      - name: Add coverage to PR
+        uses: madrapps/[email protected]
+        with:
+          paths: application/aam-backend-service/build/reports/jacoco/test/jacocoTestReport.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          min-coverage-overall: 80
+          min-coverage-changed-files: 80
+          title: Code Coverage Analyse
+          update-comment: true

.github/workflows/aam-backend-service-build-pr.yml

@@ -0,0 +1,45 @@
+name: aam-backend-service-build-pr
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/aam-backend-service-build-pr.yml'
+      - 'application/aam-backend-service/**'
+  workflow_dispatch:
+
+jobs:
+  push_pr_build_to_registry:
+    name: Build aam-backend-service and publish to container registry
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'corretto'
+          java-version: 17
+          cache: 'gradle'
+
+      - name: Build application
+        working-directory: application/aam-backend-service
+        run: ./gradlew installDist
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          platforms: linux/amd64
+          context: ./application/aam-backend-service
+          push: true
+          tags: ghcr.io/aam-digital/aam-backend-service:pr-${{ github.event.number }}

.github/workflows/aam-backend-service.yml → .github/workflows/aam-backend-service-build.yml

@@ -1,12 +1,11 @@
-name: aam-backend-service
+name: aam-backend-service-build
 
 on:
   push:
     branches:
       - main
-      - 'tw/feat/query-backend-port'
     paths:
-      - '.github/workflows/aam-backend-service.yml'
+      - '.github/workflows/aam-backend-service-build.yml'
       - 'application/aam-backend-service/**'
   workflow_dispatch:
 

README.md

@@ -1,7 +1,13 @@
-# Aam Digital Backend Services
+# Aam Digital Services
+
+Collection of aam-digital services and tools
+
+### aam-backend-service
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/57213b5887a579196d6d/maintainability)](https://codeclimate.com/github/Aam-Digital/aam-services/maintainability)
 
 A modularize Spring Boot application that contains API modules for [Aam Digital's case management platform](https://github.com/Aam-Digital/ndb-core).
 
-## API Modules
+#### API Modules
 
 - **Reporting**: Calculate aggregated reports and run queries on all data, accessible for external services for API integrations of systems

application/aam-backend-service/build.gradle.kts

@@ -58,11 +58,48 @@ dependencies {
 
     annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
 
+    testImplementation("io.cucumber:cucumber-java:7.14.0")
+    testImplementation("io.cucumber:cucumber-junit:7.14.0")
+    testImplementation("io.cucumber:cucumber-spring:7.14.0")
+    testImplementation("org.junit.vintage:junit-vintage-engine:5.10.2")
+
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.10.2")
     testImplementation("io.projectreactor:reactor-test")
+
+    testImplementation("org.testcontainers:junit-jupiter:1.19.7") {
+        constraints {
+            testImplementation("org.apache.commons:commons-compress:1.26.1") {
+                because("previous versions have security issues")
+            }
+        }
+    }
+    testImplementation("org.testcontainers:rabbitmq:1.19.7")
+    testImplementation("com.github.dasniko:testcontainers-keycloak:3.3.0") {
+        constraints {
+            testImplementation("org.apache.james:apache-mime4j-core:0.8.11") {
+                because("previous versions have security issues")
+            }
+        }
+    }
+
     testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.springframework.boot:spring-boot-testcontainers")
     testImplementation("org.springframework.security:spring-security-test")
 }
 
+jacoco {
+    toolVersion = "0.8.11"
+}
+
+tasks.jacocoTestReport {
+    dependsOn(tasks.test)
+    reports {
+        html.required.set(false)
+        csv.required.set(true)
+        xml.required.set(true)
+    }
+}
+
 sentry {
     // Generates a JVM (Java, Kotlin, etc.) source bundle and uploads your source code to Sentry.
     // This enables source context, allowing you to see your source
@@ -84,4 +121,5 @@ tasks.withType<KotlinCompile> {
 
 tasks.withType<Test> {
     useJUnitPlatform()
+    systemProperty("cucumber.junit-platform.naming-strategy", "long")
 }

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/error/AamException.kt

@@ -16,7 +16,6 @@ class InternalServerException(
     code: String = "INTERNAL_SERVER_ERROR"
 ) : AamException(message, cause, code)
 
-
 class ExternalSystemException(
     message: String = "",
     cause: Throwable? = null,

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/domain/ReportCalculation.kt

@@ -23,6 +23,7 @@ sealed class ReportCalculationOutcome {
 }
 
 data class ReportCalculation(
+    @JsonProperty("_id")
     val id: String,
     val report: DomainReference,
     var status: ReportCalculationStatus,

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/domain/ReportData.kt

@@ -1,10 +1,12 @@
 package com.aamdigital.aambackendservice.reporting.domain
 
 import com.aamdigital.aambackendservice.domain.DomainReference
+import com.fasterxml.jackson.annotation.JsonProperty
 import com.fasterxml.jackson.databind.ObjectMapper
 import java.security.MessageDigest
 
 data class ReportData(
+    @JsonProperty("_id")
     val id: String,
     val report: DomainReference,
     val calculation: DomainReference,

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/reportcalculation/controller/ReportController.kt → application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/report/controller/ReportController.kt

@@ -1,4 +1,4 @@
-package com.aamdigital.aambackendservice.reporting.reportcalculation.controller
+package com.aamdigital.aambackendservice.reporting.report.controller
 
 import com.aamdigital.aambackendservice.domain.DomainReference
 import com.aamdigital.aambackendservice.error.NotFoundException
@@ -12,12 +12,12 @@ import org.springframework.web.bind.annotation.RestController
 import reactor.core.publisher.Mono
 
 @RestController
-@RequestMapping("/v1/reporting")
+@RequestMapping("/v1/reporting/report")
 @Validated
 class ReportController(
     private val reportingStorage: ReportingStorage,
 ) {
-    @GetMapping("/report")
+    @GetMapping
     fun fetchReports(): Mono<List<ReportDto>> {
         return reportingStorage.fetchAllReports("sql")
             .zipWith(
@@ -38,7 +38,7 @@ class ReportController(
             }
     }
 
-    @GetMapping("/report/{reportId}")
+    @GetMapping("/{reportId}")
     fun fetchReport(
         @PathVariable reportId: String
     ): Mono<ReportDto> {

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/reportcalculation/controller/ReportCalculationController.kt

@@ -18,13 +18,13 @@ import org.springframework.web.bind.annotation.RestController
 import reactor.core.publisher.Mono
 
 @RestController
-@RequestMapping("/v1/reporting")
+@RequestMapping("/v1/reporting/report-calculation")
 @Validated
 class ReportCalculationController(
     private val reportingStorage: ReportingStorage,
     private val createReportCalculationUseCase: CreateReportCalculationUseCase
 ) {
-    @PostMapping("/report-calculation/report/{reportId}")
+    @PostMapping("/report/{reportId}")
     fun startCalculation(
         @PathVariable reportId: String
     ): Mono<DomainReference> {
@@ -50,14 +50,14 @@ class ReportCalculationController(
             }
     }
 
-    @GetMapping("/report-calculation/report/{reportId}")
+    @GetMapping("/report/{reportId}")
     fun fetchReportCalculations(
         @PathVariable reportId: String
     ): Mono<List<ReportCalculation>> {
         return reportingStorage.fetchCalculations(DomainReference(id = reportId))
     }
 
-    @GetMapping("/report-calculation/{calculationId}")
+    @GetMapping("/{calculationId}")
     fun fetchReportCalculation(
         @PathVariable calculationId: String
     ): Mono<ReportCalculation> {
@@ -73,7 +73,7 @@ class ReportCalculationController(
             }
     }
 
-    @GetMapping("/report-calculation/{calculationId}/data")
+    @GetMapping("/{calculationId}/data")
     fun fetchReportCalculationData(
         @PathVariable calculationId: String
     ): Mono<ReportData> {

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/report/storage/DefaultReportingStorage.kt → application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/storage/DefaultReportingStorage.kt

@@ -1,4 +1,4 @@
-package com.aamdigital.aambackendservice.reporting.report.storage
+package com.aamdigital.aambackendservice.reporting.storage
 
 import com.aamdigital.aambackendservice.couchdb.dto.CouchDbChange
 import com.aamdigital.aambackendservice.domain.DomainReference

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/report/storage/ReportCalculationRepository.kt → application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/storage/ReportCalculationRepository.kt

@@ -1,4 +1,4 @@
-package com.aamdigital.aambackendservice.reporting.report.storage
+package com.aamdigital.aambackendservice.reporting.storage
 
 import com.aamdigital.aambackendservice.couchdb.core.CouchDbStorage
 import com.aamdigital.aambackendservice.couchdb.core.getQueryParamsAllDocs

application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/report/storage/ReportRepository.kt → application/aam-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/reporting/storage/ReportRepository.kt

@@ -1,4 +1,4 @@
-package com.aamdigital.aambackendservice.reporting.report.storage
+package com.aamdigital.aambackendservice.reporting.storage
 
 import com.aamdigital.aambackendservice.couchdb.core.CouchDbStorage
 import com.aamdigital.aambackendservice.couchdb.core.getQueryParamsAllDocs

application/aam-backend-service/src/main/resources/application.yaml

@@ -6,8 +6,6 @@ spring:
   jackson:
     deserialization:
       accept-empty-string-as-null-object: true
-  webflux:
-    base-path: /api
   r2dbc:
     url: r2dbc:h2:file://././data/dbh2;DB_CLOSE_DELAY=-1
     username: local
@@ -43,6 +41,8 @@ spring:
         retry:
           enabled: true
           max-attempts: 5
+  webflux:
+    base-path: /api
 
 server:
   error:

application/aam-backend-service/src/test/kotlin/com/aamdigital/aambackendservice/common/AuthTestingService.kt

@@ -0,0 +1,39 @@
+package com.aamdigital.aambackendservice.common
+
+import com.fasterxml.jackson.databind.node.ObjectNode
+import org.slf4j.LoggerFactory
+import org.springframework.http.HttpEntity
+import org.springframework.http.HttpHeaders
+import org.springframework.http.HttpMethod
+import org.springframework.http.MediaType
+import org.springframework.util.LinkedMultiValueMap
+import org.springframework.util.MultiValueMap
+import org.springframework.web.client.RestTemplate
+
+class AuthTestingService(
+    private val restTemplate: RestTemplate,
+) {
+    private val logger = LoggerFactory.getLogger(javaClass)
+
+    fun fetchToken(client: String, secret: String, realm: String): String? {
+        val headers = HttpHeaders()
+        headers.contentType = MediaType.APPLICATION_FORM_URLENCODED
+
+        val body: MultiValueMap<String, String> = LinkedMultiValueMap()
+        body.add("client_id", client)
+        body.add("client_secret", secret)
+        body.add("grant_type", "client_credentials")
+        body.add("scope", "reporting_read reporting_write")
+
+        val requestEntity = HttpEntity(body, headers)
+
+        val tokenResponse = restTemplate.exchange(
+            "/realms/$realm/protocol/openid-connect/token",
+            HttpMethod.POST,
+            requestEntity,
+            ObjectNode::class.java
+        )
+
+        return tokenResponse.body?.get("access_token")?.textValue()
+    }
+}