diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2016-06-07 10:43:56 -0400 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2016-06-07 10:43:56 -0400 |
| commit | ee78a02aecaa948194f0e1babfe1678a5efcbbf4 (patch) | |
| tree | 98d4f3d0013534ffce93cb4603ec0266e4276dce | |
| parent | 422574400f3f640e7d3623b1647f50b9d3035552 (diff) | |
| parent | c26703b77bbec89bb1ea987510eada3a1b24e838 (diff) | |
| download | rust-ee78a02aecaa948194f0e1babfe1678a5efcbbf4.tar.gz rust-ee78a02aecaa948194f0e1babfe1678a5efcbbf4.zip | |
Rollup merge of #34060 - JDemler:master, r=steveklabnik
Improved documentation for tests/ directory This ambigouity problem was already discussed in the [forums](https://users.rust-lang.org/t/problem-using-external-modules-inside-integration-test-submodule/5312/6).
| -rw-r--r-- | src/doc/book/testing.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/doc/book/testing.md b/src/doc/book/testing.md index d8afd7c4cf3..7954085472e 100644 --- a/src/doc/book/testing.md +++ b/src/doc/book/testing.md @@ -380,8 +380,9 @@ the `tests` directory. # The `tests` directory -To write an integration test, let's make a `tests` directory, and -put a `tests/lib.rs` file inside, with this as its contents: +Each file in `tests/*.rs` directory is treated as individual crate. +So, to write an integration test, let's make a `tests` directory, and +put a `tests/integration_test.rs` file inside, with this as its contents: ```rust,ignore extern crate adder; @@ -394,8 +395,8 @@ fn it_works() { ``` This looks similar to our previous tests, but slightly different. We now have -an `extern crate adder` at the top. This is because the tests in the `tests` -directory are an entirely separate crate, and so we need to import our library. +an `extern crate adder` at the top. This is because each test in the `tests` +directory is an entirely separate crate, and so we need to import our library. This is also why `tests` is a suitable place to write integration-style tests: they use the library like any other consumer of it would. @@ -428,6 +429,11 @@ test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured Now we have three sections: our previous test is also run, as well as our new one. +Cargo will ignore files in subdirectories of the `tests/` directory. +Therefore shared modules in integrations tests are possible. +For example `tests/common/mod.rs` is not seperatly compiled by cargo but can +be imported in every test with `mod common;` + That's all there is to the `tests` directory. The `tests` module isn't needed here, since the whole thing is focused on tests. |
