scala_junit_tests
Generate a scala_junit_test
target for each file in the sources
field.
Backend: pants.backend.experimental.scala
tags
field.type_hint
Arbitrary strings to describe a target.
For example, you may tag some test targets with 'integration_test' so that you could run scie-pants-linux-x86_64 --tag='integration_test' test ::
to only run on targets with that tag.
description
field.type_hint
A human-readable description of the target.
Use scie-pants-linux-x86_64 list --documented ::
to see all targets with descriptions.
sources
field.type_hint
('*Test.scala',)
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.scala', '!TestIgnore.scala']
overrides
field.type_hint
Override the field values for generated scala_junit_tests
targets.
Expects a dictionary of relative file paths and globs to a dictionary for the overrides. You may either use a string for a single path / glob, or a string tuple for multiple paths / globs. Each override is a dictionary of field names to the overridden value.
For example:
overrides={
"Foo.scala": {"dependencies": [":files"]},
"Bar.scala": {"skip_scalafmt": True},
("Foo.scala", "Bar.scala"): {"tags": ["linter_disabled"]},
}"
File paths and globs are relative to the BUILD file's directory. Every overridden file is validated to belong to this target's sources
field.
If you'd like to override a field's value for every scala_junit_tests
target generated by this target, change the field directly on this target rather than using the overrides
field.
You can specify the same file name in multiple keys, so long as you don't override the same field more than one time for the file.
timeout
field.type_hint
A timeout (in seconds) used by each test file belonging to this target.
If unset, will default to [test].timeout_default
; if that option is also unset, then the test will never time out. Will never exceed [test].timeout_maximum
. Only applies if the option --test-timeouts
is set to true (the default).
dependencies
field.type_hint
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 scie-pants-linux-x86_64 dependencies
or scie-pants-linux-x86_64 peek
on this target to get the final result.
See https://www.pantsbuild.org/v2.19/docs/targets for more about how addresses are formed, including for generated targets. You can also run scie-pants-linux-x86_64 list ::
to find all addresses in your project, or 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.
scalac_plugins
field.type_hint
The names of Scala plugins that this source file requires.
The plugin must be defined by a corresponding scalac_plugin
AND jvm_artifact
target, and must be present in this target's resolve's lockfile.
If not specified, this will default to the plugins specified in [scalac].plugins_for_resolve
for this target's resolve.
timeout
field.type_hint
A timeout (in seconds) used by each test file belonging to this target.
If unset, will default to [test].timeout_default
; if that option is also unset, then the test will never time out. Will never exceed [test].timeout_maximum
. Only applies if the option --test-timeouts
is set to true (the default).
extra_env_vars
field.type_hint
Additional environment variables to include in test processes.
Entries are strings in the form ENV_VAR=value
to use explicitly; or just ENV_VAR
to copy the value of a variable in Pants's own environment.
This will be merged with and override values from [test].extra_env_vars
.
jdk
field.type_hint
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
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
The resolve from [jvm].resolves
to use when compiling this target.
If not defined, will default to [jvm].default_resolve
.