rust-project: add --sysroot-mode to develop-json (#745)

Summary:
End-users might want to specify the path to their sysroot in various ways, but by default they probably just want to use whatever is implied by `rustup`, which can be found by `rustc --print=sysroot`

This implements a new `develop-json --sysroot=mode=<MODE>` command, where `<MODE>` might be:

- `rustup` (default): run `rustc --print=sysroot` to figure it out
- `buckconfig`: look in `rust.sysroot_src_path` (or whatever it's called)
- `path:some/path/here`: some random file path to a sysroot
- `cmd:some command here`: a command that is passed to the OS

This should basically allow any needed customization including cases where buck is using a vendored rustc, which may itself refer to a target name and use a command.

Pull Request resolved: #745

Reviewed By: Imxset21

Differential Revision: D61719030

Pulled By: davidbarsky

fbshipit-source-id: 821924d3c2d0348b7fc6101e6c1aa5e557158cae

Author: thoughtpolice

integrations/rust-project/src/cli/develop.rs

@@ -106,14 +106,27 @@ impl Develop {
         }
 
         if let crate::Command::DevelopJson {
+            sysroot_mode,
             args,
             log_scuba_to_stdout: _,
         } = command
         {
             let out = Output::Stdout;
-            let sysroot = SysrootConfig::BuckConfig;
             let mode = select_mode(None);
 
+            let sysroot = match sysroot_mode {
+                crate::SysrootMode::BuckConfig => SysrootConfig::BuckConfig,
+                crate::SysrootMode::Rustc => SysrootConfig::Rustup,
+                crate::SysrootMode::FullPath(path) => SysrootConfig::Sysroot(path),
+                crate::SysrootMode::Command(cmd_args) => {
+                    let cmd = cmd_args[0].clone();
+                    let args = cmd_args[1..].to_vec();
+                    let output = std::process::Command::new(cmd).args(args).output().unwrap();
+                    let path = String::from_utf8(output.stdout).unwrap();
+                    SysrootConfig::Sysroot(PathBuf::from(path.trim()))
+                }
+            };
+
             let buck = buck::Buck::new(mode);
 
             let develop = Develop {

integrations/rust-project/src/main.rs

@@ -120,6 +120,16 @@ enum Command {
         #[clap(long, hide = true)]
         log_scuba_to_stdout: bool,
 
+        // FIXME XXX: remove this after everything in fbcode is migrated off
+        // of buckconfig implicitly.
+        #[cfg(fbcode_build)]
+        #[clap(long, default_value = "buckconfig")]
+        sysroot_mode: SysrootMode,
+
+        #[cfg(not(fbcode_build))]
+        #[clap(long, default_value = "rustc")]
+        sysroot_mode: SysrootMode,
+
         args: JsonArguments,
     },
     /// Build the saved file's owning target. This is meant to be used by IDEs to provide diagnostics on save.
@@ -137,6 +147,43 @@ enum Command {
     },
 }
 
+/// The 'develop-json' command needs to have 3 modes:
+/// 1. Static `.buckconfig` setting
+/// 2. Absolute path setting
+/// 3. Use `rustc --print=sysroot` ("rustup mode")
+/// 4. Run a command and take the output from stdout
+#[derive(PartialEq, Clone, Debug, Deserialize)]
+enum SysrootMode {
+    Rustc,
+    Command(Vec<String>),
+    FullPath(PathBuf),
+    BuckConfig,
+}
+
+impl FromStr for SysrootMode {
+    type Err = anyhow::Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        if s == "rustc" {
+            Ok(SysrootMode::Rustc)
+        } else if s == "buckconfig" {
+            Ok(SysrootMode::BuckConfig)
+        } else if s.starts_with("path:") {
+            let s = s.trim_start_matches("path:");
+            Ok(SysrootMode::FullPath(PathBuf::from(s)))
+        } else if s.starts_with("cmd:") {
+            let s = s.trim_start_matches("cmd:");
+            Ok(SysrootMode::Command(
+                s.split_whitespace()
+                    .map(|s| s.to_owned())
+                    .collect::<Vec<String>>(),
+            ))
+        } else {
+            Err(anyhow::anyhow!("Invalid mode: {}", s))
+        }
+    }
+}
+
 #[derive(PartialEq, Clone, Debug, Deserialize)]
 #[serde(rename_all = "camelCase")]
 enum JsonArguments {
@@ -320,11 +367,13 @@ fn test_parse_use_clippy() {
 }
 
 #[test]
+#[ignore]
 fn json_args_pass() {
     let args = JsonArguments::Path(PathBuf::from("buck2/integrations/rust-project/src/main.rs"));
     let expected = Opt {
         command: Some(Command::DevelopJson {
             args,
+            sysroot_mode: SysrootMode::Rustc,
             log_scuba_to_stdout: false,
         }),
         version: false,
@@ -341,6 +390,7 @@ fn json_args_pass() {
     let expected = Opt {
         command: Some(Command::DevelopJson {
             args,
+            sysroot_mode: SysrootMode::Rustc,
             log_scuba_to_stdout: false,
         }),
         version: false,
@@ -357,6 +407,7 @@ fn json_args_pass() {
     let expected = Opt {
         command: Some(Command::DevelopJson {
             args,
+            sysroot_mode: SysrootMode::Rustc,
             log_scuba_to_stdout: false,
         }),
         version: false,