从新的 CosmosDb 模拟器中,我得到了一个存储库来执行基本的 documentdb 操作,这个存储库被注入(inject)到其他类中。我想对一个基本查询进行单元测试。
public class DocumentDBRepository<T> where T : class
{
//Details ommited...
public IQueryable<T> GetQueryable()
{
return _client.CreateDocumentQuery<T>(
UriFactory.CreateDocumentCollectionUri(_databaseId, _collectionId),
new FeedOptions { MaxItemCount = -1, EnableCrossPartitionQuery = true });
}
public async Task<IEnumerable<T>> ExecuteQueryAsync(IQueryable<T> query)
{
IDocumentQuery<T> documentQuery = query.AsDocumentQuery();
List<T> results = new List<T>();
while (documentQuery.HasMoreResults)
{
results.AddRange(await documentQuery.ExecuteNextAsync<T>());
}
return results;
}
}
这个存储库需要一个文档客户端才能工作,它也被注入(inject)到构造函数中。
public DocumentDBRepository(string databaseId, IDocumentClient client)
{
_client = client;
_databaseId = databaseId;
_collectionId = GetCollectionName();
}
我最初的方法是使用 CosmosDb 模拟器,但这需要模拟器运行,我不喜欢这样,而且会使测试变慢。
我的第二种方法是尝试使用文档客户端的模拟。
var data = new List<MyDocumentClass>
{
new MyDocumentClass{ Description= "BBB" },
new MyDocumentClass{ Description= "ZZZ" },
}
.AsQueryable()
.OrderBy(q => q.Description);
var client = new Mock<IDocumentClient>();
client.As<IDocumentClient>()
.Setup(foo => foo.CreateDocumentQuery<MyDocumentClass>(It.IsAny<Uri>(), It.IsAny<FeedOptions>()))
.Returns(data);
DocumentDBRepository<MyDocumentClass> repo= new DocumentDBRepository<MyDocumentClass>(cosmosDatabase, client.Object);
使用这个存储库的代码是这样工作的:
var query = _documentsRepository.GetQueryable()
.Where(d => d.Description = description)
.OrderByDescending(d => d.description)
.Take(100);
//Execute query async fails.
var result = await _documentsRepository.ExecuteQueryAsync(query);
它失败了,因为存储库试图将 IQueryable
转换为 IDocumentQuery
对象,该对象非常特定于 DocumentDb api(参见方法 ExecuteQueryAsync
多于)。稍后,它对其执行 HasMoreResults
方法。所以问题是,即使我模拟 .asDocumentQuery()
返回我的对象,我也不知道如何为 HasMoreResults
和 ExecuteNextAsync< 提供结果
以便它对我的单元测试有意义。
我的第三个选择是直接模拟我的存储库而不是 DocumentClient 对象。我认为会更简单,但我不会测试很多 DocumentDb api。
最佳答案
关键是你调用的CreateDocumentQuery
,虽然显示为返回IOrderedQueryable
,但封装的结果也将从IDocumentQuery
派生> 这将允许 .AsDocumentQuery()
工作。
现在通常你不应该 mock 你不拥有的东西。但是,在这种情况下,如果您想执行 ExecuteQueryAsync
直到完成,您可以创建一个假抽象,允许测试完成。
下面的例子展示了它是如何完成的。
[TestClass]
public class DocumentDBRepositoryShould {
/// <summary>
/// Fake IOrderedQueryable IDocumentQuery for mocking purposes
/// </summary>
public interface IFakeDocumentQuery<T> : IDocumentQuery<T>, IOrderedQueryable<T> {
}
[TestMethod]
public async Task ExecuteQueryAsync() {
//Arrange
var description = "BBB";
var expected = new List<MyDocumentClass> {
new MyDocumentClass{ Description = description },
new MyDocumentClass{ Description = "ZZZ" },
new MyDocumentClass{ Description = "AAA" },
new MyDocumentClass{ Description = "CCC" },
};
var response = new FeedResponse<MyDocumentClass>(expected);
var mockDocumentQuery = new Mock<IFakeDocumentQuery<MyDocumentClass>>();
mockDocumentQuery
.SetupSequence(_ => _.HasMoreResults)
.Returns(true)
.Returns(false);
mockDocumentQuery
.Setup(_ => _.ExecuteNextAsync<MyDocumentClass>(It.IsAny<CancellationToken>()))
.ReturnsAsync(response);
var client = new Mock<IDocumentClient>();
client
.Setup(_ => _.CreateDocumentQuery<MyDocumentClass>(It.IsAny<Uri>(), It.IsAny<FeedOptions>()))
.Returns(mockDocumentQuery.Object);
var cosmosDatabase = string.Empty;
var documentsRepository = new DocumentDBRepository<MyDocumentClass>(cosmosDatabase, client.Object);
//Act
var query = documentsRepository.GetQueryable(); //Simple query.
var actual = await documentsRepository.ExecuteQueryAsync(query);
//Assert
actual.Should().BeEquivalentTo(expected);
}
}
关于c# - 如何(我应该)为 DocumentDb 单元测试模拟 DocumentClient?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/48349659/