feat: Implement Update Project Route (SCRUM-11) (!28)

Co-authored-by: Phan Huy Tran <p.tran@neusta.de>
Reviewed-on: #28
Reviewed-by: Jan Gleytenhoover <krisellp9@gmail.com>
Co-authored-by: Phan Huy Tran <ptran@noreply.localhost>
Co-committed-by: Phan Huy Tran <ptran@noreply.localhost>

requests/getProject.http

@@ -1,3 +1,3 @@
 ### GET request to example server
-GET http://localhost:8080/projects/2
+GET http://localhost:8080/projects/1
 Authorization: Bearer {{auth_token}}

requests/updateProject.http

@@ -0,0 +1,15 @@
+### GET request to example server
+PUT http://localhost:8080/projects/1
+Authorization: Bearer {{auth_token}}
+Content-Type: application/json
+
+{
+  "name": "newName",
+  "leading_employee": 2,
+  "employees": [],
+  "contractor": 9,
+  "contractor_name": "New Contractor name",
+  "comment": "new goal of project",
+  "start_date": "01.01.2010",
+  "planned_end_date": "01.01.2021"
+}

src/main/java/de/szut/lf8_starter/exceptionHandling/GlobalExceptionHandler.java

@@ -6,6 +6,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import jakarta.validation.ConstraintViolationException;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
@@ -40,6 +41,13 @@ public class GlobalExceptionHandler {
         return new ResponseEntity<>(errorDetails, HttpStatus.BAD_REQUEST);
     }
 
+    @ExceptionHandler(HttpMessageNotReadableException.class)
+    public ResponseEntity<ErrorDetails> handleHttpMessageNotReadableException(HttpMessageNotReadableException ex, WebRequest request) {
+        ErrorDetails errorDetails = new ErrorDetails(new Date(), ex.getMessage(), request.getDescription(false));
+
+        return new ResponseEntity<>(errorDetails, HttpStatus.BAD_REQUEST);
+    }
+
     @ExceptionHandler(ConstraintViolationException.class)
     public ResponseEntity<ErrorDetails> handleConstraintViolationException(ConstraintViolationException ex, WebRequest request) {
         String errorMessage = ex.getConstraintViolations().stream().findFirst().get().getMessage();

src/main/java/de/szut/lf8_starter/project/ProjectMapper.java

@@ -2,6 +2,7 @@ package de.szut.lf8_starter.project;
 
 import de.szut.lf8_starter.project.dto.CreateProjectDto;
 import de.szut.lf8_starter.project.dto.GetProjectDto;
+import de.szut.lf8_starter.project.dto.UpdateProjectDto;
 import org.springframework.stereotype.Service;
 
 @Service
@@ -38,4 +39,23 @@ public class ProjectMapper {
 
         return getProjectDto;
     }
+
+    public ProjectEntity mapUpdateDtoToEntity(UpdateProjectDto updateProjectDto, ProjectEntity projectEntity) {
+        projectEntity.setName(updateProjectDto.getName() != null ? updateProjectDto.getName() : projectEntity.getName());
+        projectEntity.setLeadingEmployee(updateProjectDto.getLeadingEmployee() != null ? updateProjectDto.getLeadingEmployee() : projectEntity.getLeadingEmployee());
+        projectEntity.setContractor(updateProjectDto.getContractor() != null ? updateProjectDto.getContractor() : projectEntity.getContractor());
+        projectEntity.setContractorName(updateProjectDto.getContractorName() != null ? updateProjectDto.getContractorName() : projectEntity.getContractorName());
+        projectEntity.setComment(updateProjectDto.getComment() != null ? updateProjectDto.getComment() : projectEntity.getComment());
+        projectEntity.setStartDate(updateProjectDto.getStartDate() != null ? updateProjectDto.getStartDate() : projectEntity.getStartDate());
+        projectEntity.setPlannedEndDate(updateProjectDto.getPlannedEndDate() != null ? updateProjectDto.getPlannedEndDate() : projectEntity.getPlannedEndDate());
+        projectEntity.setEndDate(updateProjectDto.getEndDate() != null ? updateProjectDto.getEndDate() : projectEntity.getEndDate());
+
+        if (updateProjectDto.getEmployees() != null) {
+            projectEntity.getEmployees().clear();
+
+            projectEntity.setEmployees(updateProjectDto.getEmployees());
+        }
+
+        return projectEntity;
+    }
 }

