Android 测试 (三)--Local Unit Tests

2016/11/6 posted in  Android

如果你的单测程序没有或者只有少量的 Android 依赖,你应该在你的本地开发环境中运行你的测试程序。因为这种方法可以避免每次将测试代码加载到物理设备或者模拟器上运行,所以测试效率比较高。执行单元测试的时间大大减少。你可以使用 mock 框架比如 Mockito 来解决一些依赖关系

设置编译环境

在 Android Studio 工程里, local unit tests 必须放在module-name/src/test/java/. 目录里。这个目录当你创建工程时就已经存在了

还要设置 JUnit 的需要的一些依赖。如果你的测试需要Android 的依赖。你可以使用 mock 对象

在app 的顶层 build.gradle 文件中,你可以设置这些库的依赖

dependencies {
    // Required -- JUnit 4 framework
    testCompile 'junit:junit:4.12'
    // Optional -- Mockito framework
    testCompile 'org.mockito:mockito-core:1.10.19'
}

构造一个Local Unit Test类

测试应该照着 JUnit 4 来写。JUnit 是 java 里最流行用的最广泛的测试框架。在最新的框架里,JUnit 4 的代码相比于之前的版本 更为简洁 更便于维护。不像之前的JUnit 3,在JUnit 4 中你不需要继承 junit.framework.TestCase 类。测试方法也不必使用'test'开头,也不需要使用 junit.framework or junit.extensions 的一些包

要创建一个基本的JUnit 4测试类,创建包含一个或多个测试方法的Java类。测试方法始于@Test注释和包含的代码行使并验证要测试组件的单一功能。

下面的例子显示了如何实现一个地方的单元测试类。该测试方法emailValidator_CorrectEmailSimple_ReturnsTrue验证应用中的isValidEmail()方法测试返回的结果是否正确。

import org.junit.Test;
import java.util.regex.Pattern;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

public class EmailValidatorTest {

    @Test
    public void emailValidator_CorrectEmailSimple_ReturnsTrue() {
        assertThat(EmailValidator.isValidEmail("name@email.com"), is(true));
    }
    ...
}

可以使用 junit.Assert 的方法去测试 app 里的每个组件返回的结果是否符合预期,或者检验比较对一些预期值的组件的状态。为了使测试更具可读性,你可以使用Hamcrest匹配器(如IS()和equalTo()方法)来匹配预期的结果返回的结果。

mock Android 依赖

在默认情况下,Android 插件执行 local unit test 时最终调用 android.jar 的方法。这个方法里并没有实际的执行代码。方法调用到 Android 类时,单测抛出异常。这个是为了保证你的测试代码不依赖 Android 相关(没有 mock 的情况下)

你可以在你的代码里使用 mocking 框架 stub 出你的依赖。这样在你的组件有依赖的时候能够更方便的测试。通过与mock对象替代Android的依赖,你只需要验证那些依赖的方法被调用,这样就可以将你的单测代码从 Android 环境中隔离出来了。

Mockito 是 java 的一个 mock 框架,可以与 Android 单测兼容。使用 Mockito 你可以设置一些 mock 对象,并且指定 mock 对象的返回值

要添加一个模拟对象到您的本地单元测试使用这个框架,请遵循这个编程模型:

  1. 在build.gradle 中加入Mockito库的依赖
  2. 在你的单元测试类的定义开始,加上@RunWIth(MockitoJUnitRunner.class)。这个注释告诉mockito测试验证你的框架使用的是正确的,简化了你的mock对象的初始化。
  3. 为 Android 依赖增加 mock 对象。在变量前加上@Mock
  4. 通过使用when() 和 thenReturn() 方法,指定一个特定条件返回一个值, 可以 stub 一个行为的依赖

以下的例子举例说明可以在单测里 mock 出一个 Context 对象

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.CoreMatchers.*;
import static org.mockito.Mockito.*;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import android.content.SharedPreferences;

@RunWith(MockitoJUnitRunner.class)
public class UnitTestSample {

    private static final String FAKE_STRING = "HELLO WORLD";

    @Mock
    Context mMockContext;

    @Test
    public void readStringFromContext_LocalizedString() {
        // Given a mocked Context injected into the object under test...
        when(mMockContext.getString(R.string.hello_word))
                .thenReturn(FAKE_STRING);
        ClassUnderTest myObjectUnderTest = new ClassUnderTest(mMockContext);

        // ...when the string is returned from the object under test...
        String result = myObjectUnderTest.getHelloWorldString();

        // ...then the result should be the expected one.
        assertThat(result, is(FAKE_STRING));
    }
}

更多 Mockito API reference

为了避免android.jar 中的Android API 抛出了异常。可以在 build.gradle 中加入以下,默认 Android 方法返回 null 或者0

android {
  ...
  testOptions {
    unitTests.returnDefaultValues = true
  }
}

注意:returnDefaultValues 设置为 true 时, null/0 设置为默认返回是很难调试的。这样回允许失败测试的通过。

运行本地单测

测试系列博客目录