Merge pull request #32 from ArielMAJ/release/0.5.1

ArielMAJ · web-flow · commit ec77c3e346f0 · 2024-12-17T01:01:09.000-03:00
Release/0.5.1
diff --git a/Makefile b/Makefile
@@ -20,10 +20,18 @@ run: ## Run the project locally.
 install: ## Install dependencies
 	mvn clean install
 
+.PHONY: test
+test: ## Run tests. Make sure to have the test database up.
+	mvn clean test
+
 .PHONY: up-database
 up-database: ## Start database container.
 	docker compose up -d database --force-recreate
 
+.PHONY: up-database
+up-test-database: ## Start test database container.
+	docker compose -f docker-compose-test.yaml up -d test-database --force-recreate
+
 .DEFAULT_GOAL := help
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sed 's/Makefile://g' | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
diff --git a/docker-compose-test.yaml b/docker-compose-test.yaml
@@ -0,0 +1,15 @@
+services:
+  test-database:
+    image: postgres:16.3
+    restart: always
+    environment:
+      POSTGRES_DB: ${POSTGRES_TEST_DATABASE:-test_finances}
+      POSTGRES_USER: ${POSTGRES_TEST_USER:-test_user}
+      POSTGRES_PASSWORD: ${POSTGRES_TEST_PASSWORD:-test_password}
+    ports:
+      - "${POSTGRES_TEST_PORT:-5437}:5432"
+    volumes:
+      - pgdata:/var/lib/postgresql/test-data
+
+volumes:
+  pgdata:
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -24,7 +24,7 @@ services:
       POSTGRES_USER: ${POSTGRES_USER}
       POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
     ports:
-      - "5432:5432"
+      - "${POSTGRES_PORT}:5432"
     volumes:
       - pgdata:/var/lib/postgresql/data
 
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
     </parent>
     <groupId>tech.artadevs</groupId>
     <artifactId>Finances</artifactId>
-    <version>0.5.0-SNAPSHOT</version>
+    <version>0.5.1-SNAPSHOT</version>
     <name>Finances</name>
     <description>A finance manager backend in Java - Springboot.</description>
     <url />
@@ -52,6 +52,19 @@
             <artifactId>postgresql</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>postgresql</artifactId>
+            <version>1.18.3</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>1.18.3</version>
+            <scope>test</scope>
+        </dependency>
 
         <dependency>
             <groupId>org.springdoc</groupId>
@@ -114,6 +127,30 @@
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.10</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.0</version>
+            </plugin>
         </plugins>
     </build>
 </project>
