ffb165ce26
Fix intermittent test failure caused by race condition First public pull request 😬 There's an intermittent integration test failure when you use multiple test threads (at least for me on a mac). I narrowed it down to two tests each spawning a process using `Command` which then try to compile the same file at the same time. If the timing doesn't work out, they both try to compile, and then one process runs `clean` before the other can run the executable - causing a panic. ![Screenshot 2019-04-07 at 19 54 55](https://user-images.githubusercontent.com/3453268/55688324-20520980-596f-11e9-8474-5215d61a4387.png) You can prevent it from happening by running with a single thread (`cargo test -- --test-threads=1`), because the `Command` blocks. That's not a particularly good solution though because it's not something you can configure in `Cargo.toml`. I considered making the affected tests just run serially, but it occurred to me that this could also happen if someone accidentally runs rustlings in watch mode in two terminals without realising it. I wound't consider this that unlikely given it's a tool for learning. I fixed it by ensuring that the executables made from separate processes don't conflict by appending a process id to the output executable name. I also extracted the commands into a single file next to `clean` so that we don't have to repeat the generated file name everywhere and risk missing something. |
||
---|---|---|
exercises | ||
src | ||
tests | ||
.gitignore | ||
.travis.yml | ||
Cargo.toml | ||
LICENSE | ||
README.md | ||
default_out.md | ||
info.toml | ||
install.sh |
README.md
rustlings 🦀❤️
Greetings and welcome to rustlings
. This project contains small exercises to get you used to reading and writing Rust code. This includes reading and responding to compiler messages!
...looking for the old, web-based version of Rustlings? Try here
Alternatively, for a first-time Rust learner, there's several other resources:
- The Book - The most comprehensive resource for learning Rust, but a bit theoretical sometimes. You will be using this along with Rustlings!
- Rust By Example - Learn Rust by solving little exercises! It's almost like
rustlings
, but online
Getting Started
Note: If you're on MacOS, make sure you've installed Xcode and its developer tools by typing xcode-select --install
.
Note: If you have Xcode 10+ installed, you also need to install the package file found at /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
.
You will need to have Rust installed. You can get it by visiting https://rustup.rs. This'll also install Cargo, Rust's package/project manager.
MacOS/Linux
Just run:
curl -L https://git.io/rustlings | bash
# Or if you want it to be installed to a different path:
curl -L https://git.io/rustlings | bash -s mypath/
This will install Rustlings and give you access to the rustlings
command. Run it to get started!
Windows/Manually
Basically: Clone the repository, checkout to the latest tag, run cargo install
.
git clone https://github.com/rust-lang/rustlings
cd rustlings
git checkout tags/1.0.0 # or whatever the latest version is (find out at https://github.com/rust-lang/rustlings/releases/latest)
cargo install --force --path .
Same as above, run rustlings
to get started.
Doing exercises
The exercises are sorted by topic and can be found in the subdirectory rustlings/exercises/<topic>
. For every topic there is an additional README file with some resources to get you started on the topic. We really recommend that you have a look at them before you start.
The task is simple. Most exercises contain an error that keep it from compiling, and it's up to you to fix it! Some exercises are also ran as tests, but rustlings handles them all the same. To run the exercises in the recommended order, execute:
rustlings verify
This will try to verify the completion of every exercise in a predetermined order (what we think is best for newcomers). If you don't want to rerun verify
every time you change a file, you can run:
rustlings watch
This will do the same as verify, but won't quit after running and instead automatically rerun as soon as you change a file in the exercises/
directory.
In case you want to go by your own order, or want to only verify a single exercise, you can run:
rustlings run exercises/path/to/exercise.rs
In case you get stuck, there is usually a hint at the bottom of each exercise.
Testing yourself
After every couple of sections, there will be a test that'll test your knowledge on a bunch of sections at once. These tests are found in exercises/testN.rs
.
Completion
Rustlings isn't done; there are a couple of sections that are very experimental and don't have proper documentation. These include:
- Errors (
exercises/errors/
) - Option (
exercises/option/
) - Result (
exercises/result/
) - Move Semantics (could still be improved,
exercises/move_semantics/
)
Additionally, we could use exercises on a couple of topics:
- Structs
- Better ownership stuff
impl
- ??? probably more
If you are interested in improving or adding new ones, please feel free to contribute! Read on for more information :)
Contributing
Adding an exercise
First step is to add the exercise! Call it exercises/yourTopic/yourTopicN.rs
, make sure to
put in some helpful links, and link to sections of the book in exercises/yourTopic/README.md
.
Next you want to make sure it runs when using rustlings
. All exercises are stored in info.toml
, under the exercises
array. They're ordered by the order they're ran when using rustlings verify
.
You want to make sure where in the file you add your exercise. If you're not sure, add it at the bottom and ask in your pull request. To add an exercise, edit the file like this:
...
+ [[exercises]]
+ path = "exercises/yourTopic/yourTopicN.rs"
+ mode = "compile"
...
The mode
attribute decides whether Rustlings will only compile your exercise, or compile and test it. If you have tests to verify in your exercise, choose test
, otherwise compile
.
That's all! Feel free to put up a pull request.
Working on the source code
rustlings
is basically a glorified rustc
wrapper. Therefore the source code
isn't really that complicated since the bulk of the work is done by rustc
.
src/main.rs
contains a simple clap
CLI that loads from src/verify.rs
and src/run.rs
.
Credits
rustlings
was originally written by Carol!