构建本地单元测试

本地测试直接在您自己的工作站上运行，而不是在 Android 设备或模拟器上运行。因此，它使用本地 Java 虚拟机 (JVM) 而不是 Android 设备来运行测试。本地测试可让您更快地评估应用的逻辑。不过，由于无法与 Android 框架交互，您可以运行的测试类型会受到限制。

单元测试用于验证一小段代码（即被测单元）的行为。为此，它会执行该代码并检查结果。

单元测试通常很简单，但如果被测单元在设计时未考虑可测试性，则其设置可能会出现问题：

• 您要验证的代码需要可从测试中访问。例如，您无法直接测试私有方法。而是使用其公共 API 测试该类。
• 为了隔离运行单元测试，必须将受测单元的依赖项替换为您控制的组件，例如虚构对象或其他测试替身。如果您的代码依赖于 Android 框架，则此问题尤为严重。

如需了解 Android 中的常见单元测试策略，请参阅要测试的内容。

本地测试位置

默认情况下，本地单元测试的源文件放置在 module-name/src/test/ 中。当您使用 Android Studio 创建新项目时，此目录已存在。

添加测试依赖项

您还需要为项目配置测试依赖项，以便使用 JUnit 测试框架提供的标准 API。

为此，请打开应用的模块的 build.gradle 文件，并将以下库指定为依赖项。使用 testImplementation 函数指明它们适用于本地测试源代码集，而不适用于应用：

dependencies {
  // Required -- JUnit 4 framework
  testImplementation "junit:junit:$jUnitVersion"
  // Optional -- Robolectric environment
  testImplementation "androidx.test:core:$androidXTestVersion"
  // Optional -- Mockito framework
  testImplementation "org.mockito:mockito-core:$mockitoVersion"
  // Optional -- mockito-kotlin
  testImplementation "org.mockito.kotlin:mockito-kotlin:$mockitoKotlinVersion"
  // Optional -- Mockk framework
  testImplementation "io.mockk:mockk:$mockkVersion"
}

注意：testImplementation 会为本地测试添加依赖项，而 androidTestImplementation 会为插桩测试添加依赖项。

创建本地单元测试类

您需要将本地单元测试类编写为 JUnit 4 测试类。

为此，请创建一个包含一个或多个测试方法的类，通常位于 module-name/src/test/ 中。测试方法以 @Test 注解开头，包含用于练习和验证要测试的组件的单个方面的代码。

以下示例演示了如何实现本地单元测试类。测试方法 emailValidator_correctEmailSimple_returnsTrue() 会尝试验证 isValidEmail()，这是应用内的一个方法。如果 isValidEmail() 也返回 true，则测试函数将返回 true。

Kotlin

import org.junit.Assert.assertFalse
import org.junit.Assert.assertTrue
import org.junit.Test

class EmailValidatorTest {
  @Test fun emailValidator_CorrectEmailSimple_ReturnsTrue() {
    assertTrue(EmailValidator.isValidEmail("[e-mail]"))
  }

}

Java

import org.junit.Test;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

class EmailValidatorTest {
  @Test
  public void emailValidator_CorrectEmailSimple_ReturnsTrue() {
    assertTrue(EmailValidator.isValidEmail("[e-mail]"));
  }
}

您应创建可读的测试，以评估应用中的组件是否返回预期结果。我们建议您使用断言库，例如 junit.Assert、Hamcrest 或 Truth。上面的代码段展示了如何使用 junit.Assert。

可模拟的 Android 库

执行本地单元测试时，Android Gradle 插件会包含一个库，其中含有 Android 框架的所有 API，且版本与您项目中使用的版本一致。该库包含这些 API 的所有公共方法和类，但方法内的代码已被移除。如果访问了任何方法，测试都会抛出异常。

这样，在引用 Android 框架中的类（例如 Context）时，就可以构建本地测试。更重要的是，它允许您将模拟框架与 Android 类结合使用。

注意：模拟是一种测试替身，它对其交互有预期，您可以定义其行为。请参阅测试替身。

模拟 Android 依赖项

一个典型问题是发现某个类正在使用字符串资源。您可以通过调用 Context 类中的 getString() 方法来获取字符串资源。不过，本地测试无法使用 Context 或其任何方法，因为它们属于 Android 框架。理想情况下，对 getString() 的调用应从类中移出，但这并不总是可行。解决方案是创建 Context 的模拟或桩，在调用其 getString() 方法时始终返回相同的值。

借助 Mockable Android 库和模拟框架（例如 Mockito 或 MockK），您可以在单元测试中对 Android 类的模拟行为进行编程。

如需使用 Mockito 将模拟对象添加到本地单元测试，请遵循以下编程模型：

1. 如设置测试环境中所述，在 build.gradle 文件中添加 Mockito 库依赖项。
2. 在单元测试类定义的开头，添加 @RunWith(MockitoJUnitRunner.class) 注解。此注解会告知 Mockito 测试运行程序验证您对框架的使用是否正确，并简化模拟对象的初始化。
3. 如需为 Android 依赖项创建模拟对象，请在字段声明之前添加 @Mock 注解。
4. 如需对依赖项的行为进行桩处理，您可以使用 when() 和 thenReturn() 方法指定条件以及满足条件时返回的值。

以下示例展示了如何创建单元测试，该测试使用通过 Mockito-Kotlin 创建的 Kotlin 模拟 Context 对象。

import android.content.Context
import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.runner.RunWith
import org.mockito.Mock
import org.mockito.junit.MockitoJUnitRunner
import org.mockito.kotlin.doReturn
import org.mockito.kotlin.mock

private const val FAKE_STRING = "HELLO WORLD"

@RunWith(MockitoJUnitRunner::class)
class MockedContextTest {

  @Mock
  private lateinit var mockContext: Context

  @Test
  fun readStringFromContext_LocalizedString() {
    // Given a mocked Context injected into the object under test...
    val mockContext = mock<Context> {
        on { getString(R.string.name_label) } doReturn FAKE_STRING
    }

    val myObjectUnderTest = ClassUnderTest(mockContext)

    // ...when the string is returned from the object under test...
    val result: String = myObjectUnderTest.getName()

    // ...then the result should be the expected one.
    assertEquals(result, FAKE_STRING)
  }
}

如需详细了解如何使用 Mockito 框架，请参阅 Mockito API 参考文档和示例代码中的 SharedPreferencesHelperTest 类。此外，您还可以尝试完成 Android 测试 Codelab。

注意：应避免使用复杂的模拟。您可以改用不同类型的测试替身，例如虚构对象，或者 Robolectric 影子（如果它们是 Android 类）。此外，请考虑在插桩测试中使用依赖项的实际实现。

错误：“Method … not mocked”

如果您尝试使用 Error: "Method ... not mocked 消息访问 Mockable Android 库的任何方法，该库都会抛出异常。

如果抛出的异常对您的测试造成了问题，您可以更改此行为，使方法改为返回 null 或零，具体取决于返回值类型。为此，请在 Groovy 中将以下配置添加到项目的顶级 build.gradle 文件中：

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

注意：将 returnDefaultValues 属性设置为 true 时请谨慎操作。null/零返回值可能会导致测试出现回归，这些回归很难调试，并且可能会导致失败的测试通过。请仅在万不得已时使用。