Merge 9f517e4eb8 into 766f3c50ec

.github/workflows/rust.yml

@@ -37,7 +37,10 @@ jobs:
       - name: Run cargo test
         run: cargo test --workspace
   dev-check:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
     steps:
       - uses: actions/checkout@v4
       - uses: swatinem/rust-cache@v2

CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="6.1.1"></a>
+
+## 6.1.1 (UNRELEASED)
+
+- Run the final check of all exercises in parallel.
+- Small exercise improvements.
+
 <a name="6.1.0"></a>
 
 ## 6.1.0 (2024-07-10)

Cargo.lock

@@ -357,9 +357,9 @@ checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
 
 [[package]]
 name = "lru"
-version = "0.12.3"
+version = "0.12.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d3262e75e648fce39813cb56ac41f3c3e3f65217ebf3844d818d1f9398cfb0dc"
+checksum = "37ee39891760e7d94734f6f63fedc29a2e4a152f836120753a72503f09fcf904"
 dependencies = [
  "hashbrown",
 ]
@@ -587,20 +587,21 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.120"
+version = "1.0.121"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4e0d21c9a8cae1235ad58a00c11cb40d4b1e5c784f1ef2c537876ed6ffd8b7c5"
+checksum = "4ab380d7d9f22ef3f21ad3e6c1ebe8e4fc7a2000ccba2e4d71fc96f15b2cb609"
 dependencies = [
  "itoa",
+ "memchr",
  "ryu",
  "serde",
 ]
 
 [[package]]
 name = "serde_spanned"
-version = "0.6.6"
+version = "0.6.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "79e674e01f999af37c49f70a6ede167a8a60b2503e56c5599532a65baa5969a0"
+checksum = "eb5b1b31579f3811bf615c144393417496f152e12ac8b7663bf664f4a815306d"
 dependencies = [
  "serde",
 ]
