BT

如何利用碎片时间提升技术认知与能力? 点击获取答案

测试RxJava2

| 作者 Andres Almiray 关注 0 他的粉丝 ,译者 Rays 关注 3 他的粉丝 发布于 2017年3月15日. 估计阅读时间: 50 分钟 | CNUTCon 了解国内外一线大厂50+智能运维最新实践案例。

译者注:关注InfoQ资讯的读者可能已经留意到,我们前面给出了一篇很好的RxJava文章“测试RxJava”。本文是上一篇文章的修订,用相同的例子循序渐进地介绍了如何测试RxJava2。译者将两篇文章中的不同之处用粗体标识出来,并使用添加注释的形式说明示例代码中的差异之处,以供读过前篇的读者快速浏览本文。

关键要点:

  • RxJava含有内建的、测试友好的解决方案。
  • 使用TestSubscriber去验证Observable。
  • 使用TestScheduler可实现对时间的严格控制。
  • Awaitility库提供了对测试环境进一步的控制。

本文是“测试RxJava”一文的修订,根据RxJava2规范做了全面更新。

你已经阅读过RxJava的相关内容,也已经在互联网上体验过像“RxJava实例解析”中的那些示例,现在打算在自己的代码中探索一下响应式编程了。但是,现在却一直困扰着如何测试那些可能会在代码库中发现的新功能呢?

使用响应式编程,就必须转变对给定问题的推理方式,因为我们要聚焦于作为事件流的流动数据,而非个别数据项。事件通常是被不同的线程所产生和消费,因此在编写测试时必须要对并发问题有着清晰的认识。幸运的是,RxJava提供了测试Observable和Subscription的内建支持,并且是直接构建于RxJava的核心依赖中。

第一步

让我们回顾一下在“RxJava by Example”一文中所给出的那个词汇的例子,看一下如何对该例子作测试。让我们从基础测试工具的设置开始。在我们的测试架构中,使用了JUnit作为测试工具。

import io.reactivex.Observable;
import io.reactivex.observers.TestObserver;
import io.reactivex.plugins.RxJavaPlugins;
import io.reactivex.schedulers.Schedulers;
//RxJava2中,包名由rx.xxx改为io.reactivex.xxx。
import org.junit.Test;
import java.util.*;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.awaitility.Awaitility.await;
import static org.junit.Assert.assertThat;
import static org.hamcrest.Matchers.*;


public class RxJavaTest {
    private static final List<String> WORDS = Arrays.asList(
       "the",
       "quick",
       "brown",
       "fox",
       "jumped",
       "over",
       "the",
       "lazy",
       "dog"
    );
}

事实上在没有给定调度器(Scheduler)的情况下,Subscription将默认运行于调用线程上。因此我们将在首个测试中使用原生的方法。这意味着我们可实现一个Subscription接口的对象,在Subscription发生后就立刻对其状态做断言(assert)。

@Test
public void testInSameThread() {
   // given:
   List<String> results = new ArrayList<>();
   //Observable的from方法改为fromIterable。
   Observable<String> observable = Observable.fromIterable(WORDS) 
       .zipWith(Observable.range(1, Integer.MAX_VALUE),
           (string, index) -> String.format("%2d. %s", index, string));

   // when:
   observable.subscribe(results::add);

   // then:
   assertThat(results, notNullValue());
   assertThat(results, hasSize(9));
   assertThat(results, hasItem(" 4. fox"));
}

注意这里使用了显式的List<String>容器,与实际订阅者一起累计结果。由于给定的测试很简单,所以可能会使你认为这种显式累加器的方法已经足够好了。但是切记产品级的Observable中可能封装了错误或可能产生意外的事件。例子中的Subscriber与累加器的简单组合并不足以覆盖这种情况。但不用为此烦恼,RxJava提供的TestSubscriber类型就是用于处理这种情况的。下面我们使用TestSubscriber类型重构上面的测试。

