Updated README and improved output with verbose

Author: Emilgardis

.gitlab-ci.yml

@@ -14,4 +14,4 @@ regress:nightly:
     - cargo build --release
     - cd ci/svd2rust-regress
     - rm -rf ./output
-    - cargo run --release -- --long-test
+    - cargo run --release -- --long-test --format --verbose

ci/svd2rust-regress/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "svd2rust-regress"
 version = "0.1.0"
-authors = ["James Munns <[email protected]>"]
+authors = ["James Munns <[email protected]>", "The svd2rust developers"]
 
 [dependencies]
 reqwest = "0.8"
 rayon = "1.0"
 structopt = "0.2"
 error-chain = "0.11"
-inflections = "1.1.0"
+inflections = "1.1.0"

ci/svd2rust-regress/README.md

@@ -15,7 +15,10 @@
 
 ### Preconditions
 
-By default, `svd2rust-regress` assumes you have already built `svd2rust` in the root of this repository in `--release` mode. If this is not possible, it is possible to specify the path to an `svd2rust` binary (see **Options** below).
+By default, `svd2rust-regress` assumes you have already built `svd2rust` in the root of this repository in `--release` mode.
+If this is not possible, it is possible to specify the path to an `svd2rust` binary (see **Options** below).
+
+You'll also need to have `rustfmt` version > v0.4.0 to use the `--format` flag, you can install `rustfmt` with `rustup component add rustfmt-preview`.
 
 ### Output
 
@@ -30,7 +33,7 @@ Passed: spansion_mb9af12x_k - 23 seconds
 Fail results look like this:
 
 ```text
-Failed: si_five_e310x - 0 seconds - Error(Msg("Process Failed! - cargo check"), State { next_error: None, backtrace: None })
+Failed: si_five_e310x - 0 seconds. Error: Process Failed - cargo check
 ```
 
 If all test cases passed, the return code will be `0`. If any test cases failed, the return code will be `1`.
@@ -42,24 +45,32 @@ Here are the options for running `svd2rust-regress`:
 
 ```text
 svd2rust-regress 0.1.0
-James Munns <[email protected]>
+James Munns <[email protected]>:The svd2rust developers
 
 USAGE:
     svd2rust-regress [FLAGS] [OPTIONS]
 
 FLAGS:
     -b, --bad-tests    Include tests expected to fail (will cause a non-zero return code)
+    -f, --format       Enable formatting with `rustfmt`
     -h, --help         Prints help information
     -l, --long-test    Run a long test (it's very long)
     -V, --version      Prints version information
+    -v, --verbose      Use verbose output
 
 OPTIONS:
-    -a, --architecture <arch>         Filter by architecture, case sensitive, may be combined with other filters Options
-                                      are: "CortexM", "RiscV", and "Msp430"
-    -p, --svd2rust-path <bin_path>    Path to an `svd2rust` binary, relative or absolute. Defaults to
-                                      `target/release/svd2rust[.exe]` of this repository (which must be already built)
-    -c, --chip <chip>                 Filter by chip name, case sensitive, may be combined with other filters
-    -m, --manufacturer <mfgr>         Filter by manufacturer, case sensitive, may be combined with other filters
+    -a, --architecture <arch>
+            Filter by architecture, case sensitive, may be combined with other filters Options are: "CortexM", "RiscV",
+            and "Msp430"
+    -p, --svd2rust-path <bin_path>
+            Path to an `svd2rust` binary, relative or absolute. Defaults to `target/release/svd2rust[.exe]` of this
+            repository (which must be already built)
+    -c, --chip <chip>                            Filter by chip name, case sensitive, may be combined with other filters
+    -m, --manufacturer <mfgr>
+            Filter by manufacturer, case sensitive, may be combined with other filters
+
+        --rustfmt_bin_path <rustfmt_bin_path>
+            Path to an `rustfmt` binary, relative or absolute. Defaults to `$(rustup which rustfmt)`
 ```
 
 ### Filters
@@ -92,4 +103,6 @@ cargo run --release -- --long-test -c MB9AF12xK -m Fujitsu
     Finished release [optimized] target(s) in 0.0 secs
      Running `target/release/svd2rust-regress --long-test -c MB9AF12xK -m Fujitsu`
 Passed: fujitsu_mb9af12x_k - 19 seconds
