Merge #1015

1015: Improve error diagnostics and other changes r=Alexhuszagh a=Emilgardis

- don't hide hostname querying in verbose
- output cross images as json
- associate `CROSS_DEBUG` with `MessageInfo`
<img width="490" alt="image" src="https://user-images.githubusercontent.com/1502855/195405356-1f673155-6be1-4f9f-9cc7-2cbf50604345.png">
- track caller when doing debug or error prints from `MessageInfo` and print the line it comes from




Co-authored-by: Emil Gardström <[email protected]>

Author: bors[bot]

.gitattributes

@@ -0,0 +1 @@
+Dockerfile.* linguist-language=Dockerfile

ci/test-remote.sh

@@ -45,7 +45,9 @@ cross_test_cpp() {
 
     pushd "${td}"
     retry cargo fetch
-    "${CROSS}" run --target "${TARGET}"
+    "${CROSS}" run --target "${TARGET}" | grep "Hello, world!"
+    sed -i 's/Hello, world/Hello, test/g' hellopp.cc
+    "${CROSS}" run --target "${TARGET}" | grep "Hello, test!"
     popd
 
     rm -rf "${td}"

src/bin/commands/containers.rs

@@ -396,7 +396,7 @@ pub fn create_persistent_volume(
     if let Some(channel) = channel {
         toolchain.channel = channel.channel.clone();
     };
-    let mount_finder = docker::MountFinder::create(engine)?;
+    let mount_finder = docker::MountFinder::create(engine, msg_info)?;
     let dirs = docker::ToolchainDirectories::assemble(&mount_finder, toolchain.clone())?;
     let container_id = dirs.unique_container_identifier(&toolchain.host().target)?;
     let volume_id = dirs.unique_toolchain_identifier()?;
@@ -464,7 +464,7 @@ pub fn remove_persistent_volume(
     if let Some(channel) = channel {
         toolchain.channel = channel.channel.clone();
     };
-    let mount_finder = docker::MountFinder::create(engine)?;
+    let mount_finder = docker::MountFinder::create(engine, msg_info)?;
     let dirs = docker::ToolchainDirectories::assemble(&mount_finder, toolchain)?;
     let volume_id = dirs.unique_toolchain_identifier()?;
     let volume = docker::DockerVolume::new(engine, &volume_id);

src/bin/commands/images.rs

@@ -1,5 +1,6 @@
 use std::collections::{BTreeMap, BTreeSet};
 
+use clap::builder::PossibleValue;
 use clap::{Args, Subcommand};
 use cross::docker::{self, CROSS_CUSTOM_DOCKERFILE_IMAGE_PREFIX};
 use cross::shell::MessageInfo;
@@ -26,6 +27,9 @@ pub struct ListImages {
     /// Container engine (such as docker or podman).
     #[clap(long)]
     pub engine: Option<String>,
+    /// Output format
+    #[clap(long, default_value = "human")]
+    pub format: OutputFormat,
     /// Only list images for specific target(s). By default, list all targets.
     pub targets: Vec<String>,
 }
@@ -36,6 +40,25 @@ impl ListImages {
     }
 }
 
+#[derive(Clone, Debug)]
+pub enum OutputFormat {
+    Human,
+    Json,
+}
+
+impl clap::ValueEnum for OutputFormat {
+    fn value_variants<'a>() -> &'a [Self] {
+        &[Self::Human, Self::Json]
+    }
+
+    fn to_possible_value(&self) -> Option<PossibleValue> {
+        match self {
+            OutputFormat::Human => Some(PossibleValue::new("human")),
+            OutputFormat::Json => Some(PossibleValue::new("json")),
+        }
+    }
+}
+
 #[derive(Args, Debug)]
 pub struct RemoveImages {
     /// If not provided, remove all images.
@@ -118,7 +141,7 @@ impl Images {
     }
 }
 
-#[derive(Debug, PartialOrd, Ord, PartialEq, Eq)]
+#[derive(Debug, PartialOrd, Ord, PartialEq, Eq, serde::Serialize)]
 struct Image {
     repository: String,
     tag: String,
@@ -258,7 +281,9 @@ fn get_image_target(
 }
 
 pub fn list_images(
-    ListImages { targets, .. }: ListImages,
+    ListImages {
+        targets, format, ..
+    }: ListImages,
     engine: &docker::Engine,
     msg_info: &mut MessageInfo,
 ) -> cross::Result<()> {
@@ -281,45 +306,55 @@ pub fn list_images(
     let mut keys: Vec<&str> = map.keys().map(|k| k.as_ref()).collect();
     keys.sort_unstable();
 
-    let print_string =
-        |col1: &str, col2: &str, fill: char, info: &mut MessageInfo| -> cross::Result<()> {
-            let mut row = String::new();
-            row.push('|');
-            row.push(fill);
-            row.push_str(col1);
-            let spaces = max_target_len.max(col1.len()) + 1 - col1.len();
-            for _ in 0..spaces {
-                row.push(fill);
-            }
-            row.push('|');
-            row.push(fill);
-            row.push_str(col2);
-            let spaces = max_image_len.max(col2.len()) + 1 - col2.len();
-            for _ in 0..spaces {
-                row.push(fill);
+    match format {
+        OutputFormat::Json => {
+            msg_info.info(format_args!("{}", serde_json::to_string(&map)?))?;
+        }
+        OutputFormat::Human => {
+            let print_string =
+                |col1: &str, col2: &str, fill: char, info: &mut MessageInfo| -> cross::Result<()> {
+                    let mut row = String::new();
+                    row.push('|');
+                    row.push(fill);
+                    row.push_str(col1);
+                    let spaces = max_target_len.max(col1.len()) + 1 - col1.len();
+                    for _ in 0..spaces {
+                        row.push(fill);
+                    }
+                    row.push('|');
+                    row.push(fill);
+                    row.push_str(col2);
+                    let spaces = max_image_len.max(col2.len()) + 1 - col2.len();
+                    for _ in 0..spaces {
+                        row.push(fill);
+                    }
+                    row.push('|');
+                    info.print(row)
+                };
+
+            if targets.len() != 1 {
+                print_string("Targets", "Images", ' ', msg_info)?;
+                print_string("-------", "------", '-', msg_info)?;
             }
-            row.push('|');
-            info.print(row)
-        };
-
-    if targets.len() != 1 {
-        print_string("Targets", "Images", ' ', msg_info)?;
-        print_string("-------", "------", '-', msg_info)?;
-    }
 
-    let print_single =
-        |_: &str, image: &Image, info: &mut MessageInfo| -> cross::Result<()> { info.print(image) };
-    let print_table = |target: &str, image: &Image, info: &mut MessageInfo| -> cross::Result<()> {
-        let name = image.name();
-        print_string(target, &name, ' ', info)
-    };
-
-    for target in keys {
-        for image in map.get(target).expect("map must have key").iter() {
-            if targets.len() == 1 {
-                print_single(target, image, msg_info)?;
-            } else {
-                print_table(target, image, msg_info)?;
+            let print_single = |_: &str,
+                                image: &Image,
+                                info: &mut MessageInfo|
+             -> cross::Result<()> { info.print(image) };
+            let print_table =
+                |target: &str, image: &Image, info: &mut MessageInfo| -> cross::Result<()> {
+                    let name = image.name();
+                    print_string(target, &name, ' ', info)
+                };
+
+            for target in keys {
+                for image in map.get(target).expect("map must have key").iter() {
+                    if targets.len() == 1 {
+                        print_single(target, image, msg_info)?;
+                    } else {
+                        print_table(target, image, msg_info)?;
+                    }
+                }
             }
         }
     }

src/bin/cross.rs

@@ -18,13 +18,7 @@ pub fn main() -> cross::Result<()> {
     let target_list = rustc::target_list(&mut Verbosity::Quiet.into())?;
     let args = cli::parse(&target_list)?;
     let subcommand = args.subcommand;
-    let mut msg_info = shell::MessageInfo::create(
-        args.verbose
-            + cross::config::bool_from_envvar(&std::env::var("CROSS_DEBUG").unwrap_or_default())
-                as u8,
-        args.quiet,
-        args.color.as_deref(),
-    )?;
+    let mut msg_info = shell::MessageInfo::create(args.verbose, args.quiet, args.color.as_deref())?;
     let status = match cross::run(args, target_list, &mut msg_info)? {
         Some(status) => status,
         None => {

src/docker/remote.rs

@@ -29,6 +29,7 @@ macro_rules! bail_container_exited {
     }};
 }
 
+#[track_caller]
 fn subcommand_or_exit(engine: &Engine, cmd: &str) -> Result<Command> {
     bail_container_exited!();
     Ok(engine.subcommand(cmd))
@@ -42,6 +43,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
     // NOTE: `reldir` should be a relative POSIX path to the root directory
     // on windows, this should be something like `mnt/c`. that is, all paths
     // inside the container should not have the mount prefix.
+    #[track_caller]
     fn create_dir(
         &self,
         reldir: &str,
@@ -57,6 +59,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
 
     // copy files for a docker volume, for remote host support
     // NOTE: `reldst` has the same caveats as `reldir` in `create_dir`.
+    #[track_caller]
     fn copy_files(
         &self,
         src: &Path,
@@ -72,6 +75,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
     }
 
     // copy files for a docker volume, for remote host support
+    #[track_caller]
     fn copy_files_nocache(
         &self,
         src: &Path,
@@ -92,6 +96,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
 
     // copy files for a docker volume, for remote host support
     // provides a list of files relative to src.
+    #[track_caller]
     fn copy_file_list(
         &self,
         src: &Path,
@@ -116,6 +121,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
 
     // removed files from a docker volume, for remote host support
     // provides a list of files relative to src.
+    #[track_caller]
     fn remove_file_list(
         &self,
         reldst: &str,
@@ -156,6 +162,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
             .run_and_get_status(msg_info, true)
     }
 
+    #[track_caller]
     fn container_path_exists(
         &self,
         relpath: &str,
@@ -173,6 +180,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
             .success())
     }
 
+    #[track_caller]
     pub fn copy_xargo(&self, mount_prefix: &str, msg_info: &mut MessageInfo) -> Result<()> {
         let dirs = &self.toolchain_dirs;
         let reldst = dirs.xargo_mount_path_relative()?;
@@ -194,6 +202,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
         Ok(())
     }
 
+    #[track_caller]
     pub fn copy_cargo(
         &self,
         mount_prefix: &str,
@@ -230,6 +239,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
     }
 
     // copy over files needed for all targets in the toolchain that should never change
+    #[track_caller]
     fn copy_rust_base(&self, mount_prefix: &str, msg_info: &mut MessageInfo) -> Result<()> {
         let dirs = &self.toolchain_dirs;
 
@@ -273,6 +283,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
         warn_symlinks(had_symlinks, msg_info)
     }
 
+    #[track_caller]
     fn copy_rust_manifest(&self, mount_prefix: &str, msg_info: &mut MessageInfo) -> Result<()> {
         let dirs = &self.toolchain_dirs;
 
@@ -298,6 +309,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
     }
 
     // copy over the toolchain for a specific triple
+    #[track_caller]
     fn copy_rust_triple(
         &self,
         target_triple: &TargetTriple,
@@ -335,6 +347,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
         Ok(())
     }
 
+    #[track_caller]
     pub fn copy_rust(
         &self,
         target_triple: Option<&TargetTriple>,
@@ -355,6 +368,7 @@ impl<'a, 'b, 'c> ContainerDataVolume<'a, 'b, 'c> {
         Ok(())
     }
 
+    #[track_caller]
     fn copy_mount(
         &self,
         src: &Path,