Add ProjectAlreadyExistsException and enhance project creation validations (#19)

angelmp01 · web-flow · commit bcbbb1162a3d · 2026-04-27T15:46:41.000+02:00
…tion
diff --git a/api-project/src/main/java/org/opendevstack/apiservice/project/controller/ProjectResponseFactory.java b/api-project/src/main/java/org/opendevstack/apiservice/project/controller/ProjectResponseFactory.java
@@ -8,20 +8,6 @@ public final class ProjectResponseFactory {
     private ProjectResponseFactory() {
     }
 
-    public static CreateProjectResponse conflict(String message, String location) {
-        return error(
-                ErrorKey.PROJECT_ALREADY_EXISTS.getMessage(), 
-                ErrorKey.PROJECT_ALREADY_EXISTS.getKey(), 
-                message, location);
-    }
-
-    public static CreateProjectResponse projectKeyGenerationFailed(String location) {
-        return error(ErrorKey.INTERNAL_ERROR.getMessage(), 
-                "PROJECT_KEY_GENERATION_FAILED",
-                "Failed to generate a unique project key.",
-                location);
-    }
-
     public static CreateProjectResponse notFound(String projectKey, String location) {
         return error(
                 ErrorKey.PROJECT_NOT_FOUND.getMessage(), 
@@ -31,22 +17,6 @@ public static CreateProjectResponse notFound(String projectKey, String location)
         );
     }
 
-    public static CreateProjectResponse internalError(String location) {
-        return error(
-                ErrorKey.INTERNAL_ERROR.getMessage(),
-                ErrorKey.INTERNAL_ERROR.getKey(),
-                "An error occurred while processing the request.",
-                location);
-    }
-
-    public static CreateProjectResponse internalError(String location, String message) {
-        return error(
-                ErrorKey.INTERNAL_ERROR.getMessage(),
-                ErrorKey.INTERNAL_ERROR.getKey(),
-                message,
-                location);
-    }    
-
     private static CreateProjectResponse error(String error, String errorKey, String message, String location) {
         CreateProjectResponse response = new CreateProjectResponse();
         response.setError(error);
diff --git a/api-project/src/main/java/org/opendevstack/apiservice/project/controller/advice/ProjectExceptionHandler.java b/api-project/src/main/java/org/opendevstack/apiservice/project/controller/advice/ProjectExceptionHandler.java
@@ -5,6 +5,7 @@
 import org.opendevstack.apiservice.project.controller.ProjectController;
 import org.opendevstack.apiservice.project.exception.ClientAppNotRegisteredException;
 import org.opendevstack.apiservice.project.exception.ErrorKey;
+import org.opendevstack.apiservice.project.exception.ProjectAlreadyExistsException;
 import org.opendevstack.apiservice.project.exception.ProjectCreationException;
 import org.opendevstack.apiservice.project.exception.ProjectValidationException;
 import org.opendevstack.apiservice.project.model.CreateProjectResponse;
@@ -81,10 +82,24 @@ public ResponseEntity<CreateProjectResponse> handleValidationException(ProjectVa
         response.setLocation(ProjectController.API_BASE_PATH);
         response.setError(HttpStatus.BAD_REQUEST.getReasonPhrase());
         response.setErrorKey(errorKey.getKey());
-        response.setMessage(ex.getMessage()); // Needs to get the full message with additional info provided.
+        response.setMessage(ex.getMessage());
         return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(response);
     }
 
+    @ExceptionHandler(ProjectAlreadyExistsException.class)
+    public ResponseEntity<CreateProjectResponse> handleProjectAlreadyExistsException(ProjectAlreadyExistsException ex) {
+        log.warn("Validation error: {}", ex.getMessage());
+        ErrorKey errorKey = ex.getErrorKey() != null
+            ? ex.getErrorKey()
+            : ErrorKey.PROJECT_ALREADY_EXISTS;
+        CreateProjectResponse response = new CreateProjectResponse();
+        response.setLocation(ProjectController.API_BASE_PATH);
+        response.setError(HttpStatus.CONFLICT.getReasonPhrase());
+        response.setErrorKey(errorKey.getKey());
+        response.setMessage(errorKey.getMessage());
+        return ResponseEntity.status(HttpStatus.CONFLICT).body(response);
+    }    
+
     @ExceptionHandler(ProjectCreationException.class)
     public ResponseEntity<CreateProjectResponse> handleProjectCreationException(
             ProjectCreationException ex) {
@@ -114,9 +129,9 @@ public ResponseEntity<CreateProjectResponse> handleHttpMessageNotReadableExcepti
         log.error("Unexpected error: {}", ex.getMessage(), ex);
         CreateProjectResponse response = new CreateProjectResponse();
         response.setLocation(ProjectController.API_BASE_PATH);
-        response.setError(ErrorKey.BAD_REQUEST_BODY.getMessage());
-        response.setErrorKey(ErrorKey.BAD_REQUEST_BODY.getKey());
-        response.setMessage("An error occurred while processing the request.");
+        response.setError(ErrorKey.COMPONENT_PARAM_INVALID_FORMAT.getMessage());
+        response.setErrorKey(ErrorKey.COMPONENT_PARAM_INVALID_FORMAT.getKey());
+        response.setMessage("Request body should be a valid json.");
         return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(response);
     }
 
diff --git a/api-project/src/main/java/org/opendevstack/apiservice/project/exception/ProjectAlreadyExistsException.java b/api-project/src/main/java/org/opendevstack/apiservice/project/exception/ProjectAlreadyExistsException.java
@@ -0,0 +1,19 @@
+package org.opendevstack.apiservice.project.exception;
+
+import lombok.Getter;
+
+@Getter
+public class ProjectAlreadyExistsException extends RuntimeException {
+    
+    private ErrorKey errorKey;
+
+    public ProjectAlreadyExistsException() {
+        super();
+    }
+    
+    public ProjectAlreadyExistsException(ErrorKey errorKey) {
+        super(errorKey.getMessage());
+        this.errorKey = errorKey;
+    }
+}
+
diff --git a/api-project/src/main/java/org/opendevstack/apiservice/project/facade/impl/ProjectCreationCommandBuilder.java b/api-project/src/main/java/org/opendevstack/apiservice/project/facade/impl/ProjectCreationCommandBuilder.java
@@ -6,6 +6,7 @@
 import org.opendevstack.apiservice.persistence.entity.ClientAppEntity;
 import org.opendevstack.apiservice.persistence.entity.ClientAppProjectFlavorEntity;
 import org.opendevstack.apiservice.project.exception.ErrorKey;
+import org.opendevstack.apiservice.project.exception.ProjectAlreadyExistsException;
 import org.opendevstack.apiservice.project.exception.ProjectCreationException;
 import org.opendevstack.apiservice.project.exception.ProjectValidationException;
 import org.opendevstack.apiservice.project.model.CreateProjectRequest;
@@ -15,6 +16,7 @@
 import org.opendevstack.apiservice.serviceproject.service.ProjectExistenceService;
 import org.springframework.stereotype.Component;
 
+import java.text.MessageFormat;
 import java.util.Arrays;
 import java.util.List;
 import java.util.UUID;
@@ -37,7 +39,7 @@ public ProjectCreationCommand build(CreateProjectRequest request, ClientAppEntit
         String x2account = firstNonBlank(request.getX2OdsAccount(), flavor.getServiceAccount());
         String location = firstNonBlank(request.getLocation(), flavor.getLocation());
         String projectKey = resolveProjectKey(request.getProjectKey(), flavor);
-        String projectName = firstNonBlank(request.getProjectName(), projectKey);
+        String projectName = resolveProjectName(request.getProjectName(), projectKey);
         String projectDescription = firstNonBlank(request.getProjectDescription(), "project " + projectFlavor);
 
         return new ProjectCreationCommand(
@@ -91,7 +93,11 @@ private ClientAppProjectFlavorEntity resolveByConfigurationItem(
         if (matchingFlavors.size() != 1) {
             log.warn("ConfigItem '{}' does not match exactly one flavor for clientApp '{}'",
                     configurationItem, clientId);
-            throw new ProjectValidationException(ErrorKey.INVALID_CONFIG_ITEM);
+            String message = MessageFormat.
+                    format("Not exists a project flavor configured for the Config Item {0}. " +
+                            "To create a project under {0} the projectFlavor parameter is mandatory.", 
+                            configurationItem);
+            throw new ProjectValidationException(ErrorKey.INVALID_CONFIG_ITEM, message);
         }
 
         ClientAppProjectFlavorEntity matchedFlavor = matchingFlavors.getFirst();
@@ -112,7 +118,7 @@ private String resolveProjectKey(String existingProjectKey, ClientAppProjectFlav
                     return existingProjectKey;
                 }
 
-                throw new ProjectValidationException(ErrorKey.PROJECT_ALREADY_EXISTS);
+                throw new ProjectAlreadyExistsException(ErrorKey.PROJECT_ALREADY_EXISTS);
             }
 
             String pattern = flavor.getProjectKeyPattern();
@@ -138,5 +144,19 @@ private boolean isAllowedConfigItem(String configurationItem, ClientAppProjectFl
     private String firstNonBlank(String preferred, String fallback) {
         return Strings.isNotEmpty(preferred) ? preferred : fallback;
     }
+    
+    private String resolveProjectName(String preferred, String fallback) {
+        if (!Strings.isEmpty(preferred)) {
+            try {
+                if (projectExistenceService.isProjectFoundByName(preferred)) {
+                    throw new ProjectAlreadyExistsException(ErrorKey.PROJECT_SAME_PROJECT_NAME_ALREADY_EXISTS);
+                }
+            } catch (ProjectExistenceServiceException e) {
+                throw new ProjectCreationException("Error checking if project name already exists: " + e.getMessage(), e);
+            }
+        }
+        
+        return firstNonBlank(preferred, fallback);
+    }
 }
 
diff --git a/api-project/src/test/java/org/opendevstack/apiservice/project/controller/advice/ProjectExceptionHandlerTest.java b/api-project/src/test/java/org/opendevstack/apiservice/project/controller/advice/ProjectExceptionHandlerTest.java
@@ -11,13 +11,15 @@
 import org.opendevstack.apiservice.project.controller.ProjectController;
 import org.opendevstack.apiservice.project.exception.ClientAppNotRegisteredException;
 import org.opendevstack.apiservice.project.exception.ErrorKey;
+import org.opendevstack.apiservice.project.exception.ProjectAlreadyExistsException;
 import org.opendevstack.apiservice.project.exception.ProjectCreationException;
 import org.opendevstack.apiservice.project.exception.ProjectValidationException;
 import org.opendevstack.apiservice.project.model.CreateProjectRequest;
 import org.opendevstack.apiservice.project.model.CreateProjectResponse;
 import org.springframework.core.MethodParameter;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
 import org.springframework.validation.BeanPropertyBindingResult;
 import org.springframework.validation.FieldError;
 import org.springframework.web.bind.MethodArgumentNotValidException;
@@ -287,4 +289,32 @@ void handle_generic_exception_returns_internal_server_error() {
         assertNull(result.getBody().getStatus());
         assertNull(result.getBody().getErrorDescription());
     }
+
+    @Test
+    void handle_http_message_not_readable_exception_returns_bad_request_with_error_key_017() {
+        HttpMessageNotReadableException exception = new HttpMessageNotReadableException("Malformed JSON", new RuntimeException("cause"));
+
+        ResponseEntity<CreateProjectResponse> result = sut.handleHttpMessageNotReadableException(exception);
+
+        assertEquals(HttpStatus.BAD_REQUEST, result.getStatusCode());
+        assertNotNull(result.getBody());
+        assertEquals(ProjectController.API_BASE_PATH, result.getBody().getLocation());
+        assertEquals("Bad Request", result.getBody().getError());
+        assertEquals("017", result.getBody().getErrorKey());
+        assertEquals("Request body should be a valid json.", result.getBody().getMessage());
+    }
+
+    @Test
+    void handle_project_already_exists_exception_returns_conflict() {
+        ProjectAlreadyExistsException exception = new ProjectAlreadyExistsException();
+
+        ResponseEntity<CreateProjectResponse> result = sut.handleProjectAlreadyExistsException(exception);
+
+        assertEquals(HttpStatus.CONFLICT, result.getStatusCode());
+        assertNotNull(result.getBody());
+        assertEquals(ProjectController.API_BASE_PATH, result.getBody().getLocation());
+        assertEquals("Conflict", result.getBody().getError());
+        assertEquals("025", result.getBody().getErrorKey());
+        assertEquals("Project already exists", result.getBody().getMessage());
+    }
 }
diff --git a/api-project/src/test/java/org/opendevstack/apiservice/project/facade/impl/ProjectCreationCommandBuilderTest.java b/api-project/src/test/java/org/opendevstack/apiservice/project/facade/impl/ProjectCreationCommandBuilderTest.java
@@ -8,6 +8,7 @@
 import org.opendevstack.apiservice.persistence.entity.ClientAppEntity;
 import org.opendevstack.apiservice.persistence.entity.ClientAppProjectFlavorEntity;
 import org.opendevstack.apiservice.project.exception.ErrorKey;
+import org.opendevstack.apiservice.project.exception.ProjectAlreadyExistsException;
 import org.opendevstack.apiservice.project.exception.ProjectCreationException;
 import org.opendevstack.apiservice.project.exception.ProjectValidationException;
 import org.opendevstack.apiservice.project.model.CreateProjectRequest;
@@ -97,14 +98,14 @@ void build_generates_project_key_when_request_project_key_is_null() throws Proje
     }
 
     @Test
-    void build_throws_validation_exception_when_project_key_already_exists() throws ProjectExistenceServiceException {
+    void build_throws_project_already_exists_exception_when_project_key_already_exists() throws ProjectExistenceServiceException {
         ClientAppProjectFlavorEntity flavor = build_flavor("DLSS", "CI-001", new String[] {}, "eu", "owner1");
         ClientAppEntity clientApp = build_client_app(List.of(flavor));
         CreateProjectRequest request = build_request("DLSS", null, "KEY01");
 
         when(projectExistenceService.isProjectFound("KEY01")).thenReturn(true);
 
-        ProjectValidationException ex = assertThrows(ProjectValidationException.class,
+        ProjectAlreadyExistsException ex = assertThrows(ProjectAlreadyExistsException.class,
                 () -> sut.build(request, clientApp));
         assertEquals(ErrorKey.PROJECT_ALREADY_EXISTS, ex.getErrorKey());
     }
@@ -144,6 +145,33 @@ void build_throws_project_key_generation_exception_when_generation_fails() throw
         assertThrows(ProjectCreationException.class, () -> sut.build(request, clientApp));
     }
 
+    @Test
+    void build_throws_project_already_exists_exception_when_project_name_already_exists() throws Exception {
+        ClientAppProjectFlavorEntity flavor = build_flavor("DLSS", "CI-001", new String[] {}, "eu", "owner1");
+        ClientAppEntity clientApp = build_client_app(List.of(flavor));
+        CreateProjectRequest request = build_request("DLSS", null, "KEY01");
+        request.setProjectName("Existing Project");
+
+        when(projectExistenceService.isProjectFound("KEY01")).thenReturn(false);
+        when(projectExistenceService.isProjectFoundByName("Existing Project")).thenReturn(true);
+
+        assertThrows(ProjectAlreadyExistsException.class, () -> sut.build(request, clientApp));
+    }
+
+    @Test
+    void build_throws_project_creation_exception_when_project_name_check_fails() throws Exception {
+        ClientAppProjectFlavorEntity flavor = build_flavor("DLSS", "CI-001", new String[] {}, "eu", "owner1");
+        ClientAppEntity clientApp = build_client_app(List.of(flavor));
+        CreateProjectRequest request = build_request("DLSS", null, "KEY01");
+        request.setProjectName("Any Project");
+
+        when(projectExistenceService.isProjectFound("KEY01")).thenReturn(false);
+        when(projectExistenceService.isProjectFoundByName("Any Project"))
+                .thenThrow(new ProjectExistenceServiceException("lookup failed"));
+
+        assertThrows(ProjectCreationException.class, () -> sut.build(request, clientApp));
+    }
+
     private CreateProjectRequest build_request(String flavor, String configItem, String projectKey) {
         CreateProjectRequest request = new CreateProjectRequest();
         request.setProjectKey(projectKey);
diff --git a/persistence/src/main/java/org/opendevstack/apiservice/persistence/repository/ProjectRepository.java b/persistence/src/main/java/org/opendevstack/apiservice/persistence/repository/ProjectRepository.java
@@ -22,6 +22,8 @@
 public interface ProjectRepository extends JpaRepository<ProjectEntity, UUID> {
 	
 	Optional<ProjectEntity> findByProjectKeyIgnoreCase(String projectKey);
+
+	List<ProjectEntity> findByProjectNameIgnoreCase(String projectName);
 	
 	List<ProjectEntity> findByDeletedFalse();
 	
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
@@ -1,8 +1,11 @@
 package org.opendevstack.apiservice.serviceproject.mapper;
 
 import java.util.Arrays;
+import java.util.List;
+
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
+import org.mapstruct.IterableMapping;
 import org.mapstruct.Named;
 import org.opendevstack.apiservice.persistence.entity.ProjectEntity;
 import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
@@ -13,8 +16,12 @@ public interface ProjectResponseMapper {
 
     @Mapping(source = "status", target = "status", qualifiedByName = "mapStatus")
     @Mapping(source = "id", target = "projectId")
+    @Named("mapEntityToResponse")
     ProjectResponse toCreateProjectResponse(ProjectEntity entity);
 
+    @IterableMapping(qualifiedByName = "mapEntityToResponse")
+    List<ProjectResponse> toCreateProjectResponse(List<ProjectEntity> entities);
+
     @Named("mapStatus")
     default Status mapStatus(String value) {
         if (value == null) {
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/ProjectExistenceService.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/ProjectExistenceService.java
@@ -5,4 +5,6 @@
 public interface ProjectExistenceService {
     
     boolean isProjectFound(String projectKey) throws ProjectExistenceServiceException;
+
+    boolean isProjectFoundByName(String projecName) throws ProjectExistenceServiceException;
 }
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
@@ -3,10 +3,14 @@
 import org.opendevstack.apiservice.serviceproject.model.ProjectRequest;
 import org.opendevstack.apiservice.serviceproject.model.ProjectResponse;
 
+import java.util.List;
+
 public interface ProjectService {
 
     ProjectResponse saveProject(ProjectRequest request);
 
     ProjectResponse getProject(String projectKey);
+    
+    List<ProjectResponse> findProjectsByName(String projectName);
 }
 
diff --git a/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectExistenceServiceImpl.java b/service-projects/src/main/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectExistenceServiceImpl.java
@@ -53,6 +53,11 @@ public boolean isProjectFound(String projectKey) throws ProjectExistenceServiceE
         }
     }
 
+    @Override
+    public boolean isProjectFoundByName(String projecName) throws ProjectExistenceServiceException {
+        return !projectService.findProjectsByName(projecName).isEmpty();
+    }
+
     private boolean existsInCollection(String projectKey) {
         return projectService.getProject(projectKey) != null;
     }
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
@@ -10,6 +10,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 
+import java.util.List;
 import java.util.Optional;
 
 @Service
@@ -61,6 +62,12 @@ public ProjectResponse getProject(String projectKey) {
         return null;
     }
 
+    @Override
+    public List<ProjectResponse> findProjectsByName(String projectName) {
+        List<ProjectEntity> projects = projectRepository.findByProjectNameIgnoreCase(projectName);
+        return projectResponseMapper.toCreateProjectResponse(projects);
+    }
+
     private String getLdapGroup(String role, String projectKey) {
         return ldapGroupPattern
                 .replace("{{projectKey}}", projectKey)
diff --git a/service-projects/src/test/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectExistenceServiceImplTest.java b/service-projects/src/test/java/org/opendevstack/apiservice/serviceproject/service/impl/ProjectExistenceServiceImplTest.java
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

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,6 @@`
`5`	`5`	`public interface ProjectExistenceService {`
`6`	`6`
`7`	`7`	`boolean isProjectFound(String projectKey) throws ProjectExistenceServiceException;`
	`8`	`+`
	`9`	`+ boolean isProjectFoundByName(String projecName) throws ProjectExistenceServiceException;`
`8`	`10`	`}`