component-tests.md

Component tests

<<../../_common/components/_tests_intro.md>>

Test runners

Test runners are reusable adapters between the Test Runner Framework and common frameworks used by developers to write tests in their preferred language. Each test runner component exposes the fuchsia.test.Suite capability that enables the test_manager to enumerate and execute individual tests, and declares the appropriate execution runner with test framework support.

• {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",
          },
      ],
  }

To simplify integration, the Test Runner Framework provides manifest shards for each language-specific runner. The following is an equivalent test runner CML for declaring the capabilities from the previous example component tests.

• {Rust}

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

• {C++}

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

Note: For complete details on the Test Runner Framework and component testing, see the testing documentation.

Unit tests

Unit testing{:.external} focuses on validating the individual units of code within your component and isolated from other components on the system. Unit tests should be hermetic, meaning that they do not require or provide additional capabilities outside of the test.

The Fuchsia build system provides additional GN targets to facilitate unit testing components:

• fuchsia_unittest_package(): A single-component package that automatically generates a minimal component manifest to reference the test binary and requires no additional capabilities.
• fuchsia_unittest_component(): A component declaration that generates the same minimal component manifest. This rule is useful if you need to build multiple unit test components into the same fuchsia_package().

Below is an example BUILD.gn snippet for including unit tests:

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",
  ]
}

Test components and other targets used exclusively in tests should set the testonly attribute to true.

Exercise: Echo unit tests

In this exercise, you'll add unit tests to the echo-args component with the Test Runner Framework and run those tests in a FEMU environment.

Implement unit tests

Unit tests verify that the internal functions of the component behave as expected. For the echo-args component, you'll validate that the greeting() function used in the previous exercise returns the expected values.

Add the following unit test functions to validate the behavior of the greeting() function when supplied with one, two, or three arguments:

• {Rust}

  echo-args/src/main.rs:

  {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/rust/src/main.rs" region_tag="test_mod" adjust_indentation="auto" %}
  

  The fuchsia::test attribute removes some common boilerplate for component tests in Rust, such as initializing logging for each test case.

• {C++}

  echo-args/echo_args_unittest.cc:

  {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/cpp/echo_unittest.cc" region_tag="imports" adjust_indentation="auto" %}
  
  #include "vendor/fuchsia-codelab/echo-args/echo_args.h"
  
  {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/cpp/echo_unittest.cc" region_tag="test_mod" adjust_indentation="auto" %}
  

Run the unit tests

In the previous exercise, your component project scaffold generated a fuchsia_unittest_package() in the BUILD.gn file. Locate this rule:

• {Rust}

  echo-args/BUILD.gn:

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

• {C++}

  echo-args/BUILD.gn:

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

This rule packages your unit tests into a component with the following URL:

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

Run fx build again to build the test package:

fx build

Use the ffx test command to execute the unit tests inside this package. Verify that the tests pass:

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