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

shunit2_tests

Tests of 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: ``

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 ./pants --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 ./pants list --documented :: to see all targets with descriptions.

dependencies​

field.type_hint
required

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib'].

Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json'].

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.

sources​

field.type_hint
default: ('*_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=['example.py', 'test_*.py', '!test_ignore.py'].

timeout​

field.type_hint
required

A timeout (in seconds) used by each test file belonging to this target. If unset, the test will never time out.

shell​

field.type_hint
required

Which shell to run the tests with. If unspecified, Pants will look for a shebang line.

runtime_package_dependencies​

field.type_hint
required

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_awslambda, or an archive.

skip_shellcheck​

field.type_hint
default: False

If true, don't run Shellcheck on this target's code.

skip_shfmt​

field.type_hint
default: False

If true, don't run shfmt on this target's code.