使用MoQ和System.IO.Abstraction模拟File.OpenRead遇类型匹配问题

问题描述 #

尝试使用MoQ和System.IO.Abstraction框架模拟File.OpenRead方法时，执行测试代码时出现错误：mockFile.Setup(f => f.OpenRead(filePath)).Returns(memoryStream); 报错提示OpenRead方法期望返回FileSystemStream类型，但传入的是MemoryStream实例。

原测试代码与修正后的服务类：

using System;
using System.IO;
using System.IO.Abstractions;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;

[TestClass]
public class FileServiceTests
{
    [TestMethod]
    public void OpenRead_ShouldThrowIOException_ThenReturnValidStream()
    {
        // Arrange
        var filePath = "testfile.txt";
        var expectedContent = "Hello, World!";
        var fileBytes = System.Text.Encoding.UTF8.GetBytes(expectedContent);
        var memoryStream = new MemoryStream(fileBytes);

        var mockFileSystem = new Mock<IFileSystem>();
        var mockFile = new Mock<IFile>();

        mockFileSystem.Setup(fs => fs.File).Returns(mockFile.Object);

        mockFile.Setup(f => f.OpenRead(filePath))
                .Returns(memoryStream);

        var fileService = new FileService(mockFileSystem.Object);

        using var resultStream = fileService.OpenFile(filePath);
        using var reader = new StreamReader(resultStream);
        var resultContent = reader.ReadToEnd();

        // Assert
        Assert.AreEqual(expectedContent, resultContent);
    }
}

// 修正后的服务类
public class FileService
{
    private readonly IFileSystem _fileSystem;

    public FileService(IFileSystem fileSystem)
    {
        _fileSystem = fileSystem;
    }

    public Stream OpenFile(string path)
    {
        return _fileSystem.File.OpenRead(path);
    }
}

原因分析 #

System.IO.Abstraction框架中，IFile.OpenRead方法的返回类型是FileSystemStream，而非普通的Stream。MemoryStream并不继承自FileSystemStream，因此直接返回MemoryStream会导致类型不匹配。

解决方案 #

方案1：使用官方测试辅助库（推荐） #

使用System.IO.Abstractions.TestingHelpers库提供的MockFileSystem，可以更便捷地模拟文件系统，无需手动Mock单个接口：

1. 安装NuGet包：System.IO.Abstractions.TestingHelpers
2. 修改测试代码：

[TestMethod]
public void OpenRead_ShouldReturnValidStream()
{
    // Arrange
    var filePath = "testfile.txt";
    var expectedContent = "Hello, World!";

    // 创建虚拟文件系统并添加测试文件
    var mockFileSystem = new MockFileSystem();
    mockFileSystem.AddFile(filePath, new MockFileData(expectedContent));

    var fileService = new FileService(mockFileSystem);

    // Act
    using var resultStream = fileService.OpenFile(filePath);
    using var reader = new StreamReader(resultStream);
    var resultContent = reader.ReadToEnd();

    // Assert
    Assert.AreEqual(expectedContent, resultContent);
}

方案2：手动Mock FileSystemStream #

如果不想引入额外库，可以手动MockFileSystemStream，将MemoryStream作为底层流包装：

[TestMethod]
public void OpenRead_ShouldReturnValidStream()
{
    // Arrange
    var filePath = "testfile.txt";
    var expectedContent = "Hello, World!";
    var fileBytes = System.Text.Encoding.UTF8.GetBytes(expectedContent);
    var memoryStream = new MemoryStream(fileBytes);

    var mockFileSystem = new Mock<IFileSystem>();
    var mockFile = new Mock<IFile>();
    // 创建FileSystemStream的Mock实例，传入底层MemoryStream
    var mockFileSystemStream = new Mock<FileSystemStream>(memoryStream, FileAccess.Read);

    mockFileSystem.Setup(fs => fs.File).Returns(mockFile.Object);
    // 设置OpenRead返回Mock的FileSystemStream
    mockFile.Setup(f => f.OpenRead(filePath))
            .Returns(mockFileSystemStream.Object);

    var fileService = new FileService(mockFileSystem.Object);

    // Act
    using var resultStream = fileService.OpenFile(filePath);
    using var reader = new StreamReader(resultStream);
    var resultContent = reader.ReadToEnd();

    // Assert
    Assert.AreEqual(expectedContent, resultContent);
}

注意：原测试方法名称与实际测试内容不符，建议修改为更准确的名称（如示例中的OpenRead_ShouldReturnValidStream）。

内容的提问来源于stack exchange，提问作者njdotnetdev