bender-slang: Add unit and integration tests

Author: fischeti

crates/bender-slang/tests/basic.rs

@@ -0,0 +1,81 @@
+use std::path::PathBuf;
+
+fn fixture_path(rel: &str) -> String {
+    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
+        .join("../..")
+        .join("tests/pickle")
+        .join(rel)
+        .canonicalize()
+        .expect("valid fixture path")
+        .to_string_lossy()
+        .into_owned()
+}
+
+#[test]
+fn parse_valid_file_succeeds() {
+    let mut session = bender_slang::SlangSession::new();
+    let files = vec![fixture_path("src/top.sv")];
+    let includes = vec![fixture_path("include")];
+    let defines = vec![];
+    assert!(session.parse_group(&files, &includes, &defines).is_ok());
+    assert_eq!(session.tree_count(), 1);
+}
+
+#[test]
+fn parse_invalid_file_returns_parse_error() {
+    let mut session = bender_slang::SlangSession::new();
+    let files = vec![fixture_path("src/broken.sv")];
+    let includes = vec![];
+    let defines = vec![];
+    let result = session.parse_group(&files, &includes, &defines);
+
+    match result {
+        Err(bender_slang::SlangError::ParseGroup { .. }) => {}
+        Err(other) => panic!("expected SlangError::ParseGroup, got {other}"),
+        Ok(_) => panic!("expected parse to fail"),
+    }
+}
+
+#[test]
+fn rewriter_build_from_trees_is_repeatable() {
+    let mut session = bender_slang::SlangSession::new();
+    let files = vec![fixture_path("src/top.sv")];
+    let includes = vec![fixture_path("include")];
+    let defines = vec![];
+    session
+        .parse_group(&files, &includes, &defines)
+        .expect("parse should succeed");
+
+    let trees = session.all_trees().expect("tree collection should succeed");
+    let tree = trees.first().expect("one tree expected");
+
+    let mut rewriter = bender_slang::SyntaxTreeRewriter::new();
+    rewriter.set_prefix("p_");
+    rewriter.set_suffix("_s");
+    rewriter.build_rename_map(&trees);
+    let renamed_once = rewriter.rewrite_tree(tree);
+    assert!(
+        renamed_once
+            .display(bender_slang::SlangPrintOpts {
+                expand_macros: false,
+                include_directives: true,
+                include_comments: true,
+                squash_newlines: false,
+            })
+            .contains("module p_top_s (")
+    );
+
+    // Rebuilding with the same trees should remain stable.
+    rewriter.build_rename_map(&trees);
+    let renamed_twice = rewriter.rewrite_tree(tree);
+    assert!(
+        renamed_twice
+            .display(bender_slang::SlangPrintOpts {
+                expand_macros: false,
+                include_directives: true,
+                include_comments: true,
+                squash_newlines: false,
+            })
+            .contains("module p_top_s (")
+    );
+}

tests/cli_regression.rs

@@ -161,5 +161,8 @@ regression_tests! {
     packages:                       &["packages"],
     packages_graph:                 &["packages", "--graph"],
     packages_flat:                  &["packages", "--flat"],
+    // Enable once the golden binary is built with `slang` support.
+    // pickle_basic:                   &["pickle", "--target", "top"],
+    // pickle_top_trim:                &["pickle", "--target", "top", "--top", "top"],
 
 }

tests/pickle/include/macros.svh

@@ -2,5 +2,9 @@
 `define LOG(msg) \
     $display("[LOG]: %s", msg);
 
+// Macro that references a package symbol; pickle renaming should update this.
+`define PKG_IS_ERROR(sig) \
+    common_pkg::is_error(sig)
+
 // A constant used in the RTL
 localparam int unsigned DataWidth = 32;

tests/pickle/src/broken.sv

@@ -0,0 +1,2 @@
+module broken(;
+endmodule

tests/pickle/src/core.sv

@@ -0,0 +1,3 @@
+module core;
+    leaf u_leaf();
+endmodule

tests/pickle/src/leaf.sv

@@ -0,0 +1,2 @@
+module leaf;
+endmodule

tests/pickle/src/top.sv

@@ -7,6 +7,8 @@ module top (
     input logic rst_n
 );
 
+    core u_core();
+
     // Interface Instantiation
     bus_intf #(.WIDTH(DATA_WIDTH)) axi_bus (
         .clk(clk)
@@ -25,12 +27,20 @@ module top (
 
     // Type Usage from Package (state_t)
     common_pkg::state_t current_state;
+    logic macro_error;
+
+    // Undefined dependency references must not be renamed.
+    undefined_pkg::undefined_t ext_state;
+    undefined_mod u_ext_mod();
+    virtual undefined_intf ext_if;
 
     always_ff @(posedge clk or negedge rst_n) begin
         if (!rst_n) begin
             current_state <= Idle;
+            macro_error <= 1'b0;
         end else begin
             current_state <= Busy;
+            macro_error <= `PKG_IS_ERROR(current_state);
         end
     end
 

tests/pickle/src/unused_leaf.sv

@@ -0,0 +1,2 @@
+module unused_leaf;
+endmodule

tests/pickle/src/unused_top.sv

@@ -0,0 +1,3 @@
+module unused_top;
+    unused_leaf u_unused_leaf();
+endmodule