chore(ci): break setup into composite action, and add cargo-mutants (#5)

Author: andogq

.cargo/mutants.toml

@@ -0,0 +1,6 @@
+exclude_globs = [
+    "src/passes/codegen.rs", # Until LLVM snapshot tests are implemented.
+    "src/ty/solver.rs", # Until solver is hardened and tested.
+]
+
+test_tool = "nextest"

.github/actions/setup/action.yaml

@@ -0,0 +1,33 @@
+name: Setup
+description: Setup for CI.
+
+inputs:
+  llvm-path:
+    description: Path to install LLVM to.
+    required: true
+  llvm-version:
+    description: Version of LLVM to install.
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Install LLVM Dependencies
+      shell: bash
+      run: |
+        sudo apt update 
+        wget http://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libtinfo5_6.3-2ubuntu0.1_amd64.deb
+        sudo apt install ./libtinfo5_6.3-2ubuntu0.1_amd64.deb
+
+    - name: Install LLVM and Clang
+      uses: KyleMayes/install-llvm-action@v2
+      with:
+        version: "${{ inputs.llvm-version }}"
+        directory: "${{ inputs.llvm-path }}"
+
+    - name: Install rust
+      shell: bash
+      run: |
+        rustup toolchain install stable --profile minimal --no-self-update
+
+    - uses: Swatinem/rust-cache@v2

.github/workflows/ci.yaml

@@ -9,6 +9,7 @@ on:
 env:
   CARGO_TERM_COLOR: "always"
   LLVM_PATH: "${{ github.workspace }}/llvm"
+  LLVM_VERSION: "18.1"
 
 jobs:
   test:
@@ -17,29 +18,15 @@ jobs:
     steps:
       - uses: actions/checkout@v5
 
-      - name: Install LLVM Dependencies
-        run: |
-          sudo apt update 
-          wget http://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libtinfo5_6.3-2ubuntu0.1_amd64.deb
-          sudo apt install ./libtinfo5_6.3-2ubuntu0.1_amd64.deb
-
-      - name: Install LLVM and Clang
-        uses: KyleMayes/install-llvm-action@v2
+      - uses: ./.github/actions/setup
         with:
-          version: "18.1"
-          directory: "${{ env.LLVM_PATH }}"
-
-      - name: Install rust
-        run: |
-          rustup toolchain install stable --profile minimal --no-self-update
+          llvm-version: ${{ env.LLVM_VERSION }}
+          llvm-path: ${{ env.LLVM_PATH }}
 
-      - name: Install cargo-llvm-cov
-        uses: taiki-e/install-action@cargo-llvm-cov
-
-      - name: Install cargo-nextest
-        uses: taiki-e/install-action@nextest
-
-      - uses: Swatinem/rust-cache@v2
+      - name: Install cargo-llvm-cov and nextest
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-llvm-cov,nextest
 
       - name: Test with code coverage
         run: |
@@ -69,23 +56,10 @@ jobs:
     steps:
       - uses: actions/checkout@v5
 
-      - name: Install LLVM Dependencies
-        run: |
-          sudo apt update 
-          wget http://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libtinfo5_6.3-2ubuntu0.1_amd64.deb
-          sudo apt install ./libtinfo5_6.3-2ubuntu0.1_amd64.deb
-
-      - name: Install LLVM and Clang
-        uses: KyleMayes/install-llvm-action@v2
+      - uses: ./.github/actions/setup
         with:
-          version: "18.1"
-          directory: "${{ env.LLVM_PATH }}"
-
-      - name: Install rust
-        run: |
-          rustup toolchain install stable --profile minimal --no-self-update
-
-      - uses: Swatinem/rust-cache@v2
+          llvm-version: ${{ env.LLVM_VERSION }}
+          llvm-path: ${{ env.LLVM_PATH }}
 
       - name: Run clippy
         run: |
@@ -98,8 +72,33 @@ jobs:
 
     steps:
       - uses: actions/checkout@v5
+
       - uses: streetsidesoftware/cspell-action@v8
         with:
           incremental_files_only: false
 
+  cargo-mutants:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: ./.github/actions/setup
+        with:
+          llvm-version: ${{ env.LLVM_VERSION }}
+          llvm-path: ${{ env.LLVM_PATH }}
+
+      - name: Install cargo-mutants and nextest
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-mutants,nextest
+
+      - run: cargo mutants -vV --in-place
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: mutants-out
+          path: mutants.out
+
 # spell-checker:ignore libtinfo,Swatinem

.gitignore

@@ -1 +1,2 @@
 /target
+mutants.out*

Cargo.lock

@@ -5,6 +5,7 @@ edition = "2024"
 
 [dependencies]
 inkwell = { version = "0.8.0", features = ["llvm18-1"] }
+mutants = "0.0.4"
 thiserror = "2.0.17"
 
 [dev-dependencies]

Cargo.toml

@@ -163,3 +163,57 @@ macro_rules! run_and_report {
         })
     };
 }
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    mod error {
+        use super::*;
+
+        #[rstest]
+        #[case("standard_error", CError::from(HirGenError::IfMustHaveBlock))]
+        #[case("fatal_error", CError::from(HirGenError::IfMustHaveBlock).fatal())]
+        #[case("message_error", CError::from(HirGenError::IfMustHaveBlock).with_message("some message"))]
+        #[case("fatal_and_message_error", CError::from(HirGenError::IfMustHaveBlock).fatal().with_message("some message"))]
+        fn formatting(#[case] name: &str, #[case] error: CError) {
+            assert_snapshot!(name, error, &format!("{error:?}"));
+        }
+    }
+
+    mod list {
+        use super::*;
+
+        #[rstest]
+        #[case::empty([])]
+        #[case::single_non_fatal([CError::from(HirGenError::IfMustHaveBlock)])]
+        #[case::single_fatal([CError::from(HirGenError::IfMustHaveBlock).fatal()])]
+        #[case::multiple_non_fatal(vec![CError::from(HirGenError::IfMustHaveBlock); 3])]
+        #[case::multiple_fatal(vec![CError::from(HirGenError::IfMustHaveBlock).fatal(); 3])]
+        #[case::multiple([
+            CError::from(HirGenError::IfMustHaveBlock).fatal(),
+            CError::from(HirGenError::IfMustHaveBlock),
+            CError::from(HirGenError::IfMustHaveBlock).fatal(),
+        ])]
+        fn counting(#[case] errors: impl IntoIterator<Item = CError>) {
+            let mut list = CErrorList::default();
+            let mut fatal = 0;
+            let mut non_fatal = 0;
+
+            for error in errors {
+                // Count fatal errors.
+                if error.fatal {
+                    fatal += 1;
+                } else {
+                    non_fatal += 1;
+                }
+
+                // Report the error.
+                list.report(error);
+            }
+
+            assert_eq!(list.iter_fatal().count(), fatal);
+            assert_eq!(list.iter_non_fatal().count(), non_fatal);
+        }
+    }
+}

src/error/mod.rs

@@ -0,0 +1,5 @@
+---
+source: src/error/mod.rs
+expression: error
+---
+FATAL: an `if` expression must contain at least one block. (some message)

src/error/snapshots/lumina2__error__test__error__fatal_and_message_error.snap

@@ -0,0 +1,5 @@
+---
+source: src/error/mod.rs
+expression: "CError { kind: HirGen(IfMustHaveBlock), message: None, fatal: true }"
+---
+FATAL: an `if` expression must contain at least one block.

src/error/snapshots/lumina2__error__test__error__fatal_error.snap

@@ -0,0 +1,5 @@
+---
+source: src/error/mod.rs
+expression: "CError { kind: HirGen(IfMustHaveBlock), message: Some(\"some message\"), fatal: false }"
+---
+an `if` expression must contain at least one block. (some message)