From 7d9e4fcc07e5de94e37b73436147cdbbaa35dbdc Mon Sep 17 00:00:00 2001
From: Ivar Scholten <ivar.scholten@protonmail.com>
Date: Tue, 27 Aug 2024 13:59:01 +0200
Subject: [PATCH] fix: do not assume rustup is installed in xtask codegen

When formatting generated code the xtask crate attempts to run `rustup run stable rustfmt`,
which fails if `rustup` is not installed. This results in test failures when another source manages
the compiler toolchain, for example when using Nix (or any other distro-specific packaging solution):

* xtask::codegen::grammar::test
* xtask::codegen::assists_doc_tests::test

With this commit xtask will first attempt to run `rustup run stable rustfmt`, and if that fails just
plain `rustfmt`. It still validates a stable version is being used.

This allows `cargo test` to pass on systems that do not use `rustup`.
---
 xtask/src/codegen.rs | 34 +++++++++++++++++++---------------
 1 file changed, 19 insertions(+), 15 deletions(-)

diff --git a/xtask/src/codegen.rs b/xtask/src/codegen.rs
index aeb0c00ae6..09bfed19b0 100644
--- a/xtask/src/codegen.rs
+++ b/xtask/src/codegen.rs
@@ -126,27 +126,31 @@ impl fmt::Display for Location {
     }
 }
 
-fn ensure_rustfmt(sh: &Shell) {
-    let version = cmd!(sh, "rustup run stable rustfmt --version").read().unwrap_or_default();
-    if !version.contains("stable") {
-        panic!(
-            "Failed to run rustfmt from toolchain 'stable'. \
-                 Please run `rustup component add rustfmt --toolchain stable` to install it.",
-        );
+fn rustfmt_executable(sh: &Shell) -> &str {
+    // First try explicitly requesting the stable channel via rustup in case nightly is being used by default,
+    // then plain rustfmt in case rustup isn't being used to manage the compiler (e.g. when using Nix).
+    for executable in ["rustup run stable rustfmt", "rustfmt"] {
+        let version = cmd!(sh, "{executable} --version").read().unwrap_or_default();
+        if version.contains("stable") {
+            return executable;
+        }
     }
+
+    panic!(
+        "Failed to run rustfmt from toolchain 'stable'. \
+                 Please run `rustup component add rustfmt --toolchain stable` to install it.",
+    );
 }
 
 fn reformat(text: String) -> String {
     let sh = Shell::new().unwrap();
-    ensure_rustfmt(&sh);
+    let rustfmt_exe = rustfmt_executable(&sh);
     let rustfmt_toml = project_root().join("rustfmt.toml");
-    let mut stdout = cmd!(
-        sh,
-        "rustup run stable rustfmt --config-path {rustfmt_toml} --config fn_single_line=true"
-    )
-    .stdin(text)
-    .read()
-    .unwrap();
+    let mut stdout =
+        cmd!(sh, "{rustfmt_exe} --config-path {rustfmt_toml} --config fn_single_line=true")
+            .stdin(text)
+            .read()
+            .unwrap();
     if !stdout.ends_with('\n') {
         stdout.push('\n');
     }