add testApps command

Author: Oron Port

build.sbt

@@ -1,4 +1,6 @@
 commands += DFHDLCommands.quickTestSetup
+commands += DFHDLCommands.clearSandbox
+commands += DFHDLCommands.testApps
 commands += DFHDLCommands.docExamplesRefUpdate
 
 // format: off

lib/src/main/scala/dfhdl/app/DFApp.scala

@@ -203,7 +203,7 @@ trait DFApp:
   end simRun
 
   private def listBackends: Unit =
-    println(
+    System.out.println(
       s"""|Backend option pattern: -b <lang>[.<dialect>]
           |<lang>    - the required backend language
           |<dialect> - the optional language dialect (each language has a default dialect)
@@ -237,7 +237,7 @@ trait DFApp:
           case Some(version) => s"Found version $version"
           case None          => "Not found on your system"
       else ""
-    println(
+    System.out.println(
       s"""|Linter tool option pattern: -t [<verilogLinter>][/][<vhdlLinter>]
           |<verilogLinter> - the selected Verilog/SystemVerilog linter
           |<vhdlLinter>    - the selected VHDL linter
@@ -271,7 +271,7 @@ trait DFApp:
           case Some(version) => s"Found version $version"
           case None          => "Not found on your system"
       else ""
-    println(
+    System.out.println(
       s"""|Simulator tool option pattern: -t [<verilogSimulator>][/][<vhdlSimulator>]
           |<verilogSimulator> - the selected Verilog/SystemVerilog simulator
           |<vhdlSimulator>    - the selected VHDL simulator

lib/src/test/scala/util/EmptyDesign.scala

@@ -0,0 +1,4 @@
+package util
+import dfhdl.*
+//used to create an empty design app for testing
+@top class EmptyDesign extends DFDesign

project/DFHDLCommands.scala

@@ -68,4 +68,72 @@ object DFHDLCommands {
 
     state
   }
+
+  val clearSandbox = Command.command("clearSandbox") { state =>
+    // Remove the sandbox folder and all its contents before running the tests
+    val sandboxPath = java.nio.file.Paths.get("sandbox")
+    if (java.nio.file.Files.exists(sandboxPath)) {
+      import java.nio.file._
+      import java.nio.file.attribute.BasicFileAttributes
+
+      Files.walkFileTree(
+        sandboxPath,
+        new SimpleFileVisitor[Path] {
+          override def visitFile(file: Path, attrs: BasicFileAttributes): FileVisitResult = {
+            Files.delete(file)
+            FileVisitResult.CONTINUE
+          }
+          override def postVisitDirectory(dir: Path, exc: java.io.IOException): FileVisitResult = {
+            Files.delete(dir)
+            FileVisitResult.CONTINUE
+          }
+        }
+      )
+    }
+    state
+  }
+
+  val vhdlTools = List("ghdl", "nvc", "questa", "vivado")
+  val verilogTools = List("verilator", "iverilog", "questa", "vivado")
+  val vhdlDialects = List("vhdl.v93", "vhdl.v2008")
+  val verilogDialects = List("verilog.v95", "verilog.v2001", "verilog.sv2005")
+
+  val testApps = Command.command("testApps") { state =>
+    var newState = Command.process("clearSandbox", state, _ => ())
+    val extracted = Project.extract(newState)
+    val runMainTask = LocalProject("lib") / Test / runMain
+    val existingTools: Set[String] = {
+      import java.io.{ByteArrayOutputStream, PrintStream}
+      val baos = new ByteArrayOutputStream()
+      val ps = new PrintStream(baos)
+      val oldOut = System.out
+      val oldErr = System.err
+      val arguments = s" util.top_EmptyDesign help simulate-tool -s"
+      try {
+        System.setOut(ps)
+        System.setErr(ps)
+        val extracted = Project.extract(state)
+        extracted.runInputTask(runMainTask, arguments, state)
+      } finally {
+        System.out.flush()
+        System.err.flush()
+        System.setOut(oldOut)
+        System.setErr(oldErr)
+      }
+      val helpStr = baos.toString("UTF-8")
+      val allTools = (vhdlTools ++ verilogTools).toSet
+      allTools.filter(tool => helpStr.linesIterator.exists(line => line.contains(tool) && line.contains("Found version")))
+    }
+    for (tool <- vhdlTools if existingTools.contains(tool); dialect <- vhdlDialects) {
+      val arguments = s" AES.top_CipherSim simulate -b $dialect -t $tool --Werror-tool"
+      val (updatedState, _) = extracted.runInputTask(runMainTask, arguments, newState)
+      newState = updatedState
+    }
+    for (tool <- verilogTools if existingTools.contains(tool); dialect <- verilogDialects) {
+      val arguments = s" AES.top_CipherSim simulate -b $dialect -t $tool --Werror-tool"
+      val (updatedState, _) = extracted.runInputTask(runMainTask, arguments, newState)
+      newState = updatedState
+    }
+    newState
+  }
 }