Skip to main content
Version: 2.18 (deprecated)

junit

The JUnit test framework (https://junit.org)

Backend: pants.backend.experimental.java

Config section: [junit]

Basic options​

args​

--junit-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
PANTS_JUNIT_ARGS
pants.toml
[junit]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to JUnit, e.g. --junit-args='--disable-ansi-colors'.

skip​

--[no-]junit-skip
PANTS_JUNIT_SKIP
pants.toml
[junit]
skip = <bool>
default: False

If true, don't use JUnit when running pants test.

Advanced options​

artifacts​

--junit-artifacts="['<str>', '<str>', ...]"
PANTS_JUNIT_ARTIFACTS
pants.toml
[junit]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "org.junit.platform:junit-platform-console:1.7.2",
  "org.junit.jupiter:junit-jupiter-engine:{version}",
  "org.junit.vintage:junit-vintage-engine:{version}"
]

Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version). For Maven coordinates, the string {version} version will be substituted with the value of the [junit].version option.

jvm_options​

--junit-jvm-options="['<str>', '<str>', ...]"
PANTS_JUNIT_JVM_OPTIONS
pants.toml
[junit]
jvm_options = [
    '<str>',
    '<str>',
    ...,
]
default: []

List of JVM options to pass to junit JVM processes.

Options set here will be added to those set in [jvm].global_options. Please check the documentation for the jvm subsystem to see what values are accepted here.

lockfile​

--junit-lockfile=<str>
PANTS_JUNIT_LOCKFILE
pants.toml
[junit]
lockfile = <str>
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version option. See https://github.com/pantsbuild/pants/blob/release_2.18.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.

To use a custom lockfile, set this option to a file path relative to the build root, then run pants jvm-generate-lockfiles --resolve=junit.

version​

--junit-version=<str>
PANTS_JUNIT_VERSION
pants.toml
[junit]
version = <str>
default: 5.7.2

Version string for the tool. This is available for substitution in the [junit].artifacts option by including the string {version}.

Deprecated options​

None

None