shunit2_test¶
A single test file for Bourne-based shell scripts using the shunit2 test framework.
To use, add tests to your file per https://github.com/kward/shunit2/. Specify the shell to run with by either setting the field shell or including a shebang. To test the same file with multiple shells, create multiple shunit2_tests targets, one for each shell.
Pants will automatically download the shunit2 bash script and add source ./shunit2 to your test for you. If you already have source ./shunit2, Pants will overwrite it to use the correct relative path.
Backend: pants.backend.shell
tags¶
type: Iterable[str] | None
default: 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.
description¶
type: str | None
default: None
A human-readable description of the target.
Use pants list --documented :: to see all targets with descriptions.
source¶
type: str
required
A single file that belongs to this target.
Path is relative to the BUILD file's directory, e.g. source='example.ext'.
dependencies¶
type: Iterable[str] | None
default: 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/v2.18/docs/targets 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.
timeout¶
type: int | None
default: 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).
skip_tests¶
type: bool
default: False
If true, don't run this target's tests.
shell¶
type: 'bash' | 'dash' | 'ksh' | 'pdksh' | 'sh' | 'zsh' | None
default: None
Which shell to run the tests with. If unspecified, Pants will look for a shebang line.
runtime_package_dependencies¶
type: Iterable[str] | None
default: 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.
skip_shfmt¶
backend: pants.backend.shell.lint.shfmt
type: bool
default: False
If true, don't run shfmt on this target's code.
skip_shellcheck¶
backend: pants.backend.shell.lint.shellcheck
type: bool
default: False
If true, don't run Shellcheck on this target's code.