Enable JTAG tests

Fixes #4

.github/workflows/ci.yml

@@ -162,6 +162,10 @@ jobs:
         run: |
           tar -x -f vexriscv-test-binaries.tar
 
+      - name: OpenOCD bin symlink
+        run: |
+          ln -s /opt/bin/openocd /opt/bin/openocd-vexriscv
+
       - name: Run `clash-vexriscv` unittests
         run: |
           cabal run clash-vexriscv:unittests

Cargo.toml

@@ -13,6 +13,5 @@ opt-level = "z"
 [workspace]
 members = [
   "clash-vexriscv-sim/test-programs",
-  "debug-test",
 ]
 resolver = "2"

clash-vexriscv-sim/test-programs/src/bin/print_a.expected

@@ -0,0 +1 @@
+[CPU] a

clash-vexriscv-sim/test-programs/src/bin/print_b.expected

@@ -0,0 +1 @@
+[CPU] b

clash-vexriscv-sim/tests/tests.hs

@@ -10,6 +10,7 @@ import qualified Data.List as L
 
 import Control.Monad (forM)
 import Data.Maybe (catMaybes, mapMaybe)
+import Data.Tuple.Extra (fst3)
 import Data.Word (Word8)
 import GHC.Base (when)
 import System.Directory (copyFile, doesFileExist, listDirectory)
@@ -23,8 +24,7 @@ import Test.Tasty.HUnit (Assertion, testCase, (@?=))
 import Utils.ProgramLoad (loadProgramDmem)
 import Utils.Cpu (cpu)
 
--- XXX: Disabled, we need to add OpenOCD + GDB to CI (or use the Nix shell?)
--- import qualified Tests.Jtag
+import qualified Tests.Jtag
 
 runProgramExpect ::
   -- | action to copy ELF file
@@ -109,8 +109,8 @@ runTest name mode n elfPath expectPath =
 
 main :: IO ()
 main = do
-  debugTests <- findTests sourceDir debugBinDir
-  releaseTests <- findTests sourceDir releaseBinDir
+  debugTests <- L.sortOn fst3 <$> findTests sourceDir debugBinDir
+  releaseTests <- L.sortOn fst3 <$> findTests sourceDir releaseBinDir
 
   when (L.null debugTests) $ do
     hPutStrLn stderr "No debug tests found! Was `cargo build` run?"
@@ -131,8 +131,7 @@ main = do
           "VexRiscv Tests"
           [ testGroup "Debug builds" debugTestCases
           , testGroup "Release builds" releaseTestCases
-          -- XXX: Disabled, we need to add OpenOCD + GDB to CI (or use the Nix shell?)
-          -- , Tests.Jtag.tests
+          , Tests.Jtag.tests
           ]
 
   defaultMain tests