groovy_test

Function Signature

def groovy_test(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    annotation_processor_deps: list[str] = [],
    annotation_processor_params: list[str] = [],
    annotation_processors: list[str] = [],
    contacts: list[str] = [],
    cxx_library_allowlist: list[str] = [],
    default_cxx_platform: None | str = None,
    default_host_platform: None | str = None,
    deps: list[str] = [],
    deps_query: None | str = None,
    env: dict[str, str] = {},
    exported_deps: list[str] = [],
    exported_provided_deps: list[str] = [],
    extra_arguments: list[str] = [],
    extra_groovyc_arguments: list[str] = [],
    fork_mode: str = "none",
    java_version: None | str = None,
    javac: None | str = None,
    labels: list[str] = [],
    licenses: list[str] = [],
    manifest_file: None | str = None,
    maven_coords: None | str = None,
    never_mark_as_unused_dependency: None | bool = None,
    non_exec_dep_plugins_deprecated: list[str | (str, list[str])] = [],
    on_unused_dependencies: None | str = None,
    plugins: list[str | (str, list[str])] = [],
    proguard_config: None | str = None,
    provided_deps: list[str] = [],
    remove_classes: list[str] = [],
    required_for_source_only_abi: bool = False,
    resources: list[str] = [],
    resources_root: None | str = None,
    run_test_separately: bool = False,
    runtime_deps: list[str] = [],
    source: None | str = None,
    source_abi_verification_mode: None | str = None,
    source_only_abi_deps: list[str] = [],
    srcs: list[str] = [],
    std_err_log_level: None | int | str = None,
    std_out_log_level: None | int | str = None,
    target: None | str = None,
    test_case_timeout_ms: None | int = None,
    test_rule_timeout_ms: None | int = None,
    test_type: None | str = None,
    use_cxx_libraries: None | bool = None,
    use_dependency_order_classpath: None | bool = None,
    vm_args: list[str] = [],
) -> None

Parameters

• name: (required)

  name of the target

• default_target_platform: (defaults to: None)

  specifies the default target platform, used when no platforms are specified on the command line

• target_compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with a configuration

• compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with a configuration

• exec_compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

• visibility: (defaults to: [])

  a list of visibility patterns restricting what targets can depend on this one

• within_view: (defaults to: ["PUBLIC"])

  a list of visibility patterns restricting what this target can depend on

• metadata: (defaults to: {})

  a key-value map of metadata associated with this target

• tests: (defaults to: [])

  a list of targets that provide tests for this one

• modifiers: (defaults to: [])

  an array of modifiers associated with this target

• cxx_library_allowlist: (defaults to: [])

  List of cxx_library targets to build, if use_cxx_libraries is true. This can be useful if some dependencies are Android-only and won't build for the test host platform.

• javac: (defaults to: None)

  Specifies the Java compiler program to use for this rule. The value is a source path or an execution dep (e.g., //foo/bar:bar). Overrides the value in "javac" in the "tools" section of .buckconfig.

• non_exec_dep_plugins_deprecated: (defaults to: [])

  Plugins that do not use the execution platform. This exists for historical reasons, and should not be used. Use plugins instead - plugins should be configured for the execution platform since that is where they are used.

• plugins: (defaults to: [])

  List of plugins that should be run during compilation of the target. A list of strings may additionally be provided in order to pass additional arguments to the plugin.