test(ast): add snapshot tests and tooling

Co-authored-by: Samyak S Sarnayak <[email protected]>

compiler/src/bakugo.pest

@@ -39,7 +39,7 @@ WHITESPACE = _{ "\u{0020}" | "\u{0009}" | "\u{000D}" | "\u{000A}" }
 
 /// No comments containg `NewLine`.
 // Refer TODO[3]
-COMMENT = _{ "/*" ~ (!("*/" | NewLine) ~ ANY)* ~ "*/" }
+COMMENT = _{ "/*" ~ (!("*/") ~ ANY)* ~ "*/" }
 
 /// Punctuation
 Semicolon = { ";" }

compiler/tests/examples/01_empty_main.bakugo

@@ -0,0 +1 @@
+func main() {};

compiler/tests/examples/02_comments.bakugo

@@ -0,0 +1,22 @@
+func main() {
+	/* */
+
+	/**/
+
+	/*  hey there */
+
+	/*hey there*/
+
+	/*bakugo*/
+
+	/*
+
+	*/
+
+	/*
+	*/
+
+	/*
+		bakugo
+	*/
+};

compiler/tests/examples/04_expressions.bakugo

@@ -1,4 +1,4 @@
-func expr(int) {
+func expr() {
 	-4 + 2 * 3;
 	4 & 3 | 1;
 	4;

compiler/tests/examples/error/01_func_parameters.bakugo

@@ -0,0 +1,2 @@
+func expr(int) {
+};

compiler/tests/parser.rs

@@ -1,10 +1,48 @@
-use bakugo::parser::*;
-use insta::{assert_snapshot, assert_yaml_snapshot, glob};
+use std::{fmt::Display, fs};
+
+use bakugo::{ast::BakugoParsingErrorDisplay, parser::*};
+use insta::{
+    assert_debug_snapshot, assert_display_snapshot, assert_snapshot, assert_yaml_snapshot, glob,
+};
+use miette::{GraphicalReportHandler, GraphicalTheme, NamedSource};
 use pest::Parser;
 
+struct BakugoParsingErrDebug(BakugoParsingErrorDisplay);
+
+impl Display for BakugoParsingErrDebug {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let report_handler = GraphicalReportHandler::new_themed(GraphicalTheme::unicode_nocolor());
+        report_handler.render_report(f, &self.0)
+    }
+}
+
 #[test]
 fn test_parser() {
-    glob!("examples/*.bakugo", |_| {});
+    glob!("examples/**/*.bakugo", |path| {
+        let input = fs::read_to_string(path).unwrap();
+        let parsed = parse_string(&input);
+        match parsed {
+            Ok(parsed) => assert_yaml_snapshot!(parsed),
+            Err(err) => assert_snapshot!(err.to_string()),
+        }
+    });
+}
+
+#[test]
+fn test_ast() {
+    glob!("examples/**/*.bakugo", |path| {
+        let input = fs::read_to_string(path).unwrap();
+        let mut parsed = parse_string(&input).unwrap();
+        let source_file = parsed.next().unwrap();
+        let source = NamedSource::new(
+            path.file_name().unwrap().to_str().unwrap().to_string(),
+            input.clone(),
+        );
+        match construct_ast(source, source_file) {
+            Ok(parsed) => assert_debug_snapshot!(parsed),
+            Err(err) => assert_display_snapshot!(BakugoParsingErrDebug(err)),
+        }
+    });
 }
 
 #[test]

compiler/tests/snapshots/parser__ast@01_empty_main.bakugo.snap

@@ -0,0 +1,29 @@
+---
+source: tests/parser.rs
+expression: parsed
+input_file: tests/examples/01_empty_main.bakugo
+---
+SourceFile {
+    top_level: [
+        FnDecl(
+            FnDecl {
+                name: Ident {
+                    value: "main",
+                    span: Span {
+                        str: "main",
+                        start: 5,
+                        end: 9,
+                    },
+                },
+                params: [],
+                result_kind: None,
+                body: [],
+                span: Span {
+                    str: "func main() {}",
+                    start: 0,
+                    end: 14,
+                },
+            },
+        ),
+    ],
+}

compiler/tests/snapshots/parser__ast@02_comments.bakugo.snap

@@ -0,0 +1,29 @@
+---
+source: tests/parser.rs
+expression: parsed
+input_file: tests/examples/02_comments.bakugo
+---
+SourceFile {
+    top_level: [
+        FnDecl(
+            FnDecl {
+                name: Ident {
+                    value: "main",
+                    span: Span {
+                        str: "main",
+                        start: 5,
+                        end: 9,
+                    },
+                },
+                params: [],
+                result_kind: None,
+                body: [],
+                span: Span {
+                    str: "func main() {\n\t/* */\n\n\t/**/\n\n\t/*  hey there */\n\n\t/*hey there*/\n\n\t/*bakugo*/\n\n\t/*\n\n\t*/\n\n\t/*\n\t*/\n\n\t/*\n\t\tbakugo\n\t*/\n}",
+                    start: 0,
+                    end: 114,
+                },
+            },
+        ),
+    ],
+}