22. Testing

测试(Testing)

• 原文地址: Testing
• 版本 : 6.0.0

Testing

• Java Testing Framework（测试框架）

Java Testing Framework（测试框架）

测试是您的应用程序的重要组成部分，由于 information retrieval（信息检索）本身已经是一个复杂的话题了，因此我们在设置使用 elasticsearch 的测试基础架构的时候不应该有额外的复杂性。

这是我们决定在发行版中发布一个附加文件的主要原因，它允许您使用与 elasticsearch core 相同的测试基础架构。

testing framework（测试框架）允许您设置具有多个节点的集群，以便检查您的代码是否涵盖在集群中运行所需的所有的内容。该框架阻止您自己编写复杂代码来启动，停止或者管理集群中的多个节点。

另外，还有一个非常重要的功能叫做 randomized testing（随机测试），您可以免费获取它，因为它是 elasticsearch 基础架构的一部分。

( why randomized testing ) 为什么随机测试

why randomized testing?

随机测试的关键概念不是为每个测试用例使用相同的输入值，但是在出现故障的情况下仍然可以重现它们。这允许测试使用大不相同的输入变量，以确保您的实现实际上独立于您提供的测试数据。

所有测试都使用随机测试项目 ( randomized-testing project ) 提供的一个自定义的 junit runner —— RandomizedRunner 运行。如果您对正在使用的实现感兴趣，请查看 RandomizedTesting webpage 。

Using the elasticsearch test classes ( 使用 elasticsearch 测试类 )

使用 elasticsearch 测试类

首先，您需要在项目中包含测试依赖项 ( testing dependency ) ，以及已添加的 elasticsearch dependency ( elasticsearch 依赖项 ) 。如果您使用 maven 和 它的 pom.xml ，它看起来像下面这样：

<dependencies>
  <dependency>
    <groupId>org.apache.lucene</groupId>
    <artifactId>lucene-test-framework</artifactId>
    <version>${lucene.version}</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>org.elasticsearch.test</groupId>
    <artifactId>framework</artifactId>
    <version>${elasticsearch.version}</version>
    <scope>test</scope>
  </dependency>
</dependencies>

用相应的 elasticsearch 版本及其附带的 lucene 版本替换 elasticsearch 版本和 lucene 版本。

我们提供了几个可以在您自己的测试类中继承的类，它们提供：

• pre-defined loggers (预定义的日志输出器)
• randomized testing infrastructure (随机测试的基础工具)
• a number of helper methods (一系列帮助方法)

unit tests（单元测试）

单元测试

如果您将进行的是一次完全隔离的单元测试，可以使用 ESTestCase，而无需运行 elasticsearch cluster （弹信收索集群）。如果您要测试 lucene 功能，请使用 ESTestCase，如果您要测试具体的 token streams ，请使用 ESTokenStreamTestCase 这个类。这些特定的类会执行附加的检查，确保在测试运行后不会发生
资源泄露。

integreation test（集成测试）

integration test （集成测试）

只有所有的运算集群都运行后，集成测试才能开始运行。和单元测试相比，集成测试花费的时间更多，但是集成测试基础结构通过仅重新开启整个集群试图将花费的时间最小化（如果配置已经确定了）。

如果您要进行集成测试，则您的测试类需要继承 ESIntegTestCase 类。通过继承此类，您只需要确保至少有一定数量的节点启动，而不再需要在测试中手动启动弹性搜索节点。您通过在测试运行中指定不同的系统属性，完成大量的配置集成测试。 有关更多信息，请参阅源存储库中的 TESTING.asciidoc 。

number of shards （分片数）

集成测试期间，除非通过在创建索引时重写索引设置，否则索引创建的分片数量在 1~10 之间随机生成。 除非一定需要，否则默认规则不会指定碎片数量，以便未来每次测试都将一直使用不同的分片。 或者，您可以重写 numberOfShards() 方法。 这方法同样适用于 numberOfReplicas()。

generic helper methods （通用帮助方法）

ESIntegTestCase 中有几种帮助方法，这将使您的测试更简洁。

test cluster methods （集群测试方法）

InternalTestCluster 类是随机测试中集群功能的核心功能，并允许您配置特定设置或重播某些类型的中断，以检查自定义代码的运行反应。

changing node settings（改变节点设置）

如果要确保节点的一定配置，让它们作为 EsIntegTestCase 的一部分启动，，您可以重写 nodeSettings（）方法

