Refactor project request and response models, update mappings, and add global Jackson configuration

angelmp01 · angelmp01 · commit 1d81b0f7dd78 · 2026-03-16T16:49:53.000+01:00
diff --git a/api-project/openapi/api-project.yaml b/api-project/openapi/api-project.yaml
@@ -150,3 +150,5 @@ components:
           type: string
         errorDescription:
           type: string
+        location:
+          type: string
diff --git a/api-project/src/main/java/org/opendevstack/apiservice/project/mapper/ProjectMapper.java b/api-project/src/main/java/org/opendevstack/apiservice/project/mapper/ProjectMapper.java
@@ -1,15 +1,34 @@
 package org.opendevstack.apiservice.project.mapper;
 
+import org.apache.logging.log4j.util.Strings;
 import org.mapstruct.Mapper;
 import org.opendevstack.apiservice.project.model.CreateProjectRequest;
 import org.opendevstack.apiservice.project.model.CreateProjectResponse;
+import org.opendevstack.apiservice.serviceproject.model.ProjectRequest;
+import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
 
 @Mapper(componentModel = "spring")
 public interface ProjectMapper {
     
-    org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest toServiceRequest(
+    ProjectRequest toServiceRequest(
             CreateProjectRequest apiRequest);
-    
-    CreateProjectResponse toApiResponse(
-            org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse serviceResponse);
+
+    default CreateProjectResponse toApiResponse(ProjectResponse serviceResponse) {
+        if (serviceResponse == null) {
+                return null;
+        }
+
+        CreateProjectResponse response = new CreateProjectResponse();
+        response.setProjectKey(serviceResponse.getProjectKey());
+        
+        if (!Strings.isEmpty(serviceResponse.getStatus())) {
+            response.setStatus(serviceResponse.getStatus());
+        }
+
+        if (!Strings.isEmpty(serviceResponse.getProjectKey())) {
+                response.setLocation("/api/pub/v0/projects/" + serviceResponse.getProjectKey());
+        }
+
+        return response;
+        }
 }
diff --git a/api-project/src/test/java/org/opendevstack/apiservice/project/facade/impl/ProjectsFacadeImplTest.java b/api-project/src/test/java/org/opendevstack/apiservice/project/facade/impl/ProjectsFacadeImplTest.java
@@ -9,6 +9,8 @@
 import org.opendevstack.apiservice.project.mapper.ProjectMapper;
 import org.opendevstack.apiservice.project.model.CreateProjectRequest;
 import org.opendevstack.apiservice.project.model.CreateProjectResponse;
+import org.opendevstack.apiservice.serviceproject.model.ProjectRequest;
+import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
 import org.opendevstack.apiservice.serviceproject.service.ProjectService;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -35,13 +37,13 @@ void createProject_whenServiceReturnsValue_thenMapToApiModel() throws Exception
         CreateProjectRequest request = new CreateProjectRequest("My Project");
         request.setProjectKey("PROJ01");
 
-        org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse serviceResponse =
-                new org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse();
+        ProjectResponse serviceResponse =
+                new ProjectResponse();
         serviceResponse.setProjectKey("PROJ01");
         serviceResponse.setStatus("Initiated");
 
         when(projectService.createProject(org.mockito.ArgumentMatchers.any(
-                org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest.class)))
+                ProjectRequest.class)))
                 .thenReturn(serviceResponse);
 
         CreateProjectResponse response = sut.createProject(request);
@@ -50,14 +52,14 @@ void createProject_whenServiceReturnsValue_thenMapToApiModel() throws Exception
         assertThat(response.getProjectKey()).isEqualTo("PROJ01");
         assertThat(response.getStatus()).isEqualTo("Initiated");
         verify(projectService).createProject(org.mockito.ArgumentMatchers.any(
-                org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest.class));
+                ProjectRequest.class));
     }
 
     @Test
     void createProject_whenServiceReturnsNull_thenReturnNull() throws Exception {
         CreateProjectRequest request = new CreateProjectRequest("My Project");
         when(projectService.createProject(org.mockito.ArgumentMatchers.any(
-                org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest.class)))
+                ProjectRequest.class)))
                 .thenReturn(null);
 
         CreateProjectResponse response = sut.createProject(request);