@Test
//例子中所有的Subscriber改为Observer。
public void testUsingTestObserver() {
   // given:
   TestObserver<String> observer = new TestObserver<>();
   //Observable的from方法改为fromIterable。
   Observable<String> observable = Observable.fromIterable(WORDS)
       .zipWith(Observable.range(1, Integer.MAX_VALUE),
           (string, index) -> String.format("%2d. %s", index, string));

   // when:
   observable.subscribe(observer);

   // then:
   observer.assertComplete();
   observer.assertNoErrors();
   observer.assertValueCount(9);
   //getOnNextEvents方法该为values方法。
   assertThat(observer.values(), hasItem(" 4. fox"));
}

TestObserver不仅可替代用户累加器,还另给出了一些行为。例如它能够给出接收到的消息和每个事件相关数据的规模,它也可对Subscription被完成且在Observable消费期间没有错误出现的状态做断言。虽然当前测试中的Observable并未生成任何的错误,但是回到“RxJava by Example”一文,我们从中得知了Observable将例外与数据事件等同对待。我们可通过如下的方式通过连接例外事件而模拟错误:

@Test
//例子中所有的Subscriber改为Observer。
public void testFailure() {
   // given:
   TestObserver<String> observer = new TestObserver<>();
   Exception exception = new RuntimeException("boom!");

    //Observable的from方法改为fromIterable。
    Observable<String> observable = Observable.fromIterable(WORDS)
       .zipWith(Observable.range(1, Integer.MAX_VALUE),
           (string, index) -> String.format("%2d. %s", index, string))
       .concatWith(Observable.error(exception));

   // when:
   observable.subscribe(observer);

   // then:
   observer.assertError(exception);
   observer.assertNotComplete();
}

在我们所给出的有限用例中,所有的机制运行良好。但是实际的产品代码可能会完全不同于例子。因此在下文中,我们将考虑一些更加复杂的产品实例。

定制调度器(Scheduler)

在产品代码中,很多用例中的Observable都是在特定的线程上执行,这种线程在响应式编程环境中被称为“调度器(Scheduler)”。很多Observable操作将可选的调度器参数作为附加参数使用。RxJava定义了一系列任何时候都可用的命名调度器,包括IO调度器(io)、计算调度器(computation,为共享线程)和新线程调度器(newThread)。开发人员也可去实现个人定制的调度器。让我们通过指定计算调度器来修改Observable的代码吧。

@Test
//例子中所有的Subscriber改为Observer。
public void testUsingComputationScheduler() {
   // given:
   TestObserver<String> observer = new TestObserver<>();
   //Observable的from方法改为fromIterable。
   Observable<String> observable = Observable.fromIterable(WORDS)
       .zipWith(Observable.range(1, Integer.MAX_VALUE),
           (string, index) -> String.format("%2d. %s", index, string));

   // when:
   observable.subscribeOn(Schedulers.computation())
       .subscribe(observer);

   //修订版中新添加语句。
   await().timeout(2, SECONDS)
       .until(observer::valueCount, equalTo(9));

   // then:
   observer.assertComplete();
   observer.assertNoErrors();
   assertThat(observer.values(), hasItem(" 4. fox"));
}

当运行时就会立刻发现该代码是存在问题的。Subscriber在测试线程上执行其断言,但是Observable在后台线程(计算线程)上生成值。这意味着执行Subscriber断言可能先于Observable生成所有相关事件,因而导致测试的失败。

为使测试顺利执行,有如下的一些策略可选:

  • 将Observable转化为阻塞式的。
  • 强制测试等待,直至给定的条件被满足。
  • 将计算调度器转换为即刻(Schedulers.immediate())调度器。

我们将对每个策略做展开介绍,但将从“将Observable转化为阻塞式”开始,因为实现该策略所需做的技术工作最少,这些工作与所使用的调度器无关。我们假设数据在后台线程中生成,这将导致Subscriber从同一后台线程得到通知。

我们要做的是强制生成所有的事件,并在下一个声明被执行前就在测试中完成Observable。这是通过在Observable自身上调用blockingIterable()方法实现的。

