blob: c0e04fe76bde0f0510d5cd51857da0b27a6d9e43 [file] [log] [blame]
# Copyright 2020 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import("fuchsia_test_package.gni")
import("fuchsia_unittest_component.gni")
# Defines a package that contains a component that launches a test.
# See: https://fuchsia.dev/fuchsia-src/development/components/build
#
# This template is a useful shortcut for defining classic unit tests for target
# devices.
# Pure unit tests don't require any special capabilities, so their component
# manifest can be generated by the template if a manifest is not specified.
#
# Example:
# ```
# executable("rot13_encoder_decoder_test") {
# sources = [ "rot13_encoder_decoder_test.cc" ]
# testonly = true
# }
#
# fuchsia_unittest_package("rot13-test") {
# deps = [ ":rot13_encoder_decoder_test" ]
# }
# ```
#
# The above will generate a manifest and create a test with the launch URL:
# fuchsia-pkg://fuchsia.com/rot13-test#meta/rot13-test.cmx
#
# Parameters
#
# package_name (optional)
# The name of the package.
# Type: string
# Default: target_name
#
# component_name (optional)
# The name of the component.
# Type: string
# Default: package_name if defined, else target_name
#
# manifest (optional)
# Specify a component manifest for the test.
# If a manifest is not specified, a trivial manifest will be generated.
# The generated manifest requests no special capabilities, which is good
# enough for "pure" unit tests.
# To view the generated manifest, see:
# `fx gn outputs out/default path/to/your:<target_name>_component_generated_manifest`
# Type: path
#
# required_offers (optional)
# A list of protocols that must be offered to every child and collection declared
# in the CML file.
# Type: list of strings
# Default: []
#
# required_uses (optional)
# A list of protocols that must be used by every child and collection declared
# in the CML file.
# Type: list of strings
# Default: []
#
# restricted_features (optional)
# The set of restricted CML features to allow.
# The set of features is allowlisted here: //tools/cmc/build/restricted_features/BUILD.gn
# where each feature name is represented by a group of the same name.
# Type: list of strings
# Default: []
#
# test_specs (optional)
# Additional test specifications to apply to the test defined above.
# See `test_spec.gni`.
# Type: scope
#
# deprecated_legacy_test_execution (optional)
# The test will be forced to use ELF runner.
# ELF runner has fewer features than other specialized runners,
# but in some cases may offer faster test execution.
# Type: boolean
#
# data_deps
# deps
# visibility
template("fuchsia_unittest_package") {
if (current_toolchain == default_toolchain) {
component_target = "${target_name}_component"
fuchsia_unittest_component(component_target) {
forward_variables_from(invoker,
[
"component_name",
"data_deps",
"deps",
"manifest",
"required_offers",
"required_uses",
"restricted_features",
"deprecated_legacy_test_execution",
])
if (!defined(component_name)) {
if (defined(invoker.package_name)) {
component_name = invoker.package_name
} else {
component_name = invoker.target_name
}
}
visibility = [ ":*" ]
}
_test_specs = {
}
if (defined(invoker.test_specs)) {
_test_specs = invoker.test_specs
}
_test_specs.build_rule = "fuchsia_unittest_package"
_test_specs.has_generated_manifest = !defined(invoker.manifest)
fuchsia_test_package(target_name) {
forward_variables_from(invoker,
[
"package_name",
"visibility",
])
test_specs = _test_specs
test_components = [ ":$component_target" ]
}
} else {
group(target_name) {
testonly = true
forward_variables_from(invoker, [ "visibility" ])
deps = [ ":$target_name($default_toolchain)" ]
}
not_needed(invoker, "*")
}
}