Integration testing

Unit tests are testing one module in isolation at a time: they’re small
and can test private code. Integration tests are external to your crate and use
only its public interface in the same way any other code would. Their purpose is
to test that many parts of your library work correctly together.

Cargo looks for integration tests in tests directory next to src.

File src/lib.rs:

  1. // Assume that crate is called adder, will have to extern it in integration test.
  2. pub fn add(a: i32, b: i32) -> i32 {
  3.     a + b
  4. }

File with test: tests/integration_test.rs:

  1. // extern crate we're testing, same as any other code would do.
  2. extern crate adder;
  4. #[test]
  5. fn test_add() {
  6.     assert_eq!(adder::add(3, 2), 5);
  7. }

Running tests with cargo test command:

  1. $ cargo test
  2. running 0 tests
  4. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
  6.      Running target/debug/deps/integration_test-bcd60824f5fbfe19
  8. running 1 test
  9. test test_add ... ok
  11. test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
  13.    Doc-tests adder
  15. running 0 tests
  17. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

Each Rust source file in tests directory is compiled as a separate crate. One
way of sharing some code between integration tests is making module with public
functions, importing and using it within tests.

File tests/common.rs:

  1. pub fn setup() {
  2.     // some setup code, like creating required files/directories, starting
  3.     // servers, etc.
  4. }

File with test: tests/integration_test.rs

  1. // extern crate we're testing, same as any other code will do.
  2. extern crate adder;
  4. // importing common module.
  5. mod common;
  7. #[test]
  8. fn test_add() {
  9.     // using common code.
  10.     common::setup();
  11.     assert_eq!(adder::add(3, 2), 5);
  12. }

Modules with common code follow the ordinary modules rules, so it’s ok to
create common module as tests/common/mod.rs.