如何模拟 Elasticsearch NEST 的 IGetMappingResponse 进行单元测试

Question

我自己和我的大学已经构建了一个数据访问模块，它对 ElasticeSearch(6.2.0) NoSQL 数据库执行 CRUD 和搜索操作。我们正在使用 NEST(6.2.0)，一个高级客户端来映射到 Elasticsearch 查询 DSL。该模块已在目标框架 .NET Standard 2.0 的 class 库中用 C# 编码。

在某些方法中，需要检索存储在ElasticSearch 中的索引的索引映射，以便可以使用字段类型和文本属性等字段信息来构建对Elasticsearch 数据库的搜索查询。我们可以使用 Nest 的 GetMapping 方法 (returns Nest.IGetMappingResponse).

我们在执行代码时没有问题。一切正常。但是，当我们为使用 GetMapping 方法的方法构建单元测试时，我们无法模拟响应 returns (IGetMappingResponse)。我本来是用FakeItEasy来伪造的，然后在对象里面插入一些我需要的数据。但是，为了更好地解释我的问题，我创建了一个 class 来实现 IGetMappingResponse 来模拟我的响应。当我尝试为 IndexMapping 的映射属性创建 TypeMappings 的实例时，问题就来了（在 return 中是针对模拟的属性索引).我收到一条错误消息 “'TypMappings' 不包含采用 0 个参数的构造函数。

public class MockedGetMappingResponse : IGetMappingResponse
{
    public IReadOnlyDictionary<IndexName, IndexMappings> Indices
    {
        get
        {
            return new ReadOnlyDictionary<Nest.IndexName, Nest.IndexMappings>(new Dictionary<Nest.IndexName, Nest.IndexMappings>
                {
                    ["statuses"] = new IndexMappings
                    {
                        Mappings = new TypeMappings() //Error happens here!!
                    }                      

                });
        }
        set { }
    }

    public IReadOnlyDictionary<IndexName, IndexMappings> Mappings
    {
        get { return null; }
        set { }
    }

    public void Accept(IMappingVisitor visitor)
    {
        // Just a test
    }

    public bool IsValid
    {
        get { return true; }
    }

    public ServerError ServerError
    {
        get { return null; }
    }

    public Exception OriginalException
    {
        get { return null; }
    }

    public string DebugInformation
    {
        get { return ""; }
    }

    public IApiCallDetails ApiCall
    {
        get { return null; }
        set { //do nothing }
    }

    public bool TryGetServerErrorReason(out string reason)
    {
        reason = "";
        return false;
    }
}

当我查找 Nest 类型的定义时 TypeMappings 我没有看到构建的构造函数。因此，我假设它应该使用默认值，一个没有参数的构造函数。但显然不是。我需要知道如何在 IGetMappingResponse 中模拟 TypeMappings。如果无法创建 TypeMappings 的实例，我需要知道如何针对我的预期响应创建一个模拟的 IGetMappingResponse，以便我可以测试我的代码。

Answer 1

在 Nkosi 的帮助下，我发现 TypeMappings 有一个内部构造函数。知道这一点后，我使用反射创建了一个 TypeMappings 实例。这是我用来创建对象的代码。

IReadOnlyDictionary<TypeName, TypeMapping> backingDictionary = new ReadOnlyDictionary<TypeName, TypeMapping>(new Dictionary<TypeName, TypeMapping>
        {
            [typeName.Name] = typeMapping

        });           

        Type[] typeMappingsArgs = new Type[] { typeof(IConnectionConfigurationValues), typeof(IReadOnlyDictionary<TypeName, TypeMapping>) };
        object[] typeMappingsInputParams = new object[] { elasticClient.ConnectionSettings, backingDictionary };
        TypeMappings typeMappings = (TypeMappings)typeof(TypeMappings).GetConstructor(
              BindingFlags.NonPublic | BindingFlags.Instance,
              null, typeMappingsArgs, null).Invoke(typeMappingsInputParams);

这是创建我模拟的 IGetMappingResponse 的代码。我使用 FakeItEasy 插入了一些信息。

private Nest.IGetMappingResponse GetFakeMappingResponse(Nest.IElasticClient elasticClient)
    {
        var fieldName = "fieldName";
        var indexName = "indexName";
        var documentTypeName = "documentTypeName";

        var typeMapping = new TypeMapping();
        var properties = new Properties();
        typeMapping.Properties = properties;

        var property = new TextProperty();
        property.Name = fieldName;            

        PropertyName propertyName = new PropertyName(fieldName);

        typeMapping.Properties.Add(propertyName, property);

        Type[] typeNameArgs = new Type[] { typeof(string) };
        object[] typeNameInputParams = new object[] { documentTypeName };
        TypeName typeName = (TypeName)typeof(TypeName).GetConstructor(
              BindingFlags.NonPublic | BindingFlags.Instance,
              null, typeNameArgs, null).Invoke(typeNameInputParams);


        IReadOnlyDictionary<TypeName, TypeMapping> backingDictionary = new ReadOnlyDictionary<TypeName, TypeMapping>(new Dictionary<TypeName, TypeMapping>
        {
            [typeName.Name] = typeMapping

        });           

        Type[] typeMappingsArgs = new Type[] { typeof(IConnectionConfigurationValues), typeof(IReadOnlyDictionary<TypeName, TypeMapping>) };
        object[] typeMappingsInputParams = new object[] { elasticClient.ConnectionSettings, backingDictionary };
        TypeMappings typeMappings = (TypeMappings)typeof(TypeMappings).GetConstructor(
              BindingFlags.NonPublic | BindingFlags.Instance,
              null, typeMappingsArgs, null).Invoke(typeMappingsInputParams);

        IndexMappings indexMappings = new IndexMappings();
        typeof(IndexMappings).GetProperty("Mappings", BindingFlags.Public | BindingFlags.Instance).SetValue(indexMappings, typeMappings);

        ReadOnlyDictionary<Nest.IndexName, Nest.IndexMappings> indices = new ReadOnlyDictionary<Nest.IndexName, Nest.IndexMappings>(new Dictionary<Nest.IndexName, Nest.IndexMappings>
        {
            [indexName] = indexMappings

        });

        var fakeMappingResponse = A.Fake<IGetMappingResponse>();
        A.CallTo(() => fakeMappingResponse.ServerError).Returns(null);
        A.CallTo(() => fakeMappingResponse.IsValid).Returns(true);
        A.CallTo(() => fakeMappingResponse.Indices).Returns(indices);

        return fakeMappingResponse;
    }

如何模拟 Elasticsearch NEST 的 IGetMappingResponse 进行单元测试

How to Mock Elasticsearch NEST's IGetMappingResponse for Unit Testing

c#

unit-testing

elasticsearch

nest