c#mocking IFormFile CopyToAsync()方法

时间:2017-11-15 13:45:11

标签: c# unit-testing stream moq

我正在为异步函数进行单元测试,该函数将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方法(我不确定是否有必要)。

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

3 个答案:

答案 0 :(得分:6)

我知道这可能不受欢迎,因为使用模拟框架完全是&#34;在&#34;这些天,但为什么不简单地让框架成为框架并采用简单,简单的方式?您可以创建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());
}

答案 1 :(得分:5)

  

问题在于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);

答案 2 :(得分: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);

现在它有效。