Add test suite (#15)

* Add test suite

Minor changes to parsing system were required, now CWD is not changed,
instead parser is passed root prefix that is later stripped.

* Remove unnecessary comment

Author: dominik-muc

.github/workflows/rust.yml

@@ -0,0 +1,21 @@
+name: Rust
+
+on:
+    push:
+        branches: ["master"]
+    pull_request:
+        branches: ["master"]
+
+env:
+    CARGO_TERM_COLOR: always
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+            - name: Build
+              run: cargo build --verbose
+            - name: Run tests
+              run: cargo test --verbose

.gitignore

@@ -1,6 +1,4 @@
 /target
-tests
 output.txt
-**/*.c
 **/*.o
 **/*.out

Cargo.lock

@@ -13,6 +13,8 @@ cranelift-module = "0.125.3"
 cranelift-object = "0.125.3"
 lalrpop-util = { version = "0.22.2", features = ["lexer", "unicode"] }
 
+[dev-dependencies]
+assert_cmd = "2.1.1"
 
 [build-dependencies]
 lalrpop = "0.22.2"

Cargo.toml

@@ -1,3 +1,5 @@
+use std::process::exit;
+
 use crate::{
     Cli, codegen, core,
     error::{InternalError, ariadne_renderer::AriadneRenderer, context::Context},
@@ -10,7 +12,7 @@ use crate::{
 pub fn run(config: Cli) -> Result<(), InternalError> {
     let mut ctx = Context::init(Box::new(AriadneRenderer::new()));
 
-    let prog = parse_project(&mut ctx)?;
+    let prog = parse_project(&config.dir, &mut ctx)?;
 
     if config.print_input_ast {
         println!("{:#?}", prog);
@@ -28,7 +30,7 @@ pub fn run(config: Cli) -> Result<(), InternalError> {
 
     if error_count != 0 {
         println!("{} errors occurred, compilation aborted.", error_count);
-        return Ok(());
+        exit(1)
     }
 
     if config.typecheck_only {

src/driver.rs

@@ -2,6 +2,8 @@ use std::path::PathBuf;
 
 use clap::Parser;
 
+use crate::error::InternalError;
+
 mod codegen;
 mod common;
 mod core;
@@ -36,10 +38,7 @@ pub struct Cli {
 }
 
 /// Entry point, parses command line arguments and starts the compiler pipeline.
-pub fn main() {
+pub fn main() -> Result<(), InternalError> {
     let cli = Cli::parse();
-    std::env::set_current_dir(&cli.dir).unwrap();
-    if let Err(e) = driver::run(cli) {
-        eprintln!("Internal error: {:#?}", e);
-    }
+    driver::run(cli)
 }

src/main.rs

@@ -1,5 +1,8 @@
 use std::{
-    collections::BTreeMap, fs::read_to_string, hint::unreachable_unchecked, path::PathBuf,
+    collections::BTreeMap,
+    fs::read_to_string,
+    hint::unreachable_unchecked,
+    path::{Path, PathBuf},
     sync::Arc,
 };
 
@@ -13,14 +16,14 @@ pub mod ast;
 lalrpop_util::lalrpop_mod!(pub parser, "/parser/parser.rs");
 
 /// Parses the entire `src` directory ignoring files without „mst” extension.
-///
-/// Expects that CWD is set to project root.
-pub fn parse_project(ctx: &mut Context) -> Result<ast::Program, InternalError> {
-    let mut path = PathBuf::from("src");
+pub fn parse_project(root: &Path, ctx: &mut Context) -> Result<ast::Program, InternalError> {
+    let mut path = PathBuf::from(root);
+    path.push("src");
     let files = get_files(&mut path)?;
     let mut file_map = BTreeMap::new();
     for file in files {
-        let module_path = get_module_path(&file)?;
+        let path = file.strip_prefix(root).unwrap();
+        let module_path = get_module_path(path)?;
         let parsed_file = parse_file(ctx, file)?;
         if let Some(module) = parsed_file {
             if let Some(_) = file_map.insert(module_path, module) {
@@ -35,7 +38,7 @@ pub fn parse_project(ctx: &mut Context) -> Result<ast::Program, InternalError> {
 /// Return the module path of file path.
 ///
 /// Both `bar.mst` and `bar/mod.mst` result in path `[bar]`.
-fn get_module_path(path: &PathBuf) -> Result<Vec<String>, InternalError> {
+fn get_module_path(path: &Path) -> Result<Vec<String>, InternalError> {
     let mut module_path = vec![];
     let iter: Vec<&str> = path
         .components()

src/parser/mod.rs

@@ -0,0 +1,33 @@
+
+pub fn add(lhs: i32, rhs: i32) -> i32 {
+    @iadd(lhs, rhs)
+}
+
+struct S {
+    a: i32,
+    b: i32,
+}
+
+@extern
+@no_mangle
+fn main() -> i32 {
+    let x = 42;
+    let y = f(x, 13, g(s(), 69));
+    add(x, y)
+}
+
+fn g(x: i32, z: i32) -> i32 {
+    x
+}
+
+fn f(x: i32, y: i32, z: i32) -> i32 {
+    z
+}
+
+fn s() -> i32 {
+    let s = S {
+        a = 75,
+        b = 313,
+    };
+    s.a
+}

tests/ok/001_functions/src/mod.mst

@@ -0,0 +1,14 @@
+
+mod a {
+    pub mod b {
+        pub fn test() -> i32 {
+            42
+        }
+    }
+}
+
+@extern
+@no_mangle
+fn main() -> i32 {
+    a::b::test()
+}

tests/ok/002_modules/src/mod.mst

@@ -0,0 +1,23 @@
+use std::io::Write;
+
+use assert_cmd::cargo::cargo_bin_cmd;
+
+fn test_path(s: &str) {
+    let output = cargo_bin_cmd!("mustcc").arg(s).output().unwrap();
+
+    std::io::stderr()
+        .write_all(output.stderr.as_slice())
+        .unwrap();
+
+    assert!(output.status.code() == Some(0), "non-zero exit code")
+}
+
+#[test]
+fn test_001() {
+    test_path("tests/ok/001_functions")
+}
+
+#[test]
+fn test_002() {
+    test_path("tests/ok/002_modules")
+}