shunit2_tests
Generate a shunit2_test
target for each file in the sources
field.
Backend: pants.backend.shell
dependencies
Iterable[str] | None
None
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 pants dependencies
or pants peek
on this target to get the final result.
See https://www.pantsbuild.org/2.21/docs/using-pants/key-concepts/targets-and-build-files for more about how addresses are formed, including for generated targets. You can also run pants list ::
to find all addresses in your project, or pants 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.
description
str | None
None
A human-readable description of the target.
Use pants list --documented ::
to see all targets with descriptions.
overrides
Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None
None
Override the field values for generated shunit2_test
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_test.sh": {"timeout": 120},
"bar_test.sh": {"timeout": 200},
("foo_test.sh", "bar_test.sh"): {"tags": ["slow_tests"]},
}
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 shunit2_test
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.
runtime_package_dependencies
Iterable[str] | None
None
Addresses to targets that can be built with the pants package
goal and whose resulting artifacts should be included in the test run.
Pants will build the artifacts as if you had run pants package
. It will include the results in your test's chroot, using the same name they would normally have, but without the --distdir
prefix (e.g. dist/
).
You can include anything that can be built by pants package
, e.g. a pex_binary
, python_aws_lambda_function
, or an archive
.
shell
'bash' | 'dash' | 'ksh' | 'pdksh' | 'sh' | 'zsh' | None
None
Which shell to run the tests with. If unspecified, Pants will look for a shebang line.
skip_shellcheck
bool
False
pants.backend.shell.lint.shellcheck
If true, don't run Shellcheck on this target's code.
skip_shfmt
bool
False
pants.backend.shell.lint.shfmt
If true, don't run shfmt on this target's code.
skip_tests
bool
False
If true, don't run this target's tests.
sources
Iterable[str] | None
('*_test.sh', 'test_*.sh', 'tests.sh')
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.sh', 'test_*.sh', '!test_ignore.sh']
tags
Iterable[str] | None
None
Arbitrary strings to describe a target.
For example, you may tag some test targets with 'integration_test' so that you could run pants --tag='integration_test' test ::
to only run on targets with that tag.
timeout
int | None
None
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).