Add Natvis visualizer tests in the CI pipeline to ensure Natvis does not break silently.

Author: ridwanabdillahi

.github/workflows/ci.yml

@@ -27,6 +27,7 @@ jobs:
         - nightly
         - macos
         - win-msvc
+        - win-msvc (nightly)
         - win-gnu
         include:
         - build: pinned
@@ -55,6 +56,9 @@ jobs:
         - build: win-msvc
           os: windows-2019
           rust: stable
+        - build: win-msvc (nightly)
+          os: windows-2019
+          rust: nightly
         - build: win-gnu
           os: windows-2019
           rust: stable-x86_64-gnu
@@ -156,6 +160,15 @@ jobs:
       run: |
         cargo test --test default --no-default-features --features 'std pattern unicode-perl'
 
+    # The #[debugger_visualizer] attribute is currently gated behind an unstable feature flag.
+    # In order to test the visualizers for the regex crate, they have to be tested on a nightly build.
+    - if: matrix.build == 'win-msvc (nightly)'
+      name: Run visualizer tests with debugger_visualizer feature
+      run: |
+        # install the Debuginfo Test Runner to test visualizers defined for the regex crate
+        cargo install dbt --git https://github.com/rust-lang/rust-dbg-ext.git --rev 2a17aa351ab66160464aace0e35370e3d671740a --bin dbt
+        dbt -d cdb --cargo-workspace tests/visualizers --cargo-profile debug -o target
+
   rustfmt:
     name: rustfmt
     runs-on: ubuntu-18.04

Cargo.toml

@@ -104,6 +104,9 @@ unstable = ["pattern"]
 # by default if the unstable feature is enabled.
 pattern = []
 
+# Enable to use the #[debugger_visualizer] attribute.
+debugger_visualizer = []
+
 # For very fast prefix literal matching.
 [dependencies.aho-corasick]
 version = "0.7.18"

src/lib.rs

@@ -607,6 +607,8 @@ another matching engine with fixed memory requirements.
 
 #![deny(missing_docs)]
 #![cfg_attr(feature = "pattern", feature(pattern))]
+#![cfg_attr(feature = "debugger_visualizer", feature(debugger_visualizer))]
+#![cfg_attr(feature = "debugger_visualizer", debugger_visualizer(natvis_file = "../regex.natvis"))]
 #![warn(missing_debug_implementations)]
 
 #[cfg(not(feature = "std"))]

tests/visualizers/Cargo.toml

@@ -0,0 +1,8 @@
+[workspace]
+members = [
+    "natvis",
+]
+exclude = ["target"]
+
+[profile.release]
+debug = 2

tests/visualizers/natvis/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "natvis"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies.regex]
+path = "../../../"
+features = ["debugger_visualizer"]

tests/visualizers/natvis/src/main.rs

@@ -0,0 +1,74 @@
+/***
+
+// See https://github.com/rust-lang/rust-dbg-ext/blob/main/test-framework/dbt/README.md
+// for more information on how these test scripts work.
+
+#if @cdb
+  // Start running the program
+  g
+
+  // The following line checks that we actually hit the breakpoint.
+  #check Breakpoint 0 hit
+
+  // Ensure the Natvis file for the regex crate is loaded.
+  .nvlist
+  #check natvis.exe (embedded NatVis "@{ .* }@natvis-0.natvis")
+
+  // Check the Natvis visualization for re::unicode::Regex
+  dv
+  dx re
+  #check re               : { text="hits="[0-9]+"" } [Type: regex::re_unicode::Regex]
+  #check   [<Raw View>]     [Type: regex::re_unicode::Regex]
+  #check   [Reference count] : 0x2 [Type: core::sync::atomic::AtomicUsize]
+  #check   [Weak reference count] : 0x1 [Type: core::sync::atomic::AtomicUsize]
+  #check   [+0xc00] res              : { len=0x1 } [Type: alloc::vec::Vec<alloc::string::String,alloc::alloc::Global>]
+  #check   [+0x000] nfa              [Type: regex::prog::Program]
+  #check   [+0x320] dfa              [Type: regex::prog::Program]
+  #check   [+0x640] dfa_reverse      [Type: regex::prog::Program]
+  #check   [+0x960] suffixes         [Type: regex::literal::imp::LiteralSearcher]
+  #check   [+0xc18] ac               : None [Type: enum$<core::option::Option<aho_corasick::ahocorasick::AhoCorasick<u32> >, 0, 1, Some>]
+  #check   [+0xda0] match_type       : Dfa [Type: enum$<regex::exec::MatchType>]
+
+  dx captures
+  #check captures         : { named_groups=0x0 } [Type: regex::re_unicode::Captures]
+  #check   [<Raw View>]     [Type: regex::re_unicode::Captures]
+  #check   [text]           : "<Type><hits="12123123123"></hits></Type>" [Type: str]
+  #check   [named_groups]   : { len=0x0 } [Type: @{ .* }@]
+  #check   [0]              : @{ .* }@ : "hits="12123123123"" [Type: char *]
+
+  g
+
+  dx m
+  #check m                : "hits="12123123123"" [Type: regex::re_unicode::Match]
+  #check   [<Raw View>]     [Type: regex::re_unicode::Match]
+  #check   [text]           : "<Type><hits="12123123123"></hits></Type>" [Type: str]
+  #check   [match_text]     : "hits="12123123123""
+  #check   [start]          : 0x7 [Type: unsigned __int64]
+  #check   [end]            : 0x19 [Type: unsigned __int64]
+
+  q
+
+#if not @cdb
+  #ignore-test
+
+***/
+
+use regex::{Regex, Match};
+
+pub fn main() {
+    let re = Regex::new(r#"hits="[0-9]+""#).unwrap();
+    let text = r#"<Type><hits="12123123123"></hits></Type>"#;
+
+    let captures = re.captures(text).unwrap();
+    let matches = captures.iter().filter_map(|capture| capture).collect::<Vec<Match>>();
+    assert_eq!(1, matches.len());
+    _break(); // #break
+
+    for m in matches {
+      _break(); // #break
+      assert_eq!(r#"hits="12123123123""#, m.as_str());
+    }
+}
+
+#[inline(never)]
+pub fn _break() {}