组件测试

借助 Fuchsia 测试运行程序框架,开发者可以针对 使用各种语言和运行时环境的组件,并在 目标设备。该框架提供了可实现以下功能的测试运行程序组件: fuchsia.test.Suite 协议,并与通用语言特有的集成 测试框架,例如 GoogleTest (C++)。

test_manager 组件负责在 Fuchsia 上运行测试 设备。它会检查实现测试套件协议的组件并启动 将它们视为子组件这意味着,test_manager 还负责 为每个测试套件提供功能,从而创建通常称为 test Realm

展示测试运行程序框架如何为
让开发者可以公开测试套件,让开发者工具
Fuchsia 设备。

ffx test 等开发者工具会与 test_manager 上的 来执行测试套件并检索结果。

测试运行程序

测试运行程序是测试运行程序框架和常见测试运行程序之间可重复使用的适配器 开发者在自己首选的环境中编写测试所用的框架 语言。每个测试运行程序组件都公开 fuchsia.test.Suite 功能 使 test_manager 能够枚举和执行各项测试,以及 声明具有测试框架支持的适当执行 runner

Rust

{
    // Execute tests using language-specific runner
    program: { runner: "rust_test_runner" },
    // Expose test suite protocol to test manager
    capabilities: [
        { protocol: "fuchsia.test.Suite" },
    ],
    expose: [
        {
            protocol: "fuchsia.test.Suite",
            from: "self",
        },
    ],
}

C++

{
    // Execute tests using language-specific runner
    program: { runner: "gtest_runner" },
    // Expose test suite protocol to test manager
    capabilities: [
        { protocol: "fuchsia.test.Suite" },
    ],
    expose: [
        {
            protocol: "fuchsia.test.Suite",
            from: "self",
        },
    ],
}

为了简化集成,测试运行程序框架提供了清单分片 。以下是等效的测试运行程序 用于声明先前示例组件测试中功能的 CML。

Rust

{
    include: [ "//src/sys/test_runners/rust/default.shard.cml" ]
}

C++

{
    include: [ "//src/sys/test_runners/gtest/default.shard.cml" ]
}

单元测试

单元测试侧重于测试 如何验证组件中的各个代码单元 来自系统上其他组件的数据单元测试应该是封闭测试,也就是说 不要求或在测试之外提供额外功能。

Fuchsia 构建系统提供额外的 GN 目标,以简化单元 测试组件:

  • fuchsia_unittest_package():一个单组件软件包,会自动 生成一个最小的组件清单,用于引用测试二进制文件并 不需要其他功能。
  • fuchsia_unittest_component():一个组件声明,用于生成 同一个极简组件清单如果您需要构建 多个单元测试组件放到同一个 fuchsia_package() 中。

以下是用于添加单元测试的 BUILD.gn 代码段示例:

import("//build/components.gni")

executable("bin_test") {
  sources = [ "main_test.cc" ]
  deps = [
    "//src/lib/fxl/test:gtest_main",
    "//third_party/googletest:gtest",
  ]
  testonly = true
}

fuchsia_unittest_package("hello-world-unittests") {
  deps = [
    ":bin_test",
  ]
}
<ph type="x-smartling-placeholder">

练习:Echo 单元测试

在本练习中,您将使用echo-args 测试运行程序框架,并在 FEMU 环境中运行这些测试。

实现单元测试

单元测试会验证组件的内部函数的行为是否与 符合预期。对于 echo-args 组件,您需要验证 greeting() 函数会返回预期值。

添加以下单元测试函数,以验证 greeting() 函数(如果提供 1 个、2 个或 3 个参数):

Rust

echo-args/src/main.rs

#[cfg(test)]
mod tests {
    #[fuchsia::test]
    async fn test_greet_one() {
        let names = vec![String::from("Alice")];
        let expected = "Alice";
        assert_eq!(super::greeting(&names), expected);
    }

    #[fuchsia::test]
    async fn test_greet_two() {
        let names = vec![String::from("Alice"), String::from("Bob")];
        let expected = "Alice and Bob";
        assert_eq!(super::greeting(&names), expected);
    }

    #[fuchsia::test]
    async fn test_greet_three() {
        let names = vec![String::from("Alice"), String::from("Bob"), String::from("Spot")];
        let expected = "Alice, Bob, Spot";
        assert_eq!(super::greeting(&names), expected);
    }
}
<ph type="x-smartling-placeholder">

C++

echo-args/echo_unittest.cc

#include <gtest/gtest.h>

#include "vendor/fuchsia-codelab/echo-args/echo_component.h"

TEST(EchoTest, TestGreetOne) {
  std::vector<std::string> names = {"Alice"};
  std::string expected = "Alice";
  ASSERT_TRUE(echo::greeting(names) == expected);
}

TEST(EchoTest, TestGreetTwo) {
  std::vector<std::string> names = {"Alice", "Bob"};
  std::string expected = "Alice and Bob";
  ASSERT_TRUE(echo::greeting(names) == expected);
}

TEST(EchoTest, TestGreetThree) {
  std::vector<std::string> names = {"Alice", "Bob", "Spot"};
  std::string expected = "Alice, Bob, Spot";
  ASSERT_TRUE(echo::greeting(names) == expected);
}

更新 build 配置

将以下规则添加到 BUILD.gn 文件中,以生成新的单元测试软件包:

Rust

echo-args/BUILD.gn

group("tests") {
  testonly = true
  deps = [ ":echo-args-unittests" ]
}

fuchsia_unittest_package("echo-args-unittests") {
  deps = [ ":bin_test" ]
}

C++

echo-args/BUILD.gn

group("tests") {
  testonly = true
  deps = [ ":echo-args-unittests" ]
}

executable("unittests") {
  output_name = "echo-args-test"
  testonly = true

  sources = [ "echo_unittest.cc" ]

  deps = [
    ":cpp-lib",
    "//src/lib/fxl/test:gtest_main",
    "//third_party/googletest:gtest",
  ]
}

fuchsia_unittest_package("echo-args-unittests") {
  deps = [ ":unittests" ]
}

此规则会将您的单元测试打包到具有以下网址的组件中:

fuchsia-pkg://fuchsia.com/echo-args-unittests#meta/echo-args-unittests.cm

运行单元测试

更新顶级构建目标以构建组件包和 测试软件包:

Rust

echo-args/BUILD.gn

import("//build/components.gni")
import("//build/rust/rustc_binary.gni")


group("echo-args") {
  testonly = true
  deps = [
    ":package",
    ":tests",
  ]
}

C++

echo-args/BUILD.gn

import("//build/components.gni")


group("echo-args") {
  testonly = true
  deps = [
    ":package",
    ":tests",
  ]
}

再次运行 fx build 以构建测试软件包:

fx build

使用 ffx test 命令执行此软件包中的单元测试。 验证测试是否通过:

ffx test run \
    fuchsia-pkg://fuchsia.com/echo-args-unittests#meta/echo-args-unittests.cm