fix: pom dependencies and warnings / feat: actions and sonarqube / refactor: endpoints / feat: batch answer and protocol stage endpoints

.gitattributes

@@ -0,0 +1,3 @@
+*.tex linguist-detectable=false
+*.bib linguist-detectable=false
+*.bibtex linguist-detectable=false

.github/workflows/sonarqube.yml

@@ -0,0 +1,36 @@
+name: SonarQube
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'zulu' # Alternative distribution options are available.
+      - name: Cache SonarQube packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Build and analyze
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=pet-ads_systematic

account/pom.xml

@@ -30,22 +30,7 @@
             <plugin>
                 <groupId>org.jetbrains.kotlin</groupId>
                 <artifactId>kotlin-maven-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>compile</id>
-                        <phase>compile</phase>
-                        <goals>
-                            <goal>compile</goal>
-                        </goals>
-                    </execution>
-                    <execution>
-                        <id>test-compile</id>
-                        <phase>test-compile</phase>
-                        <goals>
-                            <goal>test-compile</goal>
-                        </goals>
-                    </execution>
-                </executions>
+                <extensions>true</extensions>
             </plugin>
             <plugin>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -72,6 +57,7 @@
         <dependency>
             <groupId>org.postgresql</groupId>
             <artifactId>postgresql</artifactId>
+            <version>42.7.2</version>
         </dependency>
     </dependencies>
 </project>

account/src/main/kotlin/br/all/domain/user/Email.kt

