Skip to main content
Version: 2.23

scalatest

The Scalatest test framework (https://www.scalatest.org/)

Backend: pants.backend.experimental.scala

Config section: [scalatest]

Basic options​

args​

--scalatest-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
PANTS_SCALATEST_ARGS
pants.toml
[scalatest]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to Scalatest, e.g. --scalatest-args='-t $testname'.

See https://www.scalatest.org/user_guide/using_the_runner for supported arguments.

skip​

--[no-]scalatest-skip
PANTS_SCALATEST_SKIP
pants.toml
[scalatest]
skip = <bool>
default: False

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

Advanced options​

artifacts​

--scalatest-artifacts="['<str>', '<str>', ...]"
PANTS_SCALATEST_ARTIFACTS
pants.toml
[scalatest]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "org.scalatest:scalatest_2.13:{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 [scalatest].version option.

jvm_options​

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

List of JVM options to pass to scalatest 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​

--scalatest-lockfile=<str>
PANTS_SCALATEST_LOCKFILE
pants.toml
[scalatest]
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.23.0/src/python/pants/backend/scala/subsystems/scalatest.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=scalatest.

version​

--scalatest-version=<str>
PANTS_SCALATEST_VERSION
pants.toml
[scalatest]
version = <str>
default: 3.2.10

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

Deprecated options​

None

None