Skip to main content
Version: 2.13.x (deprecated)

junit_tests

Generate a junit_test target for each file in the sources field.

Backend: pants.backend.experimental.java

tags​

field.type_hint
required

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 --tag='integration_test' test :: to only run on targets with that tag.

description​

field.type_hint
required

A human-readable description of the target.

Use /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list --documented :: to see all targets with descriptions.

sources​

field.type_hint
default: ('*Test.java',)

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['*Test.java', '!TestIgnore.java']

dependencies​

field.type_hint
required

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 dependencies or /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 peek on this target to get the final result.

See https://www.pantsbuild.org/v2.13/docs/targets#target-addresses and https://www.pantsbuild.org/v2.13/docs/targets#target-generation for more about how addresses are formed, including for generated targets. You can also run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list :: to find all addresses in your project, or /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list dir: to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

jdk​

field.type_hint
required

The major version of the JDK that this target should be built with. If not defined, will default to [jvm].default_source_jdk.

experimental_provides_types​

field.type_hint
required

Signals that the specified types should be fulfilled by these source files during dependency inference.

This allows for specific types within packages that are otherwise inferred as belonging to jvm_artifact targets to be unambiguously inferred as belonging to this first-party source.

If a given type is defined, at least one source file captured by this target must actually provide that symbol.

resolve​

field.type_hint
required

The resolve from [jvm].resolves to use when compiling this target.

If not defined, will default to [jvm].default_resolve.