Skip to main content

test_suite

name​

def name(
    *,
    name: str,
    default_target_platform: None | str = ...,
    target_compatible_with: list[str] = ...,
    compatible_with: list[str] = ...,
    exec_compatible_with: list[str] = ...,
    visibility: list[str] = ...,
    within_view: list[str] = ...,
    metadata: OpaqueMetadata = ...,
    tests: list[str] = ...,
    modifiers: OpaqueMetadata = ...,
    _apple_platforms: dict[str, str] = ...,
    contacts: list[str] = ...,
    default_host_platform: None | str = ...,
    labels: list[str] = ...,
    licenses: list[str] = ...,
    test_deps: list[str] = ...,
) -> None

A test_suite() is used to create a grouping of tests that should all be run by just testing this rule.

Parameters​

  • name: name of the target
  • default_target_platform: specifies the default target platform, used when no platforms are specified on the command line
  • target_compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with a configuration
  • compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with a configuration
  • exec_compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with an execution platform
  • visibility: a list of visibility patterns restricting what targets can depend on this one
  • within_view: a list of visibility patterns restricting what this target can depend on
  • metadata: a key-value map of metadata associated with this target
  • tests: a list of targets that provide tests for this one
  • modifiers: an array of modifiers associated with this target

Details​

This rule can then be given to buck test, and all tests that it depends on will be invoked. Note that the test_suite() target is not tested itself, it just tells buck to run other tests. It will not show up in calls to the external runner nor in the normal test output.

Examples:

This test_suite() sets up two different sets of tests to run, 'all' tests and 'slow' tests. Note that all_tests can depend on slow_tests, and all three tests are run.


# instrumentation_tests/BUCK:
sh_test(
    name = "instrumentation_tests",
    test = "instrumentation_tests.sh",
    visibility = ["PUBLIC"],
)

# integration_tests/BUCK:
sh_test(
    name = "integration_tests",
    test = "integration_tests.sh",
    visibility = ["PUBLIC"],
)

# unit_tests/BUCK:
sh_test(
    name = "unit_tests",
    test = "unit_tests.sh",
    visibility = ["PUBLIC"],
)

# BUCK:
test_suite(
    name = "slow_tests",
    tests = [
        "//instrumentation_tests:instrumentation_tests",
        "//integration_tests:integration_tests",
    ],
)

test_suite(
    name = "all_tests",
    tests = [
        ":slow_tests",
        "//unit_tests:unit_tests",
    ],
)

Yields output like this when run:


$ buck test //:slow_tests
...
RESULTS FOR //instrumentation_tests:instrumentation_tests //integration_tests:integration_tests
PASS    <100ms  1 Passed   0 Skipped   0 Failed   //instrumentation_tests:instrumentation_tests
PASS    <100ms  1 Passed   0 Skipped   0 Failed   //integration_tests:integration_tests
TESTS PASSED
...

$ buck test //:all_tests
RESULTS FOR //instrumentation_tests:instrumentation_tests //integration_tests:integration_tests //unit_tests:unit_tests
PASS    <100ms  1 Passed   0 Skipped   0 Failed   //instrumentation_tests:instrumentation_tests
PASS    <100ms  1 Passed   0 Skipped   0 Failed   //integration_tests:integration_tests
PASS    <100ms  1 Passed   0 Skipped   0 Failed   //unit_tests:unit_tests
TESTS PASSED