From 9a123d1e76b6882df5a1d5c7046bc5d0b7966566 Mon Sep 17 00:00:00 2001 From: Phan Huy Tran Date: Wed, 23 Oct 2024 14:11:57 +0200 Subject: [PATCH] Implement feature to acknowledge project time frames when assigning employees to projects --- requests/project/createProject.http | 6 +- .../lf8_starter/project/ProjectService.java | 15 ++ .../action/crud/CreateProjectAction.java | 33 +++- .../{ => crud}/RemoveProjectAction.java | 2 +- .../employee/AddEmployeeToProjectAction.java | 20 +- .../project/CreateProjectActionTest.java | 177 +++++++++++++++++- 6 files changed, 233 insertions(+), 20 deletions(-) rename src/main/java/de/szut/lf8_starter/project/action/{ => crud}/RemoveProjectAction.java (97%) diff --git a/requests/project/createProject.http b/requests/project/createProject.http index 3338a2c..1e044b5 100644 --- a/requests/project/createProject.http +++ b/requests/project/createProject.http @@ -6,10 +6,10 @@ Content-Type: application/json { "name": "name", "leading_employee": 1, - "employees": [315, 312], + "employees": [312], "contractor": 4, "contractor_name": "Peter File", "comment": "goal of project", - "start_date": "01.01.2000", - "planned_end_date": "01.01.2001" + "start_date": "02.01.2020", + "planned_end_date": "01.01.2023" } \ No newline at end of file diff --git a/src/main/java/de/szut/lf8_starter/project/ProjectService.java b/src/main/java/de/szut/lf8_starter/project/ProjectService.java index 17afcea..5a50454 100644 --- a/src/main/java/de/szut/lf8_starter/project/ProjectService.java +++ b/src/main/java/de/szut/lf8_starter/project/ProjectService.java @@ -1,5 +1,6 @@ package de.szut.lf8_starter.project; +import de.szut.lf8_starter.project.dto.project.GetProjectDto; import org.springframework.stereotype.Service; import java.util.List; @@ -32,4 +33,18 @@ public class ProjectService { public void delete(Long id) { this.projectRepository.deleteById(id); } + + public boolean isOverlapping(GetProjectDto getProjectDto, ProjectEntity existingProjectEntity) { + return isDateRangeOverlapping(getProjectDto, existingProjectEntity) || isDateEqual(getProjectDto, existingProjectEntity); + } + + private boolean isDateRangeOverlapping(GetProjectDto getProjectDto, ProjectEntity existingProjectEntity) { + return getProjectDto.getStartDate().isBefore(existingProjectEntity.getPlannedEndDate()) + && getProjectDto.getPlannedEndDate().isAfter(existingProjectEntity.getStartDate()); + } + + private boolean isDateEqual(GetProjectDto getProjectDto, ProjectEntity existingProjectEntity) { + return getProjectDto.getStartDate().isEqual(existingProjectEntity.getStartDate()) + || getProjectDto.getPlannedEndDate().isEqual(existingProjectEntity.getPlannedEndDate()); + } } diff --git a/src/main/java/de/szut/lf8_starter/project/action/crud/CreateProjectAction.java b/src/main/java/de/szut/lf8_starter/project/action/crud/CreateProjectAction.java index 1725ba8..6b0c3b5 100644 --- a/src/main/java/de/szut/lf8_starter/project/action/crud/CreateProjectAction.java +++ b/src/main/java/de/szut/lf8_starter/project/action/crud/CreateProjectAction.java @@ -1,5 +1,6 @@ package de.szut.lf8_starter.project.action.crud; +import de.szut.lf8_starter.employee.EmployeeService; import de.szut.lf8_starter.project.ProjectEntity; import de.szut.lf8_starter.project.ProjectService; import de.szut.lf8_starter.project.dto.project.CreateProjectDto; @@ -12,15 +13,18 @@ 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.*; @RestController @RequestMapping(value = "/projects") public class CreateProjectAction { + private final EmployeeService employeeService; private final ProjectService projectService; private final ProjectMapper projectMapper; - public CreateProjectAction(ProjectService projectService, ProjectMapper mappingService) { + public CreateProjectAction(EmployeeService employeeService, ProjectService projectService, ProjectMapper mappingService) { + this.employeeService = employeeService; this.projectService = projectService; this.projectMapper = mappingService; } @@ -29,14 +33,31 @@ public class CreateProjectAction { @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "created project", content = {@Content(mediaType = "application/json", schema = @Schema(implementation = GetProjectDto.class))}), @ApiResponse(responseCode = "400", description = "invalid JSON posted", content = @Content), - @ApiResponse(responseCode = "401", description = "not authorized", content = @Content)}) + @ApiResponse(responseCode = "401", description = "not authorized", content = @Content), + @ApiResponse(responseCode = "409", description = "Project dates conflict", content = @Content) + }) @PostMapping @ResponseStatus(code = HttpStatus.CREATED) - public GetProjectDto create(@RequestBody @Valid CreateProjectDto createProjectDto) { - ProjectEntity projectEntity = this.projectMapper.mapCreateDtoToEntity(createProjectDto); + public ResponseEntity create( + @RequestBody @Valid CreateProjectDto createProjectDto, + @RequestHeader("Authorization") String accessToken + ) { + ProjectEntity project = this.projectMapper.mapCreateDtoToEntity(createProjectDto); - projectEntity = this.projectService.create(projectEntity); + for (Long employeeId : createProjectDto.getEmployees()) { + if (!this.employeeService.employeeExists(accessToken, employeeId)) { + return new ResponseEntity<>(HttpStatus.NOT_FOUND); + } - return this.projectMapper.mapToGetDto(projectEntity); + for (GetProjectDto getProjectDto : this.employeeService.getProjects(employeeId)) { + if (projectService.isOverlapping(getProjectDto, project)) { + return new ResponseEntity<>("Project dates conflict with an existing project for Employee with ID: " + employeeId, HttpStatus.CONFLICT); + } + } + } + + this.projectService.create(project); + + return new ResponseEntity<>(this.projectMapper.mapToGetDto(project), HttpStatus.CREATED); } } diff --git a/src/main/java/de/szut/lf8_starter/project/action/RemoveProjectAction.java b/src/main/java/de/szut/lf8_starter/project/action/crud/RemoveProjectAction.java similarity index 97% rename from src/main/java/de/szut/lf8_starter/project/action/RemoveProjectAction.java rename to src/main/java/de/szut/lf8_starter/project/action/crud/RemoveProjectAction.java index efbd48d..49aebab 100644 --- a/src/main/java/de/szut/lf8_starter/project/action/RemoveProjectAction.java +++ b/src/main/java/de/szut/lf8_starter/project/action/crud/RemoveProjectAction.java @@ -1,4 +1,4 @@ -package de.szut.lf8_starter.project.action; +package de.szut.lf8_starter.project.action.crud; import de.szut.lf8_starter.project.ProjectEntity; import de.szut.lf8_starter.project.ProjectService; diff --git a/src/main/java/de/szut/lf8_starter/project/action/employee/AddEmployeeToProjectAction.java b/src/main/java/de/szut/lf8_starter/project/action/employee/AddEmployeeToProjectAction.java index 1e14ae0..d9862e8 100644 --- a/src/main/java/de/szut/lf8_starter/project/action/employee/AddEmployeeToProjectAction.java +++ b/src/main/java/de/szut/lf8_starter/project/action/employee/AddEmployeeToProjectAction.java @@ -3,6 +3,7 @@ package de.szut.lf8_starter.project.action.employee; import de.szut.lf8_starter.employee.EmployeeService; import de.szut.lf8_starter.project.ProjectEntity; import de.szut.lf8_starter.project.ProjectService; +import de.szut.lf8_starter.project.dto.project.GetProjectDto; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.responses.ApiResponse; @@ -29,7 +30,8 @@ public class AddEmployeeToProjectAction { @Operation(summary = "Add an employee to a project") @ApiResponses(value = { @ApiResponse(responseCode = "204", description = "Employee added to project"), - @ApiResponse(responseCode = "404", description = "Project or employee not found", content = @Content) + @ApiResponse(responseCode = "404", description = "Project or employee not found", content = @Content), + @ApiResponse(responseCode = "409", description = "Project dates conflict", content = @Content) }) @PostMapping("/projects/{projectId}/employees/{employeeId}") public ResponseEntity create( @@ -37,18 +39,26 @@ public class AddEmployeeToProjectAction { @PathVariable Long employeeId, @RequestHeader("Authorization") String accessToken ) { - Optional project = this.projectService.findById(projectId); + Optional optionalProject = this.projectService.findById(projectId); - if (project.isEmpty()) { + if (optionalProject.isEmpty()) { return new ResponseEntity<>(HttpStatus.NOT_FOUND); } + ProjectEntity projectEntity = optionalProject.get(); + if (!this.employeeService.employeeExists(accessToken, employeeId)) { return new ResponseEntity<>(HttpStatus.NOT_FOUND); } - project.get().getEmployees().add(employeeId); - this.projectService.update(project.get()); + for (GetProjectDto getProjectDto : this.employeeService.getProjects(employeeId)) { + if (this.projectService.isOverlapping(getProjectDto, projectEntity)) { + return new ResponseEntity<>("Project dates conflict with an existing project for Employee with ID: " + employeeId, HttpStatus.CONFLICT); + } + } + + projectEntity.getEmployees().add(employeeId); + this.projectService.update(projectEntity); return new ResponseEntity<>(HttpStatus.NO_CONTENT); } diff --git a/src/test/java/de/szut/lf8_starter/integration/project/CreateProjectActionTest.java b/src/test/java/de/szut/lf8_starter/integration/project/CreateProjectActionTest.java index 27fe186..c5f87cc 100644 --- a/src/test/java/de/szut/lf8_starter/integration/project/CreateProjectActionTest.java +++ b/src/test/java/de/szut/lf8_starter/integration/project/CreateProjectActionTest.java @@ -3,15 +3,21 @@ 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.BeforeEach; 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.http.*; import org.springframework.test.web.servlet.MockMvc; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.client.RestTemplate; import java.time.LocalDate; -import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Objects; import java.util.Optional; import static org.assertj.core.api.Assertions.assertThat; @@ -27,6 +33,13 @@ class CreateProjectActionTest { private MockMvc mockMvc; @Autowired private ProjectRepository projectRepository; + @Autowired + private RestTemplate restTemplate; + + @BeforeEach + public void clear() { + this.projectRepository.deleteAll(); + } @Test void createProjectTest() throws Exception { @@ -34,7 +47,7 @@ class CreateProjectActionTest { { "name": "name", "leading_employee": 1, - "employees": [2, 3], + "employees": [312], "contractor": 4, "contractor_name": "Peter File", "comment": "goal of project", @@ -44,12 +57,15 @@ class CreateProjectActionTest { """; final String contentAsString = this.mockMvc.perform( - post("/projects").content(content).contentType(MediaType.APPLICATION_JSON) + post("/projects") + .content(content) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) ) .andExpect(status().isCreated()) .andExpect(jsonPath("name", is("name"))) .andExpect(jsonPath("leading_employee", is(1))) - .andExpect(jsonPath("employees", is(Arrays.asList(2, 3)))) + .andExpect(jsonPath("employees", is(List.of(312)))) .andExpect(jsonPath("contractor", is(4))) .andExpect(jsonPath("contractor_name", is("Peter File"))) .andExpect(jsonPath("comment", is("goal of project"))) @@ -70,4 +86,155 @@ class CreateProjectActionTest { assertThat(project.get().getStartDate()).isEqualTo(LocalDate.of(2000, 1, 1)); assertThat(project.get().getPlannedEndDate()).isEqualTo(LocalDate.of(2001, 1, 1)); } + + @Test + void createProjectShouldReturnConflictResponseOnConflictingProjects() throws Exception { + String content = """ + { + "name": "name", + "leading_employee": 1, + "employees": [312], + "contractor": 4, + "contractor_name": "Peter File", + "comment": "goal of project", + "start_date": "01.01.2000", + "planned_end_date": "01.01.2001" + } + """; + + this.mockMvc.perform( + post("/projects") + .content(content) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) + ) + .andExpect(status().isCreated()); + + this.mockMvc.perform( + post("/projects") + .content(content) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) + ) + .andExpect(status().isConflict()); + } + + @Test + void createProjectWithPastStartDate() throws Exception { + String content = """ + { + "name": "past project", + "leading_employee": 1, + "employees": [312], + "contractor": 4, + "contractor_name": "Past Contractor", + "comment": "past project", + "start_date": "01.01.1990", + "planned_end_date": "01.01.1991" + } + """; + + this.mockMvc.perform( + post("/projects") + .content(content) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) + ) + .andExpect(status().isCreated()) + .andExpect(jsonPath("name", is("past project"))) + .andExpect(jsonPath("start_date", is("01.01.1990"))) + .andExpect(jsonPath("planned_end_date", is("01.01.1991"))); + } + + @Test + void createProjectWithFutureStartDate() throws Exception { + String content = """ + { + "name": "future project", + "leading_employee": 1, + "employees": [312], + "contractor": 4, + "contractor_name": "Future Contractor", + "comment": "future project", + "start_date": "01.01.2100", + "planned_end_date": "01.01.2101" + } + """; + + this.mockMvc.perform( + post("/projects") + .content(content) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) + ) + .andExpect(status().isCreated()) + .andExpect(jsonPath("name", is("future project"))) + .andExpect(jsonPath("start_date", is("01.01.2100"))) + .andExpect(jsonPath("planned_end_date", is("01.01.2101"))); + } + + @Test + void createProjectWithOverlappingDates() throws Exception { + String content1 = """ + { + "name": "project 1", + "leading_employee": 1, + "employees": [312], + "contractor": 4, + "contractor_name": "Contractor 1", + "comment": "project 1", + "start_date": "01.01.2022", + "planned_end_date": "01.01.2023" + } + """; + + String content2 = """ + { + "name": "project 2", + "leading_employee": 1, + "employees": [312], + "contractor": 4, + "contractor_name": "Contractor 2", + "comment": "project 2", + "start_date": "01.06.2022", + "planned_end_date": "01.06.2023" + } + """; + + this.mockMvc.perform( + post("/projects") + .content(content1) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) + ) + .andExpect(status().isCreated()); + + this.mockMvc.perform( + post("/projects") + .content(content2) + .contentType(MediaType.APPLICATION_JSON) + .header(HttpHeaders.AUTHORIZATION, getBearerToken()) + ) + .andExpect(status().isConflict()); + } + + private String getBearerToken() { + String url = "https://keycloak.szut.dev/auth/realms/szut/protocol/openid-connect/token"; + + HttpHeaders headers = new HttpHeaders(); + headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); + + MultiValueMap map = new LinkedMultiValueMap<>(); + map.add("grant_type", "password"); + map.add("client_id", "employee-management-service"); + map.add("username", "user"); + map.add("password", "test"); + + HttpEntity> request = new HttpEntity<>(map, headers); + + ResponseEntity response = this.restTemplate.exchange(url, HttpMethod.POST, request, Map.class); + + return Objects.requireNonNull(response.getBody()).get("access_token").toString(); + } } +