diff --git a/src/main/java/tech/artadevs/finances/controllers/AuthenticationController.java b/src/main/java/tech/artadevs/finances/controllers/AuthenticationController.java
@@ -1,4 +1,4 @@
-package tech.artadevs.finances.controller;
+package tech.artadevs.finances.controllers;
 
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -16,7 +16,7 @@
 @RestController
 public class AuthenticationController {
     private final JwtService jwtService;
-    
+
     private final AuthenticationService authenticationService;
 
     public AuthenticationController(JwtService jwtService, AuthenticationService authenticationService) {
@@ -30,7 +30,8 @@ public ResponseEntity<UserLoginResponseDto> authenticate(@RequestBody UserLoginR
 
         String jwtToken = jwtService.generateToken(authenticatedUser);
 
-        UserLoginResponseDto loginResponse = new UserLoginResponseDto().setToken(jwtToken).setExpiresIn(jwtService.getExpirationTime());
+        UserLoginResponseDto loginResponse = new UserLoginResponseDto().setToken(jwtToken)
+                .setExpiresIn(jwtService.getExpirationTime());
 
         return ResponseEntity.ok(loginResponse);
     }
diff --git a/src/main/java/tech/artadevs/finances/controllers/CustomErrorController.java b/src/main/java/tech/artadevs/finances/controllers/CustomErrorController.java
@@ -1,4 +1,4 @@
-package tech.artadevs.finances.controller;
+package tech.artadevs.finances.controllers;
 
 import org.springframework.boot.web.servlet.error.ErrorController;
 import org.springframework.http.HttpStatus;
diff --git a/src/main/java/tech/artadevs/finances/controllers/FinancialTransactionController.java b/src/main/java/tech/artadevs/finances/controllers/FinancialTransactionController.java
@@ -1,4 +1,4 @@
-package tech.artadevs.finances.controller;
+package tech.artadevs.finances.controllers;
 
 import java.util.List;
 
diff --git a/src/main/java/tech/artadevs/finances/controllers/HealthController.java b/src/main/java/tech/artadevs/finances/controllers/HealthController.java
@@ -1,4 +1,4 @@
-package tech.artadevs.finances.controller;
+package tech.artadevs.finances.controllers;
 
 import java.util.Map;
 
@@ -7,11 +7,8 @@
 
 @RestController
 public class HealthController {
-	@GetMapping("/health")
+    @GetMapping("/health")
     public Map<String, String> health() {
         return Map.of("status", "healthy");
     }
 }
-
-
-
diff --git a/src/main/java/tech/artadevs/finances/controllers/RootController.java b/src/main/java/tech/artadevs/finances/controllers/RootController.java
@@ -1,4 +1,4 @@
-package tech.artadevs.finances.controller;
+package tech.artadevs.finances.controllers;
 
 import org.springframework.boot.web.servlet.error.ErrorController;
 import org.springframework.stereotype.Controller;
diff --git a/src/main/java/tech/artadevs/finances/controllers/UserController.java b/src/main/java/tech/artadevs/finances/controllers/UserController.java
@@ -1,5 +1,5 @@
 
-package tech.artadevs.finances.controller;
+package tech.artadevs.finances.controllers;
 
 import javax.validation.Valid;
 
diff --git a/src/main/java/tech/artadevs/finances/dtos/UserLoginRequestDto.java b/src/main/java/tech/artadevs/finances/dtos/UserLoginRequestDto.java
@@ -11,15 +11,17 @@ public String getEmail() {
 		return email;
 	}
 
-	public void setEmail(String email) {
+	public UserLoginRequestDto setEmail(String email) {
 		this.email = email;
+		return this;
 	}
 
 	public String getPassword() {
 		return password;
 	}
 
-	public void setPassword(String password) {
+	public UserLoginRequestDto setPassword(String password) {
 		this.password = password;
+		return this;
 	}
 }
diff --git a/src/main/java/tech/artadevs/finances/dtos/UserRegisterRequestDto.java b/src/main/java/tech/artadevs/finances/dtos/UserRegisterRequestDto.java
@@ -42,39 +42,44 @@ public String getName() {
 		return name;
 	}
 
-	public void setName(String name) {
+	public UserRegisterRequestDto setName(String name) {
 		this.name = name;
+		return this;
 	}
 
 	public Integer getAge() {
 		return age;
 	}
 
-	public void setAge(Integer age) {
+	public UserRegisterRequestDto setAge(Integer age) {
 		this.age = age;
+		return this;
 	}
 
 	public String getEmail() {
 		return email;
 	}
 
-	public void setEmail(String email) {
+	public UserRegisterRequestDto setEmail(String email) {
 		this.email = email;
+		return this;
 	}
 
 	public Long getAccountNumber() {
 		return accountNumber;
 	}
 
-	public void setAccountNumber(Long accountNumber) {
+	public UserRegisterRequestDto setAccountNumber(Long accountNumber) {
 		this.accountNumber = accountNumber;
+		return this;
 	}
 
 	public String getPassword() {
 		return password;
 	}
 
-	public void setPassword(String password) {
+	public UserRegisterRequestDto setPassword(String password) {
 		this.password = password;
+		return this;
 	}
 }
diff --git a/src/main/java/tech/artadevs/finances/models/User.java b/src/main/java/tech/artadevs/finances/models/User.java
@@ -66,6 +66,11 @@ public Long getId() {
 		return id;
 	}
 
+	public User setId(Long id) {
+		this.id = id;
+		return this;
+	}
+
 	public String getName() {
 		return name;
 	}
diff --git a/src/main/java/tech/artadevs/finances/services/FinancialTransactionService.java b/src/main/java/tech/artadevs/finances/services/FinancialTransactionService.java
@@ -11,7 +11,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
-import tech.artadevs.finances.controller.UserController;
+import tech.artadevs.finances.controllers.UserController;
 import tech.artadevs.finances.dtos.FinancialTransactionRequestDto;
 import tech.artadevs.finances.dtos.FinancialTransactionResponseDto;
 import tech.artadevs.finances.exception.ResourceNotFoundException;
diff --git a/src/main/java/tech/artadevs/finances/services/UserService.java b/src/main/java/tech/artadevs/finances/services/UserService.java
@@ -9,7 +9,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
-import tech.artadevs.finances.controller.UserController;
+import tech.artadevs.finances.controllers.UserController;
 import tech.artadevs.finances.dtos.UserRegisterRequestDto;
 import tech.artadevs.finances.dtos.UserResponseDto;
 import tech.artadevs.finances.dtos.ValueAlreadyInUseResponseDto;
@@ -88,13 +88,16 @@ public UserResponseDto getUserResponseDto(User user) {
     public UserResponseDto updateCurrentUser(UserRegisterRequestDto updatedUser) {
         logger.info("Update request: '{}' '{}'", updatedUser.getName(), updatedUser.getEmail());
         User currentUser = authenticationService.getCurrentUser();
+        logger.info("Update request: '{}' '{}' | Got current user: '{}' '{}'", updatedUser.getName(),
+                updatedUser.getEmail(), currentUser.getName(), currentUser.getEmail());
 
         if (!currentUser.getEmail().equalsIgnoreCase(updatedUser.getEmail())) {
             logger.info("Emails are different: 1. '{}' vs 2. '{}'", currentUser.getEmail(), updatedUser.getEmail());
             validateEmailNotAlreadyInUse(updatedUser);
         }
         if (!currentUser.getAccountNumber().equals(updatedUser.getAccountNumber())) {
-            logger.info("Account numbers are different: 1. '{}' vs 2. '{}'", currentUser.getAccountNumber(), updatedUser.getAccountNumber());
+            logger.info("Account numbers are different: 1. '{}' vs 2. '{}'", currentUser.getAccountNumber(),
+                    updatedUser.getAccountNumber());
             validateAccountNumberNotAlreadyInUse(updatedUser);
         }
 
@@ -104,6 +107,7 @@ public UserResponseDto updateCurrentUser(UserRegisterRequestDto updatedUser) {
                 .setEmail(updatedUser.getEmail())
                 .setAccountNumber(updatedUser.getAccountNumber())
                 .setPassword(authenticationService.encodePassword(updatedUser.getPassword()));
+        logger.info("Update request '{}' '{}' | Saving updated user", updatedUser.getName(), updatedUser.getEmail());
         return getUserResponseDto(userRepository.save(currentUser));
     }
 
diff --git a/src/test/java/tech/artadevs/finances/SpringbootApplicationTests.java b/src/test/java/tech/artadevs/finances/SpringbootApplicationTests.java
@@ -10,4 +10,8 @@ class SpringbootApplicationTests {
 	void contextLoads() {
 	}
 
+	@Test
+	void testMainMethod() {
+		SpringbootApplication.main(new String[] {});
+	}
 }
diff --git a/src/test/java/tech/artadevs/finances/controllers/CustomErrorControllerTest.java b/src/test/java/tech/artadevs/finances/controllers/CustomErrorControllerTest.java
@@ -0,0 +1,31 @@
+package tech.artadevs.finances.controllers;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+import tech.artadevs.finances.dtos.ApiErrorDto;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class CustomErrorControllerTest {
+
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @Test
+    void testErrorHandling() {
+        ResponseEntity<ApiErrorDto> response = restTemplate.getForEntity("/error", ApiErrorDto.class);
+
+        assertEquals(HttpStatus.NOT_FOUND, response.getStatusCode());
+
+        ApiErrorDto apiErrorDto = response.getBody();
+        assertNotNull(apiErrorDto);
+        assertEquals("Access /docs to see the API documentation.", apiErrorDto.getDetail());
+    }
+}
diff --git a/src/test/java/tech/artadevs/finances/controllers/HealthControllerTest.java b/src/test/java/tech/artadevs/finances/controllers/HealthControllerTest.java
@@ -0,0 +1,29 @@
+package tech.artadevs.finances.controllers;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class HealthControllerTest {
+
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @SuppressWarnings("null")
+    @Test
+    void testHealthEndpoint() {
+        @SuppressWarnings("rawtypes")
+        ResponseEntity<Map> response = restTemplate.getForEntity("/health", Map.class);
+
+        assertEquals(HttpStatus.OK, response.getStatusCode());
+        assertEquals("healthy", response.getBody().get("status"));
+    }
+}
diff --git a/src/test/java/tech/artadevs/finances/controllers/RootControllerTest.java b/src/test/java/tech/artadevs/finances/controllers/RootControllerTest.java
@@ -0,0 +1,27 @@
+package tech.artadevs.finances.controllers;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class RootControllerTest {
+
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @SuppressWarnings("null")
+    @Test
+    void testRedirectToDocs() {
+        ResponseEntity<String> response = restTemplate.getForEntity("/", String.class);
+
+        assertEquals(HttpStatus.OK, response.getStatusCode());
+        assertTrue(response.getBody().contains("<title>Swagger UI</title>"));
+    }
+}
diff --git a/src/test/java/tech/artadevs/finances/controllers/UserControllerTest.java b/src/test/java/tech/artadevs/finances/controllers/UserControllerTest.java
diff --git a/src/test/java/tech/artadevs/finances/services/AuthenticationServiceTest.java b/src/test/java/tech/artadevs/finances/services/AuthenticationServiceTest.java
diff --git a/src/test/java/tech/artadevs/finances/services/FinancialTransactionServiceTest.java b/src/test/java/tech/artadevs/finances/services/FinancialTransactionServiceTest.java
diff --git a/src/test/java/tech/artadevs/finances/services/JwtServiceTest.java b/src/test/java/tech/artadevs/finances/services/JwtServiceTest.java
diff --git a/src/test/java/tech/artadevs/finances/services/UserServiceTest.java b/src/test/java/tech/artadevs/finances/services/UserServiceTest.java
diff --git a/src/test/resources/application.properties b/src/test/resources/application.properties

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package tech.artadevs.finances.controller;`
	`1`	`+package tech.artadevs.finances.controllers;`
`2`	`2`
`3`	`3`	`import org.springframework.boot.web.servlet.error.ErrorController;`
`4`	`4`	`import org.springframework.http.HttpStatus;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`
`2`		`-package tech.artadevs.finances.controller;`
	`2`	`+package tech.artadevs.finances.controllers;`
`3`	`3`
`4`	`4`	`import javax.validation.Valid;`
`5`	`5`