@@ -617,9 +618,9 @@ dependencies = [
 
 [[package]]
 name = "signal-hook-mio"
-version = "0.2.3"
+version = "0.2.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "29ad2e15f37ec9a6cc544097b78a1ec90001e9f71b81338ca39f430adaca99af"
+checksum = "34db1a06d485c9142248b7a054f034b349b212551f3dfd19c94d45a754a217cd"
 dependencies = [
  "libc",
  "mio",
@@ -698,18 +699,18 @@ dependencies = [
 
 [[package]]
 name = "toml_datetime"
-version = "0.6.6"
+version = "0.6.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4badfd56924ae69bcc9039335b2e017639ce3f9b001c393c1b2d1ef846ce2cbf"
+checksum = "0dd7358ecb8fc2f8d014bf86f6f638ce72ba252a2c3a2572f2a795f1d23efb41"
 dependencies = [
  "serde",
 ]
 
 [[package]]
 name = "toml_edit"
-version = "0.22.16"
+version = "0.22.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "278f3d518e152219c994ce877758516bca5e118eaed6996192a774fb9fbf0788"
+checksum = "1490595c74d930da779e944f5ba2ecdf538af67df1a9848cbd156af43c1b7cf0"
 dependencies = [
  "indexmap",
  "serde",
@@ -755,9 +756,9 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
 
 [[package]]
 name = "version_check"
-version = "0.9.4"
+version = "0.9.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
+checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
 
 [[package]]
 name = "walkdir"
@@ -947,9 +948,9 @@ checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
 
 [[package]]
 name = "winnow"
-version = "0.6.15"
+version = "0.6.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "557404e450152cd6795bb558bca69e43c585055f4606e3bcae5894fc6dac9ba0"
+checksum = "b480ae9340fc261e6be3e95a1ba86d54ae3f9171132a73ce8d4bbaf68339507c"
 dependencies = [
  "memchr",
 ]

Cargo.toml

@@ -8,10 +8,10 @@ exclude = [
 [workspace.package]
 version = "6.1.0"
 authors = [
-  "Liv <mokou@fastmail.com>",
-  "Mo Bitar <mo8it@proton.me>",
+  "Mo Bitar <mo8it@proton.me>", # https://github.com/mo8it
+  "Liv <mokou@fastmail.com>", # https://github.com/shadows-withal
   # Alumni
-  "Carol (Nichols || Goulding) <carol.nichols@gmail.com>",
+  "Carol (Nichols || Goulding) <carol.nichols@gmail.com>", # https://github.com/carols10cents
 ]
 repository = "https://github.com/rust-lang/rustlings"
 license = "MIT"
@@ -19,7 +19,7 @@ edition = "2021"
 
 [workspace.dependencies]
 serde = { version = "1.0.204", features = ["derive"] }
-toml_edit = { version = "0.22.16", default-features = false, features = ["parse", "serde"] }
+toml_edit = { version = "0.22.18", default-features = false, features = ["parse", "serde"] }
 
 [package]
 name = "rustlings"
@@ -51,7 +51,7 @@ notify-debouncer-mini = { version = "0.4.1", default-features = false }
 os_pipe = "1.2.0"
 ratatui = { version = "0.27.0", default-features = false, features = ["crossterm"] }
 rustlings-macros = { path = "rustlings-macros", version = "=6.1.0" }
-serde_json = "1.0.120"
+serde_json = "1.0.121"
 serde.workspace = true
 toml_edit.workspace = true
 
@@ -63,3 +63,7 @@ panic = "abort"
 
 [package.metadata.release]
 pre-release-hook = ["./release-hook.sh"]
+
+# TODO: Remove after the following fix is released: https://github.com/rust-lang/rust-clippy/pull/13102
+[lints.clippy]
+needless_option_as_deref = "allow"

src/app_state.rs

@@ -1,17 +1,17 @@
-use anyhow::{bail, Context, Result};
-use ratatui::crossterm::style::Stylize;
+use anyhow::{bail, Context, Error, Result};
 use serde::Deserialize;
 use std::{
     fs::{self, File},
     io::{Read, StdoutLock, Write},
     path::{Path, PathBuf},
     process::{Command, Stdio},
+    thread,
 };
 
 use crate::{
     clear_terminal,
     embedded::EMBEDDED_FILES,
-    exercise::{Exercise, RunnableExercise, OUTPUT_CAPACITY},
+    exercise::{Exercise, RunnableExercise},
     info_file::ExerciseInfo,
     DEBUG_PROFILE,
 };
@@ -373,34 +373,49 @@ impl AppState {
 
         if let Some(ind) = self.next_pending_exercise_ind() {
             self.set_current_exercise_ind(ind)?;
-
             return Ok(ExercisesProgress::NewPending);
         }
 
         writer.write_all(RERUNNING_ALL_EXERCISES_MSG)?;
 
-        let mut output = Vec::with_capacity(OUTPUT_CAPACITY);
-        for (exercise_ind, exercise) in self.exercises().iter().enumerate() {
-            write!(writer, "Running {exercise} ... ")?;
-            writer.flush()?;
+        let n_exercises = self.exercises.len();
 
-            let success = exercise.run_exercise(&mut output, &self.target_dir)?;
-            if !success {
-                writeln!(writer, "{}\n", "FAILED".red())?;
+        let pending_exercise_ind = thread::scope(|s| {
+            let handles = self
+                .exercises
+                .iter_mut()
+                .map(|exercise| {
+                    s.spawn(|| {
+                        let success = exercise.run_exercise(None, &self.target_dir)?;
+                        exercise.done = success;
+                        Ok::<_, Error>(success)
+                    })
+                })
+                .collect::<Vec<_>>();
 
-                self.current_exercise_ind = exercise_ind;
+            for (exercise_ind, handle) in handles.into_iter().enumerate() {
+                write!(writer, "\rProgress: {exercise_ind}/{n_exercises}")?;
+                writer.flush()?;
 
-                // No check if the exercise is done before setting it to pending
-                // because no pending exercise was found.
-                self.exercises[exercise_ind].done = false;
-                self.n_done -= 1;
-
-                self.write()?;
-
-                return Ok(ExercisesProgress::NewPending);
+                let success = handle.join().unwrap()?;
+                if !success {
+                    writer.write_all(b"\n\n")?;
+                    return Ok(Some(exercise_ind));
+                }
             }
 
-            writeln!(writer, "{}", "ok".green())?;
+            Ok::<_, Error>(None)
+        })?;
+
+        if let Some(pending_exercise_ind) = pending_exercise_ind {
+            self.current_exercise_ind = pending_exercise_ind;
+            self.n_done = self
+                .exercises
+                .iter()
+                .filter(|exercise| exercise.done)
+                .count() as u16;
+            self.write()?;
+            return Ok(ExercisesProgress::NewPending);
         }
 
         // Write that the last exercise is done.
@@ -426,7 +441,6 @@ Try running `cargo --version` to diagnose the problem.";
 const RERUNNING_ALL_EXERCISES_MSG: &[u8] = b"
 All exercises seem to be done.
 Recompiling and running all exercises to make sure that all of them are actually done.
-
 ";
 
 const FENISH_LINE: &str = "+----------------------------------------------------+

src/cmd.rs

@@ -1,30 +1,43 @@
 use anyhow::{Context, Result};
-use std::{io::Read, path::Path, process::Command};
+use std::{
+    io::Read,
+    path::Path,
+    process::{Command, Stdio},
+};
 
 /// Run a command with a description for a possible error and append the merged stdout and stderr.
 /// The boolean in the returned `Result` is true if the command's exit status is success.
-pub fn run_cmd(mut cmd: Command, description: &str, output: &mut Vec<u8>) -> Result<bool> {
-    let (mut reader, writer) = os_pipe::pipe()
-        .with_context(|| format!("Failed to create a pipe to run the command `{description}``"))?;
+pub fn run_cmd(mut cmd: Command, description: &str, output: Option<&mut Vec<u8>>) -> Result<bool> {
+    let spawn = |mut cmd: Command| {
+        // NOTE: The closure drops `cmd` which prevents a pipe deadlock.
+        cmd.stdin(Stdio::null())
+            .spawn()
+            .with_context(|| format!("Failed to run the command `{description}`"))
+    };
 
-    let writer_clone = writer.try_clone().with_context(|| {
-        format!("Failed to clone the pipe writer for the command `{description}`")
-    })?;
+    let mut handle = if let Some(output) = output {
+        let (mut reader, writer) = os_pipe::pipe().with_context(|| {
+            format!("Failed to create a pipe to run the command `{description}``")
+        })?;
 
-    let mut handle = cmd
-        .stdout(writer_clone)
-        .stderr(writer)
-        .spawn()
-        .with_context(|| format!("Failed to run the command `{description}`"))?;
+        let writer_clone = writer.try_clone().with_context(|| {
+            format!("Failed to clone the pipe writer for the command `{description}`")
+        })?;
 
-    // Prevent pipe deadlock.
-    drop(cmd);
+        cmd.stdout(writer_clone).stderr(writer);
+        let handle = spawn(cmd)?;
 
-    reader
-        .read_to_end(output)
-        .with_context(|| format!("Failed to read the output of the command `{description}`"))?;
+        reader
+            .read_to_end(output)
+            .with_context(|| format!("Failed to read the output of the command `{description}`"))?;
 
-    output.push(b'\n');
+        output.push(b'\n');
+
+        handle
+    } else {
+        cmd.stdout(Stdio::null()).stderr(Stdio::null());
+        spawn(cmd)?
+    };
 
     handle
         .wait()
@@ -42,14 +55,14 @@ pub struct CargoCmd<'a> {
     /// Added as `--target-dir` if `Self::dev` is true.
     pub target_dir: &'a Path,
     /// The output buffer to append the merged stdout and stderr.
-    pub output: &'a mut Vec<u8>,
+    pub output: Option<&'a mut Vec<u8>>,
     /// true while developing Rustlings.
     pub dev: bool,
 }
 
 impl<'a> CargoCmd<'a> {
     /// Run `cargo SUBCOMMAND --bin EXERCISE_NAME … ARGS`.
-    pub fn run(&mut self) -> Result<bool> {
+    pub fn run(self) -> Result<bool> {
         let mut cmd = Command::new("cargo");
         cmd.arg(self.subcommand);
 
@@ -86,7 +99,7 @@ mod tests {
         cmd.arg("Hello");
 
         let mut output = Vec::with_capacity(8);
-        run_cmd(cmd, "echo …", &mut output).unwrap();
+        run_cmd(cmd, "echo …", Some(&mut output)).unwrap();
 
         assert_eq!(output, b"Hello\n\n");
     }

src/dev/check.rs

@@ -41,7 +41,7 @@ fn check_cargo_toml(
             bail!("The file `dev/Cargo.toml` is outdated. Please run `cargo run -- dev update` to update it");
         }
 
-        bail!("The file `Cargo.toml` is outdated. Please run `rustlings dev update` to update it");
+        bail!("The file `Cargo.toml` is outdated. Please run `rustlings dev update` to update it. Then run `rustlings dev check` again");
     }
 
     Ok(())
@@ -184,8 +184,7 @@ fn check_exercises_unsolved(info_file: &InfoFile, target_dir: &Path) -> Result<(
                     error_occurred.store(true, atomic::Ordering::Relaxed);
                 };
 
-                let mut output = Vec::with_capacity(OUTPUT_CAPACITY);
-                match exercise_info.run_exercise(&mut output, target_dir) {
+                match exercise_info.run_exercise(None, target_dir) {
                     Ok(true) => error(b"Already solved!"),
                     Ok(false) => (),
                     Err(e) => error(e.to_string().as_bytes()),
@@ -244,7 +243,7 @@ fn check_solutions(require_solutions: bool, info_file: &InfoFile, target_dir: &P
                 }
 
                 let mut output = Vec::with_capacity(OUTPUT_CAPACITY);
-                match exercise_info.run_solution(&mut output, target_dir) {
+                match exercise_info.run_solution(Some(&mut output), target_dir) {
                     Ok(true) => {
                         paths.lock().unwrap().insert(PathBuf::from(path));
                     }

src/exercise.rs

@@ -19,8 +19,10 @@ pub const OUTPUT_CAPACITY: usize = 1 << 14;
 
 // Run an exercise binary and append its output to the `output` buffer.
 // Compilation must be done before calling this method.
-fn run_bin(bin_name: &str, output: &mut Vec<u8>, target_dir: &Path) -> Result<bool> {
-    writeln!(output, "{}", "Output".underlined())?;
+fn run_bin(bin_name: &str, mut output: Option<&mut Vec<u8>>, target_dir: &Path) -> Result<bool> {
+    if let Some(output) = output.as_deref_mut() {
+        writeln!(output, "{}", "Output".underlined())?;
+    }
 
     // 7 = "/debug/".len()
     let mut bin_path = PathBuf::with_capacity(target_dir.as_os_str().len() + 7 + bin_name.len());
@@ -28,19 +30,25 @@ fn run_bin(bin_name: &str, output: &mut Vec<u8>, target_dir: &Path) -> Result<bo
     bin_path.push("debug");
     bin_path.push(bin_name);
 
-    let success = run_cmd(Command::new(&bin_path), &bin_path.to_string_lossy(), output)?;
+    let success = run_cmd(
+        Command::new(&bin_path),
+        &bin_path.to_string_lossy(),
+        output.as_deref_mut(),
+    )?;
 
-    if !success {
-        // This output is important to show the user that something went wrong.
-        // Otherwise, calling something like `exit(1)` in an exercise without further output
-        // leaves the user confused about why the exercise isn't done yet.
-        writeln!(
-            output,
-            "{}",
-            "The exercise didn't run successfully (nonzero exit code)"
-                .bold()
-                .red(),
-        )?;
+    if let Some(output) = output {
+        if !success {
+            // This output is important to show the user that something went wrong.
+            // Otherwise, calling something like `exit(1)` in an exercise without further output
+            // leaves the user confused about why the exercise isn't done yet.
+            writeln!(
+                output,
+                "{}",
+                "The exercise didn't run successfully (nonzero exit code)"
+                    .bold()
+                    .red(),
+            )?;
+        }
     }
 
     Ok(success)
@@ -77,8 +85,15 @@ pub trait RunnableExercise {
 
     // Compile, check and run the exercise or its solution (depending on `bin_name´).
     // The output is written to the `output` buffer after clearing it.
-    fn run(&self, bin_name: &str, output: &mut Vec<u8>, target_dir: &Path) -> Result<bool> {
-        output.clear();
+    fn run(
+        &self,
+        bin_name: &str,
+        mut output: Option<&mut Vec<u8>>,
+        target_dir: &Path,
+    ) -> Result<bool> {
+        if let Some(output) = output.as_deref_mut() {
+            output.clear();
+        }
 
         // Developing the official Rustlings.
         let dev = DEBUG_PROFILE && in_official_repo();
@@ -90,7 +105,7 @@ pub trait RunnableExercise {
             description: "cargo build …",
             hide_warnings: false,
             target_dir,
-            output,
+            output: output.as_deref_mut(),
             dev,
         }
         .run()?;
@@ -99,7 +114,9 @@ pub trait RunnableExercise {
         }
 
         // Discard the output of `cargo build` because it will be shown again by Clippy.
-        output.clear();
+        if let Some(output) = output.as_deref_mut() {
+            output.clear();
+        }
 
         // `--profile test` is required to also check code with `[cfg(test)]`.
         let clippy_args: &[&str] = if self.strict_clippy() {
@@ -114,7 +131,7 @@ pub trait RunnableExercise {
             description: "cargo clippy …",
             hide_warnings: false,
             target_dir,
-            output,
+            output: output.as_deref_mut(),
             dev,
         }
         .run()?;
@@ -123,7 +140,7 @@ pub trait RunnableExercise {
         }
 
         if !self.test() {
-            return run_bin(bin_name, output, target_dir);
+            return run_bin(bin_name, output.as_deref_mut(), target_dir);
         }
 
         let test_success = CargoCmd {
@@ -134,12 +151,12 @@ pub trait RunnableExercise {
             // Hide warnings because they are shown by Clippy.
             hide_warnings: true,
             target_dir,
-            output,
+            output: output.as_deref_mut(),
             dev,
         }
         .run()?;
 
-        let run_success = run_bin(bin_name, output, target_dir)?;
+        let run_success = run_bin(bin_name, output.as_deref_mut(), target_dir)?;
 
         Ok(test_success && run_success)
     }
@@ -147,13 +164,13 @@ pub trait RunnableExercise {
     /// Compile, check and run the exercise.
     /// The output is written to the `output` buffer after clearing it.
     #[inline]
-    fn run_exercise(&self, output: &mut Vec<u8>, target_dir: &Path) -> Result<bool> {
+    fn run_exercise(&self, output: Option<&mut Vec<u8>>, target_dir: &Path) -> Result<bool> {
         self.run(self.name(), output, target_dir)
     }
 
     /// Compile, check and run the exercise's solution.
     /// The output is written to the `output` buffer after clearing it.
-    fn run_solution(&self, output: &mut Vec<u8>, target_dir: &Path) -> Result<bool> {
+    fn run_solution(&self, output: Option<&mut Vec<u8>>, target_dir: &Path) -> Result<bool> {
         let name = self.name();
         let mut bin_name = String::with_capacity(name.len());
         bin_name.push_str(name);

src/run.rs

@@ -11,7 +11,7 @@ use crate::{
 pub fn run(app_state: &mut AppState) -> Result<()> {
     let exercise = app_state.current_exercise();
     let mut output = Vec::with_capacity(OUTPUT_CAPACITY);
-    let success = exercise.run_exercise(&mut output, app_state.target_dir())?;
+    let success = exercise.run_exercise(Some(&mut output), app_state.target_dir())?;
 
     let mut stdout = io::stdout().lock();
     stdout.write_all(&output)?;

src/watch/state.rs

@@ -54,7 +54,7 @@ impl<'a> WatchState<'a> {
         let success = self
             .app_state
             .current_exercise()
-            .run_exercise(&mut self.output, self.app_state.target_dir())?;
+            .run_exercise(Some(&mut self.output), self.app_state.target_dir())?;
         if success {
             self.done_status =
                 if let Some(solution_path) = self.app_state.current_solution_path()? {