你如何模擬 IAsyncEnumerable？

Question

我想對一個調用另一個服務方法的方法進行單元測試，該方法返回一個IAsyncEnumerable<T> 。 我已經創建了我的服務Mock<MyService> ，我想設置這個模擬，但我不知道該怎么做。 是否可以 ？ 是否有其他方法對調用重新調整IAsyncEnumerable方法進行單元測試

public async Task<List<String>> MyMethodIWantToTest()
{
  var results = new List<string>();
  await foreach(var item in _myService.CallSomethingReturningAsyncStream())
  {
    results.Add(item);
  }
  return results;
}

Answer 1

如果您不想做任何特別的事情，例如延遲返回，這通常是異步枚舉的重點，那么您可以創建一個生成器函數來為您返回值。

public static async IAsyncEnumerable<string> GetTestValues()
{
    yield return "foo";
    yield return "bar";

    await Task.CompletedTask; // to make the compiler warning go away
}

有了它，您可以簡單地為您的服務創建一個模擬並測試您的對象：

var serviceMock = new Mock<IMyService>();
serviceMock.Setup(s => s.CallSomethingReturningAsyncStream()).Returns(GetTestValues);

var thing = new Thing(serviceMock.Object);
var result = await thing.MyMethodIWantToTest();
Assert.Equal("foo", result[0]);
Assert.Equal("bar", result[1]);

當然，由於您現在使用的是生成器函數，因此您還可以使其更復雜並添加實際延遲，甚至包括一些控制屈服的機制。

Answer 2

我建議使用System.Linq.Async ToAsyncEnumerable ，正如 Jeroen 建議的那樣。 看起來你正在使用 Moq，所以這看起來像：

async Task MyTest()
{
  var mock = new Mock<MyService>();
  var mockData = new[] { "first", "second" };
  mock.Setup(x => x.CallSomethingReturningAsyncStream()).Returns(mockData.ToAsyncEnumerable());

  var sut = new SystemUnderTest(mock.Object);
  var result = await sut.MyMethodIWantToTest();

  // TODO: verify `result`
}

Answer 3

這實際上取決於您使用的模擬框架。 但是，使用Moq會像這個例子一樣簡單

var data = new [] {1,2,3,4};
var mockSvc = new Mock<MyService>();
mockSvc.Setup(obj => obj.CallSomethingReturningAsyncStream()).Returns(data.ToAsyncEnumerable());

Answer 4

解決這個問題的一種方法是使用專用的測試類來包裝同步枚舉的IEnumerable 。

TestAsyncEnumerable.cs

internal class TestAsyncEnumerable<T> : List<T>, IAsyncEnumerable<T>
{
   public TestAsyncEnumerable(IEnumerable<T> enumerable) : base(enumerable) { }

   public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken cancellationToken = default) => new TestAsyncEnumerator<T>(GetEnumerator());
}

internal class TestAsyncEnumerator<T> : IAsyncEnumerator<T>
{
   private readonly IEnumerator<T> _inner;

   public TestAsyncEnumerator(IEnumerator<T> inner)
   {
      _inner = inner;
   }

   public ValueTask<bool> MoveNextAsync() => new ValueTask<bool>(_inner.MoveNext());

   public T Current => _inner.Current;

   public ValueTask DisposeAsync()
   {
      _inner.Dispose();

      return new ValueTask(Task.CompletedTask);
   }
}

用法：

[Fact]
public async Task MyTest() {
   var myItemRepository = A.Fake<IMyItemRepository>();

   A.CallTo(       () => myRepository.GetAll())
    .ReturnsLazily(() => new TestAsyncEnumerable<MyItem>(new List<MyItem> { new MyItem(), ... }));


   //////////////////
   /// ACT & ASSERT
   ////////
}