feat(rest): Endpoint to add comment on a clearing request

Signed-off-by: Akshit Joshi <akshit.joshi@siemens-healthineers.com>

rest/resource-server/src/docs/asciidoc/clearingRequests.adoc

@@ -93,3 +93,26 @@ include::{snippets}/should_document_get_comments_by_clearing_request_id/curl-req
 
 ===== Example response
 include::{snippets}/should_document_get_comments_by_clearing_request_id/http-response.adoc[]
+[[resources-add-comment-to-clearingrequest]]
+==== Add a new comment to a clearing request
+
+A `POST` request will add a new comment to a specific clearing request.
+
+===== Request Parameters
+
+include::{snippets}/should_document_add_comment_to_clearingrequest/request-parameters.adoc[]
+
+===== Request Example
+
+include::{snippets}/should_document_add_comment_to_clearingrequest/curl-request.adoc[]
+
+===== Response Structure
+
+include::{snippets}/should_document_add_comment_to_clearingrequest/response-fields.adoc[]
+
+===== Response Example
+
+include::{snippets}/should_document_add_comment_to_clearingrequest/http-response.adoc[]
+
+
+

rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/clearingrequest/ClearingRequestController.java

@@ -23,6 +23,7 @@
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+
 import jakarta.servlet.http.HttpServletRequest;
 
 import io.swagger.v3.oas.annotations.Operation;
@@ -36,7 +37,6 @@
 import org.eclipse.sw360.datahandler.resourcelists.ResourceClassNotFoundException;
 import org.eclipse.sw360.datahandler.thrift.ClearingRequestState;
 import org.eclipse.sw360.datahandler.thrift.Comment;
-import org.eclipse.sw360.datahandler.thrift.components.Release;
 import org.eclipse.sw360.datahandler.thrift.projects.ClearingRequest;
 import org.eclipse.sw360.datahandler.thrift.projects.Project;
 import org.eclipse.sw360.datahandler.thrift.users.User;
@@ -144,6 +144,7 @@ private HalResource<ClearingRequest> createHalClearingRequestWithAllDetails(Clea
         return halClearingRequest;
     }
 
+
     @Operation(
             summary = "Get all the Clearing Requests visible to the user.",
             description = "Get all the Clearing Requests visible to the user.",
@@ -185,7 +186,6 @@ public ResponseEntity<CollectionModel<EntityModel<ClearingRequest>>> getMyCleari
         return new ResponseEntity<>(resources, status);
     }
 
-
     @Operation(
             summary = "Get comments for a specific clearing request",
             description = "Fetch a paginated list of comments associated with the given clearing request ID.",
@@ -229,6 +229,47 @@ public ResponseEntity<CollectionModel<?>> getCommentsByClearingRequestId(
         }
     }
 
+    @Operation(
+            summary = "Add a new comment to a clearing request.",
+            description = "Create a new comment for the clearing request.",
+            tags = {"ClearingRequest"}
+    )
+    @PreAuthorize("hasAuthority('WRITE')")
+    @RequestMapping(value = CLEARING_REQUEST_URL + "/{id}/comments", method = RequestMethod.POST)
+    public ResponseEntity<?> addComment(
+            @Parameter(description = "ID of the clearing request")
+            @PathVariable("id") String crId,
+            @Parameter(description = "Comment to be added to the clearing request",
+                    content = @Content(mediaType = "application/json",
+                            schema = @Schema(implementation = Comment.class)))
+            @RequestBody Comment comment,
+            HttpServletRequest request
+    ) {
+        try {
+            User sw360User = restControllerHelper.getSw360UserFromAuthentication();
+            ClearingRequest existingClearingRequest = sw360ClearingRequestService.getClearingRequestById(crId, sw360User);
+            ClearingRequest updatedClearingRequest = sw360ClearingRequestService.addCommentToClearingRequest(crId, comment, sw360User);
+
+            List<Comment> sortedComments = updatedClearingRequest.getComments().stream()
+                    .sorted((c1, c2) -> Long.compare(c2.getCommentedOn(), c1.getCommentedOn()))
+                    .toList();
+            List<EntityModel<Comment>> commentList = new ArrayList<>();
+
+            for (Comment c : sortedComments) {
+                HalResource<Comment> resource = createHalComment(c);
+                commentList.add(resource);
+            }
+            CollectionModel<EntityModel<Comment>> resources = CollectionModel.of(commentList);
+            return new ResponseEntity<>(resources, HttpStatus.OK);
+        }catch (IllegalArgumentException e) {
+            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
+        }catch (ResourceNotFoundException e) {
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body("Clearing request not found.");
+        }catch (TException e) {
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("An error occurred while processing the request.");
+        }
+    }
+
     private HalResource<Comment> createHalComment(Comment comment) throws TException {
         HalResource<Comment> halComment = new HalResource<>(comment);
         User commentinguser = restControllerHelper.getUserByEmail(comment.getCommentedBy());

rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/clearingrequest/Sw360ClearingRequestService.java

@@ -17,6 +17,8 @@
 import org.apache.thrift.transport.THttpClient;
 import org.apache.thrift.transport.TTransportException;
 import org.eclipse.sw360.datahandler.thrift.ClearingRequestState;
+import org.eclipse.sw360.datahandler.thrift.Comment;
+import org.eclipse.sw360.datahandler.thrift.RequestStatus;
 import org.eclipse.sw360.datahandler.thrift.SW360Exception;
 import org.eclipse.sw360.datahandler.thrift.moderation.ModerationService;
 import org.eclipse.sw360.datahandler.thrift.projects.ClearingRequest;
@@ -88,4 +90,25 @@ public Set<ClearingRequest> getMyClearingRequests(User sw360User, ClearingReques
         return clearingrequests;
     }
 
+    public ClearingRequest addCommentToClearingRequest(String crId, Comment comment, User sw360User) throws TException {
+        if (crId == null || crId.isBlank()) {
+            throw new IllegalArgumentException("Clearing request ID cannot be null or empty.");
+        }
+        if (comment.getText() == null || comment.getText().trim().isEmpty()) {
+            throw new IllegalArgumentException("Comment text cannot be empty.");
+        }
+
+        comment.setCommentedBy(sw360User.getEmail());
+        comment.setText(comment.getText().trim());
+
+        ModerationService.Iface clearingRequestClient = getThriftModerationClient();
+        RequestStatus requestStatus = clearingRequestClient.addCommentToClearingRequest(crId, comment, sw360User);
+        if (requestStatus != RequestStatus.SUCCESS) {
+            throw new TException("Error adding comment to clearing request");
+        }
+        return getClearingRequestById(crId, sw360User);
+    }
+
+
+
 }

rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ClearingRequestSpecTest.java

@@ -14,9 +14,8 @@
 import static org.mockito.BDDMockito.given;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
-import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
-import static org.springframework.restdocs.payload.PayloadDocumentation.subsectionWithPath;
-import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.post;
+import static org.springframework.restdocs.payload.PayloadDocumentation.*;
 import static org.springframework.restdocs.request.RequestDocumentation.*;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -61,6 +60,7 @@ public class ClearingRequestSpecTest extends TestRestDocsSpecBase {
     ClearingRequest cr1 = new ClearingRequest();
     ClearingRequest cr2 = new ClearingRequest();
     List<Comment> comments = new ArrayList<Comment>();
+
     @Before
     public void before() throws TException, IOException {
         clearingRequest.setId("CR-101");
@@ -198,6 +198,7 @@ public void before() throws TException, IOException {
 
         comments.add(comment);
         clearingRequest.setComments(comments);
+        given(this.clearingRequestServiceMock.addCommentToClearingRequest(eq(clearingRequest.getId()), any(), any())).willReturn(clearingRequest);
 
         given(this.clearingRequestServiceMock.getClearingRequestById(eq(clearingRequest.getId()), any())).willReturn(clearingRequest);
         given(this.clearingRequestServiceMock.getClearingRequestByProjectId(eq(clearingRequest.getProjectId()), any())).willReturn(clearingRequest);
@@ -366,4 +367,28 @@ public void should_document_get_comments_by_clearing_request_id() throws Excepti
                         )));
     }
 
+    public void should_add_comment_to_clearing_request() throws Exception {
+        Map<String, Object> comment = new LinkedHashMap<>();
+        comment.put("text", "comment text 1");
+        String accessToken = TestHelper.generateAuthHeader(testUserId, testUserPassword);
+
+        this.mockMvc.perform(
+                        post("/api/clearingrequest/" + clearingRequest.getId() + "/comments")
+                                .contentType(MediaTypes.HAL_JSON)
+                                .content(this.objectMapper.writeValueAsString(comment))
+                                .header("Authorization", accessToken))
+                .andExpect(status().isOk())
+                .andDo(this.documentationHandler.document(
+                        requestFields(
+                                fieldWithPath("text").description("The text of the comment")
+                        ),
+                        responseFields(
+                                fieldWithPath("_embedded.sw360:comments[].text").description("The text of the comment"),
+                                fieldWithPath("_embedded.sw360:comments[].commentedBy").description("The user who made the comment"),
+                                fieldWithPath("_embedded.sw360:comments[].commentedOn").description("Timestamp when the comment was made"),
+                                subsectionWithPath("_embedded.sw360:comments[]._embedded.commentingUser").description("Details of the user who made the comment"),
+                                subsectionWithPath("_links").description("<<resources-index-links,Links>> to other resources")
+                        )
+                ));
+    }
 }