Move tms attachments to separate bucket

Author: imashkanov

api-registry

@@ -1,7 +1,7 @@
 [versions]
 # Development versions
 commons-dev = "f7c7d2c"
-commons-dao-dev = "f7ac74d"
+commons-dao-dev = "82ec540518"
 plugin-api-dev = "c4040dd"
 
 # Platform versions

gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 
 import com.epam.reportportal.rules.exception.ErrorType;
 import com.epam.reportportal.rules.exception.ReportPortalException;
-import com.epam.ta.reportportal.binary.impl.AttachmentDataStoreService;
+import com.epam.ta.reportportal.binary.tms.TmsAttachmentDataStoreService;
 import com.epam.ta.reportportal.core.tms.db.entity.TmsAttachment;
 import com.epam.ta.reportportal.core.tms.db.repository.TmsAttachmentRepository;
 import com.epam.ta.reportportal.core.tms.db.repository.TmsManualScenarioPreconditionsAttachmentRepository;
@@ -34,7 +34,7 @@
 public class TmsAttachmentServiceImpl implements TmsAttachmentService {
 
   private final TmsAttachmentRepository tmsAttachmentRepository;
-  private final AttachmentDataStoreService attachmentDataStoreService;
+  private final TmsAttachmentDataStoreService tmsAttachmentDataStoreService;
   private final TmsAttachmentMapper tmsAttachmentMapper;
   private final TmsStepAttachmentRepository tmsStepAttachmentRepository;
   private final TmsTextManualScenarioAttachmentRepository tmsTextManualScenarioAttachmentRepository;
@@ -51,7 +51,7 @@ public UploadAttachmentRS uploadAttachment(MultipartFile file) {
     }
 
     try {
-      var fileId = attachmentDataStoreService.save(file.getOriginalFilename(),
+      var fileId = tmsAttachmentDataStoreService.save(file.getOriginalFilename(),
           file.getInputStream());
 
       var attachment = tmsAttachmentMapper.convertToAttachment(fileId, file);
@@ -80,7 +80,7 @@ public void deleteAttachment(Long attachmentId) {
 
     try {
       // Delete file from data store
-      attachmentDataStoreService.delete(attachment.getPathToFile());
+      tmsAttachmentDataStoreService.delete(attachment.getPathToFile());
 
       // Delete attachment record
       tmsAttachmentRepository.deleteById(attachmentId);
@@ -109,7 +109,7 @@ public void cleanupExpiredAttachments() {
       // Delete files from data store
       expiredAttachments.forEach(attachment -> {
         try {
-          attachmentDataStoreService.delete(attachment.getPathToFile());
+          tmsAttachmentDataStoreService.delete(attachment.getPathToFile());
         } catch (Exception e) {
           log.warn("Failed to delete file {} for expired attachment {}: {}",
               attachment.getPathToFile(), attachment.getId(), e.getMessage());
@@ -144,15 +144,15 @@ public TmsAttachment duplicateTmsAttachment(TmsAttachment originalAttachment) {
 
     try {
       // Step 1: Load original file from data store
-      var originalFileStream = attachmentDataStoreService.load(originalAttachment.getPathToFile())
+      var originalFileStream = tmsAttachmentDataStoreService.load(originalAttachment.getPathToFile())
           .orElseThrow(() -> new ReportPortalException(ErrorType.NOT_FOUND,
               "Original attachment file not found: " + originalAttachment.getPathToFile()));
 
       // Step 2: Generate new unique filename to avoid conflicts
       var newFileName = generateDuplicateFileName(originalAttachment.getFileName());
 
       // Step 3: Save file copy to data store
-      var newFileId = attachmentDataStoreService.save(newFileName, originalFileStream);
+      var newFileId = tmsAttachmentDataStoreService.save(newFileName, originalFileStream);
 
       // Step 4: Create duplicated attachment entity
       var duplicatedAttachment = tmsAttachmentMapper.duplicateAttachment(originalAttachment,

src/main/java/com/epam/ta/reportportal/core/tms/service/TmsAttachmentServiceImpl.java

@@ -227,3 +227,4 @@ rp.oauth2.providers.internal.algorithm=HS256
 rp.tms.attachment.ttl=PT24H
 rp.tms.attachment.cleanup.enabled=true
 rp.tms.attachment.cleanup.cleanup.cron=PT1H
+tms.datastore.type: filesystem

src/main/resources/application.properties

@@ -18,7 +18,7 @@
 
 import com.epam.reportportal.rules.exception.ErrorType;
 import com.epam.reportportal.rules.exception.ReportPortalException;
-import com.epam.ta.reportportal.binary.impl.AttachmentDataStoreService;
+import com.epam.ta.reportportal.binary.tms.TmsAttachmentDataStoreService;
 import com.epam.ta.reportportal.core.tms.db.entity.TmsAttachment;
 import com.epam.ta.reportportal.core.tms.db.repository.TmsAttachmentRepository;
 import com.epam.ta.reportportal.core.tms.db.repository.TmsManualScenarioPreconditionsAttachmentRepository;
@@ -27,7 +27,6 @@
 import com.epam.ta.reportportal.core.tms.dto.UploadAttachmentRS;
 import com.epam.ta.reportportal.core.tms.mapper.TmsAttachmentMapper;
 import java.io.ByteArrayInputStream;
-import java.io.IOException;
 import java.io.InputStream;
 import java.time.Duration;
 import java.time.Instant;
@@ -53,7 +52,7 @@ class TmsAttachmentServiceImplTest {
   private TmsAttachmentRepository tmsAttachmentRepository;
 
   @Mock
-  private AttachmentDataStoreService attachmentDataStoreService;
+  private TmsAttachmentDataStoreService tmsAttachmentDataStoreService;
 
   @Mock
   private TmsAttachmentMapper tmsAttachmentMapper;
@@ -106,7 +105,7 @@ void setUp() {
   @Test
   void uploadAttachment_ShouldSucceed_WhenValidFile() throws Exception {
     // Given valid file to upload
-    when(attachmentDataStoreService.save(anyString(), any(InputStream.class))).thenReturn(fileId);
+    when(tmsAttachmentDataStoreService.save(anyString(), any(InputStream.class))).thenReturn(fileId);
     when(tmsAttachmentMapper.convertToAttachment(fileId, file)).thenReturn(attachment);
     when(tmsAttachmentRepository.save(attachment)).thenReturn(attachment);
     when(tmsAttachmentMapper.convertToUploadAttachmentRS(attachment)).thenReturn(
@@ -120,7 +119,7 @@ void uploadAttachment_ShouldSucceed_WhenValidFile() throws Exception {
     assertEquals(uploadAttachmentRS.getId(), result.getId());
     assertEquals(uploadAttachmentRS.getFileName(), result.getFileName());
 
-    verify(attachmentDataStoreService).save(eq("test.txt"), any(InputStream.class));
+    verify(tmsAttachmentDataStoreService).save(eq("test.txt"), any(InputStream.class));
     verify(tmsAttachmentMapper).convertToAttachment(fileId, file);
     verify(tmsAttachmentRepository).save(attachment);
     verify(tmsAttachmentMapper).convertToUploadAttachmentRS(attachment);
@@ -138,13 +137,13 @@ void uploadAttachment_ShouldThrowException_WhenFileIsEmpty() {
     assertEquals(ErrorType.BAD_REQUEST_ERROR, exception.getErrorType());
     assertEquals("Error in handled Request. Please, check specified parameters: 'File cannot be empty'", exception.getMessage());
 
-    verifyNoInteractions(attachmentDataStoreService, tmsAttachmentMapper, tmsAttachmentRepository);
+    verifyNoInteractions(tmsAttachmentDataStoreService, tmsAttachmentMapper, tmsAttachmentRepository);
   }
 
   @Test
   void uploadAttachment_ShouldThrowException_WhenDataStoreServiceFails() throws Exception {
     // Given data store service throws IOException
-    when(attachmentDataStoreService.save(anyString(), any(InputStream.class)))
+    when(tmsAttachmentDataStoreService.save(anyString(), any(InputStream.class)))
         .thenThrow(new RuntimeException("Storage error"));
 
     // When/Then exception should be thrown when storage fails
@@ -154,7 +153,7 @@ void uploadAttachment_ShouldThrowException_WhenDataStoreServiceFails() throws Ex
     assertEquals(ErrorType.BINARY_DATA_CANNOT_BE_SAVED, exception.getErrorType());
     assertTrue(exception.getMessage().contains("Failed to upload attachment"));
 
-    verify(attachmentDataStoreService).save(eq("test.txt"), any(InputStream.class));
+    verify(tmsAttachmentDataStoreService).save(eq("test.txt"), any(InputStream.class));
     verifyNoInteractions(tmsAttachmentRepository);
   }
 
@@ -189,15 +188,15 @@ void getTmsAttachment_ShouldReturnEmpty_WhenNotExists() {
   void deleteAttachment_ShouldSucceed_WhenAttachmentExists() {
     // Given attachment exists in repository
     when(tmsAttachmentRepository.findById(attachmentId)).thenReturn(Optional.of(attachment));
-    doNothing().when(attachmentDataStoreService).delete(fileId);
+    doNothing().when(tmsAttachmentDataStoreService).delete(fileId);
     doNothing().when(tmsAttachmentRepository).deleteById(attachmentId);
 
     // When deleting existing attachment
     sut.deleteAttachment(attachmentId);
 
     // Then attachment should be deleted from both data store and repository
     verify(tmsAttachmentRepository).findById(attachmentId);
-    verify(attachmentDataStoreService).delete(fileId);
+    verify(tmsAttachmentDataStoreService).delete(fileId);
     verify(tmsAttachmentRepository).deleteById(attachmentId);
   }
 
@@ -214,15 +213,15 @@ void deleteAttachment_ShouldThrowException_WhenAttachmentNotFound() {
     assertTrue(exception.getMessage().contains("Attachment not found: " + attachmentId));
 
     verify(tmsAttachmentRepository).findById(attachmentId);
-    verifyNoInteractions(attachmentDataStoreService);
+    verifyNoInteractions(tmsAttachmentDataStoreService);
     verify(tmsAttachmentRepository, never()).deleteById(attachmentId);
   }
 
   @Test
   void deleteAttachment_ShouldThrowException_WhenDataStoreDeleteFails() {
     // Given attachment exists but data store delete operation fails
     when(tmsAttachmentRepository.findById(attachmentId)).thenReturn(Optional.of(attachment));
-    doThrow(new RuntimeException("Delete failed")).when(attachmentDataStoreService).delete(fileId);
+    doThrow(new RuntimeException("Delete failed")).when(tmsAttachmentDataStoreService).delete(fileId);
 
     // When/Then exception should be thrown when data store delete fails
     var exception = assertThrows(ReportPortalException.class,
@@ -231,7 +230,7 @@ void deleteAttachment_ShouldThrowException_WhenDataStoreDeleteFails() {
     assertEquals(ErrorType.UNCLASSIFIED_REPORT_PORTAL_ERROR, exception.getErrorType());
 
     verify(tmsAttachmentRepository).findById(attachmentId);
-    verify(attachmentDataStoreService).delete(fileId);
+    verify(tmsAttachmentDataStoreService).delete(fileId);
   }
 
   @Test
@@ -288,8 +287,8 @@ void cleanupExpiredAttachments_ShouldCleanup_WhenExpiredAttachmentsExist() {
 
     // Then expired attachments should be cleaned up from both data store and repository
     verify(tmsAttachmentRepository).findExpiredAttachments(any(Instant.class));
-    verify(attachmentDataStoreService).delete("path1");
-    verify(attachmentDataStoreService).delete("path2");
+    verify(tmsAttachmentDataStoreService).delete("path1");
+    verify(tmsAttachmentDataStoreService).delete("path2");
     verify(tmsAttachmentRepository).deleteByIds(Arrays.asList(1L, 2L));
   }
 
@@ -304,7 +303,7 @@ void cleanupExpiredAttachments_ShouldDoNothing_WhenNoExpiredAttachments() {
 
     // Then no cleanup operations should be performed
     verify(tmsAttachmentRepository).findExpiredAttachments(any(Instant.class));
-    verifyNoInteractions(attachmentDataStoreService);
+    verifyNoInteractions(tmsAttachmentDataStoreService);
     verify(tmsAttachmentRepository, never()).deleteByIds(anyList());
   }
 
@@ -317,15 +316,15 @@ void cleanupExpiredAttachments_ShouldContinueOnFileDeleteError() {
 
     when(tmsAttachmentRepository.findExpiredAttachments(any(Instant.class)))
         .thenReturn(List.of(expiredAttachment));
-    doThrow(new RuntimeException("File delete failed")).when(attachmentDataStoreService)
+    doThrow(new RuntimeException("File delete failed")).when(tmsAttachmentDataStoreService)
         .delete("path1");
 
     // When cleaning up expired attachments
     sut.cleanupExpiredAttachments();
 
     // Then cleanup should continue despite file delete error
     verify(tmsAttachmentRepository).findExpiredAttachments(any(Instant.class));
-    verify(attachmentDataStoreService).delete("path1");
+    verify(tmsAttachmentDataStoreService).delete("path1");
     verify(tmsAttachmentRepository).deleteByIds(List.of(1L));
   }
 
@@ -382,9 +381,9 @@ void duplicateTmsAttachment_ShouldSucceed_WhenValidAttachment() throws Exception
 
     var originalFileStream = new ByteArrayInputStream("test content".getBytes());
 
-    when(attachmentDataStoreService.load(attachment.getPathToFile()))
+    when(tmsAttachmentDataStoreService.load(attachment.getPathToFile()))
         .thenReturn(Optional.of(originalFileStream));
-    when(attachmentDataStoreService.save(anyString(), any(InputStream.class))).thenReturn(
+    when(tmsAttachmentDataStoreService.save(anyString(), any(InputStream.class))).thenReturn(
         newFileId);
     when(tmsAttachmentMapper.duplicateAttachment(eq(attachment), eq(newFileId)))
         .thenReturn(duplicatedAttachment);
@@ -397,34 +396,34 @@ void duplicateTmsAttachment_ShouldSucceed_WhenValidAttachment() throws Exception
     assertNotNull(result);
     assertEquals(duplicatedAttachment, result);
 
-    verify(attachmentDataStoreService).load(attachment.getPathToFile());
-    verify(attachmentDataStoreService).save(anyString(), eq(originalFileStream));
+    verify(tmsAttachmentDataStoreService).load(attachment.getPathToFile());
+    verify(tmsAttachmentDataStoreService).save(anyString(), eq(originalFileStream));
     verify(tmsAttachmentMapper).duplicateAttachment(attachment, newFileId);
     verify(tmsAttachmentRepository).save(duplicatedAttachment);
   }
 
   @Test
   void duplicateTmsAttachment_ShouldThrowException_WhenOriginalFileNotFound() {
     // Given original file does not exist in data store
-    when(attachmentDataStoreService.load(attachment.getPathToFile())).thenReturn(Optional.empty());
+    when(tmsAttachmentDataStoreService.load(attachment.getPathToFile())).thenReturn(Optional.empty());
 
     // When/Then exception should be thrown when original file is not found
     var exception = assertThrows(ReportPortalException.class,
         () -> sut.duplicateTmsAttachment(attachment));
 
     assertEquals(ErrorType.BINARY_DATA_CANNOT_BE_SAVED, exception.getErrorType());
 
-    verify(attachmentDataStoreService).load(attachment.getPathToFile());
+    verify(tmsAttachmentDataStoreService).load(attachment.getPathToFile());
     verifyNoInteractions(tmsAttachmentRepository);
   }
 
   @Test
   void duplicateTmsAttachment_ShouldThrowException_WhenDataStoreSaveFails() throws Exception {
     // Given original file exists but data store save operation fails
     var originalFileStream = new ByteArrayInputStream("test content".getBytes());
-    when(attachmentDataStoreService.load(attachment.getPathToFile()))
+    when(tmsAttachmentDataStoreService.load(attachment.getPathToFile()))
         .thenReturn(Optional.of(originalFileStream));
-    when(attachmentDataStoreService.save(anyString(), any(InputStream.class)))
+    when(tmsAttachmentDataStoreService.save(anyString(), any(InputStream.class)))
         .thenThrow(new RuntimeException("Storage error"));
 
     // When/Then exception should be thrown when data store save fails

src/test/java/com/epam/ta/reportportal/core/tms/service/TmsAttachmentServiceImplTest.java

@@ -23,3 +23,6 @@ embedded:
 spring:
   flyway:
     clean-disabled: false
+tms:
+  datastore:
+    type: filesystem