@Test
public void testUsingBlockingCall() {
   // given:
   //Observable的from方法改为fromIterable。
   Observable<String> observable = Observable.fromIterable(WORDS)
       .zipWith(Observable.range(1, Integer.MAX_VALUE),
           (string, index) -> String.format("%2d. %s", index, string));

   // when:
   //RxJava2中,toBlocking()和toIterable()方法改为blockingIterable()
   Iterable<String> results = observable
       .subscribeOn(Schedulers.computation())
       .blockingIterable();

   // then:
   assertThat(results, notNullValue());
   assertThat(results, iterableWithSize(9));
   assertThat(results, hasItem(" 4. fox"));
}

该方法虽然适用于我们所给出的简单代码,但可能并不适用于实际的产品代码。如果生产者生成所有的数据需要很长的时间,那将会产生什么后果?这将使测试变得非常慢,并增加了编译时间,还可能会有其它的性能问题。幸运的是,TestObserver提供了一系列方法,强制测试等待事件的结束。下面给出了一种实现方法:

//修订版中新添加的代码段。
@Test
public void testUsingComputationScheduler() {
// given:
   TestObserver<String> observer = new TestObserver<>();
   Observable<String> observable = Observable.fromIterable(WORDS)
        .zipWith(Observable.range(1, Integer.MAX_VALUE),
            (string, index) -> String.format("%2d. %s", index, string));

    // when:
    observable.subscribeOn(Schedulers.computation())
            .subscribe(observer);

    observer.awaitTerminalEvent(2, SECONDS);

    // then:
    observer.assertComplete();
    observer.assertNoErrors();
    assertThat(observer.values(), hasItem(" 4. fox"));
}

如果这些方法还不足以满足需求,这里我推荐一个便利的程序库,就是Awaitility。简单地说,Awaitility是一个以精确、简单易读的方式对异步系统相关期望进行表述的DSL。在项目中可以用Maven添加Awaitility的依赖关系。

<dependency>
    <groupId>org.awaitility</groupId>
    <artifactId>awaitility</artifactId>
    <version>2.0.0</version>
    <scope>test</scope>
</dependency>

或是使用Gradle:

testCompile 'org.awaitility:awaitility:2.0.0'

Awaitility DSL的接入点是org.awaitility.Awaitility.await()方法(参见下面例子中的第13和14行代码)。可以使用Awaitility定义使测试继续所必须达成的条件,也可在条件中加入超时或其它的时序约束,例如最小、最大或持续范围。对于上面的例子,下面的代码给出了如何在结果中使用Awaitility:

@Test
//例子中所有的Subscriber改为Observer。
public void testUsingComputationScheduler_awaitility() {
    // given:
    TestObserver<String> observer = new TestObserver<>();
    //Observable的from方法改为fromIterable。
    Observable<String> observable = Observable.fromIterable(WORDS)
        .zipWith(Observable.range(1, Integer.MAX_VALUE),
            (string, index) -> String.format("%2d. %s", index, string));

    // when:
     observable.subscribeOn(Schedulers.computation())
         .subscribe(observer);

     await().timeout(2, SECONDS)
         .until(observer::valueCount, equalTo(9));

     // then:
     observer.assertComplete();
     observer.assertNoErrors();
     //getOnNextEvents()方法改为values()方法。
    assertThat(observer.values(), hasItem(" 4. fox"));
 }

此版本测试并未以任何方式改变Observable的本质,这使得你做测试时不必对产品代码做任何改动。该版本测试使用最多2秒的等待时间通过检查Subscriber状态使Observable执行其作业。如果一切进行顺利,在2秒内就可将Subscriber的状态释放给所有的9个事件。

Awaitility具有和Hamcrest的匹配符、Java 8的lambda表达式和方法引用等的良好协作,从而给出精确的和可读的测试条件。Awaitility还提供了预制扩展,用于那些被广泛使用的JVM语言,其中包括Groovy和Scala。

我们要给出最后一个策略中使用了RxJava的扩展机制,该扩展是以RxJava API的组成部分发布的。RxJava中定义了一系列的扩展点,允许对几乎任何默认的RxJava行为进行微调。这种扩展机制使我们可以针对特定的RxJava特性提供修改过的值。利用该机制,在无需关心生成代码中所指定的调度器的情况下,我们可在测试中注入选定的调度器。这正是我们所寻找的方法,该方法被封装在RxJavaHooks类中。假设产品代码依赖于计算调度器,我们将覆盖它的默认值,返回一个调度器,它作为被调用的代码使事件处理发生,这是入队调度器(Schedulers.trampoline())。下面给出测试的代码:

