1CARGO-TEST(1) General Commands Manual CARGO-TEST(1)
2
6 cargo-test - Execute unit and integration tests of a package
7
9 cargo test [options] [testname] [-- test-options]
10
12 Compile and execute unit and integration tests.
13 The test filtering argument TESTNAME and all the arguments following
15 the two dashes (--) are passed to the test binaries and thus to libtest
16 (rustc's built in unit-test and micro-benchmarking framework). If
17 you're passing arguments to both Cargo and the binary, the ones after
18 -- go to the binary, the ones before go to Cargo. For details about
19 libtest's arguments see the output of cargo test -- --help and check
20 out the rustc book's chapter on how tests work at
21 <https://doc.rust-lang.org/rustc/tests/index.html>.
22 As an example, this will filter for tests with foo in their name and
24 run them on 3 threads in parallel:
25 cargo test foo -- --test-threads 3
27 Tests are built with the --test option to rustc which creates an
29 executable with a main function that automatically runs all functions
30 annotated with the #[test] attribute in multiple threads. #[bench]
31 annotated functions will also be run with one iteration to verify that
32 they are functional.
33 The libtest harness may be disabled by setting harness = false in the
35 target manifest settings, in which case your code will need to provide
36 its own main function to handle running tests.
37 Documentation tests are also run by default, which is handled by
39 rustdoc. It extracts code samples from documentation comments and
40 executes them. See the rustdoc book
41 <https://doc.rust-lang.org/rustdoc/> for more information on writing
42 doc tests.
43
45 Test Options
46 --no-run
47 Compile, but don't run tests.
48 --no-fail-fast
50 Run all tests regardless of failure. Without this flag, Cargo will
51 exit after the first executable fails. The Rust test harness will
52 run all tests within the executable to completion, this flag only
53 applies to the executable as a whole.
54 Package Selection
56 By default, when no package selection options are given, the packages
57 selected depend on the selected manifest file (based on the current
58 working directory if --manifest-path is not given). If the manifest is
59 the root of a workspace then the workspaces default members are
60 selected, otherwise only the package defined by the manifest will be
61 selected.
62 The default members of a workspace can be set explicitly with the
64 workspace.default-members key in the root manifest. If this is not set,
65 a virtual workspace will include all workspace members (equivalent to
66 passing --workspace), and a non-virtual workspace will include only the
67 root crate itself.
68 -p spec..., --package spec...
70 Test only the specified packages. See cargo-pkgid(1) for the SPEC
71 format. This flag may be specified multiple times and supports
72 common Unix glob patterns like *, ? and []. However, to avoid your
73 shell accidentally expanding glob patterns before Cargo handles
74 them, you must use single quotes or double quotes around each
75 pattern.
76 --workspace
78 Test all members in the workspace.
79 --all
81 Deprecated alias for --workspace.
82 --exclude SPEC...
84 Exclude the specified packages. Must be used in conjunction with
85 the --workspace flag. This flag may be specified multiple times and
86 supports common Unix glob patterns like *, ? and []. However, to
87 avoid your shell accidentally expanding glob patterns before Cargo
88 handles them, you must use single quotes or double quotes around
89 each pattern.
90 Target Selection
92 When no target selection options are given, cargo test will build the
93 following targets of the selected packages:
94 • lib — used to link with binaries, examples, integration tests, and
96 doc tests
97 • bins (only if integration tests are built and required features are
99 available)
100 • examples — to ensure they compile
102 • lib as a unit test
104 • bins as unit tests
106 • integration tests
108 • doc tests for the lib target
110 The default behavior can be changed by setting the test flag for the
112 target in the manifest settings. Setting examples to test = true will
113 build and run the example as a test. Setting targets to test = false
114 will stop them from being tested by default. Target selection options
115 that take a target by name ignore the test flag and will always test
116 the given target.
117 Doc tests for libraries may be disabled by setting doctest = false for
119 the library in the manifest.
120 Binary targets are automatically built if there is an integration test
122 or benchmark. This allows an integration test to execute the binary to
123 exercise and test its behavior. The CARGO_BIN_EXE_<name> environment
124 variable
125 <https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates>
126 is set when the integration test is built so that it can use the env
127 macro <https://doc.rust-lang.org/std/macro.env.html> to locate the
128 executable.
129 Passing target selection flags will test only the specified targets.
131 Note that --bin, --example, --test and --bench flags also support
133 common Unix glob patterns like *, ? and []. However, to avoid your
134 shell accidentally expanding glob patterns before Cargo handles them,
135 you must use single quotes or double quotes around each glob pattern.
136 --lib
138 Test the package's library.
139 --bin name...
141 Test the specified binary. This flag may be specified multiple
142 times and supports common Unix glob patterns.
143 --bins
145 Test all binary targets.
146 --example name...
148 Test the specified example. This flag may be specified multiple
149 times and supports common Unix glob patterns.
150 --examples
152 Test all example targets.
153 --test name...
155 Test the specified integration test. This flag may be specified
156 multiple times and supports common Unix glob patterns.
157 --tests
159 Test all targets in test mode that have the test = true manifest
160 flag set. By default this includes the library and binaries built
161 as unittests, and integration tests. Be aware that this will also
162 build any required dependencies, so the lib target may be built
163 twice (once as a unittest, and once as a dependency for binaries,
164 integration tests, etc.). Targets may be enabled or disabled by
165 setting the test flag in the manifest settings for the target.
166 --bench name...
168 Test the specified benchmark. This flag may be specified multiple
169 times and supports common Unix glob patterns.
170 --benches
172 Test all targets in benchmark mode that have the bench = true
173 manifest flag set. By default this includes the library and
174 binaries built as benchmarks, and bench targets. Be aware that this
175 will also build any required dependencies, so the lib target may be
176 built twice (once as a benchmark, and once as a dependency for
177 binaries, benchmarks, etc.). Targets may be enabled or disabled by
178 setting the bench flag in the manifest settings for the target.
179 --all-targets
181 Test all targets. This is equivalent to specifying --lib --bins
182 --tests --benches --examples.
183 --doc
185 Test only the library's documentation. This cannot be mixed with
186 other target options.
187 Feature Selection
189 The feature flags allow you to control which features are enabled. When
190 no feature options are given, the default feature is activated for
191 every selected package.
192 See the features documentation
194 <https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options>
195 for more details.
196 --features features
198 Space or comma separated list of features to activate. Features of
199 workspace members may be enabled with package-name/feature-name
200 syntax. This flag may be specified multiple times, which enables
201 all specified features.
202 --all-features
204 Activate all available features of all selected packages.
205 --no-default-features
207 Do not activate the default feature of the selected packages.
208 Compilation Options
210 --target triple
211 Test for the given architecture. The default is the host
212 architecture. The general format of the triple is
213 <arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
214 a list of supported targets.
215 This may also be specified with the build.target config value
217 <https://doc.rust-lang.org/cargo/reference/config.html>.
218 Note that specifying this flag makes Cargo run in a different mode
220 where the target artifacts are placed in a separate directory. See
221 the build cache
222 <https://doc.rust-lang.org/cargo/guide/build-cache.html>
223 documentation for more details.
224 --release
226 Test optimized artifacts with the release profile. See the PROFILES
227 section for details on how this affects profile selection.
228 --ignore-rust-version
230 Test the target even if the selected Rust compiler is older than
231 the required Rust version as configured in the project's
232 rust-version field.
233 Output Options
235 --target-dir directory
236 Directory for all generated artifacts and intermediate files. May
237 also be specified with the CARGO_TARGET_DIR environment variable,
238 or the build.target-dir config value
239 <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults
240 to target in the root of the workspace.
241 Display Options
243 By default the Rust test harness hides output from test execution to
244 keep results readable. Test output can be recovered (e.g., for
245 debugging) by passing --nocapture to the test binaries:
246 cargo test -- --nocapture
248 -v, --verbose
250 Use verbose output. May be specified twice for "very verbose"
251 output which includes extra output such as dependency warnings and
252 build script output. May also be specified with the term.verbose
253 config value
254 <https://doc.rust-lang.org/cargo/reference/config.html>.
255 -q, --quiet
257 No output printed to stdout.
258 --color when
260 Control when colored output is used. Valid values:
261 • auto (default): Automatically detect if color support is
263 available on the terminal.
264 • always: Always display colors.
266 • never: Never display colors.
268 May also be specified with the term.color config value
270 <https://doc.rust-lang.org/cargo/reference/config.html>.
271 --message-format fmt
273 The output format for diagnostic messages. Can be specified
274 multiple times and consists of comma-separated values. Valid
275 values:
276 • human (default): Display in a human-readable text format.
278 Conflicts with short and json.
279 • short: Emit shorter, human-readable text messages. Conflicts
281 with human and json.
282 • json: Emit JSON messages to stdout. See the reference
284 <https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
285 for more details. Conflicts with human and short.
286 • json-diagnostic-short: Ensure the rendered field of JSON
288 messages contains the "short" rendering from rustc. Cannot be
289 used with human or short.
290 • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
292 messages contains embedded ANSI color codes for respecting
293 rustc's default color scheme. Cannot be used with human or
294 short.
295 • json-render-diagnostics: Instruct Cargo to not include rustc
297 diagnostics in in JSON messages printed, but instead Cargo
298 itself should render the JSON diagnostics coming from rustc.
299 Cargo's own JSON diagnostics and others coming from rustc are
300 still emitted. Cannot be used with human or short.
301 Manifest Options
303 --manifest-path path
304 Path to the Cargo.toml file. By default, Cargo searches for the
305 Cargo.toml file in the current directory or any parent directory.
306 --frozen, --locked
308 Either of these flags requires that the Cargo.lock file is
309 up-to-date. If the lock file is missing, or it needs to be updated,
310 Cargo will exit with an error. The --frozen flag also prevents
311 Cargo from attempting to access the network to determine if it is
312 out-of-date.
313 These may be used in environments where you want to assert that the
315 Cargo.lock file is up-to-date (such as a CI build) or want to avoid
316 network access.
317 --offline
319 Prevents Cargo from accessing the network for any reason. Without
320 this flag, Cargo will stop with an error if it needs to access the
321 network and the network is not available. With this flag, Cargo
322 will attempt to proceed without the network if possible.
323 Beware that this may result in different dependency resolution than
325 online mode. Cargo will restrict itself to crates that are
326 downloaded locally, even if there might be a newer version as
327 indicated in the local copy of the index. See the cargo-fetch(1)
328 command to download dependencies before going offline.
329 May also be specified with the net.offline config value
331 <https://doc.rust-lang.org/cargo/reference/config.html>.
332 Common Options
334 +toolchain
335 If Cargo has been installed with rustup, and the first argument to
336 cargo begins with +, it will be interpreted as a rustup toolchain
337 name (such as +stable or +nightly). See the rustup documentation
338 <https://rust-lang.github.io/rustup/overrides.html> for more
339 information about how toolchain overrides work.
340 -h, --help
342 Prints help information.
343 -Z flag
345 Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
346 details.
347 Miscellaneous Options
349 The --jobs argument affects the building of the test executable but
350 does not affect how many threads are used when running the tests. The
351 Rust test harness includes an option to control the number of threads
352 used:
353 cargo test -j 2 -- --test-threads=2
355 -j N, --jobs N
357 Number of parallel jobs to run. May also be specified with the
358 build.jobs config value
359 <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults
360 to the number of CPUs.
361
363 Profiles may be used to configure compiler options such as optimization
364 levels and debug settings. See the reference
365 <https://doc.rust-lang.org/cargo/reference/profiles.html> for more
366 details.
367 Profile selection depends on the target and crate being built. By
369 default the dev or test profiles are used. If the --release flag is
370 given, then the release or bench profiles are used.
371 ┌────────────────────┬─────────────────┬───────────────────┐
374 │Target │ Default Profile │ --release Profile │
375 ├────────────────────┼─────────────────┼───────────────────┤
376 │lib, bin, example │ dev │ release │
377 ├────────────────────┼─────────────────┼───────────────────┤
378 │test, bench, or any │ test │ bench │
379 │target in "test" or │ │ │
380 │"bench" mode │ │ │
381 └────────────────────┴─────────────────┴───────────────────┘
382 Dependencies use the dev/release profiles.
384 Unit tests are separate executable artifacts which use the test/bench
386 profiles. Example targets are built the same as with cargo build (using
387 the dev/release profiles) unless you are building them with the test
388 harness (by setting test = true in the manifest or using the --example
389 flag) in which case they use the test/bench profiles. Library targets
390 are built with the dev/release profiles when linked to an integration
391 test, binary, or doctest.
392
394 See the reference
395 <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
396 for details on environment variables that Cargo reads.
397
399 • 0: Cargo succeeded.
400 • 101: Cargo failed to complete.
402
404 1. Execute all the unit and integration tests of the current package:
405 cargo test
407 2. Run only tests whose names match against a filter string:
409 cargo test name_filter
411 3. Run only a specific test within a specific integration test:
413 cargo test --test int_test_name -- modname::test_name
415
417 cargo(1), cargo-bench(1)
418 CARGO-TEST(1)