测试插件

所有常见的 Flutter 测试类型也适用于插件包，但由于插件包含原生代码，它们通常还需要其他类型的测试来测试其所有功能。

要查看这些测试类型的示例，你可以从插件模板创建一个新插件，并查看指定的目录。

• Dart 单元测试和组件测试。这些测试允许你像测试非插件包的 Dart 代码一样测试插件的 Dart 部分。但是，插件的原生代码不会被加载，因此对平台通道的任何调用都需要在测试中进行模拟。

  请参阅 test 目录中的示例。

• Dart 集成测试。由于集成测试在 Flutter 应用程序（示例应用）的上下文中运行，它们可以测试 Dart 和原生代码，以及它们之间的交互。它们也适用于测试需要在浏览器中运行的 Web 实现代码的单元测试。

  这些通常是插件最重要的测试。但是，Dart 集成测试无法与原生 UI 交互，例如原生对话框或平台视图的内容。

  请参阅 example/integration_test 目录中的示例。

• 原生单元测试。正如 Dart 单元测试可以独立测试插件的 Dart 部分一样，原生单元测试也可以独立测试原生部分。每个平台都有自己的原生单元测试系统，并且测试是用与被测代码相同的原生语言编写的。

  如果你需要模拟插件代码封装的 API，原生单元测试会特别有价值，这在 Dart 集成测试中是不可能的。

  你可以为每个平台设置和使用任何你熟悉的原生测试框架，但以下框架已在插件模板中配置

  • Android：JUnit 测试可以在 android/src/test/ 中找到。

  • iOS 和 macOS：XCTest 测试分别可以在 example/ios/RunnerTests/ 和 example/macos/RunnerTests/ 中找到。它们位于示例目录中，而不是顶级包目录中，因为它们是通过示例应用的工程运行的。

  • Linux 和 Windows：GoogleTest 测试分别可以在 linux/test/ 和 windows/test/ 中找到。

其他当前未在模板中预配置的测试类型是原生 UI 测试。在原生 UI 测试框架下运行你的应用程序，例如 Espresso 或 XCUITest，可以启用与原生和 Flutter UI 元素交互的测试，如果你的插件无法在没有原生 UI 交互的情况下进行测试，这将非常有用。

这些测试可以像其他 Flutter 单元测试一样运行，无论是从你偏好的 Flutter IDE 中，还是使用 flutter test 命令。

有关运行此类测试的信息，请查阅集成测试文档。命令必须在 example 目录中运行。

对于所有平台，在运行单元测试之前，你需要至少构建一次示例应用程序，以确保所有特定于平台的构建文件都已创建。

Android JUnit

如果你在 Android Studio 中将示例作为 Android 项目打开，可以使用Android Studio 测试 UI 运行单元测试。

要从命令行运行测试，请在 example/android 目录中使用以下命令

./gradlew testDebugUnitTest

iOS 和 macOS XCTest

如果你在 Xcode 中打开了示例应用，可以使用Xcode 测试 UI 运行单元测试。

要从命令行运行测试，请在 example/ios（针对 iOS）或 example/macos（针对 macOS）目录中使用以下命令

xcodebuild test -workspace Runner.xcworkspace -scheme Runner -configuration Debug

对于 iOS 测试，你可能需要首先在 Xcode 中打开 Runner.xcworkspace 来配置代码签名。

Linux GoogleTest

要从命令行运行测试，请在示例目录中使用以下命令，将 "my_plugin" 替换为你的插件项目名称

build/linux/plugins/x64/debug/my_plugin/my_plugin_test

如果你以发布模式而非调试模式构建了示例应用，请将 "debug" 替换为 "release"。

Windows GoogleTest

如果你在 Visual Studio 中打开了示例应用，可以使用Visual Studio 测试 UI 运行单元测试。

要从命令行运行测试，请在示例目录中使用以下命令，将 "my_plugin" 替换为你的插件项目名称

build/windows/plugins/my_plugin/Debug/my_plugin_test.exe

如果你以发布模式而非调试模式构建了示例应用，请将 "Debug" 替换为 "Release"。

测试 Flutter 项目的一般建议同样适用于插件。插件测试的一些额外考虑因素：

• 由于只有集成测试才能测试 Dart 和原生语言之间的通信，因此请尝试为每个平台通道调用至少编写一个集成测试。

• 如果某些流程无法使用集成测试进行测试（例如，它们需要与原生 UI 交互或模拟设备状态），请考虑使用单元测试编写两部分的“端到端”测试

  • 原生单元测试，设置必要的模拟，然后通过合成调用调用方法通道入口点，并验证方法响应。

  • Dart 单元测试，模拟平台通道，然后调用插件的公共 API 并验证结果。