deprecating BackendCompilationUtilities trait for object (#1575)

2 files changed, 45 insertions, 15 deletions

diff --git a/src/main/scala/firrtl/util/BackendCompilationUtilities.scala b/src/main/scala/firrtl/util/BackendCompilationUtilities.scala
index 91b88090..3bbef814 100644
--- a/src/main/scala/firrtl/util/BackendCompilationUtilities.scala
+++ b/src/main/scala/firrtl/util/BackendCompilationUtilities.scala
@@ -13,7 +13,7 @@ import firrtl.FileUtils
 
 import scala.sys.process.{ProcessBuilder, ProcessLogger, _}
 
-trait BackendCompilationUtilities extends LazyLogging {
+object BackendCompilationUtilities extends LazyLogging {
   /** Parent directory for tests */
   lazy val TestDirectory = new File("test_run_dir")
 
@@ -102,7 +102,7 @@ trait BackendCompilationUtilities extends LazyLogging {
     * @param resourceFileName specifies what filename to look for to find a .f file
     * @param extraCmdLineArgs list of additional command line arguments
     */
-  def verilogToCppWithExtraCmdLineArgs(
+  def verilogToCpp(
     dutFile: String,
     dir: File,
     vSources: Seq[File],
@@ -163,18 +163,6 @@ trait BackendCompilationUtilities extends LazyLogging {
     command
   }
 
-  @deprecated("use verilogtoCppWithExtraCmdLineArgs","1.3")
-  def verilogToCpp(
-    dutFile: String,
-    dir: File,
-    vSources: Seq[File],
-    cppHarness: File,
-    suppressVcd: Boolean = false,
-    resourceFileName: String = firrtl.transforms.BlackBoxSourceHelper.defaultFileListName
-  ): ProcessBuilder = {
-    verilogToCppWithExtraCmdLineArgs(dutFile, dir, vSources, cppHarness, suppressVcd, resourceFileName)
-  }
-
   def cppToExe(prefix: String, dir: File): ProcessBuilder =
     Seq("make", "-C", dir.toString, "-j", "-f", s"V$prefix.mk", s"V$prefix")
 
@@ -260,3 +248,44 @@ trait BackendCompilationUtilities extends LazyLogging {
     command.! != 0
   }
 }
+
+@deprecated("use object BackendCompilationUtilities", "1.3")
+trait BackendCompilationUtilities extends LazyLogging {
+  lazy val TestDirectory = BackendCompilationUtilities.TestDirectory
+  def timeStamp: String = BackendCompilationUtilities.timeStamp
+  def loggingProcessLogger: ProcessLogger = BackendCompilationUtilities.loggingProcessLogger
+  def copyResourceToFile(name: String, file: File): Unit = BackendCompilationUtilities.copyResourceToFile(name, file)
+  def createTestDirectory(testName: String): File = BackendCompilationUtilities.createTestDirectory(testName)
+  def makeHarness(template: String => String, post: String)(f: File): File = BackendCompilationUtilities.makeHarness(template, post)(f)
+  def firrtlToVerilog(prefix: String, dir: File): ProcessBuilder = BackendCompilationUtilities.firrtlToVerilog(prefix, dir)
+  def verilogToCpp(
+                    dutFile: String,
+                    dir: File,
+                    vSources: Seq[File],
+                    cppHarness: File,
+                    suppressVcd: Boolean = false,
+                    resourceFileName: String = firrtl.transforms.BlackBoxSourceHelper.defaultFileListName
+                  ): ProcessBuilder = {
+    BackendCompilationUtilities.verilogToCpp(dutFile, dir, vSources, cppHarness, suppressVcd, resourceFileName)
+  }
+  def cppToExe(prefix: String, dir: File): ProcessBuilder = BackendCompilationUtilities.cppToExe(prefix, dir)
+  def executeExpectingFailure(
+                               prefix: String,
+                               dir: File,
+                               assertionMsg: String = ""): Boolean = {
+    BackendCompilationUtilities.executeExpectingFailure(prefix, dir, assertionMsg)
+  }
+  def executeExpectingSuccess(prefix: String, dir: File): Boolean = BackendCompilationUtilities.executeExpectingSuccess(prefix, dir)
+  def yosysExpectSuccess(customTop: String,
+                         referenceTop: String,
+                         testDir: File,
+                         resets: Seq[(Int, String, Int)] = Seq.empty): Boolean = {
+    BackendCompilationUtilities.yosysExpectSuccess(customTop, referenceTop, testDir, resets)
+  }
+  def yosysExpectFailure(customTop: String,
+                         referenceTop: String,
+                         testDir: File,
+                         resets: Seq[(Int, String, Int)] = Seq.empty): Boolean = {
+    BackendCompilationUtilities.yosysExpectFailure(customTop, referenceTop, testDir, resets)
+  }
+}
diff --git a/src/test/scala/firrtlTests/VerilogEmitterTests.scala b/src/test/scala/firrtlTests/VerilogEmitterTests.scala
index 7adc490f..60ab983b 100644
--- a/src/test/scala/firrtlTests/VerilogEmitterTests.scala
+++ b/src/test/scala/firrtlTests/VerilogEmitterTests.scala
@@ -11,6 +11,7 @@ import firrtl.transforms.VerilogRename
 import firrtl.transforms.CombineCats
 import firrtl.testutils._
 import firrtl.testutils.FirrtlCheckers._
+import firrtl.util.BackendCompilationUtilities
 
 import scala.sys.process.{Process, ProcessLogger}
 
@@ -891,7 +892,7 @@ class EmittedMacroSpec extends FirrtlPropSpec {
       "+define+FIRRTL_AFTER_INITIAL=initial begin $fwrite(32'h80000002, \"printing from FIRRTL_AFTER_INITIAL macro\\n\"); end"
     )
 
-    verilogToCppWithExtraCmdLineArgs(prefix, testDir, List.empty, harness, extraCmdLineArgs = cmdLineArgs) #&&
+    BackendCompilationUtilities.verilogToCpp(prefix, testDir, List.empty, harness, extraCmdLineArgs = cmdLineArgs) #&&
       cppToExe(prefix, testDir) !
       loggingProcessLogger