@Test
//名称中的Hook改为Plugins,代码中所有subscriber改为observer。
public void testUsingRxJavaPluginsWithImmediateScheduler() {
    // given:
    //调度器由immediate改为trampoline。
    RxJavaPlugins.setComputationSchedulerHandler(scheduler -> 
                                                   Schedulers.trampoline());
     TestObserver<String> observer = new TestObserver<>();
     //Observable的from方法改为fromIterable。
     Observable<String> observable = Observable.fromIterable(WORDS)
         .zipWith(Observable.range(1, Integer.MAX_VALUE),
             (string, index) -> String.format("%2d. %s", index, string));

     try {
         // when:
         observable.subscribeOn(Schedulers.computation())
             .subscribe(observer);

         // then:
         observer.assertComplete();
         observer.assertNoErrors();
         observer.assertValueCount(9);
         assertThat(observer.values(), hasItem(" 4. fox"));
     } finally {
         RxJavaPlugins.reset();
     }
}

在测试中,产品代码察觉不到计算调度器是即刻的。请注意钩子函数必须被重置,否则即刻调度器的设置可能会发生泄漏,导致在各处的测试被破坏。使用try/finall代码块会在一定程度上模糊了测试的目的,但是幸运的是我们可以使用JUnit规则重构该行为,使测试更加精炼,结果更可读。下面给出使用上述规则的一种可能的实现代码:

//由Public改为private static
private static class ImmediateSchedulersRule implements TestRule {
   @Override
   public Statement apply(final Statement base, Description description) {
       return new Statement() {
           @Override
           //所有的调度器由immediate改为trampline。
           public void evaluate() throws Throwable {
               RxJavaPlugins.setIoSchedulerHandler(scheduler -> 
                                                Schedulers.trampoline());
               RxJavaPlugins.setComputationSchedulerHandler(scheduler -> 
                                                Schedulers.trampoline());
               RxJavaPlugins.setNewThreadSchedulerHandler(scheduler -> 
                                                Schedulers.trampoline());

               try {
                   base.evaluate();
               } finally {
                   RxJavaPlugins.reset();
               }
           }
       };
   }
}

此外,我们还对另外两个调度器的生成方法做了重写。该规则对此后其它的测试目标更为通用。在新的测试用例类中,该规则的使用方法很直接,只需简单地定义一个域,并将其中新类型标注为@Rule即可。示例代码如下:

@Rule
public final ImmediateSchedulersRule schedulers = 
                                         new ImmediateSchedulersRule();

@Test
//例子中所有的Subscriber改为Observer。
public void testUsingImmediateSchedulersRule() {
   // given:
   TestObserver<String> observer = new TestObserver<>();
   //Observable的from方法改为fromIterable。
   Observable<String> observable = Observable.fromIterable(WORDS)
       .zipWith(Observable.range(1, Integer.MAX_VALUE),
           (string, index) -> String.format("%2d. %s", index, string));

   // when:
   observable.subscribeOn(Schedulers.computation())
       .subscribe(observer);

   // then:
   observer.assertComplete();
   observer.assertNoErrors();
   observer.assertValueCount(9);
   assertThat(observer.values(), hasItem(" 4. fox"));
}

最终我们可得到与前面测试一样的行为,却没有像前面测试那样的杂乱。下面用一些篇幅来回顾一下我们目前已经做到的事情:

  • Subscribers将在同一线程中处理数据,只要没有使用特定的调度器。这意味着在Subscriber向Observable做订阅后,我们就可在该Subscriber上做断言。
  • TestObserver可累计事件,并给出自身状态的追加断言。
  • 任何对象都可转换为阻塞式的,这使得无论对象使用何种调度器,我们都可以同步等待事件的生成。
  • RxJava提供了扩展机制,允许开发人员重写其默认方法,并以适当的方式注入到产品代码中。
  • 并发代码可使用Awaitility DSL测试。