@@ -67,8 +69,8 @@ void createProject_whenServiceReturnsNull_thenReturnNull() throws Exception {
 
     @Test
     void getProject_whenServiceReturnsValue_thenMapToApiModel() throws Exception {
-        org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse serviceResponse =
-                new org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse();
+        ProjectResponse serviceResponse =
+                new ProjectResponse();
         serviceResponse.setProjectKey("PROJ01");
         serviceResponse.setStatus("Found");
 
diff --git a/core/src/main/java/org/opendevstack/apiservice/core/config/JacksonConfig.java b/core/src/main/java/org/opendevstack/apiservice/core/config/JacksonConfig.java
@@ -0,0 +1,21 @@
+package org.opendevstack.apiservice.core.config;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Global Jackson configuration.
+ * Ensures that null properties are omitted from all JSON responses.
+ */
+@Configuration
+public class JacksonConfig {
+
+    @Bean
+    public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
+        return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL);
+    }
+}
+
+
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/mapper/CreateProjectResponseMapper.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/mapper/CreateProjectResponseMapper.java
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/mapper/ProjectResponseMapper.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/mapper/ProjectResponseMapper.java
@@ -0,0 +1,11 @@
+package org.opendevstack.apiservice.serviceproject.mapper;
+
+import org.mapstruct.Mapper;
+import org.opendevstack.apiservice.persistence.entity.ProjectEntity;
+import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
+
+@Mapper(componentModel = "spring")
+public interface ProjectResponseMapper {
+    
+    ProjectResponse toCreateProjectResponse(ProjectEntity entity);
+}
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/model/ProjectRequest.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/model/ProjectRequest.java
@@ -7,7 +7,7 @@
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
-public class CreateProjectRequest {
+public class ProjectRequest {
     
     private String projectKey;
     
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/model/ProjectResponse.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/model/ProjectResponse.java
@@ -9,17 +9,9 @@
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
-public class CreateProjectResponse {
+public class ProjectResponse {
     
     private String projectKey;
     
     private String status;
-    
-    private String message;
-    
-    private String error;
-    
-    private String errorKey;
-    
-    private String errorDescription;
 }
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/ProjectService.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/ProjectService.java
@@ -1,12 +1,12 @@
 package org.opendevstack.apiservice.serviceproject.service;
 
-import org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest;
-import org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse;
+import org.opendevstack.apiservice.serviceproject.model.ProjectRequest;
+import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
 
 public interface ProjectService {
 
-    CreateProjectResponse createProject(CreateProjectRequest request);
+    ProjectResponse createProject(ProjectRequest request);
 
-    CreateProjectResponse getProject(String projectKey);
+    ProjectResponse getProject(String projectKey);
 }
 
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectServiceImpl.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectServiceImpl.java
@@ -7,9 +7,9 @@
 import org.opendevstack.apiservice.externalservice.ocp.service.OpenshiftService;
 import org.opendevstack.apiservice.persistence.entity.ProjectEntity;
 import org.opendevstack.apiservice.persistence.repository.ProjectRepository;
-import org.opendevstack.apiservice.serviceproject.mapper.CreateProjectResponseMapper;
-import org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest;
-import org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse;
+import org.opendevstack.apiservice.serviceproject.mapper.ProjectResponseMapper;
+import org.opendevstack.apiservice.serviceproject.model.ProjectRequest;
+import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
 import org.opendevstack.apiservice.serviceproject.service.GenerateProjectKeyService;
 import org.opendevstack.apiservice.serviceproject.service.ProjectService;
 import org.springframework.stereotype.Service;
@@ -31,19 +31,19 @@ public class ProjectServiceImpl implements ProjectService {
     
     private final ProjectRepository projectRepository;
     
-    private final CreateProjectResponseMapper createProjectResponseMapper;
+    private final ProjectResponseMapper projectResponseMapper;
 
     @Override
-    public CreateProjectResponse createProject(CreateProjectRequest request) {
-        return CreateProjectResponse.builder().build();
+    public ProjectResponse createProject(ProjectRequest request) {
+        return ProjectResponse.builder().build();
     }
 
     @Override
-    public CreateProjectResponse getProject(String projectKey) {
+    public ProjectResponse getProject(String projectKey) {
         Optional<ProjectEntity> project = projectRepository.findByProjectKey(projectKey);
         
         if (project.isPresent()) {
-            return createProjectResponseMapper.toCreateProjectResponse(project.get());
+            return projectResponseMapper.toCreateProjectResponse(project.get());
         }
         
         return null;
diff --git a/service-projects/src/test/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectServiceImplTest.java b/service-projects/src/test/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectServiceImplTest.java
@@ -9,9 +9,9 @@
 import org.opendevstack.apiservice.externalservice.ocp.service.OpenshiftService;
 import org.opendevstack.apiservice.persistence.entity.ProjectEntity;
 import org.opendevstack.apiservice.persistence.repository.ProjectRepository;
-import org.opendevstack.apiservice.serviceproject.mapper.CreateProjectResponseMapper;
-import org.opendevstack.apiservice.serviceproject.model.CreateProjectRequest;
-import org.opendevstack.apiservice.serviceproject.model.CreateProjectResponse;
+import org.opendevstack.apiservice.serviceproject.mapper.ProjectResponseMapper;
+import org.opendevstack.apiservice.serviceproject.model.ProjectRequest;
+import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
 import org.opendevstack.apiservice.serviceproject.service.GenerateProjectKeyService;
 
 import java.util.Optional;
@@ -44,7 +44,7 @@ class ProjectServiceImplTest {
     private ProjectRepository projectRepository;
 
     @Mock
-    private CreateProjectResponseMapper createProjectResponseMapper;
+    private ProjectResponseMapper projectResponseMapper;
 
     private ProjectServiceImpl projectService;
 
@@ -57,7 +57,7 @@ void setUp() {
                 jiraService,
                 generateProjectKeyService,
                 projectRepository,
-                createProjectResponseMapper
+                projectResponseMapper
         );
     }
 
@@ -81,23 +81,23 @@ void get_project_returns_response_when_project_exists() {
                 .ldapGroupTeam("cn=my-project-team,ou=groups,dc=example,dc=com")
                 .build();
 
-        CreateProjectResponse expectedResponse = CreateProjectResponse.builder()
+        ProjectResponse expectedResponse = ProjectResponse.builder()
                 .projectKey(projectKey)
                 .status("Completed")
                 .build();
 
         when(projectRepository.findByProjectKey(projectKey)).thenReturn(Optional.of(projectEntity));
-        when(createProjectResponseMapper.toCreateProjectResponse(projectEntity)).thenReturn(expectedResponse);
+        when(projectResponseMapper.toCreateProjectResponse(projectEntity)).thenReturn(expectedResponse);
 
         // WHEN
-        CreateProjectResponse result = projectService.getProject(projectKey);
+        ProjectResponse result = projectService.getProject(projectKey);
 
         // THEN
         assertNotNull(result);
         assertEquals(projectKey, result.getProjectKey());
         assertEquals("Completed", result.getStatus());
         verify(projectRepository).findByProjectKey(projectKey);
-        verify(createProjectResponseMapper).toCreateProjectResponse(projectEntity);
+        verify(projectResponseMapper).toCreateProjectResponse(projectEntity);
     }
 
     @Test
@@ -108,25 +108,25 @@ void get_project_returns_null_when_project_does_not_exist() {
         when(projectRepository.findByProjectKey(projectKey)).thenReturn(Optional.empty());
 
         // WHEN
-        CreateProjectResponse result = projectService.getProject(projectKey);
+        ProjectResponse result = projectService.getProject(projectKey);
 
         // THEN
         assertNull(result);
         verify(projectRepository).findByProjectKey(projectKey);
-        verify(createProjectResponseMapper, never()).toCreateProjectResponse(any());
+        verify(projectResponseMapper, never()).toCreateProjectResponse(any());
     }
 
     @Test
     void create_project_returns_empty_response() {
         // GIVEN
-        CreateProjectRequest request = new CreateProjectRequest();
+        ProjectRequest request = new ProjectRequest();
         request.setProjectKey("NEW-PROJECT");
         request.setProjectKeyPattern("NEW%06d");
         request.setProjectName("New Project");
         request.setProjectDescription("New test project");
 
         // WHEN
-        CreateProjectResponse result = projectService.createProject(request);
+        ProjectResponse result = projectService.createProject(request);
 
         // THEN
         assertNotNull(result);
@@ -152,7 +152,7 @@ void get_project_returns_null_when_project_key_is_null() {
         when(projectRepository.findByProjectKey(null)).thenReturn(Optional.empty());
 
         // WHEN
-        CreateProjectResponse result = projectService.getProject(null);
+        ProjectResponse result = projectService.getProject(null);
 
         // THEN
         assertNull(result);
@@ -173,16 +173,16 @@ void get_project_returns_response_for_soft_deleted_project() {
                 .deleted(true)
                 .build();
 
-        CreateProjectResponse expectedResponse = CreateProjectResponse.builder()
+        ProjectResponse expectedResponse = ProjectResponse.builder()
                 .projectKey(projectKey)
                 .status("Deleted")
                 .build();
 
         when(projectRepository.findByProjectKey(projectKey)).thenReturn(Optional.of(deletedEntity));
-        when(createProjectResponseMapper.toCreateProjectResponse(deletedEntity)).thenReturn(expectedResponse);
+        when(projectResponseMapper.toCreateProjectResponse(deletedEntity)).thenReturn(expectedResponse);
 
         // WHEN
-        CreateProjectResponse result = projectService.getProject(projectKey);
+        ProjectResponse result = projectService.getProject(projectKey);
 
         // THEN
         assertNotNull(result);
