Setup CI (#1)

* feat: Add CI

Signed-off-by: Ethan Uppal <[email protected]>

* chore: Bump marlin to 0.6.1

Signed-off-by: Ethan Uppal <[email protected]>

* ci: Debug stuff

Signed-off-by: Ethan Uppal <[email protected]>

* ci: ?

Signed-off-by: Ethan Uppal <[email protected]>

* test: Rework how Marlin testing is done

Signed-off-by: Ethan Uppal <[email protected]>

* test: Bring back calling veryl build on independent test runs

Signed-off-by: Ethan Uppal <[email protected]>

* fix: Remove testing code

Signed-off-by: Ethan Uppal <[email protected]>

---------

Signed-off-by: Ethan Uppal <[email protected]>

Author: ethanuppal

.github/workflows/marlin.yaml

@@ -0,0 +1,33 @@
+name: Marlin CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 1 # since we cache
+
+jobs:
+  test_veryl:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-15]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - name: Install Verilator
+        run: |
+          if [[ "$(uname)" == "Darwin" ]]; then
+            brew install verilator
+          else
+            sudo apt-get install -y verilator
+          fi
+      - name: Install Veryl
+        uses: veryl-lang/setup-veryl@v1
+      - name: Test
+        run: veryl build && cargo test

Cargo.toml

@@ -6,5 +6,5 @@ edition = "2024"
 [dependencies]
 
 [dev-dependencies]
-marlin = { version = "0.5.0", features = ["veryl"] }
+marlin = { version = "0.6.1", features = ["veryl"] }
 snafu = "0.8.5"

README.md

@@ -92,6 +92,7 @@ fn test_alu() -> Result<(), Whatever> {
 To run tests and capture the output:
 
 ```shell
+veryl build
 cargo test -- --nocapture
 ```
 

tests/veryl_tests.rs

@@ -1,4 +1,5 @@
-// file: tests/simple_test.rs
+use std::env;
+
 use marlin::veryl::prelude::*;
 use snafu::Whatever;
 
@@ -12,8 +13,9 @@ pub struct Alu32;
 #[snafu::report]
 fn test_full_adder() -> Result<(), Whatever> {
     let runtime = VerylRuntime::new(VerylRuntimeOptions {
-        call_veryl_build: true, /* warning: not thread safe! don't use if you
-                                 * have multiple tests */
+        call_veryl_build: env::var("RUNNING_TESTS_INDEPENDENTLY")
+            .map(|value| &value == "1")
+            .unwrap_or(false),
         ..Default::default()
     })?;
 
@@ -68,8 +70,9 @@ fn test_alu() -> Result<(), Whatever> {
     }
 
     let runtime = VerylRuntime::new(VerylRuntimeOptions {
-        call_veryl_build: true, /* warning: not thread safe! don't use if you
-                                 * have multiple tests */
+        call_veryl_build: env::var("RUNNING_TESTS_INDEPENDENTLY")
+            .map(|value| &value == "1")
+            .unwrap_or(false),
         ..Default::default()
     })?;