上述的每个技术都作用于不同的场景中,但是所有技术都是通过“共同的线程”(译者注:作者在原文中指出common thread是作为双关语使用的,其另一个意思是“类似的思路”)相关联:在对Subscriber状态做断言之前,测试代码需等待Observable完成。考虑到Observable的行为会生成数据,是否有方法对该行为进行检查呢?换句话说,是否可以用编程的方式做Observable的现场调试?我们将在后文中给出这样的技术。

操控时间

到目前为止我们已用黑箱方式测试了Observable和Subscription。下面我们将考虑另外一种操控时间的技术,该技术使我们可以在Observable依然处于活动状态时,打开引擎盖去查看Subscriber状态。换句话说,我们将使用采用了RxJava的TestScheduler类白箱测试技术,这可以说是RxJava再一次来救场。这种特定的调度器可精确地设定时间的内部使用方式,例如可将时间提前半秒,或是使时间跳跃5秒。我们将首先给出这种新调度器实例的创建方法,然后再讨论代码的测试。

 @Test
//例子中所有的Subscriber改为Observer。
public void testUsingTestScheduler() {
     // given:
     TestScheduler scheduler = new TestScheduler();
     TestObserver<String> observer = new TestObserver<>();
     Observable<Long> tick = Observable.interval(1, SECONDS, scheduler);

     Observable<String> observable = Observable.fromIterable(WORDS)
         .zipWith(tick,
             (string, index) -> String.format("%2d. %s", index, string));

     observable.subscribeOn(scheduler)
         .subscribe(observer);

     // expect:
     observer.assertNoValues();
     observer.assertNotComplete();

     // when:
     scheduler.advanceTimeBy(1, SECONDS);

     // then:
     observer.assertNoErrors();
     observer.assertValueCount(1);
     observer.assertValues(" 0. the");

     // when:
     scheduler.advanceTimeTo(9, SECONDS);
     observer.assertComplete();
     observer.assertNoErrors();
     observer.assertValueCount(9);
 }

该“产品”代码有了略微的改变,这是由于我们使用了绑定到调度器时隙(interval())的方法生成计数(第6行),而非生成一个计数的范围。但这样做具有一个副作用,就是计数是从零开始生成的,而非从1开始。一旦配置了Observable和测试调度器,我们立刻做出这样的断言,即假定Subscriber不具有值(第15行)且没有被完成或生成任何的错误(第16行)。这是一个完整性测试,因为此时调度器并没有被移动,因而没有任何值被Observable产生或是被Subscriber接收到。

下面将时间向前调1整秒(第21行),该操作将会导致Observable生成第一个值,这正是随后的断言集所要检查的(第24到26行)。

下面将时间从当前时间调到9秒。需要注意的是,这意味着将时间准确地调整为调度器启动后的第9秒(并非是向前调1秒后再向前调9秒,即调度器检查启动后的第10秒)。换句话说,advanceTimeBy()方法将调度器的时间调整为相对于当前位置的时间,而advanceTimeTo()以绝对的方式调整时间。此后我们做出下一轮的断言(第30到32行),用于确保所有的数据由Observable生成且被Subscriber消费。另一件需要说明的事情就是使用TestScheduler时,真实的时间是立刻发生调整的,这着意味着测试并不用实际等待9秒才去完成。

正如你所看到的,该调度器的使用是非常便利的,仅需将该调度器提供给正在测试的Observable即可。但是对使用了指定类型调度器的Observable,该调度器并不能很好地适用。但是稍等一下,之前我们看到的是如何使用RxJavaPlugins切换一个不影响生产代码的调度器,而这一次是提供一个代替即刻调度器的TestScheduler。我们甚至可以apply定制JUnit规则同样的技术,使之前的代码可以用更重用的方式予以重写。首先该新规则为:

//由public改为private static,所有Hooks改为Plugins。
private static class TestSchedulerRule implements TestRule {
   private final TestScheduler testScheduler = new TestScheduler();

   public TestScheduler getTestScheduler() {
       return testScheduler;
   }