src/main/java/de/szut/lf8_starter/project/ProjectService.java

@@ -1,6 +1,5 @@
 package de.szut.lf8_starter.project;
 
-import de.szut.lf8_starter.exceptionHandling.ResourceNotFoundException;
 import org.springframework.stereotype.Service;
 
 import java.util.List;
@@ -22,13 +21,13 @@ public class ProjectService {
         return this.projectRepository.findAll();
     }
 
-    public ProjectEntity findById(Long id) {
-        Optional<ProjectEntity> articleEntity = projectRepository.findById(id);
+    public Optional<ProjectEntity> findById(Long id) {
+        return projectRepository.findById(id);
+    }
 
-        if (articleEntity.isEmpty()) {
-            throw new ResourceNotFoundException("Project with id " + id + " not found");
-        }
+    public ProjectEntity update(ProjectEntity project) {
+        this.projectRepository.save(project);
 
-        return articleEntity.get();
+        return project;
     }
 }

src/main/java/de/szut/lf8_starter/project/action/GetProjectAction.java

@@ -13,6 +13,8 @@ import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
+import java.util.Optional;
+
 @RestController
 @RequestMapping(value = "projects")
 public class GetProjectAction {
@@ -33,8 +35,12 @@ public class GetProjectAction {
     })
     @GetMapping("/{id}")
     public ResponseEntity<GetProjectDto> findArticleById(@PathVariable Long id) {
-        ProjectEntity project = this.projectService.findById(id);
+        Optional<ProjectEntity> project = this.projectService.findById(id);
 
-        return new ResponseEntity<>(this.projectMapper.mapToGetDto(project), HttpStatus.OK);
+        if (project.isEmpty()) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+
+        return new ResponseEntity<>(this.projectMapper.mapToGetDto(project.get()), HttpStatus.OK);
     }
 }

src/main/java/de/szut/lf8_starter/project/action/UpdateProjectAction.java

@@ -0,0 +1,50 @@
+package de.szut.lf8_starter.project.action;
+
+import de.szut.lf8_starter.project.ProjectEntity;
+import de.szut.lf8_starter.project.ProjectMapper;
+import de.szut.lf8_starter.project.ProjectService;
+import de.szut.lf8_starter.project.dto.GetProjectDto;
+import de.szut.lf8_starter.project.dto.UpdateProjectDto;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import jakarta.validation.Valid;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.Optional;
+
+@RestController
+@RequestMapping(value = "/projects")
+public class UpdateProjectAction {
+    private final ProjectService projectService;
+    private final ProjectMapper projectMapper;
+
+    public UpdateProjectAction(ProjectService projectService, ProjectMapper mappingService) {
+        this.projectService = projectService;
+        this.projectMapper = mappingService;
+    }
+
+    @Operation(summary = "Update a project by ID")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "Project updated successfully",
+                    content = @Content(mediaType = "application/json", schema = @Schema(implementation = GetProjectDto.class))),
+            @ApiResponse(responseCode = "404", description = "Project not found", content = @Content)
+    })
+    @PutMapping("/{id}")
+    public ResponseEntity<GetProjectDto> updateSupplier(@PathVariable Long id, @Valid @RequestBody UpdateProjectDto updateProjectDto) {
+        Optional<ProjectEntity> project = this.projectService.findById(id);
+
+        if (project.isEmpty()) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+
+        ProjectEntity updatedProject = this.projectMapper.mapUpdateDtoToEntity(updateProjectDto, project.get());
+        this.projectService.update(updatedProject);
+
+        return new ResponseEntity<>(this.projectMapper.mapToGetDto(updatedProject), HttpStatus.OK);
+    }
+}

