test: Updated unit tests for FileExtractFunction

Author: alex-clayton-1

src/ServiceLayer.Mesh/Functions/FileExtractFunction.cs

@@ -1,3 +1,4 @@
+using Google.Protobuf.WellKnownTypes;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
@@ -77,7 +78,7 @@ private bool IsFileSuitableForExtraction(MeshFile file)
                 "File with id: {fileId} found in MeshFiles table but is not suitable for extraction. Status: {status}, LastUpdatedUtc: {lastUpdatedUtc}.",
                 file.FileId,
                 file.Status,
-                file.LastUpdatedUtc);
+                file.LastUpdatedUtc.ToTimestamp());
             return false;
         }
         return true;

tests/ServiceLayer.Mesh.Tests/Functions/FileExtractFunctionTests.cs

@@ -1,3 +1,5 @@
+using System.Globalization;
+using Google.Protobuf.WellKnownTypes;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
 using Moq;
@@ -89,7 +91,7 @@ public async Task Run_FileNotFound_ExitsSilently()
     }
 
     [Fact]
-    public async Task Run_FileInInvalidStatus_ExitsSilently()
+    public async Task Run_FileStatusInvalid_ExitsSilently()
     {
         // Arrange
         var file = new MeshFile
@@ -113,7 +115,7 @@ public async Task Run_FileInInvalidStatus_ExitsSilently()
             x => x.Log(
                 LogLevel.Warning,
                 It.IsAny<EventId>(),
-                It.Is<It.IsAnyType>((v, t) => v.ToString().StartsWith($"File with id: {message.FileId} found in MeshFiles table but is not suitable for extraction. Status: {file.Status}, LastUpdatedUtc:")),
+                It.Is<It.IsAnyType>((v, t) => v.ToString() == $"File with id: {message.FileId} found in MeshFiles table but is not suitable for extraction. Status: {file.Status}, LastUpdatedUtc: {file.LastUpdatedUtc.ToTimestamp()}."),
                 null,
                 It.IsAny<Func<It.IsAnyType, Exception?, string>>()
             ), Times.Once);
@@ -133,8 +135,9 @@ public async Task Run_FileInInvalidStatus_ExitsSilently()
     }
 
     [Fact]