   @Override
   public Statement apply(final Statement base, Description description) {
       return new Statement() {
           @Override
           public void evaluate() throws Throwable {
               RxJavaPlugins.setIoSchedulerHandler(scheduler -> 
                                                   testScheduler);
               RxJavaPlugins.setComputationSchedulerHandler(scheduler -> 
                                                   testScheduler);
               RxJavaPlugins.setNewThreadSchedulerHandler(scheduler -> 
                                                   testScheduler);

               try {
                   base.evaluate();
               } finally {
                   RxJavaPlugins.reset();
               }
           }
       };
   }
}

紧接着是实际的测试代码(在一个新的测试用例类中),去使用我们的测试规则:

@Rule
public final TestSchedulerRule testSchedulerRule = new TestSchedulerRule();

@Test
//例子中所有的Subscriber改为Observer。
public void testUsingTestSchedulersRule() {
   // given:
   TestObserver<String> observer = new TestObserver<>();

   Observable<String> observable = Observable.fromIterable(WORDS)
       .zipWith(Observable.interval(1, SECONDS),
           (string, index) -> String.format("%2d. %s", index, string));

   observable.subscribeOn(Schedulers.computation())
       .subscribe(observer);

   // expect
   observer.assertNoValues();
   observer.assertNotComplete();

   // when:
   testSchedulerRule.getTestScheduler().advanceTimeBy(1, SECONDS);

   // then:
   observer.assertNoErrors();
   observer.assertValueCount(1);
   observer.assertValues(" 0. the");

   // when:
   testSchedulerRule.getTestScheduler().advanceTimeTo(9, SECONDS);
   observer.assertComplete();
   observer.assertNoErrors();
   observer.assertValueCount(9);
}

这样你就成功地实现了它。使用经由RxJavaHooks注入TestScheduler的方法,可在无需更改原始Observable组合的情况下编写测试代码,此外它给出了一种在observable自身执行期间改变时间、并在特定点上做断言的方法。在本文中给出的所有这些技术,应该足够你选择用来测试RxJava的代码了。

未来

RxJava是最先为Java提供响应式编程能力的程序库之一。为了使RxJava API更好地符合Reactive Streams规范,即将推出的2.0版将会是重新设计的。Reactive Streams规范以Java和JavaScript运行时为目标,提供了使用非阻塞背压机制(back pressure)的异步流处理标准。这意味着下一版的RxJava中将会出现一些API改进。对这些改进的详细描述参见RxJava wiki

对于测试而言,这些核心类型(Observable、Maybe和Single)现在都给出了便利易用的test()方法,实现现场创建TestSubscriber实例。也可在TestSubscriber上链接方法调用,对这类用法也有一些新的断言方法。

本文是“测试RxJava”一文的修订。

关于作者

Andres Almiray是一位Java/Groovy开发者和Java冠军程序员,具有超过17年的软件设计和开发经验。他在Java早期推出的时代就参与了Web和桌面应用的开发。他是开源软件的忠实信徒,参与了Groovy、JMatter、Asciiidoctor等广为人知的项目。他是Griffon架构的创始者和现任项目领导者,还是JSR 377规范的牵头者。

查看英文原文: Testing RxJava2


感谢薛命灯对本文的审校。

给InfoQ中文站投稿或者参与内容翻译工作,请邮件至editors@cn.infoq.com。也欢迎大家通过新浪微博(@InfoQ@丁晓昀),微信(微信号:InfoQChina)关注我们。

评价本文

专业度
风格

您好,朋友!

您需要 注册一个InfoQ账号 或者 才能进行评论。在您完成注册后还需要进行一些设置。

获得来自InfoQ的更多体验。

告诉我们您的想法

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我
社区评论

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

讨论

登陆InfoQ,与你最关心的话题互动。


找回密码....

Follow

关注你最喜爱的话题和作者

快速浏览网站内你所感兴趣话题的精选内容。

Like

内容自由定制

选择想要阅读的主题和喜爱的作者定制自己的新闻源。

Notifications

获取更新

设置通知机制以获取内容更新对您而言是否重要

BT