public class Mytests extends ESIntegTestCase {
    @Override
    protected Settings nodeSettings(int nodeOrdinal) {
        return Settings.builder().put(super.nodeSettings(nodeOrdinal)).put("node.mode", "network").build();
    }

Accessing clients （访问客户端）

为了执行任何操作，您需要使用客户端。您可以使用 ESIntegTestCase.client（）方法来获取随机客户机。该客户端可以是 TransportClient 或 NodeClient，通常只要程序开始执行后就无需过多关心。 在 InternalTestCluster 类中有多种客户端选择方法，可以使用 ESIntegTestCase.internalCluster（）方法对其进行使用。

Scoping（范围）

在默认情况下，每个测试组件都使用唯一的集群进行测试。在每一个的测试中都删除了他们之间的索引和模板。然而有些时候，您需要为每个测试启动一个新的集群——比如：您想加载某个插件，而不想在每一个测试中加载它。

您可以在类级别上使用 @ClusterScope 注释来配置此行为。

@ClusterScope(scope=TEST, numDataNodes=1)
public class CustomSuggesterSearchTests extends ESIntegTestCase {
     // ... tests go here
}

上述例子为每个测试方法进行配置，配置内容为在测试中使用新的集群。默认范围是 SUITE （测试方法中所有方法的一个集群）。numDataNodes 设置允许您只启动一定数量的数据节点，这可以加速测试执行，因为启动新节点是一项费用高昂且耗时的操作，可能不需要此测试。

默认情况下，测试基本结构将随机启动指定主节点。如果要禁用指定主节点，可以用与 numDataNodes 类似的设置方式设置 supportsDedicatedMasters = false。如果不使用指定主节点，普通数据节点也将被允许成为主节点。

Changing plugins via configuration（通过配置更改插件）

当 elasticsearch 使用 JUnit 4 时，使用 @Before 和 @After 注释时是没有问题的。然而，您应该记住，这点在集群设置中没有任何影响，因为当运行这些方法时，集群已经处于启动并运行的状态。所以，您如果想在节点运行前配置这些设置，如：在节点启动前载入插件，您应该重写 ESIntegCase 这个类中的 nodePlugins() 方法，并返回每个节点应加载的插件类。

@Override
protected Collection<Class<? extends Plugin>> nodePlugins() {
  return Arrays.asList(CustomSuggesterPlugin.class);

Randomized testing（随机测试）

Randomized testing（随机测试）

您目前看到的代码片段都没有显示随机测试功能，因为它们被小心隐藏在 hood 下。 但是，当您编写自己的测试时，您也应该使用这些功能。 在开始之前，您应该要知道，如何重复使用相同设置的失败测试，如何失败的。 幸运的是，这很容易，因为整个 mvn 调用与失败的测试都将一起记录，这意味着你可以简单地复制和粘贴该行并运行测试。

generating random data（生成随机数据）

下一步是把使用静态测试数据的测试，转换为使用随机测试数据的测试。您可以随机化的数据类型与您正在测试的功能有很大的不同。看看下面的例子（注意，这个列表可以继续页面，因为分布式系统有许多很多移动的部分）：

• 用任意 UTF8 符号搜索数据
• 每次运行时更改映射配置，索引和字段名称
• 每次运行时更改响应大小/可配置限制
• 创建索引时更改碎片/副本的数量

那么，你如何创建随机数据。最重要的事情是，你不应该实例化自己的随机实例，而是使用随机化测试中提供的随机实例，所有弹性搜索依赖测试类都从该实例继承。

此外，还有几种帮助方法，可以创建随机 ASCII 和 Unicode 字符串，请参阅随机测试类中以 randomAscii，randomUnicode 和 randomRealisticUnicode 开头的方法。后者尝试通过非任意随机创建更真实的 unicode 字符串。

如果要调试特定随机种子的特定问题，可以使用 @Seed 注释配置特定种子进行测试。如果要多次运行测试，而不是重复启动整个测试套件，可以使用 @Repeat 注释和任意值。每次迭代都不同于使用不同的种子运行。

Assertions(断言)

Assertions

因为许多 elasticsearch 测试对类似的输出进行检查，比如命中的次数、第一次命中或特殊的高亮显示，已经创建了一些预定义的断言。这些已经被放到了弹性搜索断言类中。还有一个特定地理 ElasticsearchGeoAssertions 断言

Common matchers(常用的匹配器)

通常,你应该像如下组合断言和匹配器

SearchResponse searchResponse = client().prepareSearch() ...;
assertHitCount(searchResponse, 4);
assertFirstHit(searchResponse, hasId("4"));
assertSearchHits(searchResponse, "1", "2", "3", "4");