-    public async Task Run_FileExtractingButNotTimedOut_ExitsSilently()
+    public async Task Run_FileStatusExtractingButNotTimedOut_ExitsSilently()
     {
+        // Arrange
         var file = new MeshFile
         {
             FileType = MeshFileType.NbssAppointmentEvents,
@@ -148,28 +151,53 @@ public async Task Run_FileExtractingButNotTimedOut_ExitsSilently()
 
         var message = new FileExtractQueueMessage { FileId = "file-2" };
 
-        var exception = await Assert.ThrowsAsync<InvalidOperationException>(() => _function.Run(message));
-        Assert.Equal("File is not in expected status", exception.Message);
+        // Act
+        await _function.Run(message);
+
+        // Assert
+        _loggerMock.Verify(
+            x => x.Log(
+                LogLevel.Warning,
+                It.IsAny<EventId>(),
+                It.Is<It.IsAnyType>((v, t) => v.ToString() == $"File with id: {message.FileId} found in MeshFiles table but is not suitable for extraction. Status: {file.Status}, LastUpdatedUtc: {file.LastUpdatedUtc.ToTimestamp()}."),
+                null,
+                It.IsAny<Func<It.IsAnyType, Exception?, string>>()
+            ), Times.Once);
+        _loggerMock.Verify(
+            x => x.Log(
+                LogLevel.Warning,
+                It.IsAny<EventId>(),
+                It.Is<It.IsAnyType>((v, t) => v.ToString() == "Exiting function."),
+                null,
+                It.IsAny<Func<It.IsAnyType, Exception?, string>>()
+            ), Times.Once);
+
+        _meshInboxServiceMock.Verify(x => x.GetHeadMessageByIdAsync(It.IsAny<string>(), It.IsAny<string>()), Times.Never);
+        _blobStoreMock.Verify(x => x.UploadAsync(It.IsAny<MeshFile>(), It.IsAny<byte[]>()), Times.Never);
+        _fileTransformQueueClientMock.Verify(x => x.EnqueueFileTransformAsync(It.IsAny<MeshFile>()), Times.Never);
+        _fileTransformQueueClientMock.Verify(x => x.SendToPoisonQueueAsync(It.IsAny<FileTransformQueueMessage>()), Times.Never);
     }
 
     [Fact]
-    public async Task Run_FileExtractSuccess_UploadsBlob()
+    public async Task Run_FileValid_FileUploadedToBlobAndAcknowledgedAndEnqueued()
     {
-        var fileId = "file-3";
+        // Arrange
+        var originalLastUpdatedUtc = DateTime.UtcNow.AddHours(-1);
         var file = new MeshFile
         {
             FileType = MeshFileType.NbssAppointmentEvents,
             MailboxId = "test-mailbox",
-            FileId = fileId,
+            FileId = "file-3",
             Status = MeshFileStatus.Discovered,
-            LastUpdatedUtc = DateTime.UtcNow.AddHours(-1)
+            LastUpdatedUtc = originalLastUpdatedUtc
         };
         _dbContext.MeshFiles.Add(file);
         await _dbContext.SaveChangesAsync();
 
         var content = new byte[] { 1, 2, 3 };
+        const string blobPath = "directory/fileName";
 
-        _meshInboxServiceMock.Setup(s => s.GetMessageByIdAsync("test-mailbox", fileId))
+        _meshInboxServiceMock.Setup(s => s.GetMessageByIdAsync(file.MailboxId, file.FileId))
             .ReturnsAsync(new MeshResponse<GetMessageResponse>
             {
                 IsSuccessful = true,
@@ -178,38 +206,131 @@ public async Task Run_FileExtractSuccess_UploadsBlob()
                     FileAttachment = new FileAttachment { Content = content }
                 }
             });
+        _blobStoreMock.Setup(s => s.UploadAsync(file, content)).ReturnsAsync(blobPath);
+        _meshInboxServiceMock.Setup(s => s.AcknowledgeMessageByIdAsync(file.MailboxId, file.FileId))
+            .ReturnsAsync(new MeshResponse<AcknowledgeMessageResponse>
+            {
+                IsSuccessful = true
+            });
+
+        var message = new FileExtractQueueMessage { FileId = file.FileId };
+
+        // Act
+        await _function.Run(message);
+
+        // Assert
+        _blobStoreMock.Verify(b => b.UploadAsync(It.Is<MeshFile>(f => f.FileId == file.FileId), content), Times.Once);
+        _meshInboxServiceMock.Verify(m => m.AcknowledgeMessageByIdAsync(file.MailboxId, file.FileId), Times.Once);
+        _fileTransformQueueClientMock.Verify(q => q.EnqueueFileTransformAsync(file), Times.Once);
+        var updatedFile = _dbContext.MeshFiles.First();
+        Assert.Equal(blobPath, updatedFile.BlobPath);
+        Assert.Equal(MeshFileStatus.Extracted, updatedFile.Status);
+        Assert.True(updatedFile.LastUpdatedUtc > originalLastUpdatedUtc);
+    }
+
+    [Fact]
+    public async Task Run_GetMessageFails_ErrorLoggedAndFileSentToPoisonQueue()
+    {
+        // Arrange
+        var fileId = "file-4";
+        var originalLastUpdatedUtc = DateTime.UtcNow.AddHours(-1);
+        var file = new MeshFile
+        {
+            FileType = MeshFileType.NbssAppointmentEvents,
+            MailboxId = "test-mailbox",
+            FileId = fileId,
+            Status = MeshFileStatus.Discovered,
+            LastUpdatedUtc = originalLastUpdatedUtc
+        };
+        _dbContext.MeshFiles.Add(file);
+        await _dbContext.SaveChangesAsync();
+
+        _meshInboxServiceMock.Setup(s => s.GetMessageByIdAsync(file.MailboxId, fileId))
+            .ReturnsAsync(new MeshResponse<GetMessageResponse>
+            {
+                IsSuccessful = false
+            });
 
         var message = new FileExtractQueueMessage { FileId = fileId };
 
+        // Act
         await _function.Run(message);
 
-        _blobStoreMock.Verify(b => b.UploadAsync(It.Is<MeshFile>(f => f.FileId == fileId), content), Times.Once);
+        // Assert
+        _loggerMock.Verify(
+            x => x.Log(
+                LogLevel.Error,
+                It.IsAny<EventId>(),
+                It.Is<It.IsAnyType>((v, t) => v.ToString() == $"An exception occurred during file extraction for fileId: {fileId}"),
+                It.Is<InvalidOperationException>(e => e.Message.StartsWith("Mesh extraction failed: ")),
+                It.IsAny<Func<It.IsAnyType, Exception?, string>>()
+            ), Times.Once);
+        _blobStoreMock.Verify(b => b.UploadAsync(It.IsAny<MeshFile>(), It.IsAny<byte[]>()), Times.Never);
+        _meshInboxServiceMock.Verify(m => m.AcknowledgeMessageByIdAsync(file.MailboxId, file.FileId), Times.Never);
+        _fileTransformQueueClientMock.Verify(q => q.EnqueueFileTransformAsync(It.IsAny<MeshFile>()), Times.Never);
+        _fileExtractQueueClientMock.Verify(q => q.SendToPoisonQueueAsync(message), Times.Once);
+        var updatedFile = _dbContext.MeshFiles.First();
+        Assert.Null(updatedFile.BlobPath);
+        Assert.Equal(MeshFileStatus.FailedExtract, updatedFile.Status);
+        Assert.True(updatedFile.LastUpdatedUtc > originalLastUpdatedUtc);
     }
 
     [Fact]
-    public async Task Run_MeshResponseFails_Throws()
+    public async Task Run_AcknowledgeMessageFails_ErrorLoggedAndFileSentToPoisonQueue()
     {
+        // Arrange
         var fileId = "file-4";
+        var originalLastUpdatedUtc = DateTime.UtcNow.AddHours(-1);
         var file = new MeshFile
         {
             FileType = MeshFileType.NbssAppointmentEvents,
             MailboxId = "test-mailbox",
             FileId = fileId,
             Status = MeshFileStatus.Discovered,
-            LastUpdatedUtc = DateTime.UtcNow.AddHours(-2)
+            LastUpdatedUtc = originalLastUpdatedUtc
         };
         _dbContext.MeshFiles.Add(file);
         await _dbContext.SaveChangesAsync();
 
-        _meshInboxServiceMock.Setup(s => s.GetMessageByIdAsync("test-mailbox", fileId))
+        var content = new byte[] { 1, 2, 3 };
+
+        _meshInboxServiceMock.Setup(s => s.GetMessageByIdAsync(file.MailboxId, fileId))
             .ReturnsAsync(new MeshResponse<GetMessageResponse>
             {
-                IsSuccessful = false,
+                IsSuccessful = true,
+                Response = new GetMessageResponse
+                {
+                    FileAttachment = new FileAttachment { Content = content }
+                }
+            });
+        _blobStoreMock.Setup(s => s.UploadAsync(file, content)).ReturnsAsync("directory/fileName");
+        _meshInboxServiceMock.Setup(s => s.AcknowledgeMessageByIdAsync(file.MailboxId, file.FileId))
+            .ReturnsAsync(new MeshResponse<AcknowledgeMessageResponse>
+            {
+                IsSuccessful = false
             });
 
         var message = new FileExtractQueueMessage { FileId = fileId };
 
-        var exception = await Assert.ThrowsAsync<InvalidOperationException>(() => _function.Run(message));
-        Assert.Contains("Mesh extraction failed", exception.Message);
+        // Act
+        await _function.Run(message);
+
+        // Assert
+        _loggerMock.Verify(
+            x => x.Log(
+                LogLevel.Error,
+                It.IsAny<EventId>(),
+                It.Is<It.IsAnyType>((v, t) => v.ToString() == $"An exception occurred during file extraction for fileId: {fileId}"),
+                It.Is<InvalidOperationException>(e => e.Message.StartsWith("Mesh acknowledgement failed: ")),
+                It.IsAny<Func<It.IsAnyType, Exception?, string>>()
+            ), Times.Once);
+        _blobStoreMock.Verify(b => b.UploadAsync(file, content), Times.Once);
+        _meshInboxServiceMock.Verify(m => m.AcknowledgeMessageByIdAsync(file.MailboxId, file.FileId), Times.Once);
+        _fileTransformQueueClientMock.Verify(q => q.EnqueueFileTransformAsync(It.IsAny<MeshFile>()), Times.Never);
+        _fileExtractQueueClientMock.Verify(q => q.SendToPoisonQueueAsync(message), Times.Once);
+        var updatedFile = _dbContext.MeshFiles.First();
+        Assert.Null(updatedFile.BlobPath);
+        Assert.Equal(MeshFileStatus.FailedExtract, updatedFile.Status);
+        Assert.True(updatedFile.LastUpdatedUtc > originalLastUpdatedUtc);
     }
 }