shunit2
shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2)
Backend: pants.backend.shell
Config section: [shunit2]
Basic options
skip
--[no-]shunit2-skip
PANTS_SHUNIT2_SKIP
[shunit2]
skip = <bool>
False
If true, don't use shunit2 when running pants test
.
Advanced options
known_versions
--shunit2-known-versions="['<str>', '<str>', ...]"
PANTS_SHUNIT2_KNOWN_VERSIONS
[shunit2]
known_versions = [
'<str>',
'<str>',
...,
]
[ "b9102bb763cc603b3115ed30a5648bf950548097|macos_arm64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987", "b9102bb763cc603b3115ed30a5648bf950548097|macos_x86_64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987", "b9102bb763cc603b3115ed30a5648bf950548097|linux_x86_64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987", "b9102bb763cc603b3115ed30a5648bf950548097|linux_arm64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987" ]
Known versions to verify downloads against.
Each element is a pipe-separated string of version|platform|sha256|length
or
version|platform|sha256|length|url_override
, where:
version
is the version stringplatform
is one of[linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]
sha256
is the 64-character hex representation of the expected sha256 digest of the download file, as emitted byshasum -a 256
length
is the expected length of the download file in bytes, as emitted bywc -c
- (Optional)
url_override
is a specific url to use instead of the normally generated url for this version
E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813
.
and 3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz
.
Values are space-stripped, so pipes can be indented for readability if necessary.
url_platform_mapping
--shunit2-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_SHUNIT2_URL_PLATFORM_MAPPING
[shunit2.url_platform_mapping]
key1 = val1
key2 = val2
...
{}
A dictionary mapping platforms to strings to be used when generating the URL to download the tool.
In --url-template
, anytime the {platform}
string is used, Pants will determine the current platform, and substitute {platform}
with the respective value from your dictionary.
For example, if you define {"macos_x86_64": "apple-darwin", "linux_x86_64": "unknown-linux"}
, and run Pants on Linux with an intel architecture, then {platform}
will be substituted in the --url-template
option with unknown-linux
.
url_template
--shunit2-url-template=<str>
PANTS_SHUNIT2_URL_TEMPLATE
[shunit2]
url_template = <str>
https://raw.githubusercontent.com/kward/shunit2/{version}/shunit2
URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a file:$abspath
URL (e.g. file:/this/is/absolute
, possibly by templating the buildroot in a config file).
Use {version}
to have the value from --version
substituted, and {platform}
to have a value from --url-platform-mapping
substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.
use_unsupported_version
--shunit2-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_SHUNIT2_USE_UNSUPPORTED_VERSION
[shunit2]
use_unsupported_version = <UnsupportedVersionUsage>
error, warning
default:
error
What action to take in case the requested version of shunit2 is not supported.
Supported shunit2 versions: unspecified
version
--shunit2-version=<str>
PANTS_SHUNIT2_VERSION
[shunit2]
version = <str>
b9102bb763cc603b3115ed30a5648bf950548097
Use this version of shunit2.
Deprecated options
None
Related subsystems
None