Skip to content

Commit d5e5d22

Browse files
committed
auto merge of #9738 : catamorphism/rust/rustpkg-test-docs-need-to-submit, r=alexcrichton
r? anybody Talk about `rustpkg test` in the tutorial, and update its usage message. @steveklabnik, it would be great if you could look this over :-)
2 parents 0114ab6 + 8ba148b commit d5e5d22

File tree

2 files changed

+51
-3
lines changed

2 files changed

+51
-3
lines changed

doc/tutorial-rustpkg.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,54 @@ note: Installed package github.com/YOUR_USERNAME/hello-0.1 to /home/yourusername
206206

207207
That's it!
208208

209+
# Testing your Package
210+
211+
Testing your package is simple as well. First, let's change `src/hello/lib.rs` to contain
212+
a function that can be sensibly tested:
213+
214+
~~~
215+
#[desc = "A Rust package for determining whether unsigned integers are even."];
216+
#[license = "MIT"];
217+
218+
pub fn is_even(i: uint) -> bool {
219+
i % 2 == 0
220+
}
221+
~~~
222+
223+
Once you've edited `lib.rs`, you can create a second crate file, `src/hello/test.rs`,
224+
to put tests in:
225+
226+
~~~
227+
#[license = "MIT"];
228+
extern mod hello;
229+
use hello::is_even;
230+
231+
#[test]
232+
fn test_is_even() {
233+
assert!(is_even(0));
234+
assert!(!is_even(1));
235+
assert!(is_even(2));
236+
}
237+
~~~
238+
239+
Note that you have to import the crate you just created in `lib.rs` with the
240+
`extern mod hello` directive. That's because you're putting the tests in a different
241+
crate from the main library that you created.
242+
243+
Now, you can use the `rustpkg test` command to build this test crate (and anything else
244+
it depends on) and run the tests, all in one step:
245+
246+
~~~ {.notrust}
247+
$ rustpkg test hello
248+
WARNING: The Rust package manager is experimental and may be unstable
249+
note: Installed package hello-0.1 to /Users/tjc/.rust
250+
251+
running 1 test
252+
test test_is_even ... ok
253+
254+
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured
255+
~~~
256+
209257
# More resources
210258

211259
There's a lot more going on with `rustpkg`, this is just to get you started.

src/librustpkg/usage.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ information.");
141141
pub fn test() {
142142
io::println("rustpkg [options..] test
143143
144-
Build all targets described in the package script in the current directory
145-
with the test flag. The test bootstraps will be run afterwards and the output
146-
and exit code will be redirected.
144+
Build all test crates in the current directory with the test flag.
145+
Then, run all the resulting test executables, redirecting the output
146+
and exit code.
147147
148148
Options:
149149
-c, --cfg Pass a cfg flag to the package script");

0 commit comments

Comments
 (0)