docs/get-started/learn/components/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}

  ```json5
  {
      // 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++}

  ```json5
  {
      // 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}

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

* {C++}

  ```json5
  {
      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](/docs/development/testing/components/test_runner_framework.md).

## Unit tests

[Unit testing](https://en.wikipedia.org/wiki/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:

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


<aside class="key-point">
Test components and other targets used exclusively in tests should set the
<code>testonly</code> attribute to <code>true</code>.
</aside>


## 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" %}
  ```

  <aside class="key-point">
  The <code>fuchsia::test</code> attribute removes some common boilerplate for
  component tests in Rust, such as initializing logging for each test case.
  </aside>

* {C++}

  `echo-args/echo_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_component.h"

  {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/cpp/echo_unittest.cc" region_tag="test_mod" adjust_indentation="auto" %}
  ```

### Update the build configuration

Add the following rules to your `BUILD.gn` file to generate a new unit test package:

{% set gn_rust_testpackage %}
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/rust/BUILD.gn" region_tag="unittest" adjust_indentation="auto" %}
{% endset %}

{% set gn_cpp_testpackage %}
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/cpp/BUILD.gn" region_tag="unittest" adjust_indentation="auto" %}
{% endset %}

* {Rust}

  `echo-args/BUILD.gn`:

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

  {{ gn_rust_testpackage|replace("echo-rust-unittests","echo-args-unittests")|trim() }}
  ```

* {C++}

  `echo-args/BUILD.gn`:

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

  {{ gn_cpp_testpackage|replace("echo-cpp-test","echo-args-test")|replace("echo-cpp-unittests","echo-args-unittests")|trim() }}
  ```

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

```none {:.devsite-disable-click-to-copy}
fuchsia-pkg://fuchsia.com/echo-args-unittests#meta/echo-args-unittests.cm
```

### Run the unit tests

Update the top-level build target to build both your component package and the
test package:

* {Rust}

  `echo-args/BUILD.gn`:

  ```gn {:.devsite-disable-click-to-copy}
  {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/rust/BUILD.gn" region_tag="imports" adjust_indentation="auto" %}

  group("echo-args") {
    testonly = true
    deps = [
      ":package",
      {{ '<strong>' }}":tests",{{ '</strong>' }}
    ]
  }
  ```

* {C++}

  `echo-args/BUILD.gn`:

  ```gn {:.devsite-disable-click-to-copy}
  {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/components/echo/cpp/BUILD.gn" region_tag="imports" adjust_indentation="auto" %}

  group("echo-args") {
    testonly = true
    deps = [
      ":package",
      {{ '<strong>' }}":tests",{{ '</strong>' }}
    ]
  }
  ```

Run `fx build` again to build the test package:

```posix-terminal
fx build
```

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

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