@@ -7,51 +7,60 @@ data class Email(val value: String) : ValueObject() {
 
     init {
         val notification = validate()
-        require(notification.hasNoErrors()) {notification.message()}
+        require(notification.hasNoErrors()) { notification.message() }
     }
 
     override fun validate(): Notification {
         val notification = Notification()
 
+        if (value.isEmpty()) {
+            notification.addError("Email must not be empty.")
+            return notification
+        }
+
         if (value.isBlank()) {
             notification.addError("Email must not be blank.")
             return notification
         }
+
         if (!isValidEmailFormat(value)) notification.addError("Wrong Email format.")
+
         return notification
     }
 
     private fun isValidEmailFormat(email: String): Boolean {
-        if (!isValidEmailAddress(email)) return false
-        if (!hasLengthBelowMaximum(email)) return false
-        if (hasRepeatedSubdomains(email)) return false
-        if (email.contains("..")) return false
-        if (email.contains("@.")) return false
-        if (email.contains(".@")) return false
-        return true
-    }
-
-    private fun isValidEmailAddress(email: String): Boolean {
-        val regex = Regex("^[A-Za-z0-9+_.-]+@[a-z.]+$")
-        return regex.matches(email)
-    }
+        if (email.contains("..") || email.contains(".@") || email.contains("@.")) return false
+        if (email.startsWith(".") || email.endsWith(".")) return false
+        if (email.startsWith("@") || email.endsWith("@")) return false
 
-    fun hasRepeatedSubdomains(email: String): Boolean {
         val parts = email.split("@")
+        if (parts.size != 2) return false
 
-        if (parts.size == 2) {
-            val subdomains = parts[1].split(".")
-            val verifyedSubdomains = HashSet<String>()
+        val localPart = parts[0]
+        val domainPart = parts[1]
 
-            for (subdomain in subdomains){
-                if (!verifyedSubdomains.add(subdomain)) return true
-            }
+        if (!hasValidLength(localPart, domainPart)) return false
+        if (!isValidStructure(localPart, domainPart)) return false
+
+        return true
+    }
+
+    private fun isValidStructure(localPart: String, domainPart: String): Boolean {
+        val localRegex = Regex("^[A-Za-z0-9_!#$%&'*+/=?`{|}~^.-]+$")
+        val domainRegex = Regex("^[A-Za-z0-9.-]+$")
+
+        val domainLabels = domainPart.split(".")
+        if (domainLabels.last().length < 2 || domainLabels.any { it.startsWith("-") || it.endsWith("-") }) {
+            return false
         }
-        return false
+
+        return localRegex.matches(localPart) && domainRegex.matches(domainPart)
     }
 
-    fun hasLengthBelowMaximum(email: String): Boolean {
-        val parts = email.split("@")
-        return !(parts[0].length > 64 || parts[1].length > 255)
+    private fun hasValidLength(localPart: String, domainPart: String): Boolean {
+        if (localPart.length > 64) return false
+        if (domainPart.length > 255) return false
+        if ((localPart.length + 1 + domainPart.length) > 254) return false
+        return true
     }
 }

account/src/test/kotlin/br/all/application/user/create/RegisterUserAccountServiceImplTest.kt

@@ -33,7 +33,7 @@ class RegisterUserAccountServiceImplTest {
     inner class WhenSuccessfullyRegisteringUser {
         @Test
         fun `should register a new user`() {
-            val request = factory.registerRequest().copy(email = "user@example.com")
+            val request = factory.registerRequest()
 
             every { userAccountRepository.existsByEmail(request.email) } returns false
             every { userAccountRepository.existsByUsername(request.username) } returns false
@@ -53,7 +53,7 @@ class RegisterUserAccountServiceImplTest {
     inner class WhenFailingToRegisterUser {
         @Test
         fun `should not register user with existing email`() {
-            val request = factory.registerRequest().copy(email = "user@example.com")
+            val request = factory.registerRequest()
 
             every { userAccountRepository.existsByEmail(request.email) } returns true
             every { userAccountRepository.existsByUsername(request.username) } returns false
@@ -68,7 +68,7 @@ class RegisterUserAccountServiceImplTest {
 
         @Test
         fun `should not register user with existing username`() {
-            val request = factory.registerRequest().copy(email = "user@example.com")
+            val request = factory.registerRequest()
 
             every { userAccountRepository.existsByEmail(request.email) } returns false
             every { userAccountRepository.existsByUsername(request.username) } returns true

account/src/test/kotlin/br/all/domain/user/UserAccountTest.kt

@@ -2,11 +2,13 @@ package br.all.domain.user
 
 import io.github.serpro69.kfaker.Faker
 import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Tag
 import java.time.LocalDateTime
 import java.util.UUID
 import kotlin.test.Test
 import kotlin.test.assertFailsWith
 
+@Tag("UnitTest")
 class UserAccountTest{
 
     private val faker = Faker()

pom.xml

@@ -21,14 +21,17 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.1.2</version>
+        <version>3.4.4</version>
         <relativePath/>
     </parent>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <kotlin.code.style>official</kotlin.code.style>
         <kotlin.compiler.jvmTarget>1.8</kotlin.compiler.jvmTarget>
+        <kotlin.version>1.9.0</kotlin.version>
+        <sonar.organization>pet-ads</sonar.organization>
+        <sonar.host.url>https://sonarcloud.io</sonar.host.url>
     </properties>
 
     <repositories>
@@ -47,31 +50,26 @@
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
             <artifactId>kotlin-reflect</artifactId>
+            <version>${kotlin.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
             <artifactId>kotlin-stdlib</artifactId>
-            <version>1.9.0</version>
+            <version>${kotlin.version}</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
             <artifactId>kotlin-test-junit5</artifactId>
-            <version>1.9.0</version>
+            <version>${kotlin.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>io.github.serpro69</groupId>
             <artifactId>kotlin-faker</artifactId>
             <version>1.15.0</version>
         </dependency>
-        <dependency>
-            <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-engine</artifactId>
-            <version>5.8.2</version>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>com.tngtech.archunit</groupId>
             <artifactId>archunit-junit5</artifactId>
@@ -81,7 +79,7 @@
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
             <artifactId>kotlin-test-junit</artifactId>
-            <version>1.9.0</version>
+            <version>${kotlin.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -109,24 +107,20 @@
             <plugin>
                 <groupId>org.jetbrains.kotlin</groupId>
                 <artifactId>kotlin-maven-plugin</artifactId>
-                <version>1.9.0</version>
+                <version>${kotlin.version}</version>
                 <dependencies>
-                    <dependency>
-                        <groupId>org.mapstruct</groupId>
-                        <artifactId>mapstruct-processor</artifactId>
-                        <version>1.4.2.Final</version>
-                    </dependency>
                     <dependency>
                         <groupId>org.jetbrains.kotlin</groupId>
                         <artifactId>kotlin-maven-allopen</artifactId>
-                        <version>2.0.0-RC1</version>
+                        <version>${kotlin.version}</version>
                     </dependency>
                     <dependency>
                         <groupId>org.jetbrains.kotlin</groupId>
                         <artifactId>kotlin-maven-noarg</artifactId>
-                        <version>2.0.0-RC1</version>
+                        <version>${kotlin.version}</version>
                     </dependency>
                 </dependencies>
+                <!--
                 <executions>
                     <execution>
                         <id>compile</id>
@@ -161,13 +155,16 @@
                         </configuration>
                     </execution>
                 </executions>
+
+               This was the old executions configuration; it has been removed because, as indicated by the Kotlin docs, from version 1.8.2 onward you can replace all of it with:
+               <extensions>true</extensions>
+               This executions block is faulty and is included here only for eventual future reference.
+                -->
+                <extensions>true</extensions>
                 <configuration>
                     <compilerPlugins>
                         <plugin>spring</plugin>
                         <plugin>jpa</plugin>
-                        <compilerPlugins>
-                            <plugin>spring</plugin>
-                        </compilerPlugins>
                     </compilerPlugins>
                 </configuration>
             </plugin>

review/pom.xml

@@ -21,7 +21,6 @@
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-mongodb</artifactId>
-            <version>3.1.2</version>
         </dependency>
         <dependency>
             <groupId>org.springframework</groupId>
@@ -33,11 +32,11 @@
             <version>1.0-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
+        <!-- https://mvnrepository.com/artifact/io.swagger.core.v3/swagger-annotations-jakarta -->
         <dependency>
             <groupId>io.swagger.core.v3</groupId>
             <artifactId>swagger-annotations-jakarta</artifactId>
-            <version>2.2.19</version>
-            <scope>compile</scope>
+            <version>2.2.31</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>

review/src/main/kotlin/br/all/application/protocol/find/GetProtocolStagePresenter.kt

@@ -0,0 +1,6 @@
+package br.all.application.protocol.find
+
+import br.all.application.shared.presenter.GenericPresenter
+import br.all.application.protocol.find.GetProtocolStageService.ResponseModel
+
+interface GetProtocolStagePresenter : GenericPresenter<ResponseModel>

review/src/main/kotlin/br/all/application/protocol/find/GetProtocolStageService.kt

@@ -0,0 +1,32 @@
+package br.all.application.protocol.find
+
+import io.swagger.v3.oas.annotations.media.Schema
+import java.util.UUID
+
+interface GetProtocolStageService {
+    fun getStage(presenter: GetProtocolStagePresenter, request: RequestModel)
+
+    data class RequestModel(
+        val userId: UUID,
+        val systematicStudyId: UUID
+    )
+
+    @Schema(name = "GetProtocolStageServiceResponseModel", description = "Response model for Get Protocol Stage Service")
+    data class ResponseModel(
+        val userId: UUID,
+        val systematicStudyId: UUID,
+        val currentStage: ProtocolStage
+    )
+
+    enum class ProtocolStage {
+        PROTOCOL_PART_I,
+        PICOC,
+        PROTOCOL_PART_II,
+        PROTOCOL_PART_III,
+        IDENTIFICATION,
+        SELECTION,
+        EXTRACTION,
+        GRAPHICS,
+        FINALIZATION
+    }
+}