Compare commits

...

13 commits

Author SHA1 Message Date
mo8it a2d1cb3b22 Push newline after running an exercise instead on each rendering 2024-08-20 16:05:52 +02:00
mo8it e7ba88f905 Highlight the solution file 2024-08-20 16:04:29 +02:00
mo8it 50f6e5232e Leak info_file and cmd_runner in dev check 2024-08-20 14:47:08 +02:00
mo8it 8854f0a5ed Use anyhow! 2024-08-20 14:32:47 +02:00
mo8it 13cc3acdfd Improve readability 2024-08-20 13:56:52 +02:00
mo8it 5b7368c46d Improve error message if no exercise exists 2024-08-20 13:54:20 +02:00
mo8it 27999f2d26 Check if exercise doesn't contain tests 2024-08-20 13:49:48 +02:00
mo8it e74f2a4274 Check for #[test] with newline at the end 2024-08-20 13:39:14 +02:00
mo8it d141a73493 threads3: Improve the test 2024-08-20 13:35:07 +02:00
mo8it 631f44331e Remove --show-output for tests and use --format pretty 2024-08-20 13:08:15 +02:00
mo8it b01fddef8b Show progress of dev check 2024-08-19 23:52:22 +02:00
mo8it 78a8553f1c "Continue at" quits the list 2024-08-19 23:29:17 +02:00
mo8it b70c1abd7c Update deps 2024-08-19 23:28:53 +02:00
10 changed files with 179 additions and 156 deletions

8
Cargo.lock generated
View file