-```
+```
+
+Note that you may have to pass `--long-test` to enable some chips as they are known to take a long time to compile.

ci/svd2rust-regress/src/errors.rs

@@ -1,7 +1,7 @@
-use std::path;
+use std::path::PathBuf;
 error_chain!{
     errors {
-        ProcessFailed(command: String, stderr: Option<path::PathBuf>, stdout: Option<path::PathBuf>) {
+        ProcessFailed(command: String, stderr: Option<PathBuf>, stdout: Option<PathBuf>) {
             description("Process Failed")
             display("Process Failed - {}", command)
         }

ci/svd2rust-regress/src/main.rs

@@ -10,13 +10,14 @@ mod errors;
 mod svd_test;
 mod tests;
 
+use error_chain::ChainedError;
 use rayon::prelude::*;
+use std::fs::File;
+use std::io::Read;
 use std::path::PathBuf;
 use std::process::{exit, Command};
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::time::Instant;
-use std::fs::File;
-use std::io::Read;
 use structopt::StructOpt;
 
 #[derive(StructOpt, Debug)]
@@ -122,8 +123,14 @@ fn main() {
         (_, false) => None,
         (&Some(ref path), true) => Some(path),
         (&None, true) => {
-            if default_rustfmt.is_none() {
-                eprintln!("Warning: No rustfmt found, formatting will be skipped")
+            // FIXME: Use Option::filter instead when stable, rust-lang/rust#45860
+            if default_rustfmt
+                .iter()
+                .filter(|p| p.is_file())
+                .next()
+                .is_none()
+            {
+                panic!("No rustfmt found");
             }
             default_rustfmt.as_ref()
         }
@@ -181,22 +188,28 @@ fn main() {
                 any_fails.store(true, Ordering::Release);
                 let additional_info = if opt.verbose > 0 {
                     match e.kind() {
-                        &errors::ErrorKind::ProcessFailed(ref command, _, ref stderr) if command == "cargo check" => {
+                        &errors::ErrorKind::ProcessFailed(ref command, _, Some(ref stderr))
+                            if command == "cargo check" =>
+                        {
                             let mut buf = String::new();
                             // Unwrap is safe
-                            File::open(stderr.as_ref().unwrap()).expect("Couldn't open file").read_to_string(&mut buf).expect("Couldn't read file to string");
+                            File::open(stderr)
+                                .expect("Couldn't open file")
+                                .read_to_string(&mut buf)
+                                .expect("Couldn't read file to string");
+                            buf.insert_str(0, &format!("\n---{:?}---\n", stderr.as_os_str()));
                             buf
                         }
-                        _ => "".into()
+                        _ => "".into(),
                     }
                 } else {
                     "".into()
                 };
                 eprintln!(
-                    "Failed: {} - {} seconds - {}{}",
+                    "Failed: {} - {} seconds. {}{}",
                     t.name(),
                     start.elapsed().as_secs(),
-                    e,
+                    e.display_chain().to_string().trim_right(),
                     additional_info,
                 );
             }

ci/svd2rust-regress/src/svd_test.rs

@@ -61,7 +61,9 @@ impl CommandHelper for Output {
         };
 
         if cant_fail && !self.status.success() {
-            return Err(ErrorKind::ProcessFailed(name.into(), stdout.cloned(), stderr.cloned()).into())
+            return Err(
+                ErrorKind::ProcessFailed(name.into(), stdout.cloned(), stderr.cloned()).into(),
+            );
         }
 
         Ok(())
@@ -134,6 +136,7 @@ pub fn test(t: &TestCase, bin_path: &PathBuf, rustfmt_bin_path: Option<&PathBuf>
         &Msp430 => "msp430",
         &RiscV => "riscv",
     };
+
     Command::new(bin_path)
         .args(&["-i", &chip_svd])
         .args(&["--target", &target])

ci/svd2rust-regress/src/tests.rs

@@ -76,7 +76,7 @@ use self::RunWhen::*;
 /// that are not valid in Rust ident
 const BLACKLIST_CHARS: &'static [char] = &['(', ')', '[', ']'];
 
-/// Lovingly stolen from `svd2rust`. Probably could be `Cow`, but I'm lazy
+/// Lovingly stolen from `svd2rust`. Probably could be `Cow`
 pub trait ToSanitizedSnakeCase {
     fn to_sanitized_snake_case(&self) -> String;
 }