src/main/java/de/szut/lf8_starter/project/dto/UpdateProjectDto.java

@@ -0,0 +1,36 @@
+package de.szut.lf8_starter.project.dto;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import lombok.Getter;
+import lombok.Setter;
+
+import java.time.LocalDate;
+import java.util.List;
+
+@Getter
+@Setter
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+public class UpdateProjectDto {
+    private String name;
+
+    private Long leadingEmployee;
+
+    private List<Long> employees;
+
+    private Long contractor;
+
+    private String contractorName;
+
+    private String comment;
+
+    @JsonFormat(pattern = "dd.MM.yyyy")
+    private LocalDate startDate;
+
+    @JsonFormat(pattern = "dd.MM.yyyy")
+    private LocalDate plannedEndDate;
+
+    @JsonFormat(pattern = "dd.MM.yyyy")
+    private LocalDate endDate;
+}

src/test/java/de/szut/lf8_starter/integration/project/GetProjectActionTest.java

@@ -18,14 +18,14 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
 
 @SpringBootTest
 @AutoConfigureMockMvc(addFilters = false)
-class FindProjectActionTest {
+class GetProjectActionTest {
     @Autowired
     private MockMvc mockMvc;
     @Autowired
     private ProjectRepository projectRepository;
 
     @Test
-    void createProjectTest() throws Exception {
+    void getProjectTest() throws Exception {
         var project = new ProjectEntity();
         project.setId(1);
         project.setComment("comment");
@@ -51,4 +51,9 @@ class FindProjectActionTest {
                 .andExpect(jsonPath("employees").isArray())
                 .andExpect(jsonPath("employees", hasSize(3)));
     }
+
+    @Test
+    void getProjectShouldReturnNotFoundResponseWhenProjectIsNotFound() throws Exception {
+        this.mockMvc.perform(get("/projects/2")).andExpect(status().isNotFound());
+    }
 }

src/test/java/de/szut/lf8_starter/integration/project/UpdateProjectActionTest.java

@@ -0,0 +1,140 @@
+package de.szut.lf8_starter.integration.project;
+
+import de.szut.lf8_starter.project.ProjectEntity;
+import de.szut.lf8_starter.project.ProjectRepository;
+import org.json.JSONObject;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.servlet.MockMvc;
+
+import java.time.LocalDate;
+import java.util.Arrays;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest
+@AutoConfigureMockMvc(addFilters = false)
+class UpdateProjectActionTest {
+    @Autowired
+    private MockMvc mockMvc;
+    @Autowired
+    private ProjectRepository projectRepository;
+
+    @Test
+    void updateProjectShouldUpdateProject() throws Exception {
+        ProjectEntity project = new ProjectEntity();
+        project.setId(1);
+        project.setComment("comment");
+        project.setContractor(1);
+        project.setContractorName("contractorName");
+        project.setEndDate(LocalDate.of(2024, 1, 1));
+        project.setLeadingEmployee(1);
+        project.setName("name");
+        project.setStartDate(LocalDate.of(2021, 1, 1));
+        project.setEmployees(List.of(1L, 2L, 3L));
+        this.projectRepository.save(project);
+
+        String content = """
+                {
+                    "name": "updatedName",
+                    "leading_employee": 2,
+                    "employees": [3, 4, 5],
+                    "contractor": 6,
+                    "contractor_name": "Updated Contractor name",
+                    "comment": "new goal of project",
+                    "start_date": "01.01.2021",
+                    "planned_end_date": "01.01.2022"
+                  }
+                """;
+
+        final var contentAsString = this.mockMvc.perform(
+                        put("/projects/1").content(content).contentType(MediaType.APPLICATION_JSON)
+                )
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("name", is("updatedName")))
+                .andExpect(jsonPath("leading_employee", is(2)))
+                .andExpect(jsonPath("employees", is(Arrays.asList(3, 4, 5))))
+                .andExpect(jsonPath("contractor", is(6)))
+                .andExpect(jsonPath("contractor_name", is("Updated Contractor name")))
+                .andExpect(jsonPath("comment", is("new goal of project")))
+                .andExpect(jsonPath("start_date", is("01.01.2021")))
+                .andExpect(jsonPath("planned_end_date", is("01.01.2022")))
+                .andReturn()
+                .getResponse()
+                .getContentAsString();
+
+        final var id = Long.parseLong(new JSONObject(contentAsString).get("id").toString());
+
+        final var existingProject = this.projectRepository.findById(id);
+        assertThat(existingProject.get().getName()).isEqualTo("updatedName");
+        assertThat(existingProject.get().getLeadingEmployee()).isEqualTo(2);
+        assertThat(existingProject.get().getContractor()).isEqualTo(6);
+        assertThat(existingProject.get().getContractorName()).isEqualTo("Updated Contractor name");
+        assertThat(existingProject.get().getComment()).isEqualTo("new goal of project");
+        assertThat(existingProject.get().getStartDate()).isEqualTo(LocalDate.of(2021, 1, 1));
+        assertThat(existingProject.get().getPlannedEndDate()).isEqualTo(LocalDate.of(2022, 1, 1));
+
+    }
+
+    @Test
+    void updateProjectShouldUpdateProjectPartially() throws Exception {
+        ProjectEntity project = new ProjectEntity();
+        project.setId(1);
+        project.setName("name");
+        project.setLeadingEmployee(1);
+        project.setContractor(1);
+        project.setComment("comment");
+        project.setEmployees(List.of(1L, 2L, 3L));
+        project.setContractorName("contractorName");
+        project.setStartDate(LocalDate.of(2021, 1, 1));
+        project.setPlannedEndDate(LocalDate.of(2023, 1, 1));
+        project.setEndDate(LocalDate.of(2024, 1, 1));
+        this.projectRepository.save(project);
+
+        String content = """
+                {}
+                """;
+
+        final var contentAsString = this.mockMvc.perform(
+                        put("/projects/1").content(content).contentType(MediaType.APPLICATION_JSON)
+                )
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("name", is("name")))
+                .andExpect(jsonPath("leading_employee", is(1)))
+                .andExpect(jsonPath("employees", is(List.of(1,2,3))))
+                .andExpect(jsonPath("contractor", is(1)))
+                .andExpect(jsonPath("contractor_name", is("contractorName")))
+                .andExpect(jsonPath("comment", is("comment")))
+                .andExpect(jsonPath("start_date", is("01.01.2021")))
+                .andExpect(jsonPath("planned_end_date", is("01.01.2023")))
+                .andExpect(jsonPath("end_date", is("01.01.2024")))
+                .andReturn()
+                .getResponse()
+                .getContentAsString();
+
+        final var id = Long.parseLong(new JSONObject(contentAsString).get("id").toString());
+
+        final var existingProject = this.projectRepository.findById(id);
+        assertThat(existingProject.get().getName()).isEqualTo("name");
+        assertThat(existingProject.get().getLeadingEmployee()).isEqualTo(1);
+        assertThat(existingProject.get().getContractor()).isEqualTo(1);
+        assertThat(existingProject.get().getContractorName()).isEqualTo("contractorName");
+        assertThat(existingProject.get().getComment()).isEqualTo("comment");
+        assertThat(existingProject.get().getStartDate()).isEqualTo(LocalDate.of(2021, 1, 1));
+        assertThat(existingProject.get().getPlannedEndDate()).isEqualTo(LocalDate.of(2023, 1, 1));
+        assertThat(existingProject.get().getEndDate()).isEqualTo(LocalDate.of(2024, 1, 1));
+    }
+
+    @Test
+    void updateProjectShouldReturnNotFoundResponseWhenProjectIsNotFound() throws Exception {
+        this.mockMvc.perform(put("/projects/2").content("{}").contentType(MediaType.APPLICATION_JSON)).andExpect(status().isNotFound());
+    }
+}