LLVM-based coverage.

Also fixed a test that left output in the root directory

Author: bosschaert

build.rs

@@ -1,7 +1,4 @@
 fn main() {
     // This is needed to be able to test the println! output that some code produces
     println!("cargo:rustc-env=RUST_TEST_NOCAPTURE=1");
-
-    // // This is needed to avoid multiple tests to concurrently capture stdout
-    // println!("cargo:rustc-env=RUST_TEST_THREADS=1");
 }

code-coverage.sh

@@ -1 +1,16 @@
-cargo tarpaulin -o Html
+GRCOV_DIR=~/apps/grcov
+echo Directory containing the grcov executable: $GRCOV_DIR
+
+cargo clean 
+
+echo Run tests producing raw coverage data...
+CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE='cargo-test-%p-%m.profraw' cargo test
+
+echo Execute grcov to collect coverage data and produce HTML report...
+$GRCOV_DIR/grcov . --binary-path ./target/debug/deps/ -s . -t html --branch --ignore-not-existing --ignore '../*' --ignore "/*" -o target/coverage/html
+
+echo Deleting the *.profraw files from the current directory
+rm *.profraw
+
+open target/coverage/html/index.html
+

src/bin/main.rs

@@ -86,14 +86,16 @@ fn real_main(args: Cli) -> i32 {
             XMLUtil::grep_xml(&temp_dir, &src_file, &grep_args.regex)
         },
         Commands::Replace(replace_args) => {
+            // let x = replace_args.out_file.as_deref();
+
             XMLUtil::replace_xml(&temp_dir, &src_file,
                 &replace_args.regex, &replace_args.replace,
-                &replace_args.out_file);
+                &replace_args.out_file.as_deref());
         },
         Commands::ReplaceLinks(replace_args) => {
             XMLUtil::replace_attr(&temp_dir, &src_file,
                 &replace_args.regex, &replace_args.replace,
-                &replace_args.out_file);
+                &replace_args.out_file.as_deref());
         }
     }
 

src/xml_util.rs

@@ -28,18 +28,18 @@ impl XMLUtil {
         Self::snr_xml(Mode::Value, dir, src_file, None, Some(pattern), None, None);
     }
 
-    pub fn replace_xml(dir: &str, src_file: &str, pattern: &str, replace: &str, output_file: &Option<String>) {
+    pub fn replace_xml(dir: &str, src_file: &str, pattern: &str, replace: &str, output_file: &Option<&str>) {
         let out_file = match output_file {
-            Some(of) => of.as_str(),
+            Some(of) => of,
             None => src_file
         };
 
         Self::snr_xml(Mode::Value, dir, src_file, Some(vec!("word/document.xml")), Some(pattern), Some(replace), Some(out_file));
     }
 
-    pub fn replace_attr(dir: &str, src_file: &str, pattern: &str, replace: &str, output_file: &Option<String>) {
+    pub fn replace_attr(dir: &str, src_file: &str, pattern: &str, replace: &str, output_file: &Option<&str>) {
         let out_file = match output_file {
-            Some(of) => of.as_str(),
+            Some(of) => of,
             None => src_file
         };
 
@@ -251,7 +251,8 @@ mod tests {
         assert!(!before.contains("zzz"), "Precondition");
 
         XMLUtil::replace_xml(&testdir.to_string_lossy(), "my-source.docx",
-            "[Ss]ome", "zzz", &None);
+            "[Ss]ome", "zzz",
+            &Some(&testdir.join("output.docx").to_string_lossy()));
 
         // Check that the replacement worked as expected
         let after = fs::read_to_string(testdir.join("word/document.xml"))?;
@@ -279,7 +280,8 @@ mod tests {
         assert!(before_doc.contains(">www.example.com<"), "Precondition");
 
         XMLUtil::replace_attr(&testdir.to_string_lossy(), "my-source.docx",
-            "www.example.com", "foobar.org", &None);
+            "www.example.com", "foobar.org",
+            &Some(&testdir.join("output-2.docx").to_string_lossy()));
 
         let after_doc = fs::read_to_string("./src/test/test_tree2/word/document.xml")?;
         let after = fs::read_to_string(testdir.join("word/_rels/document.xml.rels"))?;