Extended snapshot testing to typecheck

- introduced new Handler field to concatenate all errors into a string
- remodified tests in typecheck.rs to work with snapshot
- new snapshot tests

Author: fpham0701

Cargo.toml

@@ -12,6 +12,7 @@ pest_derive = "2.7.14"
 rustc-hash = "2.1.0"
 thiserror = "2.0.8"
 codespan-reporting = "0.11.1"
+strip-ansi-escapes = "0.2"
 
 [dev-dependencies]
 insta = { version = "1.41.1", features = ["yaml"] }

src/diagnostic.rs

@@ -17,7 +17,7 @@ use crate::ir::*;
 
 /// Track Errors
 #[derive(Hash, Eq, PartialEq, Debug)]
-enum ErrorKey {
+pub enum ErrorKey {
     ExprKey(ExprId),
     StmtKey(StmtId),
 }
@@ -87,20 +87,26 @@ impl Diagnostic {
 pub struct DiagnosticHandler {
     files: SimpleFiles<String, String>,
     reported_errs: HashSet<ErrorKey>,
+    error_string: String,
 }
 
 impl DiagnosticHandler {
     pub fn new() -> Self {
         Self {
             files: SimpleFiles::new(),
             reported_errs: HashSet::new(),
+            error_string: String::new(),
         }
     }
 
     pub fn add_file(&mut self, name: String, content: String) -> usize {
         self.files.add(name, content)
     }
 
+    pub fn error_string(&self) -> &str {
+        &self.error_string
+    }
+
     pub fn emit_diagnostic_expr(
         &mut self,
         tr: &Transaction,
@@ -128,7 +134,9 @@ impl DiagnosticHandler {
 
             diagnostic.emit(buffer, &self.files);
 
-            print!("{}", String::from_utf8_lossy(buffer.as_slice()));
+            let error_msg = String::from_utf8_lossy(buffer.as_slice());
+            self.error_string.push_str(&error_msg);
+            print!("{}", error_msg);
         }
     }
 
@@ -159,17 +167,23 @@ impl DiagnosticHandler {
 
             diagnostic.emit(buffer, &self.files);
 
-            print!("{}", String::from_utf8_lossy(buffer.as_slice()));
+            let error_msg = String::from_utf8_lossy(buffer.as_slice());
+            self.error_string.push_str(&error_msg);
+            print!("{}", error_msg);
         }
     }
 }
 
 #[cfg(test)]
 mod tests {
+    use baa::BitVecValue;
+    use insta::Settings;
+    use std::path::Path;
+    use strip_ansi_escapes::strip_str;
+
     use crate::{serialize::tests::create_calyx_go_down_transaction, typecheck::*};
 
     use super::*;
-    use baa::BitVecValue;
 
     #[test]
     fn test_emit_diagnostic() {
@@ -194,6 +208,14 @@ mod tests {
 
         handler.emit_diagnostic_expr(&tr, &one_expr, "Random Warning", Level::Warning);
         handler.emit_diagnostic_expr(&tr, &zero_expr, "Random Error", Level::Error);
+
+        let content = strip_str(handler.error_string());
+
+        let mut settings = Settings::clone_current();
+        settings.set_snapshot_path(Path::new("../tests/snapshots"));
+        settings.bind(|| {
+            insta::assert_snapshot!(content);
+        });
     }
 
     #[test]

src/typecheck.rs

@@ -70,7 +70,7 @@ fn check_stmt_types(
                     let fields = st[structid].pins();
                     if fields
                         .iter()
-                        .find(|field| field.dir() == Dir::Out && st[field.name()] == st[lhs])
+                        .find(|field| field.dir() == Dir::Out && field.name() == st[lhs].name())
                         .is_some()
                     {
                         handler.emit_diagnostic_stmt(
@@ -189,23 +189,43 @@ pub fn type_check(tr: &Transaction, st: &SymbolTable, handler: &mut DiagnosticHa
 
 #[cfg(test)]
 mod tests {
+    use std::path::Path;
+
     use crate::serialize::tests::{create_add_transaction, create_calyx_go_down_transaction};
     use baa::BitVecValue;
+    use insta::Settings;
+    use strip_ansi_escapes::strip_str;
 
     use super::*;
 
     #[test]
-    fn typecheck_add_transaction() {
+    fn test_add_transaction() {
         let mut handler = DiagnosticHandler::new();
         let (add, symbols) = create_add_transaction(&mut handler);
         type_check(&add, &symbols, &mut handler);
+
+        let content = strip_str(handler.error_string());
+
+        let mut settings = Settings::clone_current();
+        settings.set_snapshot_path(Path::new("../tests/snapshots"));
+        settings.bind(|| {
+            insta::assert_snapshot!(content);
+        });
     }
 
     #[test]
-    fn typecheck_calyx_go_down_transaction() {
+    fn test_calyx_go_down_transaction() {
         let mut handler = DiagnosticHandler::new();
         let (calyx_go_done, symbols) = create_calyx_go_down_transaction(&mut handler);
         type_check(&calyx_go_done, &symbols, &mut handler);
+
+        let content = strip_str(handler.error_string());
+
+        let mut settings = Settings::clone_current();
+        settings.set_snapshot_path(Path::new("../tests/snapshots"));
+        settings.bind(|| {
+            insta::assert_snapshot!(content);
+        });
     }
 
     // Specific Tests

tests/snapshots/protocols__typecheck__tests__add_transaction.snap

@@ -0,0 +1,21 @@
+---
+source: src/typecheck.rs
+expression: content
+---
+warning: Inferred RHS type as BitVec(32) from LHS type BitVec(32).
+   ┌─ add.prot:13:3
+   │
+13 │   DUT.a := X;
+   │   ^^^^^^^^^^^ Inferred RHS type as BitVec(32) from LHS type BitVec(32).
+
+warning: Inferred RHS type as BitVec(32) from LHS type BitVec(32).
+   ┌─ add.prot:14:3
+   │
+14 │   DUT.b := X;
+   │   ^^^^^^^^^^^ Inferred RHS type as BitVec(32) from LHS type BitVec(32).
+
+error: Cannot assign to function argument. Try using assert_eq if you want to check the value of a transaction output.
+   ┌─ add.prot:15:3
+   │
+15 │   s := DUT.s;
+   │   ^^^^^^^^^^^ Cannot assign to function argument. Try using assert_eq if you want to check the value of a transaction output.

tests/snapshots/protocols__typecheck__tests__calyx_go_down_transaction.snap

@@ -0,0 +1,27 @@
+---
+source: src/typecheck.rs
+expression: content
+---
+error: Type mismatch in assignment: dut.go : BitVec(32) and 1 : BitVec(1).
+   ┌─ calyx_go_done.prot:10:3
+   │
+10 │   dut.go := 1;
+   │   ^^^^^^^^^^^^ Type mismatch in assignment: dut.go : BitVec(32) and 1 : BitVec(1).
+
+error: Type mismatch in assignment: dut.go : BitVec(32) and 0 : BitVec(1).
+   ┌─ calyx_go_done.prot:14:3
+   │
+14 │   dut.go := 0;
+   │   ^^^^^^^^^^^^ Type mismatch in assignment: dut.go : BitVec(32) and 0 : BitVec(1).
+
+warning: Inferred RHS type as BitVec(32) from LHS type BitVec(32).
+   ┌─ calyx_go_done.prot:15:3
+   │
+15 │   dut.ii := X;
+   │   ^^^^^^^^^^^^ Inferred RHS type as BitVec(32) from LHS type BitVec(32).
+
+error: Cannot assign to function argument. Try using assert_eq if you want to check the value of a transaction output.
+   ┌─ calyx_go_done.prot:16:3
+   │
+16 │   oo := dut.oo;
+   │   ^^^^^^^^^^^^^^ Cannot assign to function argument. Try using assert_eq if you want to check the value of a transaction output.