@ -368,9 +368,9 @@ dependencies = [
[[package]] [[package]]
name = "libc" name = "libc"
version = "0.2.156" version = "0.2.158"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a5f43f184355eefb8d17fc948dbecf6c13be3c141f20d834ae842193a448c72a" checksum = "d8adc4bb1803a324070e64a98ae98f38934d91957a99cfb3a43dcbc01bc56439"
[[package]] [[package]]
name = "libredox" name = "libredox"
@ -746,9 +746,9 @@ dependencies = [
[[package]] [[package]]
name = "syn" name = "syn"
version = "2.0.74" version = "2.0.75"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1fceb41e3d546d0bd83421d3409b1460cc7444cd389341a4c880fe7a042cb3d7" checksum = "f6af063034fc1935ede7be0122941bafa9bacb949334d090b77ca98b5817c7d9"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",

View file

@ -1,7 +1,6 @@
use std::{sync::mpsc, thread, time::Duration}; use std::{sync::mpsc, thread, time::Duration};
struct Queue { struct Queue {
length: u32,
first_half: Vec<u32>, first_half: Vec<u32>,
second_half: Vec<u32>, second_half: Vec<u32>,
} }
@ -9,7 +8,6 @@ struct Queue {
impl Queue { impl Queue {
fn new() -> Self { fn new() -> Self {
Self { Self {
length: 10,
first_half: vec![1, 2, 3, 4, 5], first_half: vec![1, 2, 3, 4, 5],
second_half: vec![6, 7, 8, 9, 10], second_half: vec![6, 7, 8, 9, 10],
} }
@ -48,17 +46,15 @@ mod tests {
fn threads3() { fn threads3() {
let (tx, rx) = mpsc::channel(); let (tx, rx) = mpsc::channel();
let queue = Queue::new(); let queue = Queue::new();
let queue_length = queue.length;
send_tx(queue, tx); send_tx(queue, tx);
let mut total_received: u32 = 0; let mut received = Vec::with_capacity(10);
for received in rx { for value in rx {
println!("Got: {received}"); received.push(value);
total_received += 1;
} }
println!("Number of received values: {total_received}"); received.sort();
assert_eq!(total_received, queue_length); assert_eq!(received, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
} }
} }

View file

@ -1,7 +1,6 @@
use std::{sync::mpsc, thread, time::Duration}; use std::{sync::mpsc, thread, time::Duration};
struct Queue { struct Queue {
length: u32,
first_half: Vec<u32>, first_half: Vec<u32>,
second_half: Vec<u32>, second_half: Vec<u32>,
} }
@ -9,7 +8,6 @@ struct Queue {
impl Queue { impl Queue {
fn new() -> Self { fn new() -> Self {
Self { Self {
length: 10,
first_half: vec![1, 2, 3, 4, 5], first_half: vec![1, 2, 3, 4, 5],
second_half: vec![6, 7, 8, 9, 10], second_half: vec![6, 7, 8, 9, 10],
} }
@ -50,17 +48,15 @@ mod tests {
fn threads3() { fn threads3() {
let (tx, rx) = mpsc::channel(); let (tx, rx) = mpsc::channel();
let queue = Queue::new(); let queue = Queue::new();
let queue_length = queue.length;
send_tx(queue, tx); send_tx(queue, tx);
let mut total_received: u32 = 0; let mut received = Vec::with_capacity(10);
for received in rx { for value in rx {
println!("Got: {received}"); received.push(value);
total_received += 1;
} }
println!("Number of received values: {total_received}"); received.sort();
assert_eq!(total_received, queue_length); assert_eq!(received, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
} }
} }

View file

@ -74,12 +74,14 @@ impl CmdRunner {
bail!("The command `cargo metadata …` failed. Are you in the `rustlings/` directory?"); bail!("The command `cargo metadata …` failed. Are you in the `rustlings/` directory?");
} }
let target_dir = serde_json::de::from_slice::<CargoMetadata>(&metadata_output.stdout) let metadata: CargoMetadata = serde_json::de::from_slice(&metadata_output.stdout)
.context( .context(
"Failed to read the field `target_directory` from the output of the command `cargo metadata …`", "Failed to read the field `target_directory` from the output of the command `cargo metadata …`",
)?.target_directory; )?;
Ok(Self { target_dir }) Ok(Self {
target_dir: metadata.target_directory,
})
} }
pub fn cargo<'out>( pub fn cargo<'out>(

View file

@ -97,7 +97,12 @@ fn check_info_file_exercises(info_file: &InfoFile) -> Result<HashSet<PathBuf>> {
bail!("Didn't find any `// TODO` comment in the file `{path}`.\nYou need to have at least one such comment to guide the user."); bail!("Didn't find any `// TODO` comment in the file `{path}`.\nYou need to have at least one such comment to guide the user.");
} }
if !exercise_info.test && file_buf.contains("#[test]") { let contains_tests = file_buf.contains("#[test]\n");
if exercise_info.test {
if !contains_tests {
bail!("The file `{path}` doesn't contain any tests. If you don't want to add tests to this exercise, set `test = false` for this exercise in the `info.toml` file");
}
} else if contains_tests {
bail!("The file `{path}` contains tests annotated with `#[test]` but the exercise `{name}` has `test = false` in the `info.toml` file"); bail!("The file `{path}` contains tests annotated with `#[test]` but the exercise `{name}` has `test = false` in the `info.toml` file");
} }
@ -160,11 +165,13 @@ fn check_unexpected_files(dir: &str, allowed_rust_files: &HashSet<PathBuf>) -> R
Ok(()) Ok(())
} }
fn check_exercises_unsolved(info_file: &InfoFile, cmd_runner: &CmdRunner) -> Result<()> { fn check_exercises_unsolved(
println!( info_file: &'static InfoFile,
"Running all exercises to check that they aren't already solved. This may take a while…\n", cmd_runner: &'static CmdRunner,
); ) -> Result<()> {
thread::scope(|s| { let mut stdout = io::stdout().lock();
stdout.write_all(b"Running all exercises to check that they aren't already solved...\n")?;
let handles = info_file let handles = info_file
.exercises .exercises
.iter() .iter()
@ -175,46 +182,55 @@ fn check_exercises_unsolved(info_file: &InfoFile, cmd_runner: &CmdRunner) -> Res
Some(( Some((
exercise_info.name.as_str(), exercise_info.name.as_str(),
s.spawn(|| exercise_info.run_exercise(None, cmd_runner)), thread::spawn(|| exercise_info.run_exercise(None, cmd_runner)),
)) ))
}) })
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let n_handles = handles.len();
write!(stdout, "Progress: 0/{n_handles}")?;
stdout.flush()?;
let mut handle_num = 1;
for (exercise_name, handle) in handles { for (exercise_name, handle) in handles {
let Ok(result) = handle.join() else { let Ok(result) = handle.join() else {
bail!("Panic while trying to run the exericse {exercise_name}"); bail!("Panic while trying to run the exericse {exercise_name}");
}; };
match result { match result {
Ok(true) => bail!( Ok(true) => {
"The exercise {exercise_name} is already solved.\n{SKIP_CHECK_UNSOLVED_HINT}", bail!("The exercise {exercise_name} is already solved.\n{SKIP_CHECK_UNSOLVED_HINT}",)
), }
Ok(false) => (), Ok(false) => (),
Err(e) => return Err(e), Err(e) => return Err(e),
} }
write!(stdout, "\rProgress: {handle_num}/{n_handles}")?;
stdout.flush()?;
handle_num += 1;
} }
stdout.write_all(b"\n")?;
Ok(()) Ok(())
})
} }
fn check_exercises(info_file: &InfoFile, cmd_runner: &CmdRunner) -> Result<()> { fn check_exercises(info_file: &'static InfoFile, cmd_runner: &'static CmdRunner) -> Result<()> {
match info_file.format_version.cmp(&CURRENT_FORMAT_VERSION) { match info_file.format_version.cmp(&CURRENT_FORMAT_VERSION) {
Ordering::Less => bail!("`format_version` < {CURRENT_FORMAT_VERSION} (supported version)\nPlease migrate to the latest format version"), Ordering::Less => bail!("`format_version` < {CURRENT_FORMAT_VERSION} (supported version)\nPlease migrate to the latest format version"),
Ordering::Greater => bail!("`format_version` > {CURRENT_FORMAT_VERSION} (supported version)\nTry updating the Rustlings program"), Ordering::Greater => bail!("`format_version` > {CURRENT_FORMAT_VERSION} (supported version)\nTry updating the Rustlings program"),
Ordering::Equal => (), Ordering::Equal => (),
} }
let info_file_paths = check_info_file_exercises(info_file)?; let handle = thread::spawn(move || check_exercises_unsolved(info_file, cmd_runner));
let handle = thread::spawn(move || check_unexpected_files("exercises", &info_file_paths));
let info_file_paths = check_info_file_exercises(info_file)?;
check_unexpected_files("exercises", &info_file_paths)?;
check_exercises_unsolved(info_file, cmd_runner)?;
handle.join().unwrap() handle.join().unwrap()
} }
enum SolutionCheck { enum SolutionCheck {
Success { sol_path: String }, Success { sol_path: String },
MissingRequired,
MissingOptional, MissingOptional,
RunFailure { output: Vec<u8> }, RunFailure { output: Vec<u8> },
Err(Error), Err(Error),
@ -222,20 +238,24 @@ enum SolutionCheck {
fn check_solutions( fn check_solutions(
require_solutions: bool, require_solutions: bool,
info_file: &InfoFile, info_file: &'static InfoFile,
cmd_runner: &CmdRunner, cmd_runner: &'static CmdRunner,
) -> Result<()> { ) -> Result<()> {
println!("Running all solutions. This may take a while…\n"); let mut stdout = io::stdout().lock();
thread::scope(|s| { stdout.write_all(b"Running all solutions...\n")?;
let handles = info_file let handles = info_file
.exercises .exercises
.iter() .iter()
.map(|exercise_info| { .map(|exercise_info| {
s.spawn(|| { thread::spawn(move || {
let sol_path = exercise_info.sol_path(); let sol_path = exercise_info.sol_path();
if !Path::new(&sol_path).exists() { if !Path::new(&sol_path).exists() {
if require_solutions { if require_solutions {
return SolutionCheck::MissingRequired; return SolutionCheck::Err(anyhow!(
"The solution of the exercise {} is missing",
exercise_info.name,
));
} }
return SolutionCheck::MissingOptional; return SolutionCheck::MissingOptional;
@ -261,6 +281,11 @@ fn check_solutions(
.arg("always") .arg("always")
.stdin(Stdio::null()); .stdin(Stdio::null());
let n_handles = handles.len();
write!(stdout, "Progress: 0/{n_handles}")?;
stdout.flush()?;
let mut handle_num = 1;
for (exercise_info, handle) in info_file.exercises.iter().zip(handles) { for (exercise_info, handle) in info_file.exercises.iter().zip(handles) {
let Ok(check_result) = handle.join() else { let Ok(check_result) = handle.join() else {
bail!( bail!(
@ -274,15 +299,10 @@ fn check_solutions(
fmt_cmd.arg(&sol_path); fmt_cmd.arg(&sol_path);
sol_paths.insert(PathBuf::from(sol_path)); sol_paths.insert(PathBuf::from(sol_path));
} }
SolutionCheck::MissingRequired => {
bail!(
"The solution of the exercise {} is missing",
exercise_info.name,
);
}
SolutionCheck::MissingOptional => (), SolutionCheck::MissingOptional => (),
SolutionCheck::RunFailure { output } => { SolutionCheck::RunFailure { output } => {
io::stderr().lock().write_all(&output)?; stdout.write_all(b"\n\n")?;
stdout.write_all(&output)?;
bail!( bail!(
"Running the solution of the exercise {} failed with the error above", "Running the solution of the exercise {} failed with the error above",
exercise_info.name, exercise_info.name,
@ -290,9 +310,14 @@ fn check_solutions(
} }
SolutionCheck::Err(e) => return Err(e), SolutionCheck::Err(e) => return Err(e),
} }
}
let handle = s.spawn(move || check_unexpected_files("solutions", &sol_paths)); write!(stdout, "\rProgress: {handle_num}/{n_handles}")?;
stdout.flush()?;
handle_num += 1;
}
stdout.write_all(b"\n")?;
let handle = thread::spawn(move || check_unexpected_files("solutions", &sol_paths));
if !fmt_cmd if !fmt_cmd
.status() .status()
@ -303,7 +328,6 @@ fn check_solutions(
} }
handle.join().unwrap() handle.join().unwrap()
})
} }
pub fn check(require_solutions: bool) -> Result<()> { pub fn check(require_solutions: bool) -> Result<()> {
@ -316,9 +340,12 @@ pub fn check(require_solutions: bool) -> Result<()> {
check_cargo_toml(&info_file.exercises, "Cargo.toml", b"")?; check_cargo_toml(&info_file.exercises, "Cargo.toml", b"")?;
} }
let cmd_runner = CmdRunner::build()?; // Leaking is fine since they are used until the end of the program.
check_exercises(&info_file, &cmd_runner)?; let cmd_runner = Box::leak(Box::new(CmdRunner::build()?));
check_solutions(require_solutions, &info_file, &cmd_runner)?; let info_file = Box::leak(Box::new(info_file));
check_exercises(info_file, cmd_runner)?;
check_solutions(require_solutions, info_file, cmd_runner)?;
println!("Everything looks fine!"); println!("Everything looks fine!");

View file

@ -98,7 +98,7 @@ pub trait RunnableExercise {
let output_is_some = output.is_some(); let output_is_some = output.is_some();
let mut test_cmd = cmd_runner.cargo("test", bin_name, output.as_deref_mut()); let mut test_cmd = cmd_runner.cargo("test", bin_name, output.as_deref_mut());
if output_is_some { if output_is_some {
test_cmd.args(["--", "--color", "always", "--show-output"]); test_cmd.args(["--", "--color", "always", "--format", "pretty"]);
} }
let test_success = test_cmd.run("cargo test …")?; let test_success = test_cmd.run("cargo test …")?;
if !test_success { if !test_success {

View file

@ -135,4 +135,4 @@ impl InfoFile {
} }
const NO_EXERCISES_ERR: &str = "There are no exercises yet! const NO_EXERCISES_ERR: &str = "There are no exercises yet!
If you are developing third-party exercises, add at least one exercise before testing."; Add at least one exercise before testing.";

View file

@ -75,7 +75,7 @@ fn handle_list(app_state: &mut AppState, stdout: &mut StdoutLock) -> Result<()>
} }
KeyCode::Char('c') => { KeyCode::Char('c') => {
ui_state.selected_to_current_exercise()?; ui_state.selected_to_current_exercise()?;
ui_state = ui_state.with_updated_rows(); break;
} }
_ => (), _ => (),
} }

View file

@ -33,18 +33,21 @@ pub fn run(app_state: &mut AppState) -> Result<()> {
)?; )?;
if let Some(solution_path) = app_state.current_solution_path()? { if let Some(solution_path) = app_state.current_solution_path()? {
println!( writeln!(
"\nA solution file can be found at {}\n", stdout,
style(TerminalFileLink(&solution_path)).underlined().green(), "\n{} for comparison: {}\n",
); "Solution".bold(),
style(TerminalFileLink(&solution_path)).underlined().cyan(),
)?;
} }
match app_state.done_current_exercise(&mut stdout)? { match app_state.done_current_exercise(&mut stdout)? {
ExercisesProgress::AllDone => (), ExercisesProgress::AllDone => (),
ExercisesProgress::CurrentPending | ExercisesProgress::NewPending => println!( ExercisesProgress::CurrentPending | ExercisesProgress::NewPending => writeln!(
stdout,
"Next exercise: {}", "Next exercise: {}",
app_state.current_exercise().terminal_link(), app_state.current_exercise().terminal_link(),
), )?,
} }
Ok(()) Ok(())

View file

@ -56,10 +56,12 @@ impl<'a> WatchState<'a> {
"\nChecking the exercise `{}`. Please wait…", "\nChecking the exercise `{}`. Please wait…",
self.app_state.current_exercise().name, self.app_state.current_exercise().name,
)?; )?;
let success = self let success = self
.app_state .app_state
.current_exercise() .current_exercise()
.run_exercise(Some(&mut self.output), self.app_state.cmd_runner())?; .run_exercise(Some(&mut self.output), self.app_state.cmd_runner())?;
self.output.push(b'\n');
if success { if success {
self.done_status = self.done_status =
if let Some(solution_path) = self.app_state.current_solution_path()? { if let Some(solution_path) = self.app_state.current_solution_path()? {
@ -121,11 +123,9 @@ impl<'a> WatchState<'a> {
pub fn render(&mut self) -> Result<()> { pub fn render(&mut self) -> Result<()> {
// Prevent having the first line shifted if clearing wasn't successful. // Prevent having the first line shifted if clearing wasn't successful.
self.writer.write_all(b"\n")?; self.writer.write_all(b"\n")?;
clear_terminal(&mut self.writer)?; clear_terminal(&mut self.writer)?;
self.writer.write_all(&self.output)?; self.writer.write_all(&self.output)?;
self.writer.write_all(b"\n")?;
if self.show_hint { if self.show_hint {
writeln!( writeln!(
@ -137,21 +137,20 @@ impl<'a> WatchState<'a> {
} }
if self.done_status != DoneStatus::Pending { if self.done_status != DoneStatus::Pending {
writeln!( writeln!(self.writer, "{}", "Exercise done ✓".bold().green())?;
self.writer,
"{}\n",
"Exercise done ✓
When you are done experimenting, enter `n` to move on to the next exercise 🦀"
.bold()
.green(),
)?;
}
if let DoneStatus::DoneWithSolution(solution_path) = &self.done_status { if let DoneStatus::DoneWithSolution(solution_path) = &self.done_status {
writeln!( writeln!(
self.writer, self.writer,
"A solution file can be found at {}\n", "{} for comparison: {}",
style(TerminalFileLink(solution_path)).underlined().green(), "Solution".bold(),
style(TerminalFileLink(solution_path)).underlined().cyan(),
)?;
}
writeln!(
self.writer,
"When done experimenting, enter `n` to move on to the next exercise 🦀\n",
)?; )?;
} }