c#mocking IFormFile CopyToAsync()方法

Question

我正在进行异步函数的单元测试,该函数将IFormFile列表转换为我自己的任意数据库文件类列表.

将文件数据转换为字节数组的方法是:

internal async Task<List<File>> ConvertFormFilesToFiles(ICollection<IFormFile> formFiles)
{
    var file = new File
    {
        InsertDateTime = DateTime.Now,
        LastChangeDateTime = DateTime.Now
    };
    if (formFile.Length > 0)
    {
        using (var memoryStream = new MemoryStream())
        {
            await formFile.CopyToAsync(memoryStream, CancellationToken.None);
            file.FileData = memoryStream.ToArray();
        }
    }
    // ...
}

该函数接收IFormFiles的ICollection,因此它是可模拟的.

现在我有这样的测试代码:

//Arrange
var fileConverter = new FilesConverter();
using (var fileStream = new FileStream("Files/uploadme.txt", FileMode.Open, FileAccess.Read))
{
    using (var memoryStream = new MemoryStream())
    {
        var newMemoryStream = new MemoryStream();
        fileStream.CopyTo(memoryStream);
        FormFileMock.Setup(f => f.CopyToAsync(newMemoryStream, CancellationToken.None)).Returns(Task.CompletedTask);
        // some other setups

        //Act
        var result = await fileConverter.ConvertFormFilesToFiles(new List<IFormFile> { FormFileMock.Object });
        //Assert
        Assert.IsTrue(result.Any());
    }
}

创建newMemoryStream变量是因为该函数使用新的空内存流调用CopyToAsync方法(我不确定是否有必要).

问题是await formFile.CopyToAsync(memoryStream,CancellationToken.None)不会将任何数据复制到memoryStream.

Answer 1

我知道这可能不受欢迎,因为现在使用模拟框架是完全"在",但为什么不简单地让框架成为框架并采用简单,简单的方式？你可以创建一个FormFile没有任何嘲弄.真正的交易:

var fileConverter = new FilesConverter(FilesConverterLoggerMock.Object, FileDataMock.Object);

// access to a real file should really not be in a "unit" test, but anyway: 
using (var stream = new MemoryStream(File.ReadAllBytes("Files/uploadme.txt"))
{
  // create a REAL form file
  var formFile = new FormFile(stream , 0, stream.Length, "name", "filename");

  //Act
  var result = await fileConverter.ConvertFormFilesToFiles(new List<IFormFile> { formFile });

  //Assert
  Assert.IsTrue(result.Any());
}

Answer 2

问题是await formFile.CopyToAsync(memoryStream, CancellationToken.None)不会将任何数据复制到memoryStream.

根据你的设置.什么都不会被复制.

您只需将呼叫设置为已完成返回.没有实现任何实际功能.

Callback在返回任务之前,您需要添加一个以执行某些所需的功能.

FormFileMock
    .Setup(_ => _.CopyToAsync(It.IsAny<Stream>(), CancellationToken.None))
    .Callback<Stream, CancellationToken>((stream, token) => {
        //memory stream in this scope is the one that was populated
        //when you called **fileStream.CopyTo(memoryStream);** in the test
        memoryStream.CopyTo(stream);
    }) 
    .Returns(Task.CompletedTask);

Answer 3

我结合了@Nkosi 和@nvoigt 的答案。正如 @nvoigt 指出的那样：对真实文件的访问实际上不应该在“单元”测试中进行。所以我用字节数组替换了文件，如下所示：

using (var memoryStream = new MemoryStream(new byte[]{1,2,3,4}))

而不是完整的文件。

我按照 @Nkosi 的建议在模拟对象上实现了 .callback

FormFileMock.Setup(f => f.CopyToAsync(It.IsAny<Stream>(), CancellationToken.None))
    .Callback<Stream, CancellationToken>((stream, token) =>
    {
        // with memoryStream being the stream from inside the using statement
        memoryStream.CopyTo(stream);
    }).Returns(Task.CompletedTask